aws-sdk-marketplaceagreement 1.28.0 → 1.29.0

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.
@@ -15,44 +15,15 @@ module Aws::MarketplaceAgreement
15
15
  #
16
16
  # @note AcceptedTerm is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AcceptedTerm corresponding to the set member.
17
17
  #
18
- # @!attribute [rw] byol_pricing_term
19
- # Enables you and your customers to move your existing agreements to
20
- # AWS Marketplace. The customer won't be charged for product usage in
21
- # AWS Marketplace because they already paid for the product outside of
22
- # AWS Marketplace.
23
- # @return [Types::ByolPricingTerm]
24
- #
25
- # @!attribute [rw] configurable_upfront_pricing_term
26
- # Defines a prepaid payment model that allows buyers to configure the
27
- # entitlements they want to purchase and the duration.
28
- # @return [Types::ConfigurableUpfrontPricingTerm]
29
- #
30
- # @!attribute [rw] fixed_upfront_pricing_term
31
- # Defines a pre-paid pricing model where the customers are charged a
32
- # fixed upfront amount.
33
- # @return [Types::FixedUpfrontPricingTerm]
34
- #
35
- # @!attribute [rw] free_trial_pricing_term
36
- # Defines a short-term free pricing model where the buyers aren’t
37
- # charged anything within a specified limit.
38
- # @return [Types::FreeTrialPricingTerm]
39
- #
40
18
  # @!attribute [rw] legal_term
41
19
  # Defines the list of text agreements proposed to the acceptors. An
42
20
  # example is the end user license agreement (EULA).
43
21
  # @return [Types::LegalTerm]
44
22
  #
45
- # @!attribute [rw] payment_schedule_term
46
- # Defines an installment-based pricing model where customers are
47
- # charged a fixed price on different dates during the agreement
48
- # validity period. This is used most commonly for flexible payment
49
- # schedule pricing.
50
- # @return [Types::PaymentScheduleTerm]
51
- #
52
- # @!attribute [rw] recurring_payment_term
53
- # Defines a pricing model where customers are charged a fixed
54
- # recurring price at the end of each billing period.
55
- # @return [Types::RecurringPaymentTerm]
23
+ # @!attribute [rw] support_term
24
+ # Defines the customer support available for the acceptors when they
25
+ # purchase the software.
26
+ # @return [Types::SupportTerm]
56
27
  #
57
28
  # @!attribute [rw] renewal_term
58
29
  # Defines that on graceful expiration of the agreement (when the
@@ -66,51 +37,88 @@ module Aws::MarketplaceAgreement
66
37
  # agreement's lifecycle.
67
38
  # @return [Types::RenewalTerm]
68
39
  #
69
- # @!attribute [rw] support_term
70
- # Defines the customer support available for the acceptors when they
71
- # purchase the software.
72
- # @return [Types::SupportTerm]
73
- #
74
40
  # @!attribute [rw] usage_based_pricing_term
75
41
  # Defines a usage-based pricing model (typically, pay-as-you-go
76
42
  # pricing), where the customers are charged based on product usage.
77
43
  # @return [Types::UsageBasedPricingTerm]
78
44
  #
45
+ # @!attribute [rw] configurable_upfront_pricing_term
46
+ # Defines a prepaid payment model that allows buyers to configure the
47
+ # entitlements they want to purchase and the duration.
48
+ # @return [Types::ConfigurableUpfrontPricingTerm]
49
+ #
50
+ # @!attribute [rw] byol_pricing_term
51
+ # Enables you and your customers to move your existing agreements to
52
+ # AWS Marketplace. The customer won't be charged for product usage in
53
+ # AWS Marketplace because they already paid for the product outside of
54
+ # AWS Marketplace.
55
+ # @return [Types::ByolPricingTerm]
56
+ #
57
+ # @!attribute [rw] recurring_payment_term
58
+ # Defines a pricing model where customers are charged a fixed
59
+ # recurring price at the end of each billing period.
60
+ # @return [Types::RecurringPaymentTerm]
61
+ #
79
62
  # @!attribute [rw] validity_term
80
63
  # Defines the conditions that will keep an agreement created from this
81
64
  # offer valid.
82
65
  # @return [Types::ValidityTerm]
83
66
  #
67
+ # @!attribute [rw] payment_schedule_term
68
+ # Defines an installment-based pricing model where customers are
69
+ # charged a fixed price on different dates during the agreement
70
+ # validity period. This is used most commonly for flexible payment
71
+ # schedule pricing.
72
+ # @return [Types::PaymentScheduleTerm]
73
+ #
74
+ # @!attribute [rw] free_trial_pricing_term
75
+ # Defines a short-term free pricing model where the buyers aren’t
76
+ # charged anything within a specified limit.
77
+ # @return [Types::FreeTrialPricingTerm]
78
+ #
79
+ # @!attribute [rw] fixed_upfront_pricing_term
80
+ # Defines a pre-paid pricing model where the customers are charged a
81
+ # fixed upfront amount.
82
+ # @return [Types::FixedUpfrontPricingTerm]
83
+ #
84
+ # @!attribute [rw] variable_payment_term
85
+ # Defines a payment model where sellers can submit variable payment
86
+ # requests up to a maximum charge amount, with configurable approval
87
+ # strategies and expiration timelines.
88
+ # @return [Types::VariablePaymentTerm]
89
+ #
84
90
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/AcceptedTerm AWS API Documentation
85
91
  #
86
92
  class AcceptedTerm < Struct.new(
87
- :byol_pricing_term,
88
- :configurable_upfront_pricing_term,
89
- :fixed_upfront_pricing_term,
90
- :free_trial_pricing_term,
91
93
  :legal_term,
92
- :payment_schedule_term,
93
- :recurring_payment_term,
94
- :renewal_term,
95
94
  :support_term,
95
+ :renewal_term,
96
96
  :usage_based_pricing_term,
97
+ :configurable_upfront_pricing_term,
98
+ :byol_pricing_term,
99
+ :recurring_payment_term,
97
100
  :validity_term,
101
+ :payment_schedule_term,
102
+ :free_trial_pricing_term,
103
+ :fixed_upfront_pricing_term,
104
+ :variable_payment_term,
98
105
  :unknown)
