aws-sdk-servicecatalog 1.0.0.rc1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-servicecatalog.rb +47 -0
- data/lib/aws-sdk-servicecatalog/client.rb +2425 -0
- data/lib/aws-sdk-servicecatalog/client_api.rb +1309 -0
- data/lib/aws-sdk-servicecatalog/customizations.rb +7 -0
- data/lib/aws-sdk-servicecatalog/errors.rb +23 -0
- data/lib/aws-sdk-servicecatalog/resource.rb +25 -0
- data/lib/aws-sdk-servicecatalog/types.rb +3172 -0
- metadata +80 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ServiceCatalog
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
14
|
+
# Raised when calling #load or #data on a resource class that can not be
|
15
|
+
# loaded. This can happen when:
|
16
|
+
#
|
17
|
+
# * A resource class has identifiers, but no data attributes.
|
18
|
+
# * Resource data is only available when making an API call that
|
19
|
+
# enumerates all resources of that type.
|
20
|
+
class ResourceNotLoadable < RuntimeError; end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ServiceCatalog
|
10
|
+
class Resource
|
11
|
+
|
12
|
+
# @param options ({})
|
13
|
+
# @option options [Client] :client
|
14
|
+
def initialize(options = {})
|
15
|
+
@client = options[:client] || Client.new(options)
|
16
|
+
end
|
17
|
+
|
18
|
+
# @return [Client]
|
19
|
+
def client
|
20
|
+
@client
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,3172 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module ServiceCatalog
|
10
|
+
module Types
|
11
|
+
|
12
|
+
# @note When making an API call, pass AcceptPortfolioShareInput
|
13
|
+
# data as a hash:
|
14
|
+
#
|
15
|
+
# {
|
16
|
+
# accept_language: "AcceptLanguage",
|
17
|
+
# portfolio_id: "Id", # required
|
18
|
+
# }
|
19
|
+
# @!attribute [rw] accept_language
|
20
|
+
# The language code to use for this operation. Supported language
|
21
|
+
# codes are as follows:
|
22
|
+
#
|
23
|
+
# "en" (English)
|
24
|
+
#
|
25
|
+
# "jp" (Japanese)
|
26
|
+
#
|
27
|
+
# "zh" (Chinese)
|
28
|
+
#
|
29
|
+
# If no code is specified, "en" is used as the default.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] portfolio_id
|
33
|
+
# The portfolio identifier.
|
34
|
+
# @return [String]
|
35
|
+
class AcceptPortfolioShareInput < Struct.new(
|
36
|
+
:accept_language,
|
37
|
+
:portfolio_id)
|
38
|
+
include Aws::Structure
|
39
|
+
end
|
40
|
+
|
41
|
+
class AcceptPortfolioShareOutput < Aws::EmptyStructure; end
|
42
|
+
|
43
|
+
# The access level to limit results.
|
44
|
+
# @note When making an API call, pass AccessLevelFilter
|
45
|
+
# data as a hash:
|
46
|
+
#
|
47
|
+
# {
|
48
|
+
# key: "Account", # accepts Account, Role, User
|
49
|
+
# value: "AccessLevelFilterValue",
|
50
|
+
# }
|
51
|
+
# @!attribute [rw] key
|
52
|
+
# Specifies the access level.
|
53
|
+
#
|
54
|
+
# `Account` allows results at the account level.
|
55
|
+
#
|
56
|
+
# `Role` allows results based on the federated role of the specified
|
57
|
+
# user.
|
58
|
+
#
|
59
|
+
# `User` allows results limited to the specified user.
|
60
|
+
# @return [String]
|
61
|
+
#
|
62
|
+
# @!attribute [rw] value
|
63
|
+
# Specifies the user to which the access level applies. A value of
|
64
|
+
# `Self` is currently supported.
|
65
|
+
# @return [String]
|
66
|
+
class AccessLevelFilter < Struct.new(
|
67
|
+
:key,
|
68
|
+
:value)
|
69
|
+
include Aws::Structure
|
70
|
+
end
|
71
|
+
|
72
|
+
# @note When making an API call, pass AssociatePrincipalWithPortfolioInput
|
73
|
+
# data as a hash:
|
74
|
+
#
|
75
|
+
# {
|
76
|
+
# accept_language: "AcceptLanguage",
|
77
|
+
# portfolio_id: "Id", # required
|
78
|
+
# principal_arn: "PrincipalARN", # required
|
79
|
+
# principal_type: "IAM", # required, accepts IAM
|
80
|
+
# }
|
81
|
+
# @!attribute [rw] accept_language
|
82
|
+
# The language code to use for this operation. Supported language
|
83
|
+
# codes are as follows:
|
84
|
+
#
|
85
|
+
# "en" (English)
|
86
|
+
#
|
87
|
+
# "jp" (Japanese)
|
88
|
+
#
|
89
|
+
# "zh" (Chinese)
|
90
|
+
#
|
91
|
+
# If no code is specified, "en" is used as the default.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @!attribute [rw] portfolio_id
|
95
|
+
# The portfolio identifier.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] principal_arn
|
99
|
+
# The ARN representing the principal (IAM user, role, or group).
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @!attribute [rw] principal_type
|
103
|
+
# The principal type. Must be `IAM`
|
104
|
+
# @return [String]
|
105
|
+
class AssociatePrincipalWithPortfolioInput < Struct.new(
|
106
|
+
:accept_language,
|
107
|
+
:portfolio_id,
|
108
|
+
:principal_arn,
|
109
|
+
:principal_type)
|
110
|
+
include Aws::Structure
|
111
|
+
end
|
112
|
+
|
113
|
+
class AssociatePrincipalWithPortfolioOutput < Aws::EmptyStructure; end
|
114
|
+
|
115
|
+
# @note When making an API call, pass AssociateProductWithPortfolioInput
|
116
|
+
# data as a hash:
|
117
|
+
#
|
118
|
+
# {
|
119
|
+
# accept_language: "AcceptLanguage",
|
120
|
+
# product_id: "Id", # required
|
121
|
+
# portfolio_id: "Id", # required
|
122
|
+
# source_portfolio_id: "Id",
|
123
|
+
# }
|
124
|
+
# @!attribute [rw] accept_language
|
125
|
+
# The language code to use for this operation. Supported language
|
126
|
+
# codes are as follows:
|
127
|
+
#
|
128
|
+
# "en" (English)
|
129
|
+
#
|
130
|
+
# "jp" (Japanese)
|
131
|
+
#
|
132
|
+
# "zh" (Chinese)
|
133
|
+
#
|
134
|
+
# If no code is specified, "en" is used as the default.
|
135
|
+
# @return [String]
|
136
|
+
#
|
137
|
+
# @!attribute [rw] product_id
|
138
|
+
# The product identifier.
|
139
|
+
# @return [String]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] portfolio_id
|
142
|
+
# The portfolio identifier.
|
143
|
+
# @return [String]
|
144
|
+
#
|
145
|
+
# @!attribute [rw] source_portfolio_id
|
146
|
+
# The identifier of the source portfolio to use with this association.
|
147
|
+
# @return [String]
|
148
|
+
class AssociateProductWithPortfolioInput < Struct.new(
|
149
|
+
:accept_language,
|
150
|
+
:product_id,
|
151
|
+
:portfolio_id,
|
152
|
+
:source_portfolio_id)
|
153
|
+
include Aws::Structure
|
154
|
+
end
|
155
|
+
|
156
|
+
class AssociateProductWithPortfolioOutput < Aws::EmptyStructure; end
|
157
|
+
|
158
|
+
# Detailed constraint information.
|
159
|
+
# @!attribute [rw] constraint_id
|
160
|
+
# The identifier of the constraint.
|
161
|
+
# @return [String]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] type
|
164
|
+
# The type of the constraint.
|
165
|
+
# @return [String]
|
166
|
+
#
|
167
|
+
# @!attribute [rw] description
|
168
|
+
# The text description of the constraint.
|
169
|
+
# @return [String]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] owner
|
172
|
+
# The owner of the constraint.
|
173
|
+
# @return [String]
|
174
|
+
class ConstraintDetail < Struct.new(
|
175
|
+
:constraint_id,
|
176
|
+
:type,
|
177
|
+
:description,
|
178
|
+
:owner)
|
179
|
+
include Aws::Structure
|
180
|
+
end
|
181
|
+
|
182
|
+
# An administrator-specified constraint to apply when provisioning a
|
183
|
+
# product.
|
184
|
+
# @!attribute [rw] type
|
185
|
+
# The type of the constraint.
|
186
|
+
# @return [String]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] description
|
189
|
+
# The text description of the constraint.
|
190
|
+
# @return [String]
|
191
|
+
class ConstraintSummary < Struct.new(
|
192
|
+
:type,
|
193
|
+
:description)
|
194
|
+
include Aws::Structure
|
195
|
+
end
|
196
|
+
|
197
|
+
# @note When making an API call, pass CreateConstraintInput
|
198
|
+
# data as a hash:
|
199
|
+
#
|
200
|
+
# {
|
201
|
+
# accept_language: "AcceptLanguage",
|
202
|
+
# portfolio_id: "Id", # required
|
203
|
+
# product_id: "Id", # required
|
204
|
+
# parameters: "ConstraintParameters", # required
|
205
|
+
# type: "ConstraintType", # required
|
206
|
+
# description: "ConstraintDescription",
|
207
|
+
# idempotency_token: "IdempotencyToken", # required
|
208
|
+
# }
|
209
|
+
# @!attribute [rw] accept_language
|
210
|
+
# The language code to use for this operation. Supported language
|
211
|
+
# codes are as follows:
|
212
|
+
#
|
213
|
+
# "en" (English)
|
214
|
+
#
|
215
|
+
# "jp" (Japanese)
|
216
|
+
#
|
217
|
+
# "zh" (Chinese)
|
218
|
+
#
|
219
|
+
# If no code is specified, "en" is used as the default.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] portfolio_id
|
223
|
+
# The portfolio identifier.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] product_id
|
227
|
+
# The product identifier.
|
228
|
+
# @return [String]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] parameters
|
231
|
+
# The constraint parameters.
|
232
|
+
# @return [String]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] type
|
235
|
+
# The type of the constraint.
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] description
|
239
|
+
# The text description of the constraint.
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @!attribute [rw] idempotency_token
|
243
|
+
# A token to disambiguate duplicate requests. You can create multiple
|
244
|
+
# resources using the same input in multiple requests, provided that
|
245
|
+
# you also specify a different idempotency token for each request.
|
246
|
+
#
|
247
|
+
# **A suitable default value is auto-generated.** You should
|
248
|
+
# normally not need to pass this option.
|
249
|
+
# @return [String]
|
250
|
+
class CreateConstraintInput < Struct.new(
|
251
|
+
:accept_language,
|
252
|
+
:portfolio_id,
|
253
|
+
:product_id,
|
254
|
+
:parameters,
|
255
|
+
:type,
|
256
|
+
:description,
|
257
|
+
:idempotency_token)
|
258
|
+
include Aws::Structure
|
259
|
+
end
|
260
|
+
|
261
|
+
# @!attribute [rw] constraint_detail
|
262
|
+
# The resulting detailed constraint information.
|
263
|
+
# @return [Types::ConstraintDetail]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] constraint_parameters
|
266
|
+
# The resulting constraint parameters.
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] status
|
270
|
+
# The status of the current request.
|
271
|
+
# @return [String]
|
272
|
+
class CreateConstraintOutput < Struct.new(
|
273
|
+
:constraint_detail,
|
274
|
+
:constraint_parameters,
|
275
|
+
:status)
|
276
|
+
include Aws::Structure
|
277
|
+
end
|
278
|
+
|
279
|
+
# @note When making an API call, pass CreatePortfolioInput
|
280
|
+
# data as a hash:
|
281
|
+
#
|
282
|
+
# {
|
283
|
+
# accept_language: "AcceptLanguage",
|
284
|
+
# display_name: "PortfolioDisplayName", # required
|
285
|
+
# description: "PortfolioDescription",
|
286
|
+
# provider_name: "ProviderName", # required
|
287
|
+
# tags: [
|
288
|
+
# {
|
289
|
+
# key: "TagKey", # required
|
290
|
+
# value: "TagValue", # required
|
291
|
+
# },
|
292
|
+
# ],
|
293
|
+
# idempotency_token: "IdempotencyToken", # required
|
294
|
+
# }
|
295
|
+
# @!attribute [rw] accept_language
|
296
|
+
# The language code to use for this operation. Supported language
|
297
|
+
# codes are as follows:
|
298
|
+
#
|
299
|
+
# "en" (English)
|
300
|
+
#
|
301
|
+
# "jp" (Japanese)
|
302
|
+
#
|
303
|
+
# "zh" (Chinese)
|
304
|
+
#
|
305
|
+
# If no code is specified, "en" is used as the default.
|
306
|
+
# @return [String]
|
307
|
+
#
|
308
|
+
# @!attribute [rw] display_name
|
309
|
+
# The name to use for display purposes.
|
310
|
+
# @return [String]
|
311
|
+
#
|
312
|
+
# @!attribute [rw] description
|
313
|
+
# The text description of the portfolio.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @!attribute [rw] provider_name
|
317
|
+
# The name of the portfolio provider.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] tags
|
321
|
+
# Tags to associate with the new portfolio.
|
322
|
+
# @return [Array<Types::Tag>]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] idempotency_token
|
325
|
+
# A token to disambiguate duplicate requests. You can create multiple
|
326
|
+
# resources using the same input in multiple requests, provided that
|
327
|
+
# you also specify a different idempotency token for each request.
|
328
|
+
#
|
329
|
+
# **A suitable default value is auto-generated.** You should
|
330
|
+
# normally not need to pass this option.
|
331
|
+
# @return [String]
|
332
|
+
class CreatePortfolioInput < Struct.new(
|
333
|
+
:accept_language,
|
334
|
+
:display_name,
|
335
|
+
:description,
|
336
|
+
:provider_name,
|
337
|
+
:tags,
|
338
|
+
:idempotency_token)
|
339
|
+
include Aws::Structure
|
340
|
+
end
|
341
|
+
|
342
|
+
# @!attribute [rw] portfolio_detail
|
343
|
+
# The resulting detailed portfolio information.
|
344
|
+
# @return [Types::PortfolioDetail]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] tags
|
347
|
+
# Tags successfully associated with the new portfolio.
|
348
|
+
# @return [Array<Types::Tag>]
|
349
|
+
class CreatePortfolioOutput < Struct.new(
|
350
|
+
:portfolio_detail,
|
351
|
+
:tags)
|
352
|
+
include Aws::Structure
|
353
|
+
end
|
354
|
+
|
355
|
+
# @note When making an API call, pass CreatePortfolioShareInput
|
356
|
+
# data as a hash:
|
357
|
+
#
|
358
|
+
# {
|
359
|
+
# accept_language: "AcceptLanguage",
|
360
|
+
# portfolio_id: "Id", # required
|
361
|
+
# account_id: "AccountId", # required
|
362
|
+
# }
|
363
|
+
# @!attribute [rw] accept_language
|
364
|
+
# The language code to use for this operation. Supported language
|
365
|
+
# codes are as follows:
|
366
|
+
#
|
367
|
+
# "en" (English)
|
368
|
+
#
|
369
|
+
# "jp" (Japanese)
|
370
|
+
#
|
371
|
+
# "zh" (Chinese)
|
372
|
+
#
|
373
|
+
# If no code is specified, "en" is used as the default.
|
374
|
+
# @return [String]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] portfolio_id
|
377
|
+
# The portfolio identifier.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] account_id
|
381
|
+
# The account ID with which to share the portfolio.
|
382
|
+
# @return [String]
|
383
|
+
class CreatePortfolioShareInput < Struct.new(
|
384
|
+
:accept_language,
|
385
|
+
:portfolio_id,
|
386
|
+
:account_id)
|
387
|
+
include Aws::Structure
|
388
|
+
end
|
389
|
+
|
390
|
+
class CreatePortfolioShareOutput < Aws::EmptyStructure; end
|
391
|
+
|
392
|
+
# @note When making an API call, pass CreateProductInput
|
393
|
+
# data as a hash:
|
394
|
+
#
|
395
|
+
# {
|
396
|
+
# accept_language: "AcceptLanguage",
|
397
|
+
# name: "ProductViewName", # required
|
398
|
+
# owner: "ProductViewOwner", # required
|
399
|
+
# description: "ProductViewShortDescription",
|
400
|
+
# distributor: "ProductViewOwner",
|
401
|
+
# support_description: "SupportDescription",
|
402
|
+
# support_email: "SupportEmail",
|
403
|
+
# support_url: "SupportUrl",
|
404
|
+
# product_type: "CLOUD_FORMATION_TEMPLATE", # required, accepts CLOUD_FORMATION_TEMPLATE
|
405
|
+
# tags: [
|
406
|
+
# {
|
407
|
+
# key: "TagKey", # required
|
408
|
+
# value: "TagValue", # required
|
409
|
+
# },
|
410
|
+
# ],
|
411
|
+
# provisioning_artifact_parameters: { # required
|
412
|
+
# name: "ProvisioningArtifactName",
|
413
|
+
# description: "ProvisioningArtifactDescription",
|
414
|
+
# info: { # required
|
415
|
+
# "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
|
416
|
+
# },
|
417
|
+
# type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE
|
418
|
+
# },
|
419
|
+
# idempotency_token: "IdempotencyToken", # required
|
420
|
+
# }
|
421
|
+
# @!attribute [rw] accept_language
|
422
|
+
# The language code to use for this operation. Supported language
|
423
|
+
# codes are as follows:
|
424
|
+
#
|
425
|
+
# "en" (English)
|
426
|
+
#
|
427
|
+
# "jp" (Japanese)
|
428
|
+
#
|
429
|
+
# "zh" (Chinese)
|
430
|
+
#
|
431
|
+
# If no code is specified, "en" is used as the default.
|
432
|
+
# @return [String]
|
433
|
+
#
|
434
|
+
# @!attribute [rw] name
|
435
|
+
# The name of the product.
|
436
|
+
# @return [String]
|
437
|
+
#
|
438
|
+
# @!attribute [rw] owner
|
439
|
+
# The owner of the product.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] description
|
443
|
+
# The text description of the product.
|
444
|
+
# @return [String]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] distributor
|
447
|
+
# The distributor of the product.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] support_description
|
451
|
+
# Support information about the product.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] support_email
|
455
|
+
# Contact email for product support.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] support_url
|
459
|
+
# Contact URL for product support.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] product_type
|
463
|
+
# The type of the product to create.
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] tags
|
467
|
+
# Tags to associate with the new product.
|
468
|
+
# @return [Array<Types::Tag>]
|
469
|
+
#
|
470
|
+
# @!attribute [rw] provisioning_artifact_parameters
|
471
|
+
# Parameters for the provisioning artifact.
|
472
|
+
# @return [Types::ProvisioningArtifactProperties]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] idempotency_token
|
475
|
+
# A token to disambiguate duplicate requests. You can create multiple
|
476
|
+
# resources using the same input in multiple requests, provided that
|
477
|
+
# you also specify a different idempotency token for each request.
|
478
|
+
#
|
479
|
+
# **A suitable default value is auto-generated.** You should
|
480
|
+
# normally not need to pass this option.
|
481
|
+
# @return [String]
|
482
|
+
class CreateProductInput < Struct.new(
|
483
|
+
:accept_language,
|
484
|
+
:name,
|
485
|
+
:owner,
|
486
|
+
:description,
|
487
|
+
:distributor,
|
488
|
+
:support_description,
|
489
|
+
:support_email,
|
490
|
+
:support_url,
|
491
|
+
:product_type,
|
492
|
+
:tags,
|
493
|
+
:provisioning_artifact_parameters,
|
494
|
+
:idempotency_token)
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# @!attribute [rw] product_view_detail
|
499
|
+
# The resulting detailed product view information.
|
500
|
+
# @return [Types::ProductViewDetail]
|
501
|
+
#
|
502
|
+
# @!attribute [rw] provisioning_artifact_detail
|
503
|
+
# The resulting detailed provisioning artifact information.
|
504
|
+
# @return [Types::ProvisioningArtifactDetail]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] tags
|
507
|
+
# Tags successfully associated with the new product.
|
508
|
+
# @return [Array<Types::Tag>]
|
509
|
+
class CreateProductOutput < Struct.new(
|
510
|
+
:product_view_detail,
|
511
|
+
:provisioning_artifact_detail,
|
512
|
+
:tags)
|
513
|
+
include Aws::Structure
|
514
|
+
end
|
515
|
+
|
516
|
+
# @note When making an API call, pass CreateProvisioningArtifactInput
|
517
|
+
# data as a hash:
|
518
|
+
#
|
519
|
+
# {
|
520
|
+
# accept_language: "AcceptLanguage",
|
521
|
+
# product_id: "Id", # required
|
522
|
+
# parameters: { # required
|
523
|
+
# name: "ProvisioningArtifactName",
|
524
|
+
# description: "ProvisioningArtifactDescription",
|
525
|
+
# info: { # required
|
526
|
+
# "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
|
527
|
+
# },
|
528
|
+
# type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE
|
529
|
+
# },
|
530
|
+
# idempotency_token: "IdempotencyToken", # required
|
531
|
+
# }
|
532
|
+
# @!attribute [rw] accept_language
|
533
|
+
# The language code to use for this operation. Supported language
|
534
|
+
# codes are as follows:
|
535
|
+
#
|
536
|
+
# "en" (English)
|
537
|
+
#
|
538
|
+
# "jp" (Japanese)
|
539
|
+
#
|
540
|
+
# "zh" (Chinese)
|
541
|
+
#
|
542
|
+
# If no code is specified, "en" is used as the default.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @!attribute [rw] product_id
|
546
|
+
# The product identifier.
|
547
|
+
# @return [String]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] parameters
|
550
|
+
# The parameters to use when creating the new provisioning artifact.
|
551
|
+
# @return [Types::ProvisioningArtifactProperties]
|
552
|
+
#
|
553
|
+
# @!attribute [rw] idempotency_token
|
554
|
+
# A token to disambiguate duplicate requests. You can create multiple
|
555
|
+
# resources using the same input in multiple requests, provided that
|
556
|
+
# you also specify a different idempotency token for each request.
|
557
|
+
#
|
558
|
+
# **A suitable default value is auto-generated.** You should
|
559
|
+
# normally not need to pass this option.
|
560
|
+
# @return [String]
|
561
|
+
class CreateProvisioningArtifactInput < Struct.new(
|
562
|
+
:accept_language,
|
563
|
+
:product_id,
|
564
|
+
:parameters,
|
565
|
+
:idempotency_token)
|
566
|
+
include Aws::Structure
|
567
|
+
end
|
568
|
+
|
569
|
+
# @!attribute [rw] provisioning_artifact_detail
|
570
|
+
# The resulting detailed provisioning artifact information.
|
571
|
+
# @return [Types::ProvisioningArtifactDetail]
|
572
|
+
#
|
573
|
+
# @!attribute [rw] info
|
574
|
+
# Additional information about the provisioning artifact create
|
575
|
+
# request.
|
576
|
+
# @return [Hash<String,String>]
|
577
|
+
#
|
578
|
+
# @!attribute [rw] status
|
579
|
+
# The status of the current request.
|
580
|
+
# @return [String]
|
581
|
+
class CreateProvisioningArtifactOutput < Struct.new(
|
582
|
+
:provisioning_artifact_detail,
|
583
|
+
:info,
|
584
|
+
:status)
|
585
|
+
include Aws::Structure
|
586
|
+
end
|
587
|
+
|
588
|
+
# @note When making an API call, pass DeleteConstraintInput
|
589
|
+
# data as a hash:
|
590
|
+
#
|
591
|
+
# {
|
592
|
+
# accept_language: "AcceptLanguage",
|
593
|
+
# id: "Id", # required
|
594
|
+
# }
|
595
|
+
# @!attribute [rw] accept_language
|
596
|
+
# The language code to use for this operation. Supported language
|
597
|
+
# codes are as follows:
|
598
|
+
#
|
599
|
+
# "en" (English)
|
600
|
+
#
|
601
|
+
# "jp" (Japanese)
|
602
|
+
#
|
603
|
+
# "zh" (Chinese)
|
604
|
+
#
|
605
|
+
# If no code is specified, "en" is used as the default.
|
606
|
+
# @return [String]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] id
|
609
|
+
# The identifier of the constraint to delete.
|
610
|
+
# @return [String]
|
611
|
+
class DeleteConstraintInput < Struct.new(
|
612
|
+
:accept_language,
|
613
|
+
:id)
|
614
|
+
include Aws::Structure
|
615
|
+
end
|
616
|
+
|
617
|
+
class DeleteConstraintOutput < Aws::EmptyStructure; end
|
618
|
+
|
619
|
+
# @note When making an API call, pass DeletePortfolioInput
|
620
|
+
# data as a hash:
|
621
|
+
#
|
622
|
+
# {
|
623
|
+
# accept_language: "AcceptLanguage",
|
624
|
+
# id: "Id", # required
|
625
|
+
# }
|
626
|
+
# @!attribute [rw] accept_language
|
627
|
+
# The language code to use for this operation. Supported language
|
628
|
+
# codes are as follows:
|
629
|
+
#
|
630
|
+
# "en" (English)
|
631
|
+
#
|
632
|
+
# "jp" (Japanese)
|
633
|
+
#
|
634
|
+
# "zh" (Chinese)
|
635
|
+
#
|
636
|
+
# If no code is specified, "en" is used as the default.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] id
|
640
|
+
# The identifier of the portfolio for the delete request.
|
641
|
+
# @return [String]
|
642
|
+
class DeletePortfolioInput < Struct.new(
|
643
|
+
:accept_language,
|
644
|
+
:id)
|
645
|
+
include Aws::Structure
|
646
|
+
end
|
647
|
+
|
648
|
+
class DeletePortfolioOutput < Aws::EmptyStructure; end
|
649
|
+
|
650
|
+
# @note When making an API call, pass DeletePortfolioShareInput
|
651
|
+
# data as a hash:
|
652
|
+
#
|
653
|
+
# {
|
654
|
+
# accept_language: "AcceptLanguage",
|
655
|
+
# portfolio_id: "Id", # required
|
656
|
+
# account_id: "AccountId", # required
|
657
|
+
# }
|
658
|
+
# @!attribute [rw] accept_language
|
659
|
+
# The language code to use for this operation. Supported language
|
660
|
+
# codes are as follows:
|
661
|
+
#
|
662
|
+
# "en" (English)
|
663
|
+
#
|
664
|
+
# "jp" (Japanese)
|
665
|
+
#
|
666
|
+
# "zh" (Chinese)
|
667
|
+
#
|
668
|
+
# If no code is specified, "en" is used as the default.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] portfolio_id
|
672
|
+
# The portfolio identifier.
|
673
|
+
# @return [String]
|
674
|
+
#
|
675
|
+
# @!attribute [rw] account_id
|
676
|
+
# The account ID associated with the share to delete.
|
677
|
+
# @return [String]
|
678
|
+
class DeletePortfolioShareInput < Struct.new(
|
679
|
+
:accept_language,
|
680
|
+
:portfolio_id,
|
681
|
+
:account_id)
|
682
|
+
include Aws::Structure
|
683
|
+
end
|
684
|
+
|
685
|
+
class DeletePortfolioShareOutput < Aws::EmptyStructure; end
|
686
|
+
|
687
|
+
# @note When making an API call, pass DeleteProductInput
|
688
|
+
# data as a hash:
|
689
|
+
#
|
690
|
+
# {
|
691
|
+
# accept_language: "AcceptLanguage",
|
692
|
+
# id: "Id", # required
|
693
|
+
# }
|
694
|
+
# @!attribute [rw] accept_language
|
695
|
+
# The language code to use for this operation. Supported language
|
696
|
+
# codes are as follows:
|
697
|
+
#
|
698
|
+
# "en" (English)
|
699
|
+
#
|
700
|
+
# "jp" (Japanese)
|
701
|
+
#
|
702
|
+
# "zh" (Chinese)
|
703
|
+
#
|
704
|
+
# If no code is specified, "en" is used as the default.
|
705
|
+
# @return [String]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] id
|
708
|
+
# The identifier of the product for the delete request.
|
709
|
+
# @return [String]
|
710
|
+
class DeleteProductInput < Struct.new(
|
711
|
+
:accept_language,
|
712
|
+
:id)
|
713
|
+
include Aws::Structure
|
714
|
+
end
|
715
|
+
|
716
|
+
class DeleteProductOutput < Aws::EmptyStructure; end
|
717
|
+
|
718
|
+
# @note When making an API call, pass DeleteProvisioningArtifactInput
|
719
|
+
# data as a hash:
|
720
|
+
#
|
721
|
+
# {
|
722
|
+
# accept_language: "AcceptLanguage",
|
723
|
+
# product_id: "Id", # required
|
724
|
+
# provisioning_artifact_id: "Id", # required
|
725
|
+
# }
|
726
|
+
# @!attribute [rw] accept_language
|
727
|
+
# The language code to use for this operation. Supported language
|
728
|
+
# codes are as follows:
|
729
|
+
#
|
730
|
+
# "en" (English)
|
731
|
+
#
|
732
|
+
# "jp" (Japanese)
|
733
|
+
#
|
734
|
+
# "zh" (Chinese)
|
735
|
+
#
|
736
|
+
# If no code is specified, "en" is used as the default.
|
737
|
+
# @return [String]
|
738
|
+
#
|
739
|
+
# @!attribute [rw] product_id
|
740
|
+
# The product identifier.
|
741
|
+
# @return [String]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] provisioning_artifact_id
|
744
|
+
# The identifier of the provisioning artifact for the delete request.
|
745
|
+
# @return [String]
|
746
|
+
class DeleteProvisioningArtifactInput < Struct.new(
|
747
|
+
:accept_language,
|
748
|
+
:product_id,
|
749
|
+
:provisioning_artifact_id)
|
750
|
+
include Aws::Structure
|
751
|
+
end
|
752
|
+
|
753
|
+
class DeleteProvisioningArtifactOutput < Aws::EmptyStructure; end
|
754
|
+
|
755
|
+
# @note When making an API call, pass DescribeConstraintInput
|
756
|
+
# data as a hash:
|
757
|
+
#
|
758
|
+
# {
|
759
|
+
# accept_language: "AcceptLanguage",
|
760
|
+
# id: "Id", # required
|
761
|
+
# }
|
762
|
+
# @!attribute [rw] accept_language
|
763
|
+
# The language code to use for this operation. Supported language
|
764
|
+
# codes are as follows:
|
765
|
+
#
|
766
|
+
# "en" (English)
|
767
|
+
#
|
768
|
+
# "jp" (Japanese)
|
769
|
+
#
|
770
|
+
# "zh" (Chinese)
|
771
|
+
#
|
772
|
+
# If no code is specified, "en" is used as the default.
|
773
|
+
# @return [String]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] id
|
776
|
+
# The identifier of the constraint.
|
777
|
+
# @return [String]
|
778
|
+
class DescribeConstraintInput < Struct.new(
|
779
|
+
:accept_language,
|
780
|
+
:id)
|
781
|
+
include Aws::Structure
|
782
|
+
end
|
783
|
+
|
784
|
+
# @!attribute [rw] constraint_detail
|
785
|
+
# Detailed constraint information.
|
786
|
+
# @return [Types::ConstraintDetail]
|
787
|
+
#
|
788
|
+
# @!attribute [rw] constraint_parameters
|
789
|
+
# The current parameters associated with the specified constraint.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] status
|
793
|
+
# The status of the current request.
|
794
|
+
# @return [String]
|
795
|
+
class DescribeConstraintOutput < Struct.new(
|
796
|
+
:constraint_detail,
|
797
|
+
:constraint_parameters,
|
798
|
+
:status)
|
799
|
+
include Aws::Structure
|
800
|
+
end
|
801
|
+
|
802
|
+
# @note When making an API call, pass DescribePortfolioInput
|
803
|
+
# data as a hash:
|
804
|
+
#
|
805
|
+
# {
|
806
|
+
# accept_language: "AcceptLanguage",
|
807
|
+
# id: "Id", # required
|
808
|
+
# }
|
809
|
+
# @!attribute [rw] accept_language
|
810
|
+
# The language code to use for this operation. Supported language
|
811
|
+
# codes are as follows:
|
812
|
+
#
|
813
|
+
# "en" (English)
|
814
|
+
#
|
815
|
+
# "jp" (Japanese)
|
816
|
+
#
|
817
|
+
# "zh" (Chinese)
|
818
|
+
#
|
819
|
+
# If no code is specified, "en" is used as the default.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] id
|
823
|
+
# The identifier of the portfolio for which to retrieve information.
|
824
|
+
# @return [String]
|
825
|
+
class DescribePortfolioInput < Struct.new(
|
826
|
+
:accept_language,
|
827
|
+
:id)
|
828
|
+
include Aws::Structure
|
829
|
+
end
|
830
|
+
|
831
|
+
# @!attribute [rw] portfolio_detail
|
832
|
+
# Detailed portfolio information.
|
833
|
+
# @return [Types::PortfolioDetail]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] tags
|
836
|
+
# Tags associated with the portfolio.
|
837
|
+
# @return [Array<Types::Tag>]
|
838
|
+
class DescribePortfolioOutput < Struct.new(
|
839
|
+
:portfolio_detail,
|
840
|
+
:tags)
|
841
|
+
include Aws::Structure
|
842
|
+
end
|
843
|
+
|
844
|
+
# @note When making an API call, pass DescribeProductAsAdminInput
|
845
|
+
# data as a hash:
|
846
|
+
#
|
847
|
+
# {
|
848
|
+
# accept_language: "AcceptLanguage",
|
849
|
+
# id: "Id", # required
|
850
|
+
# }
|
851
|
+
# @!attribute [rw] accept_language
|
852
|
+
# The language code to use for this operation. Supported language
|
853
|
+
# codes are as follows:
|
854
|
+
#
|
855
|
+
# "en" (English)
|
856
|
+
#
|
857
|
+
# "jp" (Japanese)
|
858
|
+
#
|
859
|
+
# "zh" (Chinese)
|
860
|
+
#
|
861
|
+
# If no code is specified, "en" is used as the default.
|
862
|
+
# @return [String]
|
863
|
+
#
|
864
|
+
# @!attribute [rw] id
|
865
|
+
# The identifier of the product for which to retrieve information.
|
866
|
+
# @return [String]
|
867
|
+
class DescribeProductAsAdminInput < Struct.new(
|
868
|
+
:accept_language,
|
869
|
+
:id)
|
870
|
+
include Aws::Structure
|
871
|
+
end
|
872
|
+
|
873
|
+
# @!attribute [rw] product_view_detail
|
874
|
+
# Detailed product view information.
|
875
|
+
# @return [Types::ProductViewDetail]
|
876
|
+
#
|
877
|
+
# @!attribute [rw] tags
|
878
|
+
# Tags associated with the product.
|
879
|
+
# @return [Array<Types::Tag>]
|
880
|
+
class DescribeProductAsAdminOutput < Struct.new(
|
881
|
+
:product_view_detail,
|
882
|
+
:tags)
|
883
|
+
include Aws::Structure
|
884
|
+
end
|
885
|
+
|
886
|
+
# @note When making an API call, pass DescribeProductInput
|
887
|
+
# data as a hash:
|
888
|
+
#
|
889
|
+
# {
|
890
|
+
# accept_language: "AcceptLanguage",
|
891
|
+
# id: "Id", # required
|
892
|
+
# }
|
893
|
+
# @!attribute [rw] accept_language
|
894
|
+
# The language code to use for this operation. Supported language
|
895
|
+
# codes are as follows:
|
896
|
+
#
|
897
|
+
# "en" (English)
|
898
|
+
#
|
899
|
+
# "jp" (Japanese)
|
900
|
+
#
|
901
|
+
# "zh" (Chinese)
|
902
|
+
#
|
903
|
+
# If no code is specified, "en" is used as the default.
|
904
|
+
# @return [String]
|
905
|
+
#
|
906
|
+
# @!attribute [rw] id
|
907
|
+
# The `ProductId` of the product to describe.
|
908
|
+
# @return [String]
|
909
|
+
class DescribeProductInput < Struct.new(
|
910
|
+
:accept_language,
|
911
|
+
:id)
|
912
|
+
include Aws::Structure
|
913
|
+
end
|
914
|
+
|
915
|
+
# @!attribute [rw] product_view_summary
|
916
|
+
# The summary metadata about the specified product.
|
917
|
+
# @return [Types::ProductViewSummary]
|
918
|
+
#
|
919
|
+
# @!attribute [rw] provisioning_artifacts
|
920
|
+
# A list of provisioning artifact objects for the specified product.
|
921
|
+
# The `ProvisioningArtifacts` parameter represent the ways the
|
922
|
+
# specified product can be provisioned.
|
923
|
+
# @return [Array<Types::ProvisioningArtifact>]
|
924
|
+
class DescribeProductOutput < Struct.new(
|
925
|
+
:product_view_summary,
|
926
|
+
:provisioning_artifacts)
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
930
|
+
# @note When making an API call, pass DescribeProductViewInput
|
931
|
+
# data as a hash:
|
932
|
+
#
|
933
|
+
# {
|
934
|
+
# accept_language: "AcceptLanguage",
|
935
|
+
# id: "Id", # required
|
936
|
+
# }
|
937
|
+
# @!attribute [rw] accept_language
|
938
|
+
# The language code to use for this operation. Supported language
|
939
|
+
# codes are as follows:
|
940
|
+
#
|
941
|
+
# "en" (English)
|
942
|
+
#
|
943
|
+
# "jp" (Japanese)
|
944
|
+
#
|
945
|
+
# "zh" (Chinese)
|
946
|
+
#
|
947
|
+
# If no code is specified, "en" is used as the default.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
# @!attribute [rw] id
|
951
|
+
# The `ProductViewId` of the product to describe.
|
952
|
+
# @return [String]
|
953
|
+
class DescribeProductViewInput < Struct.new(
|
954
|
+
:accept_language,
|
955
|
+
:id)
|
956
|
+
include Aws::Structure
|
957
|
+
end
|
958
|
+
|
959
|
+
# @!attribute [rw] product_view_summary
|
960
|
+
# The summary metadata about the specified product.
|
961
|
+
# @return [Types::ProductViewSummary]
|
962
|
+
#
|
963
|
+
# @!attribute [rw] provisioning_artifacts
|
964
|
+
# A list of provisioning artifact objects for the specified product.
|
965
|
+
# The `ProvisioningArtifacts` represent the ways in which the
|
966
|
+
# specified product can be provisioned.
|
967
|
+
# @return [Array<Types::ProvisioningArtifact>]
|
968
|
+
class DescribeProductViewOutput < Struct.new(
|
969
|
+
:product_view_summary,
|
970
|
+
:provisioning_artifacts)
|
971
|
+
include Aws::Structure
|
972
|
+
end
|
973
|
+
|
974
|
+
# @note When making an API call, pass DescribeProvisioningArtifactInput
|
975
|
+
# data as a hash:
|
976
|
+
#
|
977
|
+
# {
|
978
|
+
# accept_language: "AcceptLanguage",
|
979
|
+
# provisioning_artifact_id: "Id", # required
|
980
|
+
# product_id: "Id", # required
|
981
|
+
# }
|
982
|
+
# @!attribute [rw] accept_language
|
983
|
+
# The language code to use for this operation. Supported language
|
984
|
+
# codes are as follows:
|
985
|
+
#
|
986
|
+
# "en" (English)
|
987
|
+
#
|
988
|
+
# "jp" (Japanese)
|
989
|
+
#
|
990
|
+
# "zh" (Chinese)
|
991
|
+
#
|
992
|
+
# If no code is specified, "en" is used as the default.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] provisioning_artifact_id
|
996
|
+
# The identifier of the provisioning artifact.
|
997
|
+
# @return [String]
|
998
|
+
#
|
999
|
+
# @!attribute [rw] product_id
|
1000
|
+
# The product identifier.
|
1001
|
+
# @return [String]
|
1002
|
+
class DescribeProvisioningArtifactInput < Struct.new(
|
1003
|
+
:accept_language,
|
1004
|
+
:provisioning_artifact_id,
|
1005
|
+
:product_id)
|
1006
|
+
include Aws::Structure
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# @!attribute [rw] provisioning_artifact_detail
|
1010
|
+
# Detailed provisioning artifact information.
|
1011
|
+
# @return [Types::ProvisioningArtifactDetail]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] info
|
1014
|
+
# Additional information about the provisioning artifact.
|
1015
|
+
# @return [Hash<String,String>]
|
1016
|
+
#
|
1017
|
+
# @!attribute [rw] status
|
1018
|
+
# The status of the current request.
|
1019
|
+
# @return [String]
|
1020
|
+
class DescribeProvisioningArtifactOutput < Struct.new(
|
1021
|
+
:provisioning_artifact_detail,
|
1022
|
+
:info,
|
1023
|
+
:status)
|
1024
|
+
include Aws::Structure
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# @note When making an API call, pass DescribeProvisioningParametersInput
|
1028
|
+
# data as a hash:
|
1029
|
+
#
|
1030
|
+
# {
|
1031
|
+
# accept_language: "AcceptLanguage",
|
1032
|
+
# product_id: "Id", # required
|
1033
|
+
# provisioning_artifact_id: "Id", # required
|
1034
|
+
# path_id: "Id",
|
1035
|
+
# }
|
1036
|
+
# @!attribute [rw] accept_language
|
1037
|
+
# The language code to use for this operation. Supported language
|
1038
|
+
# codes are as follows:
|
1039
|
+
#
|
1040
|
+
# "en" (English)
|
1041
|
+
#
|
1042
|
+
# "jp" (Japanese)
|
1043
|
+
#
|
1044
|
+
# "zh" (Chinese)
|
1045
|
+
#
|
1046
|
+
# If no code is specified, "en" is used as the default.
|
1047
|
+
# @return [String]
|
1048
|
+
#
|
1049
|
+
# @!attribute [rw] product_id
|
1050
|
+
# The product identifier.
|
1051
|
+
# @return [String]
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] provisioning_artifact_id
|
1054
|
+
# The provisioning artifact identifier for this product.
|
1055
|
+
# @return [String]
|
1056
|
+
#
|
1057
|
+
# @!attribute [rw] path_id
|
1058
|
+
# The identifier of the path for this product's provisioning. This
|
1059
|
+
# value is optional if the product has a default path, and is required
|
1060
|
+
# if there is more than one path for the specified product.
|
1061
|
+
# @return [String]
|
1062
|
+
class DescribeProvisioningParametersInput < Struct.new(
|
1063
|
+
:accept_language,
|
1064
|
+
:product_id,
|
1065
|
+
:provisioning_artifact_id,
|
1066
|
+
:path_id)
|
1067
|
+
include Aws::Structure
|
1068
|
+
end
|
1069
|
+
|
1070
|
+
# @!attribute [rw] provisioning_artifact_parameters
|
1071
|
+
# The list of parameters used to successfully provision the product.
|
1072
|
+
# Each parameter includes a list of allowable values and additional
|
1073
|
+
# metadata about each parameter.
|
1074
|
+
# @return [Array<Types::ProvisioningArtifactParameter>]
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] constraint_summaries
|
1077
|
+
# The list of constraint summaries that apply to provisioning this
|
1078
|
+
# product.
|
1079
|
+
# @return [Array<Types::ConstraintSummary>]
|
1080
|
+
#
|
1081
|
+
# @!attribute [rw] usage_instructions
|
1082
|
+
# Any additional metadata specifically related to the provisioning of
|
1083
|
+
# the product. For example, see the `Version` field of the
|
1084
|
+
# CloudFormation template.
|
1085
|
+
# @return [Array<Types::UsageInstruction>]
|
1086
|
+
class DescribeProvisioningParametersOutput < Struct.new(
|
1087
|
+
:provisioning_artifact_parameters,
|
1088
|
+
:constraint_summaries,
|
1089
|
+
:usage_instructions)
|
1090
|
+
include Aws::Structure
|
1091
|
+
end
|
1092
|
+
|
1093
|
+
# @note When making an API call, pass DescribeRecordInput
|
1094
|
+
# data as a hash:
|
1095
|
+
#
|
1096
|
+
# {
|
1097
|
+
# accept_language: "AcceptLanguage",
|
1098
|
+
# id: "Id", # required
|
1099
|
+
# page_token: "PageToken",
|
1100
|
+
# page_size: 1,
|
1101
|
+
# }
|
1102
|
+
# @!attribute [rw] accept_language
|
1103
|
+
# The language code to use for this operation. Supported language
|
1104
|
+
# codes are as follows:
|
1105
|
+
#
|
1106
|
+
# "en" (English)
|
1107
|
+
#
|
1108
|
+
# "jp" (Japanese)
|
1109
|
+
#
|
1110
|
+
# "zh" (Chinese)
|
1111
|
+
#
|
1112
|
+
# If no code is specified, "en" is used as the default.
|
1113
|
+
# @return [String]
|
1114
|
+
#
|
1115
|
+
# @!attribute [rw] id
|
1116
|
+
# The record identifier of the ProvisionedProduct object for which to
|
1117
|
+
# retrieve output information. This is the `RecordDetail.RecordId`
|
1118
|
+
# obtained from the request operation's response.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] page_token
|
1122
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1123
|
+
# the first page of size `PageSize`.
|
1124
|
+
# @return [String]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] page_size
|
1127
|
+
# The maximum number of items to return in the results. If more
|
1128
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1129
|
+
# `NextPageToken` in the response is non-null.
|
1130
|
+
# @return [Integer]
|
1131
|
+
class DescribeRecordInput < Struct.new(
|
1132
|
+
:accept_language,
|
1133
|
+
:id,
|
1134
|
+
:page_token,
|
1135
|
+
:page_size)
|
1136
|
+
include Aws::Structure
|
1137
|
+
end
|
1138
|
+
|
1139
|
+
# @!attribute [rw] record_detail
|
1140
|
+
# Detailed record information for the specified product.
|
1141
|
+
# @return [Types::RecordDetail]
|
1142
|
+
#
|
1143
|
+
# @!attribute [rw] record_outputs
|
1144
|
+
# A list of outputs for the specified Product object created as the
|
1145
|
+
# result of a request. For example, a CloudFormation-backed product
|
1146
|
+
# that creates an S3 bucket would have an output for the S3 bucket
|
1147
|
+
# URL.
|
1148
|
+
# @return [Array<Types::RecordOutput>]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] next_page_token
|
1151
|
+
# The page token to use to retrieve the next page of results for this
|
1152
|
+
# operation. If there are no more pages, this value is null.
|
1153
|
+
# @return [String]
|
1154
|
+
class DescribeRecordOutput < Struct.new(
|
1155
|
+
:record_detail,
|
1156
|
+
:record_outputs,
|
1157
|
+
:next_page_token)
|
1158
|
+
include Aws::Structure
|
1159
|
+
end
|
1160
|
+
|
1161
|
+
# @note When making an API call, pass DisassociatePrincipalFromPortfolioInput
|
1162
|
+
# data as a hash:
|
1163
|
+
#
|
1164
|
+
# {
|
1165
|
+
# accept_language: "AcceptLanguage",
|
1166
|
+
# portfolio_id: "Id", # required
|
1167
|
+
# principal_arn: "PrincipalARN", # required
|
1168
|
+
# }
|
1169
|
+
# @!attribute [rw] accept_language
|
1170
|
+
# The language code to use for this operation. Supported language
|
1171
|
+
# codes are as follows:
|
1172
|
+
#
|
1173
|
+
# "en" (English)
|
1174
|
+
#
|
1175
|
+
# "jp" (Japanese)
|
1176
|
+
#
|
1177
|
+
# "zh" (Chinese)
|
1178
|
+
#
|
1179
|
+
# If no code is specified, "en" is used as the default.
|
1180
|
+
# @return [String]
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] portfolio_id
|
1183
|
+
# The portfolio identifier.
|
1184
|
+
# @return [String]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] principal_arn
|
1187
|
+
# The ARN representing the principal (IAM user, role, or group).
|
1188
|
+
# @return [String]
|
1189
|
+
class DisassociatePrincipalFromPortfolioInput < Struct.new(
|
1190
|
+
:accept_language,
|
1191
|
+
:portfolio_id,
|
1192
|
+
:principal_arn)
|
1193
|
+
include Aws::Structure
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
class DisassociatePrincipalFromPortfolioOutput < Aws::EmptyStructure; end
|
1197
|
+
|
1198
|
+
# @note When making an API call, pass DisassociateProductFromPortfolioInput
|
1199
|
+
# data as a hash:
|
1200
|
+
#
|
1201
|
+
# {
|
1202
|
+
# accept_language: "AcceptLanguage",
|
1203
|
+
# product_id: "Id", # required
|
1204
|
+
# portfolio_id: "Id", # required
|
1205
|
+
# }
|
1206
|
+
# @!attribute [rw] accept_language
|
1207
|
+
# The language code to use for this operation. Supported language
|
1208
|
+
# codes are as follows:
|
1209
|
+
#
|
1210
|
+
# "en" (English)
|
1211
|
+
#
|
1212
|
+
# "jp" (Japanese)
|
1213
|
+
#
|
1214
|
+
# "zh" (Chinese)
|
1215
|
+
#
|
1216
|
+
# If no code is specified, "en" is used as the default.
|
1217
|
+
# @return [String]
|
1218
|
+
#
|
1219
|
+
# @!attribute [rw] product_id
|
1220
|
+
# The product identifier.
|
1221
|
+
# @return [String]
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] portfolio_id
|
1224
|
+
# The portfolio identifier.
|
1225
|
+
# @return [String]
|
1226
|
+
class DisassociateProductFromPortfolioInput < Struct.new(
|
1227
|
+
:accept_language,
|
1228
|
+
:product_id,
|
1229
|
+
:portfolio_id)
|
1230
|
+
include Aws::Structure
|
1231
|
+
end
|
1232
|
+
|
1233
|
+
class DisassociateProductFromPortfolioOutput < Aws::EmptyStructure; end
|
1234
|
+
|
1235
|
+
# Summary information about a path for a user to have access to a
|
1236
|
+
# specified product.
|
1237
|
+
# @!attribute [rw] id
|
1238
|
+
# The unique identifier of the product path.
|
1239
|
+
# @return [String]
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] constraint_summaries
|
1242
|
+
# List of constraints on the portfolio-product relationship.
|
1243
|
+
# @return [Array<Types::ConstraintSummary>]
|
1244
|
+
#
|
1245
|
+
# @!attribute [rw] tags
|
1246
|
+
# List of tags used by this launch path.
|
1247
|
+
# @return [Array<Types::Tag>]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] name
|
1250
|
+
# Corresponds to the name of the portfolio to which the user was
|
1251
|
+
# assigned.
|
1252
|
+
# @return [String]
|
1253
|
+
class LaunchPathSummary < Struct.new(
|
1254
|
+
:id,
|
1255
|
+
:constraint_summaries,
|
1256
|
+
:tags,
|
1257
|
+
:name)
|
1258
|
+
include Aws::Structure
|
1259
|
+
end
|
1260
|
+
|
1261
|
+
# @note When making an API call, pass ListAcceptedPortfolioSharesInput
|
1262
|
+
# data as a hash:
|
1263
|
+
#
|
1264
|
+
# {
|
1265
|
+
# accept_language: "AcceptLanguage",
|
1266
|
+
# page_token: "PageToken",
|
1267
|
+
# page_size: 1,
|
1268
|
+
# }
|
1269
|
+
# @!attribute [rw] accept_language
|
1270
|
+
# The language code to use for this operation. Supported language
|
1271
|
+
# codes are as follows:
|
1272
|
+
#
|
1273
|
+
# "en" (English)
|
1274
|
+
#
|
1275
|
+
# "jp" (Japanese)
|
1276
|
+
#
|
1277
|
+
# "zh" (Chinese)
|
1278
|
+
#
|
1279
|
+
# If no code is specified, "en" is used as the default.
|
1280
|
+
# @return [String]
|
1281
|
+
#
|
1282
|
+
# @!attribute [rw] page_token
|
1283
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1284
|
+
# the first page of size `PageSize`.
|
1285
|
+
# @return [String]
|
1286
|
+
#
|
1287
|
+
# @!attribute [rw] page_size
|
1288
|
+
# The maximum number of items to return in the results. If more
|
1289
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1290
|
+
# `NextPageToken` in the response is non-null.
|
1291
|
+
# @return [Integer]
|
1292
|
+
class ListAcceptedPortfolioSharesInput < Struct.new(
|
1293
|
+
:accept_language,
|
1294
|
+
:page_token,
|
1295
|
+
:page_size)
|
1296
|
+
include Aws::Structure
|
1297
|
+
end
|
1298
|
+
|
1299
|
+
# @!attribute [rw] portfolio_details
|
1300
|
+
# List of detailed portfolio information objects.
|
1301
|
+
# @return [Array<Types::PortfolioDetail>]
|
1302
|
+
#
|
1303
|
+
# @!attribute [rw] next_page_token
|
1304
|
+
# The page token to use to retrieve the next page of results for this
|
1305
|
+
# operation. If there are no more pages, this value is null.
|
1306
|
+
# @return [String]
|
1307
|
+
class ListAcceptedPortfolioSharesOutput < Struct.new(
|
1308
|
+
:portfolio_details,
|
1309
|
+
:next_page_token)
|
1310
|
+
include Aws::Structure
|
1311
|
+
end
|
1312
|
+
|
1313
|
+
# @note When making an API call, pass ListConstraintsForPortfolioInput
|
1314
|
+
# data as a hash:
|
1315
|
+
#
|
1316
|
+
# {
|
1317
|
+
# accept_language: "AcceptLanguage",
|
1318
|
+
# portfolio_id: "Id", # required
|
1319
|
+
# product_id: "Id",
|
1320
|
+
# page_size: 1,
|
1321
|
+
# page_token: "PageToken",
|
1322
|
+
# }
|
1323
|
+
# @!attribute [rw] accept_language
|
1324
|
+
# The language code to use for this operation. Supported language
|
1325
|
+
# codes are as follows:
|
1326
|
+
#
|
1327
|
+
# "en" (English)
|
1328
|
+
#
|
1329
|
+
# "jp" (Japanese)
|
1330
|
+
#
|
1331
|
+
# "zh" (Chinese)
|
1332
|
+
#
|
1333
|
+
# If no code is specified, "en" is used as the default.
|
1334
|
+
# @return [String]
|
1335
|
+
#
|
1336
|
+
# @!attribute [rw] portfolio_id
|
1337
|
+
# The portfolio identifier.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] product_id
|
1341
|
+
# The product identifier.
|
1342
|
+
# @return [String]
|
1343
|
+
#
|
1344
|
+
# @!attribute [rw] page_size
|
1345
|
+
# The maximum number of items to return in the results. If more
|
1346
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1347
|
+
# `NextPageToken` in the response is non-null.
|
1348
|
+
# @return [Integer]
|
1349
|
+
#
|
1350
|
+
# @!attribute [rw] page_token
|
1351
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1352
|
+
# the first page of size `PageSize`.
|
1353
|
+
# @return [String]
|
1354
|
+
class ListConstraintsForPortfolioInput < Struct.new(
|
1355
|
+
:accept_language,
|
1356
|
+
:portfolio_id,
|
1357
|
+
:product_id,
|
1358
|
+
:page_size,
|
1359
|
+
:page_token)
|
1360
|
+
include Aws::Structure
|
1361
|
+
end
|
1362
|
+
|
1363
|
+
# @!attribute [rw] constraint_details
|
1364
|
+
# List of detailed constraint information objects.
|
1365
|
+
# @return [Array<Types::ConstraintDetail>]
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] next_page_token
|
1368
|
+
# The page token to use to retrieve the next page of results for this
|
1369
|
+
# operation. If there are no more pages, this value is null.
|
1370
|
+
# @return [String]
|
1371
|
+
class ListConstraintsForPortfolioOutput < Struct.new(
|
1372
|
+
:constraint_details,
|
1373
|
+
:next_page_token)
|
1374
|
+
include Aws::Structure
|
1375
|
+
end
|
1376
|
+
|
1377
|
+
# @note When making an API call, pass ListLaunchPathsInput
|
1378
|
+
# data as a hash:
|
1379
|
+
#
|
1380
|
+
# {
|
1381
|
+
# accept_language: "AcceptLanguage",
|
1382
|
+
# product_id: "Id", # required
|
1383
|
+
# page_size: 1,
|
1384
|
+
# page_token: "PageToken",
|
1385
|
+
# }
|
1386
|
+
# @!attribute [rw] accept_language
|
1387
|
+
# The language code to use for this operation. Supported language
|
1388
|
+
# codes are as follows:
|
1389
|
+
#
|
1390
|
+
# "en" (English)
|
1391
|
+
#
|
1392
|
+
# "jp" (Japanese)
|
1393
|
+
#
|
1394
|
+
# "zh" (Chinese)
|
1395
|
+
#
|
1396
|
+
# If no code is specified, "en" is used as the default.
|
1397
|
+
# @return [String]
|
1398
|
+
#
|
1399
|
+
# @!attribute [rw] product_id
|
1400
|
+
# The product identifier.. Identifies the product for which to
|
1401
|
+
# retrieve `LaunchPathSummaries` information.
|
1402
|
+
# @return [String]
|
1403
|
+
#
|
1404
|
+
# @!attribute [rw] page_size
|
1405
|
+
# The maximum number of items to return in the results. If more
|
1406
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1407
|
+
# `NextPageToken` in the response is non-null.
|
1408
|
+
# @return [Integer]
|
1409
|
+
#
|
1410
|
+
# @!attribute [rw] page_token
|
1411
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1412
|
+
# the first page of size `PageSize`.
|
1413
|
+
# @return [String]
|
1414
|
+
class ListLaunchPathsInput < Struct.new(
|
1415
|
+
:accept_language,
|
1416
|
+
:product_id,
|
1417
|
+
:page_size,
|
1418
|
+
:page_token)
|
1419
|
+
include Aws::Structure
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# @!attribute [rw] launch_path_summaries
|
1423
|
+
# List of launch path information summaries for the specified
|
1424
|
+
# `PageToken`.
|
1425
|
+
# @return [Array<Types::LaunchPathSummary>]
|
1426
|
+
#
|
1427
|
+
# @!attribute [rw] next_page_token
|
1428
|
+
# The page token to use to retrieve the next page of results for this
|
1429
|
+
# operation. If there are no more pages, this value is null.
|
1430
|
+
# @return [String]
|
1431
|
+
class ListLaunchPathsOutput < Struct.new(
|
1432
|
+
:launch_path_summaries,
|
1433
|
+
:next_page_token)
|
1434
|
+
include Aws::Structure
|
1435
|
+
end
|
1436
|
+
|
1437
|
+
# @note When making an API call, pass ListPortfolioAccessInput
|
1438
|
+
# data as a hash:
|
1439
|
+
#
|
1440
|
+
# {
|
1441
|
+
# accept_language: "AcceptLanguage",
|
1442
|
+
# portfolio_id: "Id", # required
|
1443
|
+
# }
|
1444
|
+
# @!attribute [rw] accept_language
|
1445
|
+
# The language code to use for this operation. Supported language
|
1446
|
+
# codes are as follows:
|
1447
|
+
#
|
1448
|
+
# "en" (English)
|
1449
|
+
#
|
1450
|
+
# "jp" (Japanese)
|
1451
|
+
#
|
1452
|
+
# "zh" (Chinese)
|
1453
|
+
#
|
1454
|
+
# If no code is specified, "en" is used as the default.
|
1455
|
+
# @return [String]
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] portfolio_id
|
1458
|
+
# The portfolio identifier.
|
1459
|
+
# @return [String]
|
1460
|
+
class ListPortfolioAccessInput < Struct.new(
|
1461
|
+
:accept_language,
|
1462
|
+
:portfolio_id)
|
1463
|
+
include Aws::Structure
|
1464
|
+
end
|
1465
|
+
|
1466
|
+
# @!attribute [rw] account_ids
|
1467
|
+
# List of account IDs associated with access to the portfolio.
|
1468
|
+
# @return [Array<String>]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] next_page_token
|
1471
|
+
# The page token to use to retrieve the next page of results for this
|
1472
|
+
# operation. If there are no more pages, this value is null.
|
1473
|
+
# @return [String]
|
1474
|
+
class ListPortfolioAccessOutput < Struct.new(
|
1475
|
+
:account_ids,
|
1476
|
+
:next_page_token)
|
1477
|
+
include Aws::Structure
|
1478
|
+
end
|
1479
|
+
|
1480
|
+
# @note When making an API call, pass ListPortfoliosForProductInput
|
1481
|
+
# data as a hash:
|
1482
|
+
#
|
1483
|
+
# {
|
1484
|
+
# accept_language: "AcceptLanguage",
|
1485
|
+
# product_id: "Id", # required
|
1486
|
+
# page_token: "PageToken",
|
1487
|
+
# page_size: 1,
|
1488
|
+
# }
|
1489
|
+
# @!attribute [rw] accept_language
|
1490
|
+
# The language code to use for this operation. Supported language
|
1491
|
+
# codes are as follows:
|
1492
|
+
#
|
1493
|
+
# "en" (English)
|
1494
|
+
#
|
1495
|
+
# "jp" (Japanese)
|
1496
|
+
#
|
1497
|
+
# "zh" (Chinese)
|
1498
|
+
#
|
1499
|
+
# If no code is specified, "en" is used as the default.
|
1500
|
+
# @return [String]
|
1501
|
+
#
|
1502
|
+
# @!attribute [rw] product_id
|
1503
|
+
# The product identifier.
|
1504
|
+
# @return [String]
|
1505
|
+
#
|
1506
|
+
# @!attribute [rw] page_token
|
1507
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1508
|
+
# the first page of size `PageSize`.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1511
|
+
# @!attribute [rw] page_size
|
1512
|
+
# The maximum number of items to return in the results. If more
|
1513
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1514
|
+
# `NextPageToken` in the response is non-null.
|
1515
|
+
# @return [Integer]
|
1516
|
+
class ListPortfoliosForProductInput < Struct.new(
|
1517
|
+
:accept_language,
|
1518
|
+
:product_id,
|
1519
|
+
:page_token,
|
1520
|
+
:page_size)
|
1521
|
+
include Aws::Structure
|
1522
|
+
end
|
1523
|
+
|
1524
|
+
# @!attribute [rw] portfolio_details
|
1525
|
+
# List of detailed portfolio information objects.
|
1526
|
+
# @return [Array<Types::PortfolioDetail>]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] next_page_token
|
1529
|
+
# The page token to use to retrieve the next page of results for this
|
1530
|
+
# operation. If there are no more pages, this value is null.
|
1531
|
+
# @return [String]
|
1532
|
+
class ListPortfoliosForProductOutput < Struct.new(
|
1533
|
+
:portfolio_details,
|
1534
|
+
:next_page_token)
|
1535
|
+
include Aws::Structure
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# @note When making an API call, pass ListPortfoliosInput
|
1539
|
+
# data as a hash:
|
1540
|
+
#
|
1541
|
+
# {
|
1542
|
+
# accept_language: "AcceptLanguage",
|
1543
|
+
# page_token: "PageToken",
|
1544
|
+
# page_size: 1,
|
1545
|
+
# }
|
1546
|
+
# @!attribute [rw] accept_language
|
1547
|
+
# The language code to use for this operation. Supported language
|
1548
|
+
# codes are as follows:
|
1549
|
+
#
|
1550
|
+
# "en" (English)
|
1551
|
+
#
|
1552
|
+
# "jp" (Japanese)
|
1553
|
+
#
|
1554
|
+
# "zh" (Chinese)
|
1555
|
+
#
|
1556
|
+
# If no code is specified, "en" is used as the default.
|
1557
|
+
# @return [String]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] page_token
|
1560
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1561
|
+
# the first page of size `PageSize`.
|
1562
|
+
# @return [String]
|
1563
|
+
#
|
1564
|
+
# @!attribute [rw] page_size
|
1565
|
+
# The maximum number of items to return in the results. If more
|
1566
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1567
|
+
# `NextPageToken` in the response is non-null.
|
1568
|
+
# @return [Integer]
|
1569
|
+
class ListPortfoliosInput < Struct.new(
|
1570
|
+
:accept_language,
|
1571
|
+
:page_token,
|
1572
|
+
:page_size)
|
1573
|
+
include Aws::Structure
|
1574
|
+
end
|
1575
|
+
|
1576
|
+
# @!attribute [rw] portfolio_details
|
1577
|
+
# List of detailed portfolio information objects.
|
1578
|
+
# @return [Array<Types::PortfolioDetail>]
|
1579
|
+
#
|
1580
|
+
# @!attribute [rw] next_page_token
|
1581
|
+
# The page token to use to retrieve the next page of results for this
|
1582
|
+
# operation. If there are no more pages, this value is null.
|
1583
|
+
# @return [String]
|
1584
|
+
class ListPortfoliosOutput < Struct.new(
|
1585
|
+
:portfolio_details,
|
1586
|
+
:next_page_token)
|
1587
|
+
include Aws::Structure
|
1588
|
+
end
|
1589
|
+
|
1590
|
+
# @note When making an API call, pass ListPrincipalsForPortfolioInput
|
1591
|
+
# data as a hash:
|
1592
|
+
#
|
1593
|
+
# {
|
1594
|
+
# accept_language: "AcceptLanguage",
|
1595
|
+
# portfolio_id: "Id", # required
|
1596
|
+
# page_size: 1,
|
1597
|
+
# page_token: "PageToken",
|
1598
|
+
# }
|
1599
|
+
# @!attribute [rw] accept_language
|
1600
|
+
# The language code to use for this operation. Supported language
|
1601
|
+
# codes are as follows:
|
1602
|
+
#
|
1603
|
+
# "en" (English)
|
1604
|
+
#
|
1605
|
+
# "jp" (Japanese)
|
1606
|
+
#
|
1607
|
+
# "zh" (Chinese)
|
1608
|
+
#
|
1609
|
+
# If no code is specified, "en" is used as the default.
|
1610
|
+
# @return [String]
|
1611
|
+
#
|
1612
|
+
# @!attribute [rw] portfolio_id
|
1613
|
+
# The portfolio identifier.
|
1614
|
+
# @return [String]
|
1615
|
+
#
|
1616
|
+
# @!attribute [rw] page_size
|
1617
|
+
# The maximum number of items to return in the results. If more
|
1618
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1619
|
+
# `NextPageToken` in the response is non-null.
|
1620
|
+
# @return [Integer]
|
1621
|
+
#
|
1622
|
+
# @!attribute [rw] page_token
|
1623
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1624
|
+
# the first page of size `PageSize`.
|
1625
|
+
# @return [String]
|
1626
|
+
class ListPrincipalsForPortfolioInput < Struct.new(
|
1627
|
+
:accept_language,
|
1628
|
+
:portfolio_id,
|
1629
|
+
:page_size,
|
1630
|
+
:page_token)
|
1631
|
+
include Aws::Structure
|
1632
|
+
end
|
1633
|
+
|
1634
|
+
# @!attribute [rw] principals
|
1635
|
+
# The IAM principals (users or roles) associated with the portfolio.
|
1636
|
+
# @return [Array<Types::Principal>]
|
1637
|
+
#
|
1638
|
+
# @!attribute [rw] next_page_token
|
1639
|
+
# The page token to use to retrieve the next page of results for this
|
1640
|
+
# operation. If there are no more pages, this value is null.
|
1641
|
+
# @return [String]
|
1642
|
+
class ListPrincipalsForPortfolioOutput < Struct.new(
|
1643
|
+
:principals,
|
1644
|
+
:next_page_token)
|
1645
|
+
include Aws::Structure
|
1646
|
+
end
|
1647
|
+
|
1648
|
+
# @note When making an API call, pass ListProvisioningArtifactsInput
|
1649
|
+
# data as a hash:
|
1650
|
+
#
|
1651
|
+
# {
|
1652
|
+
# accept_language: "AcceptLanguage",
|
1653
|
+
# product_id: "Id", # required
|
1654
|
+
# }
|
1655
|
+
# @!attribute [rw] accept_language
|
1656
|
+
# The language code to use for this operation. Supported language
|
1657
|
+
# codes are as follows:
|
1658
|
+
#
|
1659
|
+
# "en" (English)
|
1660
|
+
#
|
1661
|
+
# "jp" (Japanese)
|
1662
|
+
#
|
1663
|
+
# "zh" (Chinese)
|
1664
|
+
#
|
1665
|
+
# If no code is specified, "en" is used as the default.
|
1666
|
+
# @return [String]
|
1667
|
+
#
|
1668
|
+
# @!attribute [rw] product_id
|
1669
|
+
# The product identifier.
|
1670
|
+
# @return [String]
|
1671
|
+
class ListProvisioningArtifactsInput < Struct.new(
|
1672
|
+
:accept_language,
|
1673
|
+
:product_id)
|
1674
|
+
include Aws::Structure
|
1675
|
+
end
|
1676
|
+
|
1677
|
+
# @!attribute [rw] provisioning_artifact_details
|
1678
|
+
# List of detailed provisioning artifact information objects.
|
1679
|
+
# @return [Array<Types::ProvisioningArtifactDetail>]
|
1680
|
+
#
|
1681
|
+
# @!attribute [rw] next_page_token
|
1682
|
+
# The page token to use to retrieve the next page of results for this
|
1683
|
+
# operation. If there are no more pages, this value is null.
|
1684
|
+
# @return [String]
|
1685
|
+
class ListProvisioningArtifactsOutput < Struct.new(
|
1686
|
+
:provisioning_artifact_details,
|
1687
|
+
:next_page_token)
|
1688
|
+
include Aws::Structure
|
1689
|
+
end
|
1690
|
+
|
1691
|
+
# @note When making an API call, pass ListRecordHistoryInput
|
1692
|
+
# data as a hash:
|
1693
|
+
#
|
1694
|
+
# {
|
1695
|
+
# accept_language: "AcceptLanguage",
|
1696
|
+
# access_level_filter: {
|
1697
|
+
# key: "Account", # accepts Account, Role, User
|
1698
|
+
# value: "AccessLevelFilterValue",
|
1699
|
+
# },
|
1700
|
+
# search_filter: {
|
1701
|
+
# key: "SearchFilterKey",
|
1702
|
+
# value: "SearchFilterValue",
|
1703
|
+
# },
|
1704
|
+
# page_size: 1,
|
1705
|
+
# page_token: "PageToken",
|
1706
|
+
# }
|
1707
|
+
# @!attribute [rw] accept_language
|
1708
|
+
# The language code to use for this operation. Supported language
|
1709
|
+
# codes are as follows:
|
1710
|
+
#
|
1711
|
+
# "en" (English)
|
1712
|
+
#
|
1713
|
+
# "jp" (Japanese)
|
1714
|
+
#
|
1715
|
+
# "zh" (Chinese)
|
1716
|
+
#
|
1717
|
+
# If no code is specified, "en" is used as the default.
|
1718
|
+
# @return [String]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] access_level_filter
|
1721
|
+
# The access level for obtaining results. If left unspecified, `User`
|
1722
|
+
# level access is used.
|
1723
|
+
# @return [Types::AccessLevelFilter]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] search_filter
|
1726
|
+
# The filter to limit search results.
|
1727
|
+
# @return [Types::ListRecordHistorySearchFilter]
|
1728
|
+
#
|
1729
|
+
# @!attribute [rw] page_size
|
1730
|
+
# The maximum number of items to return in the results. If more
|
1731
|
+
# results exist than fit in the specified `PageSize`, the value of
|
1732
|
+
# `NextPageToken` in the response is non-null.
|
1733
|
+
# @return [Integer]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] page_token
|
1736
|
+
# The page token of the first page retrieved. If null, this retrieves
|
1737
|
+
# the first page of size `PageSize`.
|
1738
|
+
# @return [String]
|
1739
|
+
class ListRecordHistoryInput < Struct.new(
|
1740
|
+
:accept_language,
|
1741
|
+
:access_level_filter,
|
1742
|
+
:search_filter,
|
1743
|
+
:page_size,
|
1744
|
+
:page_token)
|
1745
|
+
include Aws::Structure
|
1746
|
+
end
|
1747
|
+
|
1748
|
+
# @!attribute [rw] record_details
|
1749
|
+
# A list of record detail objects, listed in reverse chronological
|
1750
|
+
# order.
|
1751
|
+
# @return [Array<Types::RecordDetail>]
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] next_page_token
|
1754
|
+
# The page token to use to retrieve the next page of results for this
|
1755
|
+
# operation. If there are no more pages, this value is null.
|
1756
|
+
# @return [String]
|
1757
|
+
class ListRecordHistoryOutput < Struct.new(
|
1758
|
+
:record_details,
|
1759
|
+
:next_page_token)
|
1760
|
+
include Aws::Structure
|
1761
|
+
end
|
1762
|
+
|
1763
|
+
# The search filter to limit results when listing request history
|
1764
|
+
# records.
|
1765
|
+
# @note When making an API call, pass ListRecordHistorySearchFilter
|
1766
|
+
# data as a hash:
|
1767
|
+
#
|
1768
|
+
# {
|
1769
|
+
# key: "SearchFilterKey",
|
1770
|
+
# value: "SearchFilterValue",
|
1771
|
+
# }
|
1772
|
+
# @!attribute [rw] key
|
1773
|
+
# The filter key.
|
1774
|
+
# @return [String]
|
1775
|
+
#
|
1776
|
+
# @!attribute [rw] value
|
1777
|
+
# The filter value for `Key`.
|
1778
|
+
# @return [String]
|
1779
|
+
class ListRecordHistorySearchFilter < Struct.new(
|
1780
|
+
:key,
|
1781
|
+
:value)
|
1782
|
+
include Aws::Structure
|
1783
|
+
end
|
1784
|
+
|
1785
|
+
# The constraints that the administrator has put on the parameter.
|
1786
|
+
# @!attribute [rw] allowed_values
|
1787
|
+
# The values that the administrator has allowed for the parameter.
|
1788
|
+
# @return [Array<String>]
|
1789
|
+
class ParameterConstraints < Struct.new(
|
1790
|
+
:allowed_values)
|
1791
|
+
include Aws::Structure
|
1792
|
+
end
|
1793
|
+
|
1794
|
+
# Detailed portfolio information.
|
1795
|
+
# @!attribute [rw] id
|
1796
|
+
# The identifier for the portfolio.
|
1797
|
+
# @return [String]
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] arn
|
1800
|
+
# The ARN assigned to the portfolio.
|
1801
|
+
# @return [String]
|
1802
|
+
#
|
1803
|
+
# @!attribute [rw] display_name
|
1804
|
+
# The name to use for display purposes.
|
1805
|
+
# @return [String]
|
1806
|
+
#
|
1807
|
+
# @!attribute [rw] description
|
1808
|
+
# The text description of the portfolio.
|
1809
|
+
# @return [String]
|
1810
|
+
#
|
1811
|
+
# @!attribute [rw] created_time
|
1812
|
+
# The UTC timestamp of the creation time.
|
1813
|
+
# @return [Time]
|
1814
|
+
#
|
1815
|
+
# @!attribute [rw] provider_name
|
1816
|
+
# The name of the portfolio provider.
|
1817
|
+
# @return [String]
|
1818
|
+
class PortfolioDetail < Struct.new(
|
1819
|
+
:id,
|
1820
|
+
:arn,
|
1821
|
+
:display_name,
|
1822
|
+
:description,
|
1823
|
+
:created_time,
|
1824
|
+
:provider_name)
|
1825
|
+
include Aws::Structure
|
1826
|
+
end
|
1827
|
+
|
1828
|
+
# A principal's ARN and type.
|
1829
|
+
# @!attribute [rw] principal_arn
|
1830
|
+
# The ARN representing the principal (IAM user, role, or group).
|
1831
|
+
# @return [String]
|
1832
|
+
#
|
1833
|
+
# @!attribute [rw] principal_type
|
1834
|
+
# The principal type. Must be `IAM`
|
1835
|
+
# @return [String]
|
1836
|
+
class Principal < Struct.new(
|
1837
|
+
:principal_arn,
|
1838
|
+
:principal_type)
|
1839
|
+
include Aws::Structure
|
1840
|
+
end
|
1841
|
+
|
1842
|
+
# A single product view aggregation value/count pair, containing
|
1843
|
+
# metadata about each product to which the calling user has access.
|
1844
|
+
# @!attribute [rw] value
|
1845
|
+
# The value of the product view aggregation.
|
1846
|
+
# @return [String]
|
1847
|
+
#
|
1848
|
+
# @!attribute [rw] approximate_count
|
1849
|
+
# An approximate count of the products that match the value.
|
1850
|
+
# @return [Integer]
|
1851
|
+
class ProductViewAggregationValue < Struct.new(
|
1852
|
+
:value,
|
1853
|
+
:approximate_count)
|
1854
|
+
include Aws::Structure
|
1855
|
+
end
|
1856
|
+
|
1857
|
+
# Detailed product view information.
|
1858
|
+
# @!attribute [rw] product_view_summary
|
1859
|
+
# The summary metadata about the specified product view.
|
1860
|
+
# @return [Types::ProductViewSummary]
|
1861
|
+
#
|
1862
|
+
# @!attribute [rw] status
|
1863
|
+
# Current status of the product.
|
1864
|
+
# @return [String]
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] product_arn
|
1867
|
+
# The ARN associated with the product.
|
1868
|
+
# @return [String]
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] created_time
|
1871
|
+
# The UTC timestamp of the creation time.
|
1872
|
+
# @return [Time]
|
1873
|
+
class ProductViewDetail < Struct.new(
|
1874
|
+
:product_view_summary,
|
1875
|
+
:status,
|
1876
|
+
:product_arn,
|
1877
|
+
:created_time)
|
1878
|
+
include Aws::Structure
|
1879
|
+
end
|
1880
|
+
|
1881
|
+
# The summary metadata about the specified product.
|
1882
|
+
# @!attribute [rw] id
|
1883
|
+
# The product view identifier.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] product_id
|
1887
|
+
# The product identifier.
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] name
|
1891
|
+
# The name of the product.
|
1892
|
+
# @return [String]
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] owner
|
1895
|
+
# The owner of the product. Contact the product administrator for the
|
1896
|
+
# significance of this value.
|
1897
|
+
# @return [String]
|
1898
|
+
#
|
1899
|
+
# @!attribute [rw] short_description
|
1900
|
+
# Short description of the product.
|
1901
|
+
# @return [String]
|
1902
|
+
#
|
1903
|
+
# @!attribute [rw] type
|
1904
|
+
# The product type. Contact the product administrator for the
|
1905
|
+
# significance of this value.
|
1906
|
+
# @return [String]
|
1907
|
+
#
|
1908
|
+
# @!attribute [rw] distributor
|
1909
|
+
# The distributor of the product. Contact the product administrator
|
1910
|
+
# for the significance of this value.
|
1911
|
+
# @return [String]
|
1912
|
+
#
|
1913
|
+
# @!attribute [rw] has_default_path
|
1914
|
+
# A value of `false` indicates that the product does not have a
|
1915
|
+
# default path, while a value of `true` indicates that it does. If
|
1916
|
+
# it's false, call ListLaunchPaths to disambiguate between paths. If
|
1917
|
+
# true, ListLaunchPaths is not required, and the output of the
|
1918
|
+
# ProductViewSummary operation can be used directly with
|
1919
|
+
# DescribeProvisioningParameters.
|
1920
|
+
# @return [Boolean]
|
1921
|
+
#
|
1922
|
+
# @!attribute [rw] support_email
|
1923
|
+
# The email contact information to obtain support for this Product.
|
1924
|
+
# @return [String]
|
1925
|
+
#
|
1926
|
+
# @!attribute [rw] support_description
|
1927
|
+
# The description of the support for this Product.
|
1928
|
+
# @return [String]
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] support_url
|
1931
|
+
# The URL information to obtain support for this Product.
|
1932
|
+
# @return [String]
|
1933
|
+
class ProductViewSummary < Struct.new(
|
1934
|
+
:id,
|
1935
|
+
:product_id,
|
1936
|
+
:name,
|
1937
|
+
:owner,
|
1938
|
+
:short_description,
|
1939
|
+
:type,
|
1940
|
+
:distributor,
|
1941
|
+
:has_default_path,
|
1942
|
+
:support_email,
|
1943
|
+
:support_description,
|
1944
|
+
:support_url)
|
1945
|
+
include Aws::Structure
|
1946
|
+
end
|
1947
|
+
|
1948
|
+
# @note When making an API call, pass ProvisionProductInput
|
1949
|
+
# data as a hash:
|
1950
|
+
#
|
1951
|
+
# {
|
1952
|
+
# accept_language: "AcceptLanguage",
|
1953
|
+
# product_id: "Id", # required
|
1954
|
+
# provisioning_artifact_id: "Id", # required
|
1955
|
+
# path_id: "Id",
|
1956
|
+
# provisioned_product_name: "ProvisionedProductName", # required
|
1957
|
+
# provisioning_parameters: [
|
1958
|
+
# {
|
1959
|
+
# key: "ParameterKey",
|
1960
|
+
# value: "ParameterValue",
|
1961
|
+
# },
|
1962
|
+
# ],
|
1963
|
+
# tags: [
|
1964
|
+
# {
|
1965
|
+
# key: "TagKey", # required
|
1966
|
+
# value: "TagValue", # required
|
1967
|
+
# },
|
1968
|
+
# ],
|
1969
|
+
# notification_arns: ["NotificationArn"],
|
1970
|
+
# provision_token: "IdempotencyToken", # required
|
1971
|
+
# }
|
1972
|
+
# @!attribute [rw] accept_language
|
1973
|
+
# The language code to use for this operation. Supported language
|
1974
|
+
# codes are as follows:
|
1975
|
+
#
|
1976
|
+
# "en" (English)
|
1977
|
+
#
|
1978
|
+
# "jp" (Japanese)
|
1979
|
+
#
|
1980
|
+
# "zh" (Chinese)
|
1981
|
+
#
|
1982
|
+
# If no code is specified, "en" is used as the default.
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] product_id
|
1986
|
+
# The product identifier.
|
1987
|
+
# @return [String]
|
1988
|
+
#
|
1989
|
+
# @!attribute [rw] provisioning_artifact_id
|
1990
|
+
# The provisioning artifact identifier for this product.
|
1991
|
+
# @return [String]
|
1992
|
+
#
|
1993
|
+
# @!attribute [rw] path_id
|
1994
|
+
# The identifier of the path for this product's provisioning. This
|
1995
|
+
# value is optional if the product has a default path, and is required
|
1996
|
+
# if there is more than one path for the specified product.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @!attribute [rw] provisioned_product_name
|
2000
|
+
# A user-friendly name to identify the ProvisionedProduct object. This
|
2001
|
+
# value must be unique for the AWS account and cannot be updated after
|
2002
|
+
# the product is provisioned.
|
2003
|
+
# @return [String]
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] provisioning_parameters
|
2006
|
+
# Parameters specified by the administrator that are required for
|
2007
|
+
# provisioning the product.
|
2008
|
+
# @return [Array<Types::ProvisioningParameter>]
|
2009
|
+
#
|
2010
|
+
# @!attribute [rw] tags
|
2011
|
+
# A list of tags to use as provisioning options.
|
2012
|
+
# @return [Array<Types::Tag>]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] notification_arns
|
2015
|
+
# Passed to CloudFormation. The SNS topic ARNs to which to publish
|
2016
|
+
# stack-related events.
|
2017
|
+
# @return [Array<String>]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] provision_token
|
2020
|
+
# An idempotency token that uniquely identifies the provisioning
|
2021
|
+
# request.
|
2022
|
+
#
|
2023
|
+
# **A suitable default value is auto-generated.** You should
|
2024
|
+
# normally not need to pass this option.
|
2025
|
+
# @return [String]
|
2026
|
+
class ProvisionProductInput < Struct.new(
|
2027
|
+
:accept_language,
|
2028
|
+
:product_id,
|
2029
|
+
:provisioning_artifact_id,
|
2030
|
+
:path_id,
|
2031
|
+
:provisioned_product_name,
|
2032
|
+
:provisioning_parameters,
|
2033
|
+
:tags,
|
2034
|
+
:notification_arns,
|
2035
|
+
:provision_token)
|
2036
|
+
include Aws::Structure
|
2037
|
+
end
|
2038
|
+
|
2039
|
+
# @!attribute [rw] record_detail
|
2040
|
+
# The detailed result of the ProvisionProduct request, containing the
|
2041
|
+
# inputs made to that request, the current state of the request, a
|
2042
|
+
# pointer to the ProvisionedProduct object of the request, and a list
|
2043
|
+
# of any errors that the request encountered.
|
2044
|
+
# @return [Types::RecordDetail]
|
2045
|
+
class ProvisionProductOutput < Struct.new(
|
2046
|
+
:record_detail)
|
2047
|
+
include Aws::Structure
|
2048
|
+
end
|
2049
|
+
|
2050
|
+
# Detailed information about a ProvisionedProduct object.
|
2051
|
+
# @!attribute [rw] name
|
2052
|
+
# The user-friendly name of the ProvisionedProduct object.
|
2053
|
+
# @return [String]
|
2054
|
+
#
|
2055
|
+
# @!attribute [rw] arn
|
2056
|
+
# The ARN associated with the ProvisionedProduct object.
|
2057
|
+
# @return [String]
|
2058
|
+
#
|
2059
|
+
# @!attribute [rw] type
|
2060
|
+
# The type of the ProvisionedProduct object.
|
2061
|
+
# @return [String]
|
2062
|
+
#
|
2063
|
+
# @!attribute [rw] id
|
2064
|
+
# The identifier of the ProvisionedProduct object.
|
2065
|
+
# @return [String]
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] status
|
2068
|
+
# The current status of the ProvisionedProduct.
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] status_message
|
2072
|
+
# The current status message of the ProvisionedProduct.
|
2073
|
+
# @return [String]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] created_time
|
2076
|
+
# The UTC timestamp of the creation time.
|
2077
|
+
# @return [Time]
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] idempotency_token
|
2080
|
+
# A token to disambiguate duplicate requests. You can create multiple
|
2081
|
+
# resources using the same input in multiple requests, provided that
|
2082
|
+
# you also specify a different idempotency token for each request.
|
2083
|
+
# @return [String]
|
2084
|
+
#
|
2085
|
+
# @!attribute [rw] last_record_id
|
2086
|
+
# The record identifier of the last request performed on this
|
2087
|
+
# ProvisionedProduct object.
|
2088
|
+
# @return [String]
|
2089
|
+
class ProvisionedProductDetail < Struct.new(
|
2090
|
+
:name,
|
2091
|
+
:arn,
|
2092
|
+
:type,
|
2093
|
+
:id,
|
2094
|
+
:status,
|
2095
|
+
:status_message,
|
2096
|
+
:created_time,
|
2097
|
+
:idempotency_token,
|
2098
|
+
:last_record_id)
|
2099
|
+
include Aws::Structure
|
2100
|
+
end
|
2101
|
+
|
2102
|
+
# Contains information indicating the ways in which a product can be
|
2103
|
+
# provisioned.
|
2104
|
+
# @!attribute [rw] id
|
2105
|
+
# The identifier for the artifact.
|
2106
|
+
# @return [String]
|
2107
|
+
#
|
2108
|
+
# @!attribute [rw] name
|
2109
|
+
# The name of the artifact.
|
2110
|
+
# @return [String]
|
2111
|
+
#
|
2112
|
+
# @!attribute [rw] description
|
2113
|
+
# The text description of the artifact.
|
2114
|
+
# @return [String]
|
2115
|
+
#
|
2116
|
+
# @!attribute [rw] created_time
|
2117
|
+
# The UTC timestamp of the creation time.
|
2118
|
+
# @return [Time]
|
2119
|
+
class ProvisioningArtifact < Struct.new(
|
2120
|
+
:id,
|
2121
|
+
:name,
|
2122
|
+
:description,
|
2123
|
+
:created_time)
|
2124
|
+
include Aws::Structure
|
2125
|
+
end
|
2126
|
+
|
2127
|
+
# Detailed provisioning artifact information.
|
2128
|
+
# @!attribute [rw] id
|
2129
|
+
# The identifier of the provisioning artifact.
|
2130
|
+
# @return [String]
|
2131
|
+
#
|
2132
|
+
# @!attribute [rw] name
|
2133
|
+
# The name assigned to the provisioning artifact.
|
2134
|
+
# @return [String]
|
2135
|
+
#
|
2136
|
+
# @!attribute [rw] description
|
2137
|
+
# The text description of the provisioning artifact.
|
2138
|
+
# @return [String]
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] type
|
2141
|
+
# The type of the provisioning artifact.
|
2142
|
+
# @return [String]
|
2143
|
+
#
|
2144
|
+
# @!attribute [rw] created_time
|
2145
|
+
# The UTC timestamp of the creation time.
|
2146
|
+
# @return [Time]
|
2147
|
+
class ProvisioningArtifactDetail < Struct.new(
|
2148
|
+
:id,
|
2149
|
+
:name,
|
2150
|
+
:description,
|
2151
|
+
:type,
|
2152
|
+
:created_time)
|
2153
|
+
include Aws::Structure
|
2154
|
+
end
|
2155
|
+
|
2156
|
+
# A parameter used to successfully provision the product. This value
|
2157
|
+
# includes a list of allowable values and additional metadata.
|
2158
|
+
# @!attribute [rw] parameter_key
|
2159
|
+
# The parameter key.
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @!attribute [rw] default_value
|
2163
|
+
# The default value for this parameter.
|
2164
|
+
# @return [String]
|
2165
|
+
#
|
2166
|
+
# @!attribute [rw] parameter_type
|
2167
|
+
# The parameter type.
|
2168
|
+
# @return [String]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] is_no_echo
|
2171
|
+
# If this value is true, the value for this parameter is obfuscated
|
2172
|
+
# from view when the parameter is retrieved. This parameter is used to
|
2173
|
+
# hide sensitive information.
|
2174
|
+
# @return [Boolean]
|
2175
|
+
#
|
2176
|
+
# @!attribute [rw] description
|
2177
|
+
# The text description of the parameter.
|
2178
|
+
# @return [String]
|
2179
|
+
#
|
2180
|
+
# @!attribute [rw] parameter_constraints
|
2181
|
+
# The list of constraints that the administrator has put on the
|
2182
|
+
# parameter.
|
2183
|
+
# @return [Types::ParameterConstraints]
|
2184
|
+
class ProvisioningArtifactParameter < Struct.new(
|
2185
|
+
:parameter_key,
|
2186
|
+
:default_value,
|
2187
|
+
:parameter_type,
|
2188
|
+
:is_no_echo,
|
2189
|
+
:description,
|
2190
|
+
:parameter_constraints)
|
2191
|
+
include Aws::Structure
|
2192
|
+
end
|
2193
|
+
|
2194
|
+
# Provisioning artifact properties.
|
2195
|
+
# @note When making an API call, pass ProvisioningArtifactProperties
|
2196
|
+
# data as a hash:
|
2197
|
+
#
|
2198
|
+
# {
|
2199
|
+
# name: "ProvisioningArtifactName",
|
2200
|
+
# description: "ProvisioningArtifactDescription",
|
2201
|
+
# info: { # required
|
2202
|
+
# "ProvisioningArtifactInfoKey" => "ProvisioningArtifactInfoValue",
|
2203
|
+
# },
|
2204
|
+
# type: "CLOUD_FORMATION_TEMPLATE", # accepts CLOUD_FORMATION_TEMPLATE
|
2205
|
+
# }
|
2206
|
+
# @!attribute [rw] name
|
2207
|
+
# The name assigned to the provisioning artifact properties.
|
2208
|
+
# @return [String]
|
2209
|
+
#
|
2210
|
+
# @!attribute [rw] description
|
2211
|
+
# The text description of the provisioning artifact properties.
|
2212
|
+
# @return [String]
|
2213
|
+
#
|
2214
|
+
# @!attribute [rw] info
|
2215
|
+
# Additional information about the provisioning artifact properties.
|
2216
|
+
# @return [Hash<String,String>]
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] type
|
2219
|
+
# The type of the provisioning artifact properties.
|
2220
|
+
# @return [String]
|
2221
|
+
class ProvisioningArtifactProperties < Struct.new(
|
2222
|
+
:name,
|
2223
|
+
:description,
|
2224
|
+
:info,
|
2225
|
+
:type)
|
2226
|
+
include Aws::Structure
|
2227
|
+
end
|
2228
|
+
|
2229
|
+
# The arameter key/value pairs used to provision a product.
|
2230
|
+
# @note When making an API call, pass ProvisioningParameter
|
2231
|
+
# data as a hash:
|
2232
|
+
#
|
2233
|
+
# {
|
2234
|
+
# key: "ParameterKey",
|
2235
|
+
# value: "ParameterValue",
|
2236
|
+
# }
|
2237
|
+
# @!attribute [rw] key
|
2238
|
+
# The `ProvisioningArtifactParameter.ParameterKey` parameter from
|
2239
|
+
# DescribeProvisioningParameters.
|
2240
|
+
# @return [String]
|
2241
|
+
#
|
2242
|
+
# @!attribute [rw] value
|
2243
|
+
# The value to use for provisioning. Any constraints on this value can
|
2244
|
+
# be found in `ProvisioningArtifactParameter` for `Key`.
|
2245
|
+
# @return [String]
|
2246
|
+
class ProvisioningParameter < Struct.new(
|
2247
|
+
:key,
|
2248
|
+
:value)
|
2249
|
+
include Aws::Structure
|
2250
|
+
end
|
2251
|
+
|
2252
|
+
# The full details of a specific ProvisionedProduct object.
|
2253
|
+
# @!attribute [rw] record_id
|
2254
|
+
# The identifier of the ProvisionedProduct object record.
|
2255
|
+
# @return [String]
|
2256
|
+
#
|
2257
|
+
# @!attribute [rw] provisioned_product_name
|
2258
|
+
# The user-friendly name of the ProvisionedProduct object.
|
2259
|
+
# @return [String]
|
2260
|
+
#
|
2261
|
+
# @!attribute [rw] status
|
2262
|
+
# The status of the ProvisionedProduct object.
|
2263
|
+
# @return [String]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] created_time
|
2266
|
+
# The UTC timestamp of the creation time.
|
2267
|
+
# @return [Time]
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] updated_time
|
2270
|
+
# The time when the record for the ProvisionedProduct object was last
|
2271
|
+
# updated.
|
2272
|
+
# @return [Time]
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] provisioned_product_type
|
2275
|
+
# The type of the ProvisionedProduct object.
|
2276
|
+
# @return [String]
|
2277
|
+
#
|
2278
|
+
# @!attribute [rw] record_type
|
2279
|
+
# The record type for this record.
|
2280
|
+
# @return [String]
|
2281
|
+
#
|
2282
|
+
# @!attribute [rw] provisioned_product_id
|
2283
|
+
# The identifier of the ProvisionedProduct object.
|
2284
|
+
# @return [String]
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] product_id
|
2287
|
+
# The product identifier.
|
2288
|
+
# @return [String]
|
2289
|
+
#
|
2290
|
+
# @!attribute [rw] provisioning_artifact_id
|
2291
|
+
# The provisioning artifact identifier for this product.
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] path_id
|
2295
|
+
# The identifier of the path for this product's provisioning.
|
2296
|
+
# @return [String]
|
2297
|
+
#
|
2298
|
+
# @!attribute [rw] record_errors
|
2299
|
+
# A list of errors that occurred while processing the request.
|
2300
|
+
# @return [Array<Types::RecordError>]
|
2301
|
+
#
|
2302
|
+
# @!attribute [rw] record_tags
|
2303
|
+
# List of tags associated with this record.
|
2304
|
+
# @return [Array<Types::RecordTag>]
|
2305
|
+
class RecordDetail < Struct.new(
|
2306
|
+
:record_id,
|
2307
|
+
:provisioned_product_name,
|
2308
|
+
:status,
|
2309
|
+
:created_time,
|
2310
|
+
:updated_time,
|
2311
|
+
:provisioned_product_type,
|
2312
|
+
:record_type,
|
2313
|
+
:provisioned_product_id,
|
2314
|
+
:product_id,
|
2315
|
+
:provisioning_artifact_id,
|
2316
|
+
:path_id,
|
2317
|
+
:record_errors,
|
2318
|
+
:record_tags)
|
2319
|
+
include Aws::Structure
|
2320
|
+
end
|
2321
|
+
|
2322
|
+
# The error code and description resulting from an operation.
|
2323
|
+
# @!attribute [rw] code
|
2324
|
+
# The numeric value of the error.
|
2325
|
+
# @return [String]
|
2326
|
+
#
|
2327
|
+
# @!attribute [rw] description
|
2328
|
+
# The text description of the error.
|
2329
|
+
# @return [String]
|
2330
|
+
class RecordError < Struct.new(
|
2331
|
+
:code,
|
2332
|
+
:description)
|
2333
|
+
include Aws::Structure
|
2334
|
+
end
|
2335
|
+
|
2336
|
+
# An output for the specified Product object created as the result of a
|
2337
|
+
# request. For example, a CloudFormation-backed product that creates an
|
2338
|
+
# S3 bucket would have an output for the S3 bucket URL.
|
2339
|
+
# @!attribute [rw] output_key
|
2340
|
+
# The output key.
|
2341
|
+
# @return [String]
|
2342
|
+
#
|
2343
|
+
# @!attribute [rw] output_value
|
2344
|
+
# The output value.
|
2345
|
+
# @return [String]
|
2346
|
+
#
|
2347
|
+
# @!attribute [rw] description
|
2348
|
+
# The text description of the output.
|
2349
|
+
# @return [String]
|
2350
|
+
class RecordOutput < Struct.new(
|
2351
|
+
:output_key,
|
2352
|
+
:output_value,
|
2353
|
+
:description)
|
2354
|
+
include Aws::Structure
|
2355
|
+
end
|
2356
|
+
|
2357
|
+
# A tag associated with the record, stored as a key-value pair.
|
2358
|
+
# @!attribute [rw] key
|
2359
|
+
# The key for this tag.
|
2360
|
+
# @return [String]
|
2361
|
+
#
|
2362
|
+
# @!attribute [rw] value
|
2363
|
+
# The value for this tag.
|
2364
|
+
# @return [String]
|
2365
|
+
class RecordTag < Struct.new(
|
2366
|
+
:key,
|
2367
|
+
:value)
|
2368
|
+
include Aws::Structure
|
2369
|
+
end
|
2370
|
+
|
2371
|
+
# @note When making an API call, pass RejectPortfolioShareInput
|
2372
|
+
# data as a hash:
|
2373
|
+
#
|
2374
|
+
# {
|
2375
|
+
# accept_language: "AcceptLanguage",
|
2376
|
+
# portfolio_id: "Id", # required
|
2377
|
+
# }
|
2378
|
+
# @!attribute [rw] accept_language
|
2379
|
+
# The language code to use for this operation. Supported language
|
2380
|
+
# codes are as follows:
|
2381
|
+
#
|
2382
|
+
# "en" (English)
|
2383
|
+
#
|
2384
|
+
# "jp" (Japanese)
|
2385
|
+
#
|
2386
|
+
# "zh" (Chinese)
|
2387
|
+
#
|
2388
|
+
# If no code is specified, "en" is used as the default.
|
2389
|
+
# @return [String]
|
2390
|
+
#
|
2391
|
+
# @!attribute [rw] portfolio_id
|
2392
|
+
# The portfolio identifier.
|
2393
|
+
# @return [String]
|
2394
|
+
class RejectPortfolioShareInput < Struct.new(
|
2395
|
+
:accept_language,
|
2396
|
+
:portfolio_id)
|
2397
|
+
include Aws::Structure
|
2398
|
+
end
|
2399
|
+
|
2400
|
+
class RejectPortfolioShareOutput < Aws::EmptyStructure; end
|
2401
|
+
|
2402
|
+
# @note When making an API call, pass ScanProvisionedProductsInput
|
2403
|
+
# data as a hash:
|
2404
|
+
#
|
2405
|
+
# {
|
2406
|
+
# accept_language: "AcceptLanguage",
|
2407
|
+
# access_level_filter: {
|
2408
|
+
# key: "Account", # accepts Account, Role, User
|
2409
|
+
# value: "AccessLevelFilterValue",
|
2410
|
+
# },
|
2411
|
+
# page_size: 1,
|
2412
|
+
# page_token: "PageToken",
|
2413
|
+
# }
|
2414
|
+
# @!attribute [rw] accept_language
|
2415
|
+
# The language code to use for this operation. Supported language
|
2416
|
+
# codes are as follows:
|
2417
|
+
#
|
2418
|
+
# "en" (English)
|
2419
|
+
#
|
2420
|
+
# "jp" (Japanese)
|
2421
|
+
#
|
2422
|
+
# "zh" (Chinese)
|
2423
|
+
#
|
2424
|
+
# If no code is specified, "en" is used as the default.
|
2425
|
+
# @return [String]
|
2426
|
+
#
|
2427
|
+
# @!attribute [rw] access_level_filter
|
2428
|
+
# The access level for obtaining results. If left unspecified, `User`
|
2429
|
+
# level access is used.
|
2430
|
+
# @return [Types::AccessLevelFilter]
|
2431
|
+
#
|
2432
|
+
# @!attribute [rw] page_size
|
2433
|
+
# The maximum number of items to return in the results. If more
|
2434
|
+
# results exist than fit in the specified `PageSize`, the value of
|
2435
|
+
# `NextPageToken` in the response is non-null.
|
2436
|
+
# @return [Integer]
|
2437
|
+
#
|
2438
|
+
# @!attribute [rw] page_token
|
2439
|
+
# The page token of the first page retrieved. If null, this retrieves
|
2440
|
+
# the first page of size `PageSize`.
|
2441
|
+
# @return [String]
|
2442
|
+
class ScanProvisionedProductsInput < Struct.new(
|
2443
|
+
:accept_language,
|
2444
|
+
:access_level_filter,
|
2445
|
+
:page_size,
|
2446
|
+
:page_token)
|
2447
|
+
include Aws::Structure
|
2448
|
+
end
|
2449
|
+
|
2450
|
+
# @!attribute [rw] provisioned_products
|
2451
|
+
# A list of ProvisionedProduct detail objects.
|
2452
|
+
# @return [Array<Types::ProvisionedProductDetail>]
|
2453
|
+
#
|
2454
|
+
# @!attribute [rw] next_page_token
|
2455
|
+
# The page token to use to retrieve the next page of results for this
|
2456
|
+
# operation. If there are no more pages, this value is null.
|
2457
|
+
# @return [String]
|
2458
|
+
class ScanProvisionedProductsOutput < Struct.new(
|
2459
|
+
:provisioned_products,
|
2460
|
+
:next_page_token)
|
2461
|
+
include Aws::Structure
|
2462
|
+
end
|
2463
|
+
|
2464
|
+
# @note When making an API call, pass SearchProductsAsAdminInput
|
2465
|
+
# data as a hash:
|
2466
|
+
#
|
2467
|
+
# {
|
2468
|
+
# accept_language: "AcceptLanguage",
|
2469
|
+
# portfolio_id: "Id",
|
2470
|
+
# filters: {
|
2471
|
+
# "FullTextSearch" => ["ProductViewFilterValue"],
|
2472
|
+
# },
|
2473
|
+
# sort_by: "Title", # accepts Title, VersionCount, CreationDate
|
2474
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
2475
|
+
# page_token: "PageToken",
|
2476
|
+
# page_size: 1,
|
2477
|
+
# product_source: "ACCOUNT", # accepts ACCOUNT
|
2478
|
+
# }
|
2479
|
+
# @!attribute [rw] accept_language
|
2480
|
+
# The language code to use for this operation. Supported language
|
2481
|
+
# codes are as follows:
|
2482
|
+
#
|
2483
|
+
# "en" (English)
|
2484
|
+
#
|
2485
|
+
# "jp" (Japanese)
|
2486
|
+
#
|
2487
|
+
# "zh" (Chinese)
|
2488
|
+
#
|
2489
|
+
# If no code is specified, "en" is used as the default.
|
2490
|
+
# @return [String]
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] portfolio_id
|
2493
|
+
# The portfolio identifier.
|
2494
|
+
# @return [String]
|
2495
|
+
#
|
2496
|
+
# @!attribute [rw] filters
|
2497
|
+
# The list of filters with which to limit search results. If no search
|
2498
|
+
# filters are specified, the output is all the products to which the
|
2499
|
+
# administrator has access.
|
2500
|
+
# @return [Hash<String,Array<String>>]
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] sort_by
|
2503
|
+
# The sort field specifier. If no value is specified, results are not
|
2504
|
+
# sorted.
|
2505
|
+
# @return [String]
|
2506
|
+
#
|
2507
|
+
# @!attribute [rw] sort_order
|
2508
|
+
# The sort order specifier. If no value is specified, results are not
|
2509
|
+
# sorted.
|
2510
|
+
# @return [String]
|
2511
|
+
#
|
2512
|
+
# @!attribute [rw] page_token
|
2513
|
+
# The page token of the first page retrieved. If null, this retrieves
|
2514
|
+
# the first page of size `PageSize`.
|
2515
|
+
# @return [String]
|
2516
|
+
#
|
2517
|
+
# @!attribute [rw] page_size
|
2518
|
+
# The maximum number of items to return in the results. If more
|
2519
|
+
# results exist than fit in the specified `PageSize`, the value of
|
2520
|
+
# `NextPageToken` in the response is non-null.
|
2521
|
+
# @return [Integer]
|
2522
|
+
#
|
2523
|
+
# @!attribute [rw] product_source
|
2524
|
+
# Access level of the source of the product.
|
2525
|
+
# @return [String]
|
2526
|
+
class SearchProductsAsAdminInput < Struct.new(
|
2527
|
+
:accept_language,
|
2528
|
+
:portfolio_id,
|
2529
|
+
:filters,
|
2530
|
+
:sort_by,
|
2531
|
+
:sort_order,
|
2532
|
+
:page_token,
|
2533
|
+
:page_size,
|
2534
|
+
:product_source)
|
2535
|
+
include Aws::Structure
|
2536
|
+
end
|
2537
|
+
|
2538
|
+
# @!attribute [rw] product_view_details
|
2539
|
+
# List of detailed product view information objects.
|
2540
|
+
# @return [Array<Types::ProductViewDetail>]
|
2541
|
+
#
|
2542
|
+
# @!attribute [rw] next_page_token
|
2543
|
+
# The page token to use to retrieve the next page of results for this
|
2544
|
+
# operation. If there are no more pages, this value is null.
|
2545
|
+
# @return [String]
|
2546
|
+
class SearchProductsAsAdminOutput < Struct.new(
|
2547
|
+
:product_view_details,
|
2548
|
+
:next_page_token)
|
2549
|
+
include Aws::Structure
|
2550
|
+
end
|
2551
|
+
|
2552
|
+
# @note When making an API call, pass SearchProductsInput
|
2553
|
+
# data as a hash:
|
2554
|
+
#
|
2555
|
+
# {
|
2556
|
+
# accept_language: "AcceptLanguage",
|
2557
|
+
# filters: {
|
2558
|
+
# "FullTextSearch" => ["ProductViewFilterValue"],
|
2559
|
+
# },
|
2560
|
+
# page_size: 1,
|
2561
|
+
# sort_by: "Title", # accepts Title, VersionCount, CreationDate
|
2562
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
2563
|
+
# page_token: "PageToken",
|
2564
|
+
# }
|
2565
|
+
# @!attribute [rw] accept_language
|
2566
|
+
# The language code to use for this operation. Supported language
|
2567
|
+
# codes are as follows:
|
2568
|
+
#
|
2569
|
+
# "en" (English)
|
2570
|
+
#
|
2571
|
+
# "jp" (Japanese)
|
2572
|
+
#
|
2573
|
+
# "zh" (Chinese)
|
2574
|
+
#
|
2575
|
+
# If no code is specified, "en" is used as the default.
|
2576
|
+
# @return [String]
|
2577
|
+
#
|
2578
|
+
# @!attribute [rw] filters
|
2579
|
+
# The list of filters with which to limit search results. If no search
|
2580
|
+
# filters are specified, the output is all the products to which the
|
2581
|
+
# calling user has access.
|
2582
|
+
# @return [Hash<String,Array<String>>]
|
2583
|
+
#
|
2584
|
+
# @!attribute [rw] page_size
|
2585
|
+
# The maximum number of items to return in the results. If more
|
2586
|
+
# results exist than fit in the specified `PageSize`, the value of
|
2587
|
+
# `NextPageToken` in the response is non-null.
|
2588
|
+
# @return [Integer]
|
2589
|
+
#
|
2590
|
+
# @!attribute [rw] sort_by
|
2591
|
+
# The sort field specifier. If no value is specified, results are not
|
2592
|
+
# sorted.
|
2593
|
+
# @return [String]
|
2594
|
+
#
|
2595
|
+
# @!attribute [rw] sort_order
|
2596
|
+
# The sort order specifier. If no value is specified, results are not
|
2597
|
+
# sorted.
|
2598
|
+
# @return [String]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] page_token
|
2601
|
+
# The page token of the first page retrieved. If null, this retrieves
|
2602
|
+
# the first page of size `PageSize`.
|
2603
|
+
# @return [String]
|
2604
|
+
class SearchProductsInput < Struct.new(
|
2605
|
+
:accept_language,
|
2606
|
+
:filters,
|
2607
|
+
:page_size,
|
2608
|
+
:sort_by,
|
2609
|
+
:sort_order,
|
2610
|
+
:page_token)
|
2611
|
+
include Aws::Structure
|
2612
|
+
end
|
2613
|
+
|
2614
|
+
# @!attribute [rw] product_view_summaries
|
2615
|
+
# A list of the product view summary objects.
|
2616
|
+
# @return [Array<Types::ProductViewSummary>]
|
2617
|
+
#
|
2618
|
+
# @!attribute [rw] product_view_aggregations
|
2619
|
+
# A list of the product view aggregation value objects.
|
2620
|
+
# @return [Hash<String,Array<Types::ProductViewAggregationValue>>]
|
2621
|
+
#
|
2622
|
+
# @!attribute [rw] next_page_token
|
2623
|
+
# The page token to use to retrieve the next page of results for this
|
2624
|
+
# operation. If there are no more pages, this value is null.
|
2625
|
+
# @return [String]
|
2626
|
+
class SearchProductsOutput < Struct.new(
|
2627
|
+
:product_view_summaries,
|
2628
|
+
:product_view_aggregations,
|
2629
|
+
:next_page_token)
|
2630
|
+
include Aws::Structure
|
2631
|
+
end
|
2632
|
+
|
2633
|
+
# Key/value pairs to associate with this provisioning. These tags are
|
2634
|
+
# entirely discretionary and are propagated to the resources created in
|
2635
|
+
# the provisioning.
|
2636
|
+
# @note When making an API call, pass Tag
|
2637
|
+
# data as a hash:
|
2638
|
+
#
|
2639
|
+
# {
|
2640
|
+
# key: "TagKey", # required
|
2641
|
+
# value: "TagValue", # required
|
2642
|
+
# }
|
2643
|
+
# @!attribute [rw] key
|
2644
|
+
# The `ProvisioningArtifactParameter.TagKey` parameter from
|
2645
|
+
# DescribeProvisioningParameters.
|
2646
|
+
# @return [String]
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] value
|
2649
|
+
# The esired value for this key.
|
2650
|
+
# @return [String]
|
2651
|
+
class Tag < Struct.new(
|
2652
|
+
:key,
|
2653
|
+
:value)
|
2654
|
+
include Aws::Structure
|
2655
|
+
end
|
2656
|
+
|
2657
|
+
# @note When making an API call, pass TerminateProvisionedProductInput
|
2658
|
+
# data as a hash:
|
2659
|
+
#
|
2660
|
+
# {
|
2661
|
+
# provisioned_product_name: "ProvisionedProductNameOrArn",
|
2662
|
+
# provisioned_product_id: "Id",
|
2663
|
+
# terminate_token: "IdempotencyToken", # required
|
2664
|
+
# ignore_errors: false,
|
2665
|
+
# accept_language: "AcceptLanguage",
|
2666
|
+
# }
|
2667
|
+
# @!attribute [rw] provisioned_product_name
|
2668
|
+
# The name of the ProvisionedProduct object to terminate. You must
|
2669
|
+
# specify either `ProvisionedProductName` or `ProvisionedProductId`,
|
2670
|
+
# but not both.
|
2671
|
+
# @return [String]
|
2672
|
+
#
|
2673
|
+
# @!attribute [rw] provisioned_product_id
|
2674
|
+
# The identifier of the ProvisionedProduct object to terminate. You
|
2675
|
+
# must specify either `ProvisionedProductName` or
|
2676
|
+
# `ProvisionedProductId`, but not both.
|
2677
|
+
# @return [String]
|
2678
|
+
#
|
2679
|
+
# @!attribute [rw] terminate_token
|
2680
|
+
# An idempotency token that uniquely identifies the termination
|
2681
|
+
# request. This token is only valid during the termination process.
|
2682
|
+
# After the ProvisionedProduct object is terminated, further requests
|
2683
|
+
# to terminate the same ProvisionedProduct object always return
|
2684
|
+
# **ResourceNotFound** regardless of the value of `TerminateToken`.
|
2685
|
+
#
|
2686
|
+
# **A suitable default value is auto-generated.** You should
|
2687
|
+
# normally not need to pass this option.
|
2688
|
+
# @return [String]
|
2689
|
+
#
|
2690
|
+
# @!attribute [rw] ignore_errors
|
2691
|
+
# If set to true, AWS Service Catalog stops managing the specified
|
2692
|
+
# ProvisionedProduct object even if it cannot delete the underlying
|
2693
|
+
# resources.
|
2694
|
+
# @return [Boolean]
|
2695
|
+
#
|
2696
|
+
# @!attribute [rw] accept_language
|
2697
|
+
# The language code to use for this operation. Supported language
|
2698
|
+
# codes are as follows:
|
2699
|
+
#
|
2700
|
+
# "en" (English)
|
2701
|
+
#
|
2702
|
+
# "jp" (Japanese)
|
2703
|
+
#
|
2704
|
+
# "zh" (Chinese)
|
2705
|
+
#
|
2706
|
+
# If no code is specified, "en" is used as the default.
|
2707
|
+
# @return [String]
|
2708
|
+
class TerminateProvisionedProductInput < Struct.new(
|
2709
|
+
:provisioned_product_name,
|
2710
|
+
:provisioned_product_id,
|
2711
|
+
:terminate_token,
|
2712
|
+
:ignore_errors,
|
2713
|
+
:accept_language)
|
2714
|
+
include Aws::Structure
|
2715
|
+
end
|
2716
|
+
|
2717
|
+
# @!attribute [rw] record_detail
|
2718
|
+
# The detailed result of the TerminateProvisionedProduct request,
|
2719
|
+
# containing the inputs made to that request, the current state of the
|
2720
|
+
# request, a pointer to the ProvisionedProduct object that the request
|
2721
|
+
# is modifying, and a list of any errors that the request encountered.
|
2722
|
+
# @return [Types::RecordDetail]
|
2723
|
+
class TerminateProvisionedProductOutput < Struct.new(
|
2724
|
+
:record_detail)
|
2725
|
+
include Aws::Structure
|
2726
|
+
end
|
2727
|
+
|
2728
|
+
# @note When making an API call, pass UpdateConstraintInput
|
2729
|
+
# data as a hash:
|
2730
|
+
#
|
2731
|
+
# {
|
2732
|
+
# accept_language: "AcceptLanguage",
|
2733
|
+
# id: "Id", # required
|
2734
|
+
# description: "ConstraintDescription",
|
2735
|
+
# }
|
2736
|
+
# @!attribute [rw] accept_language
|
2737
|
+
# The language code to use for this operation. Supported language
|
2738
|
+
# codes are as follows:
|
2739
|
+
#
|
2740
|
+
# "en" (English)
|
2741
|
+
#
|
2742
|
+
# "jp" (Japanese)
|
2743
|
+
#
|
2744
|
+
# "zh" (Chinese)
|
2745
|
+
#
|
2746
|
+
# If no code is specified, "en" is used as the default.
|
2747
|
+
# @return [String]
|
2748
|
+
#
|
2749
|
+
# @!attribute [rw] id
|
2750
|
+
# The identifier of the constraint to update.
|
2751
|
+
# @return [String]
|
2752
|
+
#
|
2753
|
+
# @!attribute [rw] description
|
2754
|
+
# The updated text description of the constraint.
|
2755
|
+
# @return [String]
|
2756
|
+
class UpdateConstraintInput < Struct.new(
|
2757
|
+
:accept_language,
|
2758
|
+
:id,
|
2759
|
+
:description)
|
2760
|
+
include Aws::Structure
|
2761
|
+
end
|
2762
|
+
|
2763
|
+
# @!attribute [rw] constraint_detail
|
2764
|
+
# The resulting detailed constraint information.
|
2765
|
+
# @return [Types::ConstraintDetail]
|
2766
|
+
#
|
2767
|
+
# @!attribute [rw] constraint_parameters
|
2768
|
+
# The resulting updated constraint parameters.
|
2769
|
+
# @return [String]
|
2770
|
+
#
|
2771
|
+
# @!attribute [rw] status
|
2772
|
+
# The status of the current request.
|
2773
|
+
# @return [String]
|
2774
|
+
class UpdateConstraintOutput < Struct.new(
|
2775
|
+
:constraint_detail,
|
2776
|
+
:constraint_parameters,
|
2777
|
+
:status)
|
2778
|
+
include Aws::Structure
|
2779
|
+
end
|
2780
|
+
|
2781
|
+
# @note When making an API call, pass UpdatePortfolioInput
|
2782
|
+
# data as a hash:
|
2783
|
+
#
|
2784
|
+
# {
|
2785
|
+
# accept_language: "AcceptLanguage",
|
2786
|
+
# id: "Id", # required
|
2787
|
+
# display_name: "PortfolioDisplayName",
|
2788
|
+
# description: "PortfolioDescription",
|
2789
|
+
# provider_name: "ProviderName",
|
2790
|
+
# add_tags: [
|
2791
|
+
# {
|
2792
|
+
# key: "TagKey", # required
|
2793
|
+
# value: "TagValue", # required
|
2794
|
+
# },
|
2795
|
+
# ],
|
2796
|
+
# remove_tags: ["TagKey"],
|
2797
|
+
# }
|
2798
|
+
# @!attribute [rw] accept_language
|
2799
|
+
# The language code to use for this operation. Supported language
|
2800
|
+
# codes are as follows:
|
2801
|
+
#
|
2802
|
+
# "en" (English)
|
2803
|
+
#
|
2804
|
+
# "jp" (Japanese)
|
2805
|
+
#
|
2806
|
+
# "zh" (Chinese)
|
2807
|
+
#
|
2808
|
+
# If no code is specified, "en" is used as the default.
|
2809
|
+
# @return [String]
|
2810
|
+
#
|
2811
|
+
# @!attribute [rw] id
|
2812
|
+
# The identifier of the portfolio for the update request.
|
2813
|
+
# @return [String]
|
2814
|
+
#
|
2815
|
+
# @!attribute [rw] display_name
|
2816
|
+
# The name to use for display purposes.
|
2817
|
+
# @return [String]
|
2818
|
+
#
|
2819
|
+
# @!attribute [rw] description
|
2820
|
+
# The updated text description of the portfolio.
|
2821
|
+
# @return [String]
|
2822
|
+
#
|
2823
|
+
# @!attribute [rw] provider_name
|
2824
|
+
# The updated name of the portfolio provider.
|
2825
|
+
# @return [String]
|
2826
|
+
#
|
2827
|
+
# @!attribute [rw] add_tags
|
2828
|
+
# Tags to add to the existing list of tags associated with the
|
2829
|
+
# portfolio.
|
2830
|
+
# @return [Array<Types::Tag>]
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] remove_tags
|
2833
|
+
# Tags to remove from the existing list of tags associated with the
|
2834
|
+
# portfolio.
|
2835
|
+
# @return [Array<String>]
|
2836
|
+
class UpdatePortfolioInput < Struct.new(
|
2837
|
+
:accept_language,
|
2838
|
+
:id,
|
2839
|
+
:display_name,
|
2840
|
+
:description,
|
2841
|
+
:provider_name,
|
2842
|
+
:add_tags,
|
2843
|
+
:remove_tags)
|
2844
|
+
include Aws::Structure
|
2845
|
+
end
|
2846
|
+
|
2847
|
+
# @!attribute [rw] portfolio_detail
|
2848
|
+
# The resulting detailed portfolio information.
|
2849
|
+
# @return [Types::PortfolioDetail]
|
2850
|
+
#
|
2851
|
+
# @!attribute [rw] tags
|
2852
|
+
# Tags associated with the portfolio.
|
2853
|
+
# @return [Array<Types::Tag>]
|
2854
|
+
class UpdatePortfolioOutput < Struct.new(
|
2855
|
+
:portfolio_detail,
|
2856
|
+
:tags)
|
2857
|
+
include Aws::Structure
|
2858
|
+
end
|
2859
|
+
|
2860
|
+
# @note When making an API call, pass UpdateProductInput
|
2861
|
+
# data as a hash:
|
2862
|
+
#
|
2863
|
+
# {
|
2864
|
+
# accept_language: "AcceptLanguage",
|
2865
|
+
# id: "Id", # required
|
2866
|
+
# name: "ProductViewName",
|
2867
|
+
# owner: "ProductViewOwner",
|
2868
|
+
# description: "ProductViewShortDescription",
|
2869
|
+
# distributor: "ProductViewOwner",
|
2870
|
+
# support_description: "SupportDescription",
|
2871
|
+
# support_email: "SupportEmail",
|
2872
|
+
# support_url: "SupportUrl",
|
2873
|
+
# add_tags: [
|
2874
|
+
# {
|
2875
|
+
# key: "TagKey", # required
|
2876
|
+
# value: "TagValue", # required
|
2877
|
+
# },
|
2878
|
+
# ],
|
2879
|
+
# remove_tags: ["TagKey"],
|
2880
|
+
# }
|
2881
|
+
# @!attribute [rw] accept_language
|
2882
|
+
# The language code to use for this operation. Supported language
|
2883
|
+
# codes are as follows:
|
2884
|
+
#
|
2885
|
+
# "en" (English)
|
2886
|
+
#
|
2887
|
+
# "jp" (Japanese)
|
2888
|
+
#
|
2889
|
+
# "zh" (Chinese)
|
2890
|
+
#
|
2891
|
+
# If no code is specified, "en" is used as the default.
|
2892
|
+
# @return [String]
|
2893
|
+
#
|
2894
|
+
# @!attribute [rw] id
|
2895
|
+
# The identifier of the product for the update request.
|
2896
|
+
# @return [String]
|
2897
|
+
#
|
2898
|
+
# @!attribute [rw] name
|
2899
|
+
# The updated product name.
|
2900
|
+
# @return [String]
|
2901
|
+
#
|
2902
|
+
# @!attribute [rw] owner
|
2903
|
+
# The updated owner of the product.
|
2904
|
+
# @return [String]
|
2905
|
+
#
|
2906
|
+
# @!attribute [rw] description
|
2907
|
+
# The updated text description of the product.
|
2908
|
+
# @return [String]
|
2909
|
+
#
|
2910
|
+
# @!attribute [rw] distributor
|
2911
|
+
# The updated distributor of the product.
|
2912
|
+
# @return [String]
|
2913
|
+
#
|
2914
|
+
# @!attribute [rw] support_description
|
2915
|
+
# The updated support description for the product.
|
2916
|
+
# @return [String]
|
2917
|
+
#
|
2918
|
+
# @!attribute [rw] support_email
|
2919
|
+
# The updated support email for the product.
|
2920
|
+
# @return [String]
|
2921
|
+
#
|
2922
|
+
# @!attribute [rw] support_url
|
2923
|
+
# The updated support URL for the product.
|
2924
|
+
# @return [String]
|
2925
|
+
#
|
2926
|
+
# @!attribute [rw] add_tags
|
2927
|
+
# Tags to add to the existing list of tags associated with the
|
2928
|
+
# product.
|
2929
|
+
# @return [Array<Types::Tag>]
|
2930
|
+
#
|
2931
|
+
# @!attribute [rw] remove_tags
|
2932
|
+
# Tags to remove from the existing list of tags associated with the
|
2933
|
+
# product.
|
2934
|
+
# @return [Array<String>]
|
2935
|
+
class UpdateProductInput < Struct.new(
|
2936
|
+
:accept_language,
|
2937
|
+
:id,
|
2938
|
+
:name,
|
2939
|
+
:owner,
|
2940
|
+
:description,
|
2941
|
+
:distributor,
|
2942
|
+
:support_description,
|
2943
|
+
:support_email,
|
2944
|
+
:support_url,
|
2945
|
+
:add_tags,
|
2946
|
+
:remove_tags)
|
2947
|
+
include Aws::Structure
|
2948
|
+
end
|
2949
|
+
|
2950
|
+
# @!attribute [rw] product_view_detail
|
2951
|
+
# The resulting detailed product view information.
|
2952
|
+
# @return [Types::ProductViewDetail]
|
2953
|
+
#
|
2954
|
+
# @!attribute [rw] tags
|
2955
|
+
# Tags associated with the product.
|
2956
|
+
# @return [Array<Types::Tag>]
|
2957
|
+
class UpdateProductOutput < Struct.new(
|
2958
|
+
:product_view_detail,
|
2959
|
+
:tags)
|
2960
|
+
include Aws::Structure
|
2961
|
+
end
|
2962
|
+
|
2963
|
+
# @note When making an API call, pass UpdateProvisionedProductInput
|
2964
|
+
# data as a hash:
|
2965
|
+
#
|
2966
|
+
# {
|
2967
|
+
# accept_language: "AcceptLanguage",
|
2968
|
+
# provisioned_product_name: "ProvisionedProductNameOrArn",
|
2969
|
+
# provisioned_product_id: "Id",
|
2970
|
+
# product_id: "Id",
|
2971
|
+
# provisioning_artifact_id: "Id",
|
2972
|
+
# path_id: "Id",
|
2973
|
+
# provisioning_parameters: [
|
2974
|
+
# {
|
2975
|
+
# key: "ParameterKey",
|
2976
|
+
# value: "ParameterValue",
|
2977
|
+
# use_previous_value: false,
|
2978
|
+
# },
|
2979
|
+
# ],
|
2980
|
+
# update_token: "IdempotencyToken", # required
|
2981
|
+
# }
|
2982
|
+
# @!attribute [rw] accept_language
|
2983
|
+
# The language code to use for this operation. Supported language
|
2984
|
+
# codes are as follows:
|
2985
|
+
#
|
2986
|
+
# "en" (English)
|
2987
|
+
#
|
2988
|
+
# "jp" (Japanese)
|
2989
|
+
#
|
2990
|
+
# "zh" (Chinese)
|
2991
|
+
#
|
2992
|
+
# If no code is specified, "en" is used as the default.
|
2993
|
+
# @return [String]
|
2994
|
+
#
|
2995
|
+
# @!attribute [rw] provisioned_product_name
|
2996
|
+
# The updated name of the ProvisionedProduct object . You must specify
|
2997
|
+
# either `ProvisionedProductName` or `ProvisionedProductId`, but not
|
2998
|
+
# both.
|
2999
|
+
# @return [String]
|
3000
|
+
#
|
3001
|
+
# @!attribute [rw] provisioned_product_id
|
3002
|
+
# The identifier of the ProvisionedProduct object to update. You must
|
3003
|
+
# specify either `ProvisionedProductName` or `ProvisionedProductId`,
|
3004
|
+
# but not both.
|
3005
|
+
# @return [String]
|
3006
|
+
#
|
3007
|
+
# @!attribute [rw] product_id
|
3008
|
+
# The identifier of the ProvisionedProduct object.
|
3009
|
+
# @return [String]
|
3010
|
+
#
|
3011
|
+
# @!attribute [rw] provisioning_artifact_id
|
3012
|
+
# The provisioning artifact identifier for this product.
|
3013
|
+
# @return [String]
|
3014
|
+
#
|
3015
|
+
# @!attribute [rw] path_id
|
3016
|
+
# The identifier of the path to use in the updated ProvisionedProduct
|
3017
|
+
# object. This value is optional if the product has a default path,
|
3018
|
+
# and is required if there is more than one path for the specified
|
3019
|
+
# product.
|
3020
|
+
# @return [String]
|
3021
|
+
#
|
3022
|
+
# @!attribute [rw] provisioning_parameters
|
3023
|
+
# A list of `ProvisioningParameter` objects used to update the
|
3024
|
+
# ProvisionedProduct object.
|
3025
|
+
# @return [Array<Types::UpdateProvisioningParameter>]
|
3026
|
+
#
|
3027
|
+
# @!attribute [rw] update_token
|
3028
|
+
# The idempotency token that uniquely identifies the provisioning
|
3029
|
+
# update request.
|
3030
|
+
#
|
3031
|
+
# **A suitable default value is auto-generated.** You should
|
3032
|
+
# normally not need to pass this option.
|
3033
|
+
# @return [String]
|
3034
|
+
class UpdateProvisionedProductInput < Struct.new(
|
3035
|
+
:accept_language,
|
3036
|
+
:provisioned_product_name,
|
3037
|
+
:provisioned_product_id,
|
3038
|
+
:product_id,
|
3039
|
+
:provisioning_artifact_id,
|
3040
|
+
:path_id,
|
3041
|
+
:provisioning_parameters,
|
3042
|
+
:update_token)
|
3043
|
+
include Aws::Structure
|
3044
|
+
end
|
3045
|
+
|
3046
|
+
# @!attribute [rw] record_detail
|
3047
|
+
# The detailed result of the UpdateProvisionedProduct request,
|
3048
|
+
# containing the inputs made to that request, the current state of the
|
3049
|
+
# request, a pointer to the ProvisionedProduct object that the request
|
3050
|
+
# is modifying, and a list of any errors that the request encountered.
|
3051
|
+
# @return [Types::RecordDetail]
|
3052
|
+
class UpdateProvisionedProductOutput < Struct.new(
|
3053
|
+
:record_detail)
|
3054
|
+
include Aws::Structure
|
3055
|
+
end
|
3056
|
+
|
3057
|
+
# @note When making an API call, pass UpdateProvisioningArtifactInput
|
3058
|
+
# data as a hash:
|
3059
|
+
#
|
3060
|
+
# {
|
3061
|
+
# accept_language: "AcceptLanguage",
|
3062
|
+
# product_id: "Id", # required
|
3063
|
+
# provisioning_artifact_id: "Id", # required
|
3064
|
+
# name: "ProvisioningArtifactName",
|
3065
|
+
# description: "ProvisioningArtifactDescription",
|
3066
|
+
# }
|
3067
|
+
# @!attribute [rw] accept_language
|
3068
|
+
# The language code to use for this operation. Supported language
|
3069
|
+
# codes are as follows:
|
3070
|
+
#
|
3071
|
+
# "en" (English)
|
3072
|
+
#
|
3073
|
+
# "jp" (Japanese)
|
3074
|
+
#
|
3075
|
+
# "zh" (Chinese)
|
3076
|
+
#
|
3077
|
+
# If no code is specified, "en" is used as the default.
|
3078
|
+
# @return [String]
|
3079
|
+
#
|
3080
|
+
# @!attribute [rw] product_id
|
3081
|
+
# The product identifier.
|
3082
|
+
# @return [String]
|
3083
|
+
#
|
3084
|
+
# @!attribute [rw] provisioning_artifact_id
|
3085
|
+
# The identifier of the provisioning artifact for the update request.
|
3086
|
+
# @return [String]
|
3087
|
+
#
|
3088
|
+
# @!attribute [rw] name
|
3089
|
+
# The updated name of the provisioning artifact.
|
3090
|
+
# @return [String]
|
3091
|
+
#
|
3092
|
+
# @!attribute [rw] description
|
3093
|
+
# The updated text description of the provisioning artifact.
|
3094
|
+
# @return [String]
|
3095
|
+
class UpdateProvisioningArtifactInput < Struct.new(
|
3096
|
+
:accept_language,
|
3097
|
+
:product_id,
|
3098
|
+
:provisioning_artifact_id,
|
3099
|
+
:name,
|
3100
|
+
:description)
|
3101
|
+
include Aws::Structure
|
3102
|
+
end
|
3103
|
+
|
3104
|
+
# @!attribute [rw] provisioning_artifact_detail
|
3105
|
+
# The resulting detailed provisioning artifact information.
|
3106
|
+
# @return [Types::ProvisioningArtifactDetail]
|
3107
|
+
#
|
3108
|
+
# @!attribute [rw] info
|
3109
|
+
# Additional information about the provisioning artifact update
|
3110
|
+
# request.
|
3111
|
+
# @return [Hash<String,String>]
|
3112
|
+
#
|
3113
|
+
# @!attribute [rw] status
|
3114
|
+
# The status of the current request.
|
3115
|
+
# @return [String]
|
3116
|
+
class UpdateProvisioningArtifactOutput < Struct.new(
|
3117
|
+
:provisioning_artifact_detail,
|
3118
|
+
:info,
|
3119
|
+
:status)
|
3120
|
+
include Aws::Structure
|
3121
|
+
end
|
3122
|
+
|
3123
|
+
# The parameter key/value pair used to update a ProvisionedProduct
|
3124
|
+
# object. If `UsePreviousValue` is set to true, `Value` is ignored and
|
3125
|
+
# the value for `Key` is kept as previously set (current value).
|
3126
|
+
# @note When making an API call, pass UpdateProvisioningParameter
|
3127
|
+
# data as a hash:
|
3128
|
+
#
|
3129
|
+
# {
|
3130
|
+
# key: "ParameterKey",
|
3131
|
+
# value: "ParameterValue",
|
3132
|
+
# use_previous_value: false,
|
3133
|
+
# }
|
3134
|
+
# @!attribute [rw] key
|
3135
|
+
# The `ProvisioningArtifactParameter.ParameterKey` parameter from
|
3136
|
+
# DescribeProvisioningParameters.
|
3137
|
+
# @return [String]
|
3138
|
+
#
|
3139
|
+
# @!attribute [rw] value
|
3140
|
+
# The value to use for updating the product provisioning. Any
|
3141
|
+
# constraints on this value can be found in the
|
3142
|
+
# `ProvisioningArtifactParameter` parameter for `Key`.
|
3143
|
+
# @return [String]
|
3144
|
+
#
|
3145
|
+
# @!attribute [rw] use_previous_value
|
3146
|
+
# If true, uses the currently set value for `Key`, ignoring
|
3147
|
+
# `UpdateProvisioningParameter.Value`.
|
3148
|
+
# @return [Boolean]
|
3149
|
+
class UpdateProvisioningParameter < Struct.new(
|
3150
|
+
:key,
|
3151
|
+
:value,
|
3152
|
+
:use_previous_value)
|
3153
|
+
include Aws::Structure
|
3154
|
+
end
|
3155
|
+
|
3156
|
+
# Additional information provided by the administrator.
|
3157
|
+
# @!attribute [rw] type
|
3158
|
+
# The usage instruction type for the value.
|
3159
|
+
# @return [String]
|
3160
|
+
#
|
3161
|
+
# @!attribute [rw] value
|
3162
|
+
# The usage instruction value for this type.
|
3163
|
+
# @return [String]
|
3164
|
+
class UsageInstruction < Struct.new(
|
3165
|
+
:type,
|
3166
|
+
:value)
|
3167
|
+
include Aws::Structure
|
3168
|
+
end
|
3169
|
+
|
3170
|
+
end
|
3171
|
+
end
|
3172
|
+
end
|