aws-sdk-marketplacecatalog 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-marketplacecatalog.rb +47 -0
- data/lib/aws-sdk-marketplacecatalog/client.rb +617 -0
- data/lib/aws-sdk-marketplacecatalog/client_api.rb +331 -0
- data/lib/aws-sdk-marketplacecatalog/customizations.rb +0 -0
- data/lib/aws-sdk-marketplacecatalog/errors.rb +142 -0
- data/lib/aws-sdk-marketplacecatalog/resource.rb +23 -0
- data/lib/aws-sdk-marketplacecatalog/types.rb +786 -0
- metadata +88 -0
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceCatalog
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,786 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::MarketplaceCatalog
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Access is denied.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] message
|
14
|
+
# @return [String]
|
15
|
+
#
|
16
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/AccessDeniedException AWS API Documentation
|
17
|
+
#
|
18
|
+
class AccessDeniedException < Struct.new(
|
19
|
+
:message)
|
20
|
+
include Aws::Structure
|
21
|
+
end
|
22
|
+
|
23
|
+
# @note When making an API call, you may pass CancelChangeSetRequest
|
24
|
+
# data as a hash:
|
25
|
+
#
|
26
|
+
# {
|
27
|
+
# catalog: "Catalog", # required
|
28
|
+
# change_set_id: "ResourceId", # required
|
29
|
+
# }
|
30
|
+
#
|
31
|
+
# @!attribute [rw] catalog
|
32
|
+
# Required. The catalog related to the request. Fixed value:
|
33
|
+
# `AWSMarketplace`.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] change_set_id
|
37
|
+
# Required. The unique identifier of the `StartChangeSet` request that
|
38
|
+
# you want to cancel.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/CancelChangeSetRequest AWS API Documentation
|
42
|
+
#
|
43
|
+
class CancelChangeSetRequest < Struct.new(
|
44
|
+
:catalog,
|
45
|
+
:change_set_id)
|
46
|
+
include Aws::Structure
|
47
|
+
end
|
48
|
+
|
49
|
+
# @!attribute [rw] change_set_id
|
50
|
+
# The unique identifier for the change set referenced in this request.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] change_set_arn
|
54
|
+
# The ARN associated with the change set referenced in this request.
|
55
|
+
# @return [String]
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/CancelChangeSetResponse AWS API Documentation
|
58
|
+
#
|
59
|
+
class CancelChangeSetResponse < Struct.new(
|
60
|
+
:change_set_id,
|
61
|
+
:change_set_arn)
|
62
|
+
include Aws::Structure
|
63
|
+
end
|
64
|
+
|
65
|
+
# An object that contains the `ChangeType`, `Details`, and `Entity`.
|
66
|
+
#
|
67
|
+
# @note When making an API call, you may pass Change
|
68
|
+
# data as a hash:
|
69
|
+
#
|
70
|
+
# {
|
71
|
+
# change_type: "ChangeType", # required
|
72
|
+
# entity: { # required
|
73
|
+
# type: "EntityType", # required
|
74
|
+
# identifier: "Identifier",
|
75
|
+
# },
|
76
|
+
# details: "Json", # required
|
77
|
+
# }
|
78
|
+
#
|
79
|
+
# @!attribute [rw] change_type
|
80
|
+
# Change types are single string values that describe your intention
|
81
|
+
# for the change. Each change type is unique for each `EntityType`
|
82
|
+
# provided in the change's scope.
|
83
|
+
# @return [String]
|
84
|
+
#
|
85
|
+
# @!attribute [rw] entity
|
86
|
+
# The entity to be changed.
|
87
|
+
# @return [Types::Entity]
|
88
|
+
#
|
89
|
+
# @!attribute [rw] details
|
90
|
+
# This object contains details specific to the change type of the
|
91
|
+
# requested change.
|
92
|
+
# @return [String]
|
93
|
+
#
|
94
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/Change AWS API Documentation
|
95
|
+
#
|
96
|
+
class Change < Struct.new(
|
97
|
+
:change_type,
|
98
|
+
:entity,
|
99
|
+
:details)
|
100
|
+
include Aws::Structure
|
101
|
+
end
|
102
|
+
|
103
|
+
# A summary of a change set returned in a list of change sets when the
|
104
|
+
# `ListChangeSets` action is called.
|
105
|
+
#
|
106
|
+
# @!attribute [rw] change_set_id
|
107
|
+
# The unique identifier for a change set.
|
108
|
+
# @return [String]
|
109
|
+
#
|
110
|
+
# @!attribute [rw] change_set_arn
|
111
|
+
# The ARN associated with the unique identifier for the change set
|
112
|
+
# referenced in this request.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] change_set_name
|
116
|
+
# The non-unique name for the change set.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] start_time
|
120
|
+
# The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change
|
121
|
+
# set was started.
|
122
|
+
# @return [String]
|
123
|
+
#
|
124
|
+
# @!attribute [rw] end_time
|
125
|
+
# The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change
|
126
|
+
# set was finished.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] status
|
130
|
+
# The current status of the change set.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] entity_id_list
|
134
|
+
# This object is a list of entity IDs (string) that are a part of a
|
135
|
+
# change set. The entity ID list is a maximum of 20 entities. It must
|
136
|
+
# contain at least one entity.
|
137
|
+
# @return [Array<String>]
|
138
|
+
#
|
139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ChangeSetSummaryListItem AWS API Documentation
|
140
|
+
#
|
141
|
+
class ChangeSetSummaryListItem < Struct.new(
|
142
|
+
:change_set_id,
|
143
|
+
:change_set_arn,
|
144
|
+
:change_set_name,
|
145
|
+
:start_time,
|
146
|
+
:end_time,
|
147
|
+
:status,
|
148
|
+
:entity_id_list)
|
149
|
+
include Aws::Structure
|
150
|
+
end
|
151
|
+
|
152
|
+
# This object is a container for common summary information about the
|
153
|
+
# change. The summary doesn't contain the whole change structure.
|
154
|
+
#
|
155
|
+
# @!attribute [rw] change_type
|
156
|
+
# The type of the change.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] entity
|
160
|
+
# The entity to be changed.
|
161
|
+
# @return [Types::Entity]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] error_detail_list
|
164
|
+
# An array of `ErrorDetail` objects associated with the change.
|
165
|
+
# @return [Array<Types::ErrorDetail>]
|
166
|
+
#
|
167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ChangeSummary AWS API Documentation
|
168
|
+
#
|
169
|
+
class ChangeSummary < Struct.new(
|
170
|
+
:change_type,
|
171
|
+
:entity,
|
172
|
+
:error_detail_list)
|
173
|
+
include Aws::Structure
|
174
|
+
end
|
175
|
+
|
176
|
+
# @note When making an API call, you may pass DescribeChangeSetRequest
|
177
|
+
# data as a hash:
|
178
|
+
#
|
179
|
+
# {
|
180
|
+
# catalog: "Catalog", # required
|
181
|
+
# change_set_id: "ResourceId", # required
|
182
|
+
# }
|
183
|
+
#
|
184
|
+
# @!attribute [rw] catalog
|
185
|
+
# Required. The catalog related to the request. Fixed value:
|
186
|
+
# `AWSMarketplace`
|
187
|
+
# @return [String]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] change_set_id
|
190
|
+
# Required. The unique identifier for the `StartChangeSet` request
|
191
|
+
# that you want to describe the details for.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeChangeSetRequest AWS API Documentation
|
195
|
+
#
|
196
|
+
class DescribeChangeSetRequest < Struct.new(
|
197
|
+
:catalog,
|
198
|
+
:change_set_id)
|
199
|
+
include Aws::Structure
|
200
|
+
end
|
201
|
+
|
202
|
+
# @!attribute [rw] change_set_id
|
203
|
+
# Required. The unique identifier for the change set referenced in
|
204
|
+
# this request.
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @!attribute [rw] change_set_arn
|
208
|
+
# The ARN associated with the unique identifier for the change set
|
209
|
+
# referenced in this request.
|
210
|
+
# @return [String]
|
211
|
+
#
|
212
|
+
# @!attribute [rw] change_set_name
|
213
|
+
# The optional name provided in the `StartChangeSet` request. If you
|
214
|
+
# do not provide a name, one is set by default.
|
215
|
+
# @return [String]
|
216
|
+
#
|
217
|
+
# @!attribute [rw] start_time
|
218
|
+
# The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the
|
219
|
+
# request started.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] end_time
|
223
|
+
# The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the
|
224
|
+
# request transitioned to a terminal state. The change cannot
|
225
|
+
# transition to a different state. Null if the request is not in a
|
226
|
+
# terminal state.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] status
|
230
|
+
# The status of the change request.
|
231
|
+
# @return [String]
|
232
|
+
#
|
233
|
+
# @!attribute [rw] failure_description
|
234
|
+
# Returned if there is a failure on the change set, but that failure
|
235
|
+
# is not related to any of the changes in the request.
|
236
|
+
# @return [String]
|
237
|
+
#
|
238
|
+
# @!attribute [rw] change_set
|
239
|
+
# An array of `ChangeSummary` objects.
|
240
|
+
# @return [Array<Types::ChangeSummary>]
|
241
|
+
#
|
242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeChangeSetResponse AWS API Documentation
|
243
|
+
#
|
244
|
+
class DescribeChangeSetResponse < Struct.new(
|
245
|
+
:change_set_id,
|
246
|
+
:change_set_arn,
|
247
|
+
:change_set_name,
|
248
|
+
:start_time,
|
249
|
+
:end_time,
|
250
|
+
:status,
|
251
|
+
:failure_description,
|
252
|
+
:change_set)
|
253
|
+
include Aws::Structure
|
254
|
+
end
|
255
|
+
|
256
|
+
# @note When making an API call, you may pass DescribeEntityRequest
|
257
|
+
# data as a hash:
|
258
|
+
#
|
259
|
+
# {
|
260
|
+
# catalog: "Catalog", # required
|
261
|
+
# entity_id: "ResourceId", # required
|
262
|
+
# }
|
263
|
+
#
|
264
|
+
# @!attribute [rw] catalog
|
265
|
+
# Required. The catalog related to the request. Fixed value:
|
266
|
+
# `AWSMarketplace`
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] entity_id
|
270
|
+
# Required. The unique ID of the entity to describe.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeEntityRequest AWS API Documentation
|
274
|
+
#
|
275
|
+
class DescribeEntityRequest < Struct.new(
|
276
|
+
:catalog,
|
277
|
+
:entity_id)
|
278
|
+
include Aws::Structure
|
279
|
+
end
|
280
|
+
|
281
|
+
# @!attribute [rw] entity_type
|
282
|
+
# The named type of the entity, in the format of `EntityType@Version`.
|
283
|
+
# @return [String]
|
284
|
+
#
|
285
|
+
# @!attribute [rw] entity_identifier
|
286
|
+
# The identifier of the entity, in the format of
|
287
|
+
# `EntityId@RevisionId`.
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] entity_arn
|
291
|
+
# The ARN associated to the unique identifier for the change set
|
292
|
+
# referenced in this request.
|
293
|
+
# @return [String]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] last_modified_date
|
296
|
+
# The last modified date of the entity, in ISO 8601 format
|
297
|
+
# (2018-02-27T13:45:22Z).
|
298
|
+
# @return [String]
|
299
|
+
#
|
300
|
+
# @!attribute [rw] details
|
301
|
+
# This stringified JSON object includes the details of the entity.
|
302
|
+
# @return [String]
|
303
|
+
#
|
304
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/DescribeEntityResponse AWS API Documentation
|
305
|
+
#
|
306
|
+
class DescribeEntityResponse < Struct.new(
|
307
|
+
:entity_type,
|
308
|
+
:entity_identifier,
|
309
|
+
:entity_arn,
|
310
|
+
:last_modified_date,
|
311
|
+
:details)
|
312
|
+
include Aws::Structure
|
313
|
+
end
|
314
|
+
|
315
|
+
# A product entity contains data that describes your product, its
|
316
|
+
# supported features, and how it can be used or launched by your
|
317
|
+
# customer.
|
318
|
+
#
|
319
|
+
# @note When making an API call, you may pass Entity
|
320
|
+
# data as a hash:
|
321
|
+
#
|
322
|
+
# {
|
323
|
+
# type: "EntityType", # required
|
324
|
+
# identifier: "Identifier",
|
325
|
+
# }
|
326
|
+
#
|
327
|
+
# @!attribute [rw] type
|
328
|
+
# The type of entity.
|
329
|
+
# @return [String]
|
330
|
+
#
|
331
|
+
# @!attribute [rw] identifier
|
332
|
+
# The identifier for the entity.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/Entity AWS API Documentation
|
336
|
+
#
|
337
|
+
class Entity < Struct.new(
|
338
|
+
:type,
|
339
|
+
:identifier)
|
340
|
+
include Aws::Structure
|
341
|
+
end
|
342
|
+
|
343
|
+
# This object is a container for common summary information about the
|
344
|
+
# entity. The summary doesn't contain the whole entity structure, but
|
345
|
+
# it does contain information common across all entities.
|
346
|
+
#
|
347
|
+
# @!attribute [rw] name
|
348
|
+
# The name for the entity. This value is not unique. It is defined by
|
349
|
+
# the provider.
|
350
|
+
# @return [String]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] entity_type
|
353
|
+
# The type of the entity.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] entity_id
|
357
|
+
# The unique identifier for the entity.
|
358
|
+
# @return [String]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] entity_arn
|
361
|
+
# The ARN associated with the unique identifier for the entity.
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] last_modified_date
|
365
|
+
# The last time the entity was published, using ISO 8601 format
|
366
|
+
# (2018-02-27T13:45:22Z).
|
367
|
+
# @return [String]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] visibility
|
370
|
+
# The visibility status of the entity to subscribers. This value can
|
371
|
+
# be `Public` (everyone can view the entity), `Limited` (the entity is
|
372
|
+
# visible to limited accounts only), or `Restricted` (the entity was
|
373
|
+
# published and then unpublished and only existing subscribers can
|
374
|
+
# view it).
|
375
|
+
# @return [String]
|
376
|
+
#
|
377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/EntitySummary AWS API Documentation
|
378
|
+
#
|
379
|
+
class EntitySummary < Struct.new(
|
380
|
+
:name,
|
381
|
+
:entity_type,
|
382
|
+
:entity_id,
|
383
|
+
:entity_arn,
|
384
|
+
:last_modified_date,
|
385
|
+
:visibility)
|
386
|
+
include Aws::Structure
|
387
|
+
end
|
388
|
+
|
389
|
+
# Details about the error.
|
390
|
+
#
|
391
|
+
# @!attribute [rw] error_code
|
392
|
+
# The error code that identifies the type of error.
|
393
|
+
# @return [String]
|
394
|
+
#
|
395
|
+
# @!attribute [rw] error_message
|
396
|
+
# The message for the error.
|
397
|
+
# @return [String]
|
398
|
+
#
|
399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ErrorDetail AWS API Documentation
|
400
|
+
#
|
401
|
+
class ErrorDetail < Struct.new(
|
402
|
+
:error_code,
|
403
|
+
:error_message)
|
404
|
+
include Aws::Structure
|
405
|
+
end
|
406
|
+
|
407
|
+
# A filter object, used to optionally filter results from calls to the
|
408
|
+
# `ListEntities` and `ListChangeSets` actions.
|
409
|
+
#
|
410
|
+
# @note When making an API call, you may pass Filter
|
411
|
+
# data as a hash:
|
412
|
+
#
|
413
|
+
# {
|
414
|
+
# name: "FilterName",
|
415
|
+
# value_list: ["StringValue"],
|
416
|
+
# }
|
417
|
+
#
|
418
|
+
# @!attribute [rw] name
|
419
|
+
# For `ListEntities`, the supported value for this is an `EntityId`.
|
420
|
+
#
|
421
|
+
# For `ListChangeSets`, the supported values are as follows:
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] value_list
|
425
|
+
# `ListEntities` - This is a list of unique `EntityId`s.
|
426
|
+
#
|
427
|
+
# `ListChangeSets` - The supported filter names and associated
|
428
|
+
# `ValueList`s is as follows:
|
429
|
+
#
|
430
|
+
# * `ChangeSetName` - The supported `ValueList` is a list of
|
431
|
+
# non-unique `ChangeSetName`s. These are defined when you call the
|
432
|
+
# `StartChangeSet` action.
|
433
|
+
#
|
434
|
+
# * `Status` - The supported `ValueList` is a list of statuses for all
|
435
|
+
# change set requests.
|
436
|
+
#
|
437
|
+
# * `EntityId` - The supported `ValueList` is a list of unique
|
438
|
+
# `EntityId`s.
|
439
|
+
#
|
440
|
+
# * `BeforeStartTime` - The supported `ValueList` is a list of all
|
441
|
+
# change sets that started before the filter value.
|
442
|
+
#
|
443
|
+
# * `AfterStartTime` - The supported `ValueList` is a list of all
|
444
|
+
# change sets that started after the filter value.
|
445
|
+
#
|
446
|
+
# * `BeforeEndTime` - The supported `ValueList` is a list of all
|
447
|
+
# change sets that ended before the filter value.
|
448
|
+
#
|
449
|
+
# * `AfterEndTime` - The supported `ValueList` is a list of all change
|
450
|
+
# sets that ended after the filter value.
|
451
|
+
# @return [Array<String>]
|
452
|
+
#
|
453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/Filter AWS API Documentation
|
454
|
+
#
|
455
|
+
class Filter < Struct.new(
|
456
|
+
:name,
|
457
|
+
:value_list)
|
458
|
+
include Aws::Structure
|
459
|
+
end
|
460
|
+
|
461
|
+
# There was an internal service exception.
|
462
|
+
#
|
463
|
+
# @!attribute [rw] message
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/InternalServiceException AWS API Documentation
|
467
|
+
#
|
468
|
+
class InternalServiceException < Struct.new(
|
469
|
+
:message)
|
470
|
+
include Aws::Structure
|
471
|
+
end
|
472
|
+
|
473
|
+
# @note When making an API call, you may pass ListChangeSetsRequest
|
474
|
+
# data as a hash:
|
475
|
+
#
|
476
|
+
# {
|
477
|
+
# catalog: "Catalog", # required
|
478
|
+
# filter_list: [
|
479
|
+
# {
|
480
|
+
# name: "FilterName",
|
481
|
+
# value_list: ["StringValue"],
|
482
|
+
# },
|
483
|
+
# ],
|
484
|
+
# sort: {
|
485
|
+
# sort_by: "SortBy",
|
486
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
487
|
+
# },
|
488
|
+
# max_results: 1,
|
489
|
+
# next_token: "NextToken",
|
490
|
+
# }
|
491
|
+
#
|
492
|
+
# @!attribute [rw] catalog
|
493
|
+
# The catalog related to the request. Fixed value: `AWSMarketplace`
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] filter_list
|
497
|
+
# An array of filter objects.
|
498
|
+
# @return [Array<Types::Filter>]
|
499
|
+
#
|
500
|
+
# @!attribute [rw] sort
|
501
|
+
# An object that contains two attributes, `sortBy` and `sortOrder`.
|
502
|
+
# @return [Types::Sort]
|
503
|
+
#
|
504
|
+
# @!attribute [rw] max_results
|
505
|
+
# The maximum number of results returned by a single call. This value
|
506
|
+
# must be provided in the next call to retrieve the next set of
|
507
|
+
# results. By default, this value is 20.
|
508
|
+
# @return [Integer]
|
509
|
+
#
|
510
|
+
# @!attribute [rw] next_token
|
511
|
+
# The token value retrieved from a previous call to access the next
|
512
|
+
# page of results.
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListChangeSetsRequest AWS API Documentation
|
516
|
+
#
|
517
|
+
class ListChangeSetsRequest < Struct.new(
|
518
|
+
:catalog,
|
519
|
+
:filter_list,
|
520
|
+
:sort,
|
521
|
+
:max_results,
|
522
|
+
:next_token)
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
526
|
+
# @!attribute [rw] change_set_summary_list
|
527
|
+
# Array of `ChangeSetSummaryListItem` objects.
|
528
|
+
# @return [Array<Types::ChangeSetSummaryListItem>]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] next_token
|
531
|
+
# The value of the next token, if it exists. Null if there are no more
|
532
|
+
# results.
|
533
|
+
# @return [String]
|
534
|
+
#
|
535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListChangeSetsResponse AWS API Documentation
|
536
|
+
#
|
537
|
+
class ListChangeSetsResponse < Struct.new(
|
538
|
+
:change_set_summary_list,
|
539
|
+
:next_token)
|
540
|
+
include Aws::Structure
|
541
|
+
end
|
542
|
+
|
543
|
+
# @note When making an API call, you may pass ListEntitiesRequest
|
544
|
+
# data as a hash:
|
545
|
+
#
|
546
|
+
# {
|
547
|
+
# catalog: "Catalog", # required
|
548
|
+
# entity_type: "EntityType", # required
|
549
|
+
# filter_list: [
|
550
|
+
# {
|
551
|
+
# name: "FilterName",
|
552
|
+
# value_list: ["StringValue"],
|
553
|
+
# },
|
554
|
+
# ],
|
555
|
+
# sort: {
|
556
|
+
# sort_by: "SortBy",
|
557
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
558
|
+
# },
|
559
|
+
# next_token: "NextToken",
|
560
|
+
# max_results: 1,
|
561
|
+
# }
|
562
|
+
#
|
563
|
+
# @!attribute [rw] catalog
|
564
|
+
# The catalog related to the request. Fixed value: `AWSMarketplace`
|
565
|
+
# @return [String]
|
566
|
+
#
|
567
|
+
# @!attribute [rw] entity_type
|
568
|
+
# The type of entities to retrieve.
|
569
|
+
# @return [String]
|
570
|
+
#
|
571
|
+
# @!attribute [rw] filter_list
|
572
|
+
# An array of filter objects. Each filter object contains two
|
573
|
+
# attributes, `filterName` and `filterValues`.
|
574
|
+
# @return [Array<Types::Filter>]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] sort
|
577
|
+
# An object that contains two attributes, `sortBy` and `sortOrder`.
|
578
|
+
# @return [Types::Sort]
|
579
|
+
#
|
580
|
+
# @!attribute [rw] next_token
|
581
|
+
# The value of the next token, if it exists. Null if there are no more
|
582
|
+
# results.
|
583
|
+
# @return [String]
|
584
|
+
#
|
585
|
+
# @!attribute [rw] max_results
|
586
|
+
# Specifies the upper limit of the elements on a single page. If a
|
587
|
+
# value isn't provided, the default value is 20.
|
588
|
+
# @return [Integer]
|
589
|
+
#
|
590
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListEntitiesRequest AWS API Documentation
|
591
|
+
#
|
592
|
+
class ListEntitiesRequest < Struct.new(
|
593
|
+
:catalog,
|
594
|
+
:entity_type,
|
595
|
+
:filter_list,
|
596
|
+
:sort,
|
597
|
+
:next_token,
|
598
|
+
:max_results)
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# @!attribute [rw] entity_summary_list
|
603
|
+
# Array of `EntitySummary` object.
|
604
|
+
# @return [Array<Types::EntitySummary>]
|
605
|
+
#
|
606
|
+
# @!attribute [rw] next_token
|
607
|
+
# The value of the next token if it exists. Null if there is no more
|
608
|
+
# result.
|
609
|
+
# @return [String]
|
610
|
+
#
|
611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ListEntitiesResponse AWS API Documentation
|
612
|
+
#
|
613
|
+
class ListEntitiesResponse < Struct.new(
|
614
|
+
:entity_summary_list,
|
615
|
+
:next_token)
|
616
|
+
include Aws::Structure
|
617
|
+
end
|
618
|
+
|
619
|
+
# The resource is currently in use.
|
620
|
+
#
|
621
|
+
# @!attribute [rw] message
|
622
|
+
# @return [String]
|
623
|
+
#
|
624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ResourceInUseException AWS API Documentation
|
625
|
+
#
|
626
|
+
class ResourceInUseException < Struct.new(
|
627
|
+
:message)
|
628
|
+
include Aws::Structure
|
629
|
+
end
|
630
|
+
|
631
|
+
# The specified resource wasn't found.
|
632
|
+
#
|
633
|
+
# @!attribute [rw] message
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ResourceNotFoundException AWS API Documentation
|
637
|
+
#
|
638
|
+
class ResourceNotFoundException < Struct.new(
|
639
|
+
:message)
|
640
|
+
include Aws::Structure
|
641
|
+
end
|
642
|
+
|
643
|
+
# Currently, the specified resource is not supported.
|
644
|
+
#
|
645
|
+
# @!attribute [rw] message
|
646
|
+
# @return [String]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ResourceNotSupportedException AWS API Documentation
|
649
|
+
#
|
650
|
+
class ResourceNotSupportedException < Struct.new(
|
651
|
+
:message)
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# The maximum number of open requests per account has been exceeded.
|
656
|
+
#
|
657
|
+
# @!attribute [rw] message
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ServiceQuotaExceededException AWS API Documentation
|
661
|
+
#
|
662
|
+
class ServiceQuotaExceededException < Struct.new(
|
663
|
+
:message)
|
664
|
+
include Aws::Structure
|
665
|
+
end
|
666
|
+
|
667
|
+
# An object that contains two attributes, `sortBy` and `sortOrder`.
|
668
|
+
#
|
669
|
+
# @note When making an API call, you may pass Sort
|
670
|
+
# data as a hash:
|
671
|
+
#
|
672
|
+
# {
|
673
|
+
# sort_by: "SortBy",
|
674
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
675
|
+
# }
|
676
|
+
#
|
677
|
+
# @!attribute [rw] sort_by
|
678
|
+
# For `ListEntities`, supported attributes include `LastModifiedDate`
|
679
|
+
# (default), `Visibility`, `EntityId`, and `Name`.
|
680
|
+
#
|
681
|
+
# For `ListChangeSets`, supported attributes include `StartTime` and
|
682
|
+
# `EndTime`.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] sort_order
|
686
|
+
# The sorting order. Can be `ASCENDING` or `DESCENDING`. The default
|
687
|
+
# value is `DESCENDING`.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/Sort AWS API Documentation
|
691
|
+
#
|
692
|
+
class Sort < Struct.new(
|
693
|
+
:sort_by,
|
694
|
+
:sort_order)
|
695
|
+
include Aws::Structure
|
696
|
+
end
|
697
|
+
|
698
|
+
# @note When making an API call, you may pass StartChangeSetRequest
|
699
|
+
# data as a hash:
|
700
|
+
#
|
701
|
+
# {
|
702
|
+
# catalog: "Catalog", # required
|
703
|
+
# change_set: [ # required
|
704
|
+
# {
|
705
|
+
# change_type: "ChangeType", # required
|
706
|
+
# entity: { # required
|
707
|
+
# type: "EntityType", # required
|
708
|
+
# identifier: "Identifier",
|
709
|
+
# },
|
710
|
+
# details: "Json", # required
|
711
|
+
# },
|
712
|
+
# ],
|
713
|
+
# change_set_name: "ChangeSetName",
|
714
|
+
# client_request_token: "ClientRequestToken",
|
715
|
+
# }
|
716
|
+
#
|
717
|
+
# @!attribute [rw] catalog
|
718
|
+
# The catalog related to the request. Fixed value: `AWSMarketplace`
|
719
|
+
# @return [String]
|
720
|
+
#
|
721
|
+
# @!attribute [rw] change_set
|
722
|
+
# Array of `change` object.
|
723
|
+
# @return [Array<Types::Change>]
|
724
|
+
#
|
725
|
+
# @!attribute [rw] change_set_name
|
726
|
+
# Optional case sensitive string of up to 100 ASCII characters. The
|
727
|
+
# change set name can be used to filter the list of change sets.
|
728
|
+
# @return [String]
|
729
|
+
#
|
730
|
+
# @!attribute [rw] client_request_token
|
731
|
+
# A unique token to identify the request to ensure idempotency.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/StartChangeSetRequest AWS API Documentation
|
735
|
+
#
|
736
|
+
class StartChangeSetRequest < Struct.new(
|
737
|
+
:catalog,
|
738
|
+
:change_set,
|
739
|
+
:change_set_name,
|
740
|
+
:client_request_token)
|
741
|
+
include Aws::Structure
|
742
|
+
end
|
743
|
+
|
744
|
+
# @!attribute [rw] change_set_id
|
745
|
+
# Unique identifier generated for the request.
|
746
|
+
# @return [String]
|
747
|
+
#
|
748
|
+
# @!attribute [rw] change_set_arn
|
749
|
+
# The ARN associated to the unique identifier generated for the
|
750
|
+
# request.
|
751
|
+
# @return [String]
|
752
|
+
#
|
753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/StartChangeSetResponse AWS API Documentation
|
754
|
+
#
|
755
|
+
class StartChangeSetResponse < Struct.new(
|
756
|
+
:change_set_id,
|
757
|
+
:change_set_arn)
|
758
|
+
include Aws::Structure
|
759
|
+
end
|
760
|
+
|
761
|
+
# Too many requests.
|
762
|
+
#
|
763
|
+
# @!attribute [rw] message
|
764
|
+
# @return [String]
|
765
|
+
#
|
766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ThrottlingException AWS API Documentation
|
767
|
+
#
|
768
|
+
class ThrottlingException < Struct.new(
|
769
|
+
:message)
|
770
|
+
include Aws::Structure
|
771
|
+
end
|
772
|
+
|
773
|
+
# An error occurred during validation.
|
774
|
+
#
|
775
|
+
# @!attribute [rw] message
|
776
|
+
# @return [String]
|
777
|
+
#
|
778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-catalog-2018-09-17/ValidationException AWS API Documentation
|
779
|
+
#
|
780
|
+
class ValidationException < Struct.new(
|
781
|
+
:message)
|
782
|
+
include Aws::Structure
|
783
|
+
end
|
784
|
+
|
785
|
+
end
|
786
|
+
end
|