99
106
  SENSITIVE = []
100
107
  include Aws::Structure
101
108
  include Aws::Structure::Union
102
109
 
103
- class ByolPricingTerm < AcceptedTerm; end
104
- class ConfigurableUpfrontPricingTerm < AcceptedTerm; end
105
- class FixedUpfrontPricingTerm < AcceptedTerm; end
106
- class FreeTrialPricingTerm < AcceptedTerm; end
107
110
  class LegalTerm < AcceptedTerm; end
108
- class PaymentScheduleTerm < AcceptedTerm; end
109
- class RecurringPaymentTerm < AcceptedTerm; end
110
- class RenewalTerm < AcceptedTerm; end
111
111
  class SupportTerm < AcceptedTerm; end
112
+ class RenewalTerm < AcceptedTerm; end
112
113
  class UsageBasedPricingTerm < AcceptedTerm; end
114
+ class ConfigurableUpfrontPricingTerm < AcceptedTerm; end
115
+ class ByolPricingTerm < AcceptedTerm; end
116
+ class RecurringPaymentTerm < AcceptedTerm; end
113
117
  class ValidityTerm < AcceptedTerm; end
118
+ class PaymentScheduleTerm < AcceptedTerm; end
119
+ class FreeTrialPricingTerm < AcceptedTerm; end
120
+ class FixedUpfrontPricingTerm < AcceptedTerm; end
121
+ class VariablePaymentTerm < AcceptedTerm; end
114
122
  class Unknown < AcceptedTerm; end
115
123
  end
116
124
 
@@ -131,60 +139,59 @@ module Aws::MarketplaceAgreement
131
139
 
132
140
  # User does not have sufficient access to perform this action.
133
141
  #
134
- # @!attribute [rw] message
135
- # @return [String]
136
- #
137
142
  # @!attribute [rw] request_id
138
143
  # The unique identifier for the error.
139
144
  # @return [String]
140
145
  #
146
+ # @!attribute [rw] message
147
+ # @return [String]
148
+ #
141
149
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/AccessDeniedException AWS API Documentation
142
150
  #
143
151
  class AccessDeniedException < Struct.new(
144
- :message,
145
- :request_id)
152
+ :request_id,
153
+ :message)
146
154
  SENSITIVE = []
147
155
  include Aws::Structure
148
156
  end
149
157
 
150
158
  # A summary of the agreement, including top-level attributes (for
151
- # example, the agreement ID, version, proposer, and acceptor).
152
- #
153
- # @!attribute [rw] acceptance_time
154
- # The date and time that the agreement was accepted.
155
- # @return [Time]
156
- #
157
- # @!attribute [rw] acceptor
158
- # Details of the party accepting the agreement terms. This is commonly
159
- # the buyer for `PurchaseAgreement.`
160
- # @return [Types::Acceptor]
159
+ # example, the agreement ID, proposer, and acceptor).
161
160
  #
162
161
  # @!attribute [rw] agreement_id
163
162
  # The unique identifier of the agreement.
164
163
  # @return [String]
165
164
  #
166
- # @!attribute [rw] agreement_type
167
- # The type of agreement. Values are `PurchaseAgreement` or
168
- # `VendorInsightsAgreement`.
169
- # @return [String]
165
+ # @!attribute [rw] acceptance_time
166
+ # The date and time that the agreement was accepted.
167
+ # @return [Time]
168
+ #
169
+ # @!attribute [rw] start_time
170
+ # The date and time when the agreement starts.
171
+ # @return [Time]
170
172
  #
171
173
  # @!attribute [rw] end_time
172
174
  # The date and time when the agreement ends. The field is `null` for
173
175
  # pay-as-you-go agreements, which don’t have end dates.
174
176
  # @return [Time]
175
177
  #
176
- # @!attribute [rw] proposal_summary
177
- # A summary of the proposal
178
- # @return [Types::ProposalSummary]
178
+ # @!attribute [rw] agreement_type
179
+ # The type of agreement. Value is `PurchaseAgreement`.
180
+ # @return [String]
181
+ #
182
+ # @!attribute [rw] acceptor
183
+ # Details of the party accepting the agreement terms. This is commonly
184
+ # the buyer for `PurchaseAgreement.`
185
+ # @return [Types::Acceptor]
179
186
  #
180
187
  # @!attribute [rw] proposer
181
188
  # Details of the party proposing the agreement terms, most commonly
182
189
  # the seller for `PurchaseAgreement`.
183
190
  # @return [Types::Proposer]
184
191
  #
185
- # @!attribute [rw] start_time
186
- # The date and time when the agreement starts.
187
- # @return [Time]
192
+ # @!attribute [rw] proposal_summary
193
+ # A summary of the proposal
194
+ # @return [Types::ProposalSummary]
188
195
  #
189
196
  # @!attribute [rw] status
190
197
  # The current status of the agreement.
@@ -193,14 +200,14 @@ module Aws::MarketplaceAgreement
193
200
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/AgreementViewSummary AWS API Documentation
194
201
  #
195
202
  class AgreementViewSummary < Struct.new(
196
- :acceptance_time,
197
- :acceptor,
198
203
  :agreement_id,
199
- :agreement_type,
204
+ :acceptance_time,
205
+ :start_time,
200
206
  :end_time,
201
- :proposal_summary,
207
+ :agreement_type,
208
+ :acceptor,
202
209
  :proposer,
203
- :start_time,
210
+ :proposal_summary,
204
211
  :status)
205
212
  SENSITIVE = []
206
213
  include Aws::Structure
@@ -226,10 +233,9 @@ module Aws::MarketplaceAgreement
226
233
  # Defines a prepaid payment model that allows buyers to configure the
227
234
  # entitlements they want to purchase and the duration.
228
235
  #
229
- # @!attribute [rw] configuration
230
- # Additional parameters specified by the acceptor while accepting the
231
- # term.
232
- # @return [Types::ConfigurableUpfrontPricingTermConfiguration]
236
+ # @!attribute [rw] type
237
+ # Category of selector.
238
+ # @return [String]
233
239
  #
234
240
  # @!attribute [rw] currency_code
235
241
  # Defines the currency for the prices mentioned in the term.
@@ -239,17 +245,18 @@ module Aws::MarketplaceAgreement
239
245
  # A rate card defines the per unit rates for product dimensions.
240
246
  # @return [Array<Types::ConfigurableUpfrontRateCardItem>]
241
247
  #
242
- # @!attribute [rw] type
243
- # Category of selector.
244
- # @return [String]
248
+ # @!attribute [rw] configuration
249
+ # Additional parameters specified by the acceptor while accepting the
250
+ # term.
251
+ # @return [Types::ConfigurableUpfrontPricingTermConfiguration]
245
252
  #
246
253
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ConfigurableUpfrontPricingTerm AWS API Documentation
247
254
  #
248
255
  class ConfigurableUpfrontPricingTerm < Struct.new(
249
- :configuration,
256
+ :type,
250
257
  :currency_code,
251
258
  :rate_cards,
252
- :type)
259
+ :configuration)
253
260
  SENSITIVE = []
254
261
  include Aws::Structure
255
262
  end
@@ -257,21 +264,21 @@ module Aws::MarketplaceAgreement
257
264
  # Defines a prepaid payment model that allows buyers to configure the
258
265
  # entitlements they want to purchase and the duration.
259
266
  #
260
- # @!attribute [rw] dimensions
261
- # Defines the dimensions that the acceptor has purchased from the
262
- # overall set of dimensions presented in the rate card.
263
- # @return [Array<Types::Dimension>]
264
- #
265
267
  # @!attribute [rw] selector_value
266
268
  # Defines the length of time for which the particular
267
269
  # pricing/dimension is being purchased by the acceptor.
268
270
  # @return [String]
269
271
  #
272
+ # @!attribute [rw] dimensions
273
+ # Defines the dimensions that the acceptor has purchased from the
274
+ # overall set of dimensions presented in the rate card.
275
+ # @return [Array<Types::Dimension>]
276
+ #
270
277
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ConfigurableUpfrontPricingTermConfiguration AWS API Documentation
271
278
  #
272
279
  class ConfigurableUpfrontPricingTermConfiguration < Struct.new(
273
- :dimensions,
274
- :selector_value)
280
+ :selector_value,
281
+ :dimensions)
275
282
  SENSITIVE = []
276
283
  include Aws::Structure
277
284
  end
@@ -281,6 +288,11 @@ module Aws::MarketplaceAgreement
281
288
  # various rate cards (including pricing and dimensions) that have been
282
289
  # proposed.
283
290
  #
291
+ # @!attribute [rw] selector
292
+ # Differentiates between the mutually exclusive rate cards in the same
293
+ # pricing term to be selected by the buyer.
294
+ # @return [Types::Selector]
295
+ #
284
296
  # @!attribute [rw] constraints
285
297
  # Defines limits on how the term can be configured by acceptors.
286
298
  # @return [Types::Constraints]
@@ -289,17 +301,12 @@ module Aws::MarketplaceAgreement
289
301
  # Defines the per unit rates for product dimensions.
290
302
  # @return [Array<Types::RateCardItem>]
291
303
  #
292
- # @!attribute [rw] selector
293
- # Differentiates between the mutually exclusive rate cards in the same
294
- # pricing term to be selected by the buyer.
295
- # @return [Types::Selector]
296
- #
297
304
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ConfigurableUpfrontRateCardItem AWS API Documentation
298
305
  #
299
306
  class ConfigurableUpfrontRateCardItem < Struct.new(
307
+ :selector,
300
308
  :constraints,
301
- :rate_card,
302
- :selector)
309
+ :rate_card)
303
310
  SENSITIVE = []
304
311
  include Aws::Structure
305
312
  end
@@ -339,6 +346,29 @@ module Aws::MarketplaceAgreement
339
346
  include Aws::Structure
340
347
  end
341
348
 
349
+ # @!attribute [rw] agreement_id
350
+ # The unique identifier of the agreement.
351
+ # @return [String]
352
+ #
353
+ # @!attribute [rw] acceptor
354
+ # The details of the party accepting the agreement terms. This is
355
+ # commonly the buyer for `PurchaseAgreement`.
356
+ # @return [Types::Acceptor]
357
+ #
358
+ # @!attribute [rw] proposer
359
+ # The details of the party proposing the agreement terms. This is
360
+ # commonly the seller for `PurchaseAgreement`.
361
+ # @return [Types::Proposer]
362
+ #
363
+ # @!attribute [rw] start_time
364
+ # The date and time when the agreement starts.
365
+ # @return [Time]
366
+ #
367
+ # @!attribute [rw] end_time
368
+ # The date and time when the agreement ends. The field is `null` for
369
+ # pay-as-you-go agreements, which don’t have end dates.
370
+ # @return [Time]
371
+ #
342
372
  # @!attribute [rw] acceptance_time
343
373
  # The date and time the offer was accepted or the agreement was
344
374
  # created.
@@ -349,25 +379,11 @@ module Aws::MarketplaceAgreement
349
379
  # </note>
350
380
  # @return [Time]
351
381
  #
352
- # @!attribute [rw] acceptor
353
- # The details of the party accepting the agreement terms. This is
354
- # commonly the buyer for `PurchaseAgreement`.
355
- # @return [Types::Acceptor]
356
- #
357
- # @!attribute [rw] agreement_id
358
- # The unique identifier of the agreement.
359
- # @return [String]
360
- #
361
382
  # @!attribute [rw] agreement_type
362
383
  # The type of agreement. Values are `PurchaseAgreement` or
363
384
  # `VendorInsightsAgreement`.
364
385
  # @return [String]
365
386
  #
366
- # @!attribute [rw] end_time
367
- # The date and time when the agreement ends. The field is `null` for
368
- # pay-as-you-go agreements, which don’t have end dates.
369
- # @return [Time]
370
- #
371
387
  # @!attribute [rw] estimated_charges
372
388
  # The estimated cost of the agreement.
373
389
  # @return [Types::EstimatedCharges]
@@ -376,15 +392,6 @@ module Aws::MarketplaceAgreement
376
392
  # A summary of the proposal received from the proposer.
377
393
  # @return [Types::ProposalSummary]
378
394
  #
379
- # @!attribute [rw] proposer
380
- # The details of the party proposing the agreement terms. This is
381
- # commonly the seller for `PurchaseAgreement`.
382
- # @return [Types::Proposer]
383
- #
384
- # @!attribute [rw] start_time
385
- # The date and time when the agreement starts.
386
- # @return [Time]
387
- #
388
395
  # @!attribute [rw] status
389
396
  # The current status of the agreement.
390
397
  #
@@ -405,14 +412,6 @@ module Aws::MarketplaceAgreement
405
412
  # * `REPLACED` – The agreement was replaced using an agreement
406
413
  # replacement offer.
407
414
  #
408
- # * `ROLLED_BACK` (Only applicable to inactive agreement revisions) –
409
- # The agreement revision has been rolled back because of an error.
410
- # An earlier revision is now active.
411
- #
412
- # * `SUPERCEDED` (Only applicable to inactive agreement revisions) –
413
- # The agreement revision is no longer active and another agreement
414
- # revision is now active.
415
- #
416
415
  # * `TERMINATED` – The agreement ended before the defined end date
417
416
  # because of an AWS termination (for example, a payment failure).
418
417
  # @return [String]
@@ -420,15 +419,15 @@ module Aws::MarketplaceAgreement
420
419
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/DescribeAgreementOutput AWS API Documentation
421
420
  #
422
421
  class DescribeAgreementOutput < Struct.new(
423
- :acceptance_time,
424
- :acceptor,
425
422
  :agreement_id,
426
- :agreement_type,
423
+ :acceptor,
424
+ :proposer,
425
+ :start_time,
427
426
  :end_time,
427
+ :acceptance_time,
428
+ :agreement_type,
428
429
  :estimated_charges,
429
430
  :proposal_summary,
430
- :proposer,
431
- :start_time,
432
431
  :status)
433
432
  SENSITIVE = []
434
433
  include Aws::Structure
@@ -509,6 +508,10 @@ module Aws::MarketplaceAgreement
509
508
 
510
509
  # Estimated cost of the agreement.
511
510
  #
511
+ # @!attribute [rw] currency_code
512
+ # Defines the currency code for the charge.
513
+ # @return [String]
514
+ #
512
515
  # @!attribute [rw] agreement_value
513
516
  # The total known amount customer has to pay across the lifecycle of
514
517
  # the agreement.
@@ -538,15 +541,11 @@ module Aws::MarketplaceAgreement
538
541
  # </note>
539
542
  # @return [String]
540
543
  #
541
- # @!attribute [rw] currency_code
542
- # Defines the currency code for the charge.
543
- # @return [String]
544
- #
545
544
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/EstimatedCharges AWS API Documentation
546
545
  #
547
546
  class EstimatedCharges < Struct.new(
548
- :agreement_value,
549
- :currency_code)
547
+ :currency_code,
548
+ :agreement_value)
550
549
  SENSITIVE = []
551
550
  include Aws::Structure
552
551
  end
@@ -575,6 +574,10 @@ module Aws::MarketplaceAgreement
575
574
  # Defines a prepaid pricing model where the customers are charged a
576
575
  # fixed upfront amount.
577
576
  #
577
+ # @!attribute [rw] type
578
+ # Category of the term being updated.
579
+ # @return [String]
580
+ #
578
581
  # @!attribute [rw] currency_code
579
582
  # Defines the currency for the prices mentioned in this term.
580
583
  # @return [String]
@@ -583,28 +586,24 @@ module Aws::MarketplaceAgreement
583
586
  # Contract duration for the terms.
584
587
  # @return [String]
585
588
  #
586
- # @!attribute [rw] grants
587
- # Entitlements granted to the acceptor of fixed upfront as part of
588
- # agreement execution.
589
- # @return [Array<Types::GrantItem>]
590
- #
591
589
  # @!attribute [rw] price
592
590
  # Fixed amount to be charged to the customer when this term is
593
591
  # accepted.
594
592
  # @return [String]
595
593
  #
596
- # @!attribute [rw] type
597
- # Category of the term being updated.
598
- # @return [String]
594
+ # @!attribute [rw] grants
595
+ # Entitlements granted to the acceptor of fixed upfront as part of
596
+ # agreement execution.
597
+ # @return [Array<Types::GrantItem>]
599
598
  #
600
599
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/FixedUpfrontPricingTerm AWS API Documentation
601
600
  #
602
601
  class FixedUpfrontPricingTerm < Struct.new(
602
+ :type,
603
603
  :currency_code,
604
604
  :duration,
605
- :grants,
606
605
  :price,
607
- :type)
606
+ :grants)
608
607
  SENSITIVE = []
609
608
  include Aws::Structure
610
609
  end
@@ -612,6 +611,10 @@ module Aws::MarketplaceAgreement
612
611
  # Defines a short-term free pricing model where the buyers aren’t
613
612
  # charged anything within a specified limit.
614
613
  #
614
+ # @!attribute [rw] type
615
+ # Category of the term.
616
+ # @return [String]
617
+ #
615
618
  # @!attribute [rw] duration
616
619
  # Duration of the free trial period (5–31 days).
617
620
  # @return [String]
@@ -621,16 +624,12 @@ module Aws::MarketplaceAgreement
621
624
  # agreement execution.
622
625
  # @return [Array<Types::GrantItem>]
623
626
  #
624
- # @!attribute [rw] type
625
- # Category of the term.
626
- # @return [String]
627
- #
628
627
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/FreeTrialPricingTerm AWS API Documentation
629
628
  #
630
629
  class FreeTrialPricingTerm < Struct.new(
630
+ :type,
631
631
  :duration,
632
- :grants,
633
- :type)
632
+ :grants)
634
633
  SENSITIVE = []
635
634
  include Aws::Structure
636
635
  end
@@ -702,18 +701,18 @@ module Aws::MarketplaceAgreement
702
701
 
703
702
  # Unexpected error during processing of request.
704
703
  #
705
- # @!attribute [rw] message
706
- # @return [String]
707
- #
708
704
  # @!attribute [rw] request_id
709
705
  # The unique identifier for the error.
710
706
  # @return [String]
711
707
  #
708
+ # @!attribute [rw] message
709
+ # @return [String]
710
+ #
712
711
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/InternalServerException AWS API Documentation
713
712
  #
714
713
  class InternalServerException < Struct.new(
715
- :message,
716
- :request_id)
714
+ :request_id,
715
+ :message)
717
716
  SENSITIVE = []
718
717
  include Aws::Structure
719
718
  end
@@ -721,20 +720,20 @@ module Aws::MarketplaceAgreement
721
720
  # Defines the list of text agreements proposed to the acceptors. An
722
721
  # example is the end user license agreement (EULA).
723
722
  #
723
+ # @!attribute [rw] type
724
+ # Category of the term being updated.
725
+ # @return [String]
726
+ #
724
727
  # @!attribute [rw] documents
725
728
  # List of references to legal resources proposed to the buyers. An
726
729
  # example is the EULA.
727
730
  # @return [Array<Types::DocumentItem>]
728
731
  #
729
- # @!attribute [rw] type
730
- # Category of the term being updated.
731
- # @return [String]
732
- #
733
732
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/LegalTerm AWS API Documentation
734
733
  #
735
734
  class LegalTerm < Struct.new(
736
- :documents,
737
- :type)
735
+ :type,
736
+ :documents)
738
737
  SENSITIVE = []
739
738
  include Aws::Structure
740
739
  end
@@ -743,6 +742,10 @@ module Aws::MarketplaceAgreement
743
742
  # a fixed price on different dates during the agreement validity period.
744
743
  # This is used most commonly for flexible payment schedule pricing.
745
744
  #
745
+ # @!attribute [rw] type
746
+ # Type of the term.
747
+ # @return [String]
748
+ #
746
749
  # @!attribute [rw] currency_code
747
750
  # Defines the currency for the prices mentioned in the term.
748
751
  # @return [String]
@@ -753,35 +756,38 @@ module Aws::MarketplaceAgreement
753
756
  # calculating the price.
754
757
  # @return [Array<Types::ScheduleItem>]
755
758
  #
756
- # @!attribute [rw] type
757
- # Type of the term.
758
- # @return [String]
759
- #
760
759
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/PaymentScheduleTerm AWS API Documentation
761
760
  #
762
761
  class PaymentScheduleTerm < Struct.new(
762
+ :type,
763
763
  :currency_code,
764
- :schedule,
765
- :type)
764
+ :schedule)
766
765
  SENSITIVE = []
767
766
  include Aws::Structure
768
767
  end
769
768
 
770
769
  # A summary of the proposal received from the proposer.
771
770
  #
771
+ # @!attribute [rw] resources
772
+ # The list of resources involved in the agreement.
773
+ # @return [Array<Types::Resource>]
774
+ #
772
775
  # @!attribute [rw] offer_id
773
776
  # The unique identifier of the offer in AWS Marketplace.
774
777
  # @return [String]
775
778
  #
776
- # @!attribute [rw] resources
777
- # The list of resources involved in the agreement.
778
- # @return [Array<Types::Resource>]
779
+ # @!attribute [rw] offer_set_id
780
+ # A unique identifier for the offer set containing this offer. All
781
+ # agreements created from offers in this set include this identifier
782
+ # as context.
783
+ # @return [String]
779
784
  #
780
785
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ProposalSummary AWS API Documentation
781
786
  #
782
787
  class ProposalSummary < Struct.new(
788
+ :resources,
783
789
  :offer_id,
784
- :resources)
790
+ :offer_set_id)
785
791
  SENSITIVE = []
786
792
  include Aws::Structure
787
793
  end
@@ -826,29 +832,29 @@ module Aws::MarketplaceAgreement
826
832
  # Defines a pricing model where customers are charged a fixed recurring
827
833
  # price at the end of each billing period.
828
834
  #
829
- # @!attribute [rw] billing_period
830
- # Defines the recurrence at which buyers are charged.
835
+ # @!attribute [rw] type
836
+ # Type of the term being updated.
831
837
  # @return [String]
832
838
  #
833
839
  # @!attribute [rw] currency_code
834
840
  # Defines the currency for the prices mentioned in this term.
835
841
  # @return [String]
836
842
  #
837
- # @!attribute [rw] price
838
- # Amount charged to the buyer every billing period.
843
+ # @!attribute [rw] billing_period
844
+ # Defines the recurrence at which buyers are charged.
839
845
  # @return [String]
840
846
  #
841
- # @!attribute [rw] type
842
- # Type of the term being updated.
847
+ # @!attribute [rw] price
848
+ # Amount charged to the buyer every billing period.
843
849
  # @return [String]
844
850
  #
845
851
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/RecurringPaymentTerm AWS API Documentation
846
852
  #
847
853
  class RecurringPaymentTerm < Struct.new(
848
- :billing_period,
854
+ :type,
849
855
  :currency_code,
850
- :price,
851
- :type)
856
+ :billing_period,
857
+ :price)
852
858
  SENSITIVE = []
853
859
  include Aws::Structure
854
860
  end
@@ -863,20 +869,20 @@ module Aws::MarketplaceAgreement
863
869
  # `True` to `False` or `False` to `True` at anytime during the
864
870
  # agreement's lifecycle.
865
871
  #
872
+ # @!attribute [rw] type
873
+ # Category of the term being updated.
874
+ # @return [String]
875
+ #
866
876
  # @!attribute [rw] configuration
867
877
  # Additional parameters specified by the acceptor while accepting the
868
878
  # term.
869
879
  # @return [Types::RenewalTermConfiguration]
870
880
  #
871
- # @!attribute [rw] type
872
- # Category of the term being updated.
873
- # @return [String]
874
- #
875
881
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/RenewalTerm AWS API Documentation
876
882
  #
877
883
  class RenewalTerm < Struct.new(
878
- :configuration,
879
- :type)
884
+ :type,
885
+ :configuration)
880
886
  SENSITIVE = []
881
887
  include Aws::Structure
882
888
  end
@@ -924,13 +930,13 @@ module Aws::MarketplaceAgreement
924
930
 
925
931
  # Request references a resource which does not exist.
926
932
  #
927
- # @!attribute [rw] message
928
- # @return [String]
929
- #
930
933
  # @!attribute [rw] request_id
931
934
  # The unique identifier for the error.
932
935
  # @return [String]
933
936
  #
937
+ # @!attribute [rw] message
938
+ # @return [String]
939
+ #
934
940
  # @!attribute [rw] resource_id
935
941
  # The unique identifier for the resource.
936
942
  # @return [String]
@@ -942,8 +948,8 @@ module Aws::MarketplaceAgreement
942
948
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ResourceNotFoundException AWS API Documentation
943
949
  #
944
950
  class ResourceNotFoundException < Struct.new(
945
- :message,
946
951
  :request_id,
952
+ :message,
947
953
  :resource_id,
948
954
  :resource_type)
949
955
  SENSITIVE = []
@@ -953,21 +959,21 @@ module Aws::MarketplaceAgreement
953
959
  # An individual installment of the payment that includes the date and
954
960
  # amount of the charge.
955
961
  #
956
- # @!attribute [rw] charge_amount
957
- # The price that the customer would pay on the scheduled date
958
- # (chargeDate).
959
- # @return [String]
960
- #
961
962
  # @!attribute [rw] charge_date
962
963
  # The date that the customer would pay the price defined in this
963
964
  # payment schedule term. Invoices are generated on the date provided.
964
965
  # @return [Time]
965
966
  #
967
+ # @!attribute [rw] charge_amount
968
+ # The price that the customer would pay on the scheduled date
969
+ # (chargeDate).
970
+ # @return [String]
971
+ #
966
972
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ScheduleItem AWS API Documentation
967
973
  #
968
974
  class ScheduleItem < Struct.new(
969
- :charge_amount,
970
- :charge_date)
975
+ :charge_date,
976
+ :charge_amount)
971
977
  SENSITIVE = []
972
978
  include Aws::Structure
973
979
  end
@@ -985,12 +991,11 @@ module Aws::MarketplaceAgreement
985
991
  # * `ResourceIdentifier` – The unique identifier of the resource.
986
992
  #
987
993
  # * `ResourceType` – Type of the resource, which is the product
988
- # (`AmiProduct`, `ContainerProduct`, or `SaaSProduct`).
994
+ # (`AmiProduct`, `ContainerProduct`, `SaaSProduct`,
995
+ # `ProfessionalServicesProduct`, or `MachineLearningProduct`).
989
996
  #
990
- # * `PartyType` – The party type (either `Acceptor` or `Proposer`) of
991
- # the caller. For agreements where the caller is the proposer, use
992
- # the `Proposer` filter. For agreements where the caller is the
993
- # acceptor, use the `Acceptor` filter.
997
+ # * `PartyType` – The party type of the caller. For agreements where
998
+ # the caller is the proposer, use the `Proposer` filter.
994
999
  #
995
1000
  # * `AcceptorAccountId` – The AWS account ID of the party accepting
996
1001
  # the agreement terms.
@@ -1008,10 +1013,20 @@ module Aws::MarketplaceAgreement
1008
1013
  # * `AfterEndTime` – A date used to filter agreements with a date
1009
1014
  # after the `endTime` of an agreement.
1010
1015
  #
1011
- # * `AgreementType` – The type of agreement. Values include
1012
- # `PurchaseAgreement` or `VendorInsightsAgreement`.
1016
+ # * `AgreementType` – The type of agreement. Supported value includes
1017
+ # `PurchaseAgreement`.
1018
+ #
1019
+ # * `OfferSetId` – A unique identifier for the offer set containing
1020
+ # this offer. All agreements created from offers in this set include
1021
+ # this identifier as context.
1013
1022
  # @return [Array<Types::Filter>]
1014
1023
  #
1024
+ # @!attribute [rw] sort
1025
+ # An object that contains the `SortBy` and `SortOrder` attributes.
1026
+ # Only `EndTime` is supported for `SearchAgreements`. The default sort
1027
+ # is `EndTime` descending.
1028
+ # @return [Types::Sort]
1029
+ #
1015
1030
  # @!attribute [rw] max_results
1016
1031
  # The maximum number of agreements to return in the response.
1017
1032
  # @return [Integer]
@@ -1020,25 +1035,21 @@ module Aws::MarketplaceAgreement
1020
1035
  # A token to specify where to start pagination.
1021
1036
  # @return [String]
1022
1037
  #
1023
- # @!attribute [rw] sort
1024
- # An object that contains the `SortBy` and `SortOrder` attributes.
1025
- # @return [Types::Sort]
1026
- #
1027
1038
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SearchAgreementsInput AWS API Documentation
1028
1039
  #
1029
1040
  class SearchAgreementsInput < Struct.new(
1030
1041
  :catalog,
1031
1042
  :filters,
1043
+ :sort,
1032
1044
  :max_results,
1033
- :next_token,
1034
- :sort)
1045
+ :next_token)
1035
1046
  SENSITIVE = []
1036
1047
  include Aws::Structure
1037
1048
  end
1038
1049
 
1039
1050
  # @!attribute [rw] agreement_view_summaries
1040
1051
  # A summary of the agreement, including top-level attributes (for
1041
- # example, the agreement ID, version, proposer, and acceptor).
1052
+ # example, the agreement ID, proposer, and acceptor).
1042
1053
  # @return [Array<Types::AgreementViewSummary>]
1043
1054
  #
1044
1055
  # @!attribute [rw] next_token
@@ -1099,38 +1110,38 @@ module Aws::MarketplaceAgreement
1099
1110
  # Defines the customer support available for the acceptors when they
1100
1111
  # purchase the software.
1101
1112
  #
1113
+ # @!attribute [rw] type
1114
+ # Category of the term being updated.
1115
+ # @return [String]
1116
+ #
1102
1117
  # @!attribute [rw] refund_policy
1103
1118
  # Free-text field about the refund policy description that will be
1104
1119
  # shown to customers as is on the website and console.
1105
1120
  # @return [String]
1106
1121
  #
1107
- # @!attribute [rw] type
1108
- # Category of the term being updated.
1109
- # @return [String]
1110
- #
1111
1122
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/SupportTerm AWS API Documentation
1112
1123
  #
1113
1124
  class SupportTerm < Struct.new(
1114
- :refund_policy,
1115
- :type)
1125
+ :type,
1126
+ :refund_policy)
1116
1127
  SENSITIVE = []
1117
1128
  include Aws::Structure
1118
1129
  end
1119
1130
 
1120
1131
  # Request was denied due to request throttling.
1121
1132
  #
1122
- # @!attribute [rw] message
1123
- # @return [String]
1124
- #
1125
1133
  # @!attribute [rw] request_id
1126
1134
  # The unique identifier for the error.
1127
1135
  # @return [String]
1128
1136
  #
1137
+ # @!attribute [rw] message
1138
+ # @return [String]
1139
+ #
1129
1140
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ThrottlingException AWS API Documentation
1130
1141
  #
1131
1142
  class ThrottlingException < Struct.new(
1132
- :message,
1133
- :request_id)
1143
+ :request_id,
1144
+ :message)
1134
1145
  SENSITIVE = []
1135
1146
  include Aws::Structure
1136
1147
  end
@@ -1138,6 +1149,10 @@ module Aws::MarketplaceAgreement
1138
1149
  # Defines a usage-based pricing model (typically, pay-as-you-go
1139
1150
  # pricing), where the customers are charged based on product usage.
1140
1151
  #
1152
+ # @!attribute [rw] type
1153
+ # Category of the term.
1154
+ # @return [String]
1155
+ #
1141
1156
  # @!attribute [rw] currency_code
1142
1157
  # Defines the currency for the prices mentioned in the term.
1143
1158
  # @return [String]
@@ -1146,16 +1161,12 @@ module Aws::MarketplaceAgreement
1146
1161
  # List of rate cards.
1147
1162
  # @return [Array<Types::UsageBasedRateCardItem>]
1148
1163
  #
1149
- # @!attribute [rw] type
1150
- # Category of the term.
1151
- # @return [String]
1152
- #
1153
1164
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/UsageBasedPricingTerm AWS API Documentation
1154
1165
  #
1155
1166
  class UsageBasedPricingTerm < Struct.new(
1167
+ :type,
1156
1168
  :currency_code,
1157
- :rate_cards,
1158
- :type)
1169
+ :rate_cards)
1159
1170
  SENSITIVE = []
1160
1171
  include Aws::Structure
1161
1172
  end
@@ -1178,9 +1189,9 @@ module Aws::MarketplaceAgreement
1178
1189
 
1179
1190
  # The input fails to satisfy the constraints specified by the service.
1180
1191
  #
1181
- # @!attribute [rw] fields
1182
- # The fields associated with the error.
1183
- # @return [Array<Types::ValidationExceptionField>]
1192
+ # @!attribute [rw] request_id
1193
+ # The unique identifier associated with the error.
1194
+ # @return [String]
1184
1195
  #
1185
1196
  # @!attribute [rw] message
1186
1197
  # @return [String]
@@ -1189,36 +1200,36 @@ module Aws::MarketplaceAgreement
1189
1200
  # The reason associated with the error.
1190
1201
  # @return [String]
1191
1202
  #
1192
- # @!attribute [rw] request_id
1193
- # The unique identifier associated with the error.
1194
- # @return [String]
1203
+ # @!attribute [rw] fields
1204
+ # The fields associated with the error.
1205
+ # @return [Array<Types::ValidationExceptionField>]
1195
1206
  #
1196
1207
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ValidationException AWS API Documentation
1197
1208
  #
1198
1209
  class ValidationException < Struct.new(
1199
- :fields,
1210
+ :request_id,
1200
1211
  :message,
1201
1212
  :reason,
1202
- :request_id)
1213
+ :fields)
1203
1214
  SENSITIVE = []
1204
1215
  include Aws::Structure
1205
1216
  end
1206
1217
 
1207
1218
  # The input fails to satisfy the constraints specified by the service.
1208
1219
  #
1209
- # @!attribute [rw] message
1210
- # See applicable actions.
1211
- # @return [String]
1212
- #
1213
1220
  # @!attribute [rw] name
1214
1221
  # The name of the field associated with the error.
1215
1222
  # @return [String]
1216
1223
  #
1224
+ # @!attribute [rw] message
1225
+ # See applicable actions.
1226
+ # @return [String]
1227
+ #
1217
1228
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ValidationExceptionField AWS API Documentation
1218
1229
  #
1219
1230
  class ValidationExceptionField < Struct.new(
1220
- :message,
1221
- :name)
1231
+ :name,
1232
+ :message)
1222
1233
  SENSITIVE = []
1223
1234
  include Aws::Structure
1224
1235
  end
@@ -1226,6 +1237,10 @@ module Aws::MarketplaceAgreement
1226
1237
  # Defines the conditions that will keep an agreement created from this
1227
1238
  # offer valid.
1228
1239
  #
1240
+ # @!attribute [rw] type
1241
+ # Category of the term being updated.
1242
+ # @return [String]
1243
+ #
1229
1244
  # @!attribute [rw] agreement_duration
1230
1245
  # Defines the duration that the agreement remains active. If
1231
1246
  # `AgreementStartDate` isn’t provided, the agreement duration is
@@ -1233,13 +1248,6 @@ module Aws::MarketplaceAgreement
1233
1248
  # represented in the ISO\_8601 format.
1234
1249
  # @return [String]
1235
1250
  #
1236
- # @!attribute [rw] agreement_end_date
1237
- # Defines the date when the agreement ends. The agreement ends at
1238
- # 23:59:59.999 UTC on the date provided. If `AgreementEndDate` isn’t
1239
- # provided, the agreement end date is determined by the validity of
1240
- # individual terms.
1241
- # @return [Time]
1242
- #
1243
1251
  # @!attribute [rw] agreement_start_date
1244
1252
  # Defines the date when agreement starts. The agreement starts at
1245
1253
  # 00:00:00.000 UTC on the date provided. If `AgreementStartDate` isn’t
@@ -1247,17 +1255,78 @@ module Aws::MarketplaceAgreement
1247
1255
  # signature time.
1248
1256
  # @return [Time]
1249
1257
  #
1250
- # @!attribute [rw] type
1251
- # Category of the term being updated.
1252
- # @return [String]
1258
+ # @!attribute [rw] agreement_end_date
1259
+ # Defines the date when the agreement ends. The agreement ends at
1260
+ # 23:59:59.999 UTC on the date provided. If `AgreementEndDate` isn’t
1261
+ # provided, the agreement end date is determined by the validity of
1262
+ # individual terms.
1263
+ # @return [Time]
1253
1264
  #
1254
1265
  # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/ValidityTerm AWS API Documentation
1255
1266
  #
1256
1267
  class ValidityTerm < Struct.new(
1268
+ :type,
1257
1269
  :agreement_duration,
1258
- :agreement_end_date,
1259
1270
  :agreement_start_date,
1260
- :type)
1271
+ :agreement_end_date)
1272
+ SENSITIVE = []
1273
+ include Aws::Structure
1274
+ end
1275
+
1276
+ # Defines a payment model where sellers can submit variable payment
1277
+ # requests up to a maximum charge amount, with configurable approval
1278
+ # strategies and expiration timelines.
1279
+ #
1280
+ # @!attribute [rw] type
1281
+ # Type of the term.
1282
+ # @return [String]
1283
+ #
1284
+ # @!attribute [rw] currency_code
1285
+ # Defines the currency for the prices mentioned in the term.
1286
+ # @return [String]
1287
+ #
1288
+ # @!attribute [rw] max_total_charge_amount
1289
+ # The maximum total amount that can be charged to the customer through
1290
+ # variable payment requests under this term.
1291
+ # @return [String]
1292
+ #
1293
+ # @!attribute [rw] configuration
1294
+ # Additional parameters specified by the acceptor while accepting the
1295
+ # term.
1296
+ # @return [Types::VariablePaymentTermConfiguration]
1297
+ #
1298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/VariablePaymentTerm AWS API Documentation
1299
+ #
1300
+ class VariablePaymentTerm < Struct.new(
1301
+ :type,
1302
+ :currency_code,
1303
+ :max_total_charge_amount,
1304
+ :configuration)
1305
+ SENSITIVE = []
1306
+ include Aws::Structure
1307
+ end
1308
+
1309
+ # Additional parameters specified by the acceptor while accepting the
1310
+ # variable payment term.
1311
+ #
1312
+ # @!attribute [rw] payment_request_approval_strategy
1313
+ # Defines the strategy for approving payment requests. Values include
1314
+ # `AUTO_APPROVE_ON_EXPIRATION` and `WAIT_FOR_APPROVAL`
1315
+ # @return [String]
1316
+ #
1317
+ # @!attribute [rw] expiration_duration
1318
+ # Defines the duration after which a payment request is automatically
1319
+ # approved if no further action is taken. This only applies when the
1320
+ # payment request approval strategy is set to
1321
+ # `AUTO_APPROVE_ON_EXPIRATION`. The duration is represented in the
1322
+ # ISO\_8601 format (e.g., P10D for 10 days).
1323
+ # @return [String]
1324
+ #
1325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/marketplace-agreement-2020-03-01/VariablePaymentTermConfiguration AWS API Documentation
1326
+ #
1327
+ class VariablePaymentTermConfiguration < Struct.new(
1328
+ :payment_request_approval_strategy,
1329
+ :expiration_duration)
1261
1330
  SENSITIVE = []
1262
1331
  include Aws::Structure
1263
1332
  end