@aws-sdk/client-marketplace-agreement 3.533.0 → 3.540.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.
- package/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/MarketplaceAgreement.d.ts +2 -1
- package/dist-types/MarketplaceAgreementClient.d.ts +1 -1
- package/dist-types/commands/DescribeAgreementCommand.d.ts +2 -1
- package/dist-types/commands/GetAgreementTermsCommand.d.ts +2 -1
- package/dist-types/commands/SearchAgreementsCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +158 -158
- package/dist-types/ts3.4/MarketplaceAgreement.d.ts +1 -0
- package/dist-types/ts3.4/commands/DescribeAgreementCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAgreementTermsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchAgreementsCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,31 +1,30 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { MarketplaceAgreementServiceException as __BaseException } from "./MarketplaceAgreementServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>Enables you and your customers to move your existing agreements to AWS Marketplace. The
|
|
6
5
|
* customer won't be charged for product usage in AWS Marketplace because they already paid
|
|
7
6
|
* for the product outside of AWS Marketplace.</p>
|
|
7
|
+
* @public
|
|
8
8
|
*/
|
|
9
9
|
export interface ByolPricingTerm {
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>Type of the term being updated.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
type?: string;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* @public
|
|
18
17
|
* <p>Defines the dimensions that the acceptor has purchased from the overall set of
|
|
19
18
|
* dimensions presented in the rate card.</p>
|
|
19
|
+
* @public
|
|
20
20
|
*/
|
|
21
21
|
export interface Dimension {
|
|
22
22
|
/**
|
|
23
|
-
* @public
|
|
24
23
|
* <p>The name of key value of the dimension.</p>
|
|
24
|
+
* @public
|
|
25
25
|
*/
|
|
26
26
|
dimensionKey: string | undefined;
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>The number of units of the dimension the acceptor has purchased.</p>
|
|
30
29
|
* <note>
|
|
31
30
|
* <p>For Agreements with <code>ConfigurableUpfrontPricingTerm</code>, the
|
|
@@ -33,208 +32,208 @@ export interface Dimension {
|
|
|
33
32
|
* seller (proposer), whereas the <code>Configuration</code> section will define the actual
|
|
34
33
|
* dimensions, prices, and units the buyer has chosen to accept.</p>
|
|
35
34
|
* </note>
|
|
35
|
+
* @public
|
|
36
36
|
*/
|
|
37
37
|
dimensionValue: number | undefined;
|
|
38
38
|
}
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they
|
|
42
41
|
* want to purchase and the duration.</p>
|
|
42
|
+
* @public
|
|
43
43
|
*/
|
|
44
44
|
export interface ConfigurableUpfrontPricingTermConfiguration {
|
|
45
45
|
/**
|
|
46
|
-
* @public
|
|
47
46
|
* <p>Defines the length of time for which the particular pricing/dimension is being purchased
|
|
48
47
|
* by the acceptor.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
selectorValue: string | undefined;
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>Defines the dimensions that the acceptor has purchased from the overall set of
|
|
54
53
|
* dimensions presented in the rate card.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
dimensions: Dimension[] | undefined;
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>Defines limits on how the term can be configured by acceptors. </p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
export interface Constraints {
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>Determines if buyers are allowed to select multiple dimensions in the rate card. The
|
|
66
65
|
* possible values are <code>Allowed</code> and <code>Disallowed</code>. The default value is
|
|
67
66
|
* <code>Allowed</code>.</p>
|
|
67
|
+
* @public
|
|
68
68
|
*/
|
|
69
69
|
multipleDimensionSelection?: string;
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>Determines if acceptors are allowed to configure quantity for each dimension in rate
|
|
73
72
|
* card. The possible values are <code>Allowed</code> and <code>Disallowed</code>. The default
|
|
74
73
|
* value is <code>Allowed</code>.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
quantityConfiguration?: string;
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
-
* @public
|
|
80
79
|
* <p>Defines the per unit rates for each individual product dimension.</p>
|
|
80
|
+
* @public
|
|
81
81
|
*/
|
|
82
82
|
export interface RateCardItem {
|
|
83
83
|
/**
|
|
84
|
-
* @public
|
|
85
84
|
* <p>Dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.</p>
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
dimensionKey?: string;
|
|
88
88
|
/**
|
|
89
|
-
* @public
|
|
90
89
|
* <p>Per unit price for the product dimension that’s used for calculating the amount to be charged.</p>
|
|
90
|
+
* @public
|
|
91
91
|
*/
|
|
92
92
|
price?: string;
|
|
93
93
|
}
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>Differentiates between the mutually exclusive rate cards in the same pricing term to be
|
|
97
96
|
* selected by the buyer.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
export interface Selector {
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>Category of selector.</p>
|
|
102
|
+
* @public
|
|
103
103
|
*/
|
|
104
104
|
type?: string;
|
|
105
105
|
/**
|
|
106
|
-
* @public
|
|
107
106
|
* <p>Contract duration. This field supports the ISO 8601 format. </p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
value?: string;
|
|
110
110
|
}
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>Within the prepaid payment model defined under <code>ConfigurableUpfrontPricingTerm</code>, the <code>RateCardItem</code> defines all the various rate cards (including pricing and dimensions) that have been proposed.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
export interface ConfigurableUpfrontRateCardItem {
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
selector?: Selector;
|
|
121
121
|
/**
|
|
122
|
-
* @public
|
|
123
122
|
* <p>Defines limits on how the term can be configured by acceptors.</p>
|
|
123
|
+
* @public
|
|
124
124
|
*/
|
|
125
125
|
constraints?: Constraints;
|
|
126
126
|
/**
|
|
127
|
-
* @public
|
|
128
127
|
* <p>Defines the per unit rates for product dimensions.</p>
|
|
128
|
+
* @public
|
|
129
129
|
*/
|
|
130
130
|
rateCard?: RateCardItem[];
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they
|
|
135
134
|
* want to purchase and the duration.</p>
|
|
135
|
+
* @public
|
|
136
136
|
*/
|
|
137
137
|
export interface ConfigurableUpfrontPricingTerm {
|
|
138
138
|
/**
|
|
139
|
-
* @public
|
|
140
139
|
* <p>Category of selector.</p>
|
|
140
|
+
* @public
|
|
141
141
|
*/
|
|
142
142
|
type?: string;
|
|
143
143
|
/**
|
|
144
|
-
* @public
|
|
145
144
|
* <p>Defines the currency for the prices mentioned in the term.</p>
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
currencyCode?: string;
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>A rate card defines the per unit rates for product dimensions.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
rateCards?: ConfigurableUpfrontRateCardItem[];
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
configuration?: ConfigurableUpfrontPricingTermConfiguration;
|
|
158
158
|
}
|
|
159
159
|
/**
|
|
160
|
-
* @public
|
|
161
160
|
* <p>Entitlements granted to the acceptor of fixed upfront as part of agreement execution.</p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
export interface GrantItem {
|
|
164
164
|
/**
|
|
165
|
-
* @public
|
|
166
165
|
* <p>Unique dimension key defined in the product document. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace. </p>
|
|
166
|
+
* @public
|
|
167
167
|
*/
|
|
168
168
|
dimensionKey?: string;
|
|
169
169
|
/**
|
|
170
|
-
* @public
|
|
171
170
|
* <p>Maximum amount of capacity that the buyer can be entitled to the given dimension of the product. If <code>MaxQuantity</code> is not provided, the buyer will be able to use an unlimited amount of the given dimension. </p>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
maxQuantity?: number;
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* @public
|
|
177
176
|
* <p>Defines a prepaid pricing model where the customers are charged a fixed upfront
|
|
178
177
|
* amount.</p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
export interface FixedUpfrontPricingTerm {
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>Category of the term being updated.</p>
|
|
183
|
+
* @public
|
|
184
184
|
*/
|
|
185
185
|
type?: string;
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>Defines the currency for the prices mentioned in this term. </p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
currencyCode?: string;
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>Contract duration for the terms.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
duration?: string;
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>Fixed amount to be charged to the customer when this term is accepted.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
price?: string;
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>Entitlements granted to the acceptor of fixed upfront as part of agreement
|
|
204
203
|
* execution.</p>
|
|
204
|
+
* @public
|
|
205
205
|
*/
|
|
206
206
|
grants?: GrantItem[];
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>Defines a short-term free pricing model where the buyers aren’t charged anything within
|
|
211
210
|
* a specified limit.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
export interface FreeTrialPricingTerm {
|
|
214
214
|
/**
|
|
215
|
-
* @public
|
|
216
215
|
* <p>Category of the term.</p>
|
|
216
|
+
* @public
|
|
217
217
|
*/
|
|
218
218
|
type?: string;
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
220
|
* <p>Duration of the free trial period (5–31 days). </p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
duration?: string;
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>Entitlements granted to the acceptor of a free trial as part of an agreement
|
|
227
226
|
* execution.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
grants?: GrantItem[];
|
|
230
230
|
}
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>Includes the list of references to legal resources proposed by the proposer to the acceptor. Each <code>DocumentItem</code> refers to an individual reference.</p>
|
|
233
|
+
* @public
|
|
234
234
|
*/
|
|
235
235
|
export interface DocumentItem {
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>Category of the document. Document types include:</p>
|
|
239
238
|
* <ul>
|
|
240
239
|
* <li>
|
|
@@ -262,118 +261,118 @@ export interface DocumentItem {
|
|
|
262
261
|
* because it’s managed by AWS Marketplace.</p>
|
|
263
262
|
* </li>
|
|
264
263
|
* </ul>
|
|
264
|
+
* @public
|
|
265
265
|
*/
|
|
266
266
|
type?: string;
|
|
267
267
|
/**
|
|
268
|
-
* @public
|
|
269
268
|
* <p>A URL to the legal document for buyers to read. Required when <code>Type</code> is <code>CustomEula</code>.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
url?: string;
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>Version of standard contracts provided by AWS Marketplace. Required when Type is <code>StandardEula</code> or <code>StandardDsa</code>. </p>
|
|
274
|
+
* @public
|
|
275
275
|
*/
|
|
276
276
|
version?: string;
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>Defines the list of text agreements proposed to the acceptors. An example is the end
|
|
281
280
|
* user license agreement (EULA).</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
export interface LegalTerm {
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>Category of the term being updated.</p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
type?: string;
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <p>List of references to legal resources proposed to the buyers. An example is the
|
|
292
291
|
* EULA.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
documents?: DocumentItem[];
|
|
295
295
|
}
|
|
296
296
|
/**
|
|
297
|
-
* @public
|
|
298
297
|
* <p>An individual installment of the payment that includes the date and amount of the charge.</p>
|
|
298
|
+
* @public
|
|
299
299
|
*/
|
|
300
300
|
export interface ScheduleItem {
|
|
301
301
|
/**
|
|
302
|
-
* @public
|
|
303
302
|
* <p>The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
chargeDate?: Date;
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>The price that the customer would pay on the scheduled date (chargeDate).</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
chargeAmount?: string;
|
|
311
311
|
}
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>Defines an installment-based pricing model where customers are charged a fixed price on
|
|
315
314
|
* different dates during the agreement validity period. This is used most commonly for
|
|
316
315
|
* flexible payment schedule pricing.</p>
|
|
316
|
+
* @public
|
|
317
317
|
*/
|
|
318
318
|
export interface PaymentScheduleTerm {
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>Type of the term.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
type?: string;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>Defines the currency for the prices mentioned in the term. </p>
|
|
326
|
+
* @public
|
|
327
327
|
*/
|
|
328
328
|
currencyCode?: string;
|
|
329
329
|
/**
|
|
330
|
-
* @public
|
|
331
330
|
* <p>List of the payment schedule where each element defines one installment of payment. It
|
|
332
331
|
* contains the information necessary for calculating the price.</p>
|
|
332
|
+
* @public
|
|
333
333
|
*/
|
|
334
334
|
schedule?: ScheduleItem[];
|
|
335
335
|
}
|
|
336
336
|
/**
|
|
337
|
-
* @public
|
|
338
337
|
* <p>Defines a pricing model where customers are charged a fixed recurring price at the end
|
|
339
338
|
* of each billing period.</p>
|
|
339
|
+
* @public
|
|
340
340
|
*/
|
|
341
341
|
export interface RecurringPaymentTerm {
|
|
342
342
|
/**
|
|
343
|
-
* @public
|
|
344
343
|
* <p>Type of the term being updated.</p>
|
|
344
|
+
* @public
|
|
345
345
|
*/
|
|
346
346
|
type?: string;
|
|
347
347
|
/**
|
|
348
|
-
* @public
|
|
349
348
|
* <p>Defines the currency for the prices mentioned in this term. </p>
|
|
349
|
+
* @public
|
|
350
350
|
*/
|
|
351
351
|
currencyCode?: string;
|
|
352
352
|
/**
|
|
353
|
-
* @public
|
|
354
353
|
* <p>Defines the recurrence at which buyers are charged.</p>
|
|
354
|
+
* @public
|
|
355
355
|
*/
|
|
356
356
|
billingPeriod?: string;
|
|
357
357
|
/**
|
|
358
|
-
* @public
|
|
359
358
|
* <p>Amount charged to the buyer every billing period.</p>
|
|
359
|
+
* @public
|
|
360
360
|
*/
|
|
361
361
|
price?: string;
|
|
362
362
|
}
|
|
363
363
|
/**
|
|
364
|
-
* @public
|
|
365
364
|
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
365
|
+
* @public
|
|
366
366
|
*/
|
|
367
367
|
export interface RenewalTermConfiguration {
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>Defines whether the acceptor has chosen to auto-renew the agreement at the end of its
|
|
371
370
|
* lifecycle. Can be set to <code>True</code> or <code>False</code>.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
enableAutoRenew: boolean | undefined;
|
|
374
374
|
}
|
|
375
375
|
/**
|
|
376
|
-
* @public
|
|
377
376
|
* <p>Defines that on graceful expiration of the agreement (when the agreement ends on its
|
|
378
377
|
* pre-defined end date), a new agreement will be created using the accepted terms on the
|
|
379
378
|
* existing agreement. In other words, the agreement will be renewed. The presence of
|
|
@@ -382,105 +381,106 @@ export interface RenewalTermConfiguration {
|
|
|
382
381
|
* acceptance/agreement creation. Buyers can also change this flag from <code>True</code> to
|
|
383
382
|
* <code>False</code> or <code>False</code> to <code>True</code> at anytime during the
|
|
384
383
|
* agreement's lifecycle.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
export interface RenewalTerm {
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>Category of the term being updated. </p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
type?: string;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
configuration?: RenewalTermConfiguration;
|
|
397
397
|
}
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>Defines the customer support available for the acceptors when they purchase the
|
|
401
400
|
* software.</p>
|
|
401
|
+
* @public
|
|
402
402
|
*/
|
|
403
403
|
export interface SupportTerm {
|
|
404
404
|
/**
|
|
405
|
-
* @public
|
|
406
405
|
* <p>Category of the term being updated.</p>
|
|
406
|
+
* @public
|
|
407
407
|
*/
|
|
408
408
|
type?: string;
|
|
409
409
|
/**
|
|
410
|
-
* @public
|
|
411
410
|
* <p>Free-text field about the refund policy description that will be shown to customers as
|
|
412
411
|
* is on the website and console.</p>
|
|
412
|
+
* @public
|
|
413
413
|
*/
|
|
414
414
|
refundPolicy?: string;
|
|
415
415
|
}
|
|
416
416
|
/**
|
|
417
|
-
* @public
|
|
418
417
|
* <p>Within the pay-as-you-go model defined under <code>UsageBasedPricingTerm</code>, the <code>UsageBasedRateCardItem</code> defines an individual rate for a product dimension.</p>
|
|
418
|
+
* @public
|
|
419
419
|
*/
|
|
420
420
|
export interface UsageBasedRateCardItem {
|
|
421
421
|
/**
|
|
422
|
-
* @public
|
|
423
422
|
* <p>Defines the per unit rates for product dimensions.</p>
|
|
423
|
+
* @public
|
|
424
424
|
*/
|
|
425
425
|
rateCard?: RateCardItem[];
|
|
426
426
|
}
|
|
427
427
|
/**
|
|
428
|
-
* @public
|
|
429
428
|
* <p>Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the
|
|
430
429
|
* customers are charged based on product usage.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
export interface UsageBasedPricingTerm {
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>Category of the term.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
type?: string;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>Defines the currency for the prices mentioned in the term. </p>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
currencyCode?: string;
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>List of rate cards.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
rateCards?: UsageBasedRateCardItem[];
|
|
448
448
|
}
|
|
449
449
|
/**
|
|
450
|
-
* @public
|
|
451
450
|
* <p>Defines the conditions that will keep an agreement created from this offer valid. </p>
|
|
451
|
+
* @public
|
|
452
452
|
*/
|
|
453
453
|
export interface ValidityTerm {
|
|
454
454
|
/**
|
|
455
|
-
* @public
|
|
456
455
|
* <p>Category of the term being updated. </p>
|
|
456
|
+
* @public
|
|
457
457
|
*/
|
|
458
458
|
type?: string;
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>Defines the duration that the agreement remains active. If
|
|
462
461
|
* <code>AgreementStartDate</code> isn’t provided, the agreement duration is relative to
|
|
463
462
|
* the agreement signature time. The duration is represented in the ISO_8601 format.</p>
|
|
463
|
+
* @public
|
|
464
464
|
*/
|
|
465
465
|
agreementDuration?: string;
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the
|
|
469
468
|
* date provided. If <code>AgreementStartDate</code> isn’t provided, the agreement start date
|
|
470
469
|
* is determined based on agreement signature time.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
agreementStartDate?: Date;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the
|
|
476
475
|
* date provided. If <code>AgreementEndDate</code> isn’t provided, the agreement end date is
|
|
477
476
|
* determined by the validity of individual terms.</p>
|
|
477
|
+
* @public
|
|
478
478
|
*/
|
|
479
479
|
agreementEndDate?: Date;
|
|
480
480
|
}
|
|
481
481
|
/**
|
|
482
|
-
* @public
|
|
483
482
|
* <p>A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.</p>
|
|
483
|
+
* @public
|
|
484
484
|
*/
|
|
485
485
|
export type AcceptedTerm = AcceptedTerm.ByolPricingTermMember | AcceptedTerm.ConfigurableUpfrontPricingTermMember | AcceptedTerm.FixedUpfrontPricingTermMember | AcceptedTerm.FreeTrialPricingTermMember | AcceptedTerm.LegalTermMember | AcceptedTerm.PaymentScheduleTermMember | AcceptedTerm.RecurringPaymentTermMember | AcceptedTerm.RenewalTermMember | AcceptedTerm.SupportTermMember | AcceptedTerm.UsageBasedPricingTermMember | AcceptedTerm.ValidityTermMember | AcceptedTerm.$UnknownMember;
|
|
486
486
|
/**
|
|
@@ -488,8 +488,8 @@ export type AcceptedTerm = AcceptedTerm.ByolPricingTermMember | AcceptedTerm.Con
|
|
|
488
488
|
*/
|
|
489
489
|
export declare namespace AcceptedTerm {
|
|
490
490
|
/**
|
|
491
|
-
* @public
|
|
492
491
|
* <p>Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).</p>
|
|
492
|
+
* @public
|
|
493
493
|
*/
|
|
494
494
|
interface LegalTermMember {
|
|
495
495
|
legalTerm: LegalTerm;
|
|
@@ -506,8 +506,8 @@ export declare namespace AcceptedTerm {
|
|
|
506
506
|
$unknown?: never;
|
|
507
507
|
}
|
|
508
508
|
/**
|
|
509
|
-
* @public
|
|
510
509
|
* <p>Defines the customer support available for the acceptors when they purchase the software.</p>
|
|
510
|
+
* @public
|
|
511
511
|
*/
|
|
512
512
|
interface SupportTermMember {
|
|
513
513
|
legalTerm?: never;
|
|
@@ -524,8 +524,8 @@ export declare namespace AcceptedTerm {
|
|
|
524
524
|
$unknown?: never;
|
|
525
525
|
}
|
|
526
526
|
/**
|
|
527
|
-
* @public
|
|
528
527
|
* <p>Defines that on graceful expiration of the agreement (when the agreement ends on its pre-defined end date), a new agreement will be created using the accepted terms on the existing agreement. In other words, the agreement will be renewed. Presence of <code>RenewalTerm</code> in the offer document means that auto-renewal is allowed. Buyers will have the option to accept or decline auto-renewal at the offer acceptance/agreement creation. Buyers can also change this flag from <code>True</code> to <code>False</code> or <code>False</code> to <code>True</code> at anytime during the agreement's lifecycle.</p>
|
|
528
|
+
* @public
|
|
529
529
|
*/
|
|
530
530
|
interface RenewalTermMember {
|
|
531
531
|
legalTerm?: never;
|
|
@@ -542,8 +542,8 @@ export declare namespace AcceptedTerm {
|
|
|
542
542
|
$unknown?: never;
|
|
543
543
|
}
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
interface UsageBasedPricingTermMember {
|
|
549
549
|
legalTerm?: never;
|
|
@@ -560,8 +560,8 @@ export declare namespace AcceptedTerm {
|
|
|
560
560
|
$unknown?: never;
|
|
561
561
|
}
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
interface ConfigurableUpfrontPricingTermMember {
|
|
567
567
|
legalTerm?: never;
|
|
@@ -578,8 +578,8 @@ export declare namespace AcceptedTerm {
|
|
|
578
578
|
$unknown?: never;
|
|
579
579
|
}
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>Enables you and your customers to move your existing agreements to AWS Marketplace. The customer won't be charged for product usage in AWS Marketplace because they already paid for the product outside of AWS Marketplace.</p>
|
|
582
|
+
* @public
|
|
583
583
|
*/
|
|
584
584
|
interface ByolPricingTermMember {
|
|
585
585
|
legalTerm?: never;
|
|
@@ -596,8 +596,8 @@ export declare namespace AcceptedTerm {
|
|
|
596
596
|
$unknown?: never;
|
|
597
597
|
}
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.</p>
|
|
600
|
+
* @public
|
|
601
601
|
*/
|
|
602
602
|
interface RecurringPaymentTermMember {
|
|
603
603
|
legalTerm?: never;
|
|
@@ -614,8 +614,8 @@ export declare namespace AcceptedTerm {
|
|
|
614
614
|
$unknown?: never;
|
|
615
615
|
}
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>Defines the conditions that will keep an agreement created from this offer valid.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
interface ValidityTermMember {
|
|
621
621
|
legalTerm?: never;
|
|
@@ -632,8 +632,8 @@ export declare namespace AcceptedTerm {
|
|
|
632
632
|
$unknown?: never;
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
|
-
* @public
|
|
636
635
|
* <p>Defines an installment-based pricing model where customers are charged a fixed price on different dates during the agreement validity period. This is used most commonly for flexible payment schedule pricing.</p>
|
|
636
|
+
* @public
|
|
637
637
|
*/
|
|
638
638
|
interface PaymentScheduleTermMember {
|
|
639
639
|
legalTerm?: never;
|
|
@@ -650,8 +650,8 @@ export declare namespace AcceptedTerm {
|
|
|
650
650
|
$unknown?: never;
|
|
651
651
|
}
|
|
652
652
|
/**
|
|
653
|
-
* @public
|
|
654
653
|
* <p>Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.</p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
interface FreeTrialPricingTermMember {
|
|
657
657
|
legalTerm?: never;
|
|
@@ -668,8 +668,8 @@ export declare namespace AcceptedTerm {
|
|
|
668
668
|
$unknown?: never;
|
|
669
669
|
}
|
|
670
670
|
/**
|
|
671
|
-
* @public
|
|
672
671
|
* <p>Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.</p>
|
|
672
|
+
* @public
|
|
673
673
|
*/
|
|
674
674
|
interface FixedUpfrontPricingTermMember {
|
|
675
675
|
legalTerm?: never;
|
|
@@ -719,27 +719,27 @@ export declare namespace AcceptedTerm {
|
|
|
719
719
|
const visit: <T>(value: AcceptedTerm, visitor: Visitor<T>) => T;
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>The details of the party accepting the agreement terms. This is commonly the buyer for
|
|
724
723
|
* <code>PurchaseAgreement</code>.</p>
|
|
724
|
+
* @public
|
|
725
725
|
*/
|
|
726
726
|
export interface Acceptor {
|
|
727
727
|
/**
|
|
728
|
-
* @public
|
|
729
728
|
* <p>The AWS account ID of the acceptor.</p>
|
|
729
|
+
* @public
|
|
730
730
|
*/
|
|
731
731
|
accountId?: string;
|
|
732
732
|
}
|
|
733
733
|
/**
|
|
734
|
-
* @public
|
|
735
734
|
* <p>User does not have sufficient access to perform this action.</p>
|
|
735
|
+
* @public
|
|
736
736
|
*/
|
|
737
737
|
export declare class AccessDeniedException extends __BaseException {
|
|
738
738
|
readonly name: "AccessDeniedException";
|
|
739
739
|
readonly $fault: "client";
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>The unique identifier for the error.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
requestId?: string;
|
|
745
745
|
/**
|
|
@@ -767,108 +767,108 @@ export declare const AgreementStatus: {
|
|
|
767
767
|
*/
|
|
768
768
|
export type AgreementStatus = (typeof AgreementStatus)[keyof typeof AgreementStatus];
|
|
769
769
|
/**
|
|
770
|
-
* @public
|
|
771
770
|
* <p>The list of resources involved in the agreement.</p>
|
|
771
|
+
* @public
|
|
772
772
|
*/
|
|
773
773
|
export interface Resource {
|
|
774
774
|
/**
|
|
775
|
-
* @public
|
|
776
775
|
* <p>The unique identifier of the resource.</p>
|
|
777
776
|
* <note>
|
|
778
777
|
* <p>We mention the term resource, which is most commonly a product, so a
|
|
779
778
|
* <code>resourceId</code> is also a <code>productId</code>.</p>
|
|
780
779
|
* </note>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
id?: string;
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>Type of the resource, which is the product. Values include <code>SaaSProduct</code> or
|
|
786
785
|
* <code>AmiProduct</code>.</p>
|
|
786
|
+
* @public
|
|
787
787
|
*/
|
|
788
788
|
type?: string;
|
|
789
789
|
}
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>A summary of the proposal received from the proposer.</p>
|
|
792
|
+
* @public
|
|
793
793
|
*/
|
|
794
794
|
export interface ProposalSummary {
|
|
795
795
|
/**
|
|
796
|
-
* @public
|
|
797
796
|
* <p>The list of resources involved in the agreement.</p>
|
|
797
|
+
* @public
|
|
798
798
|
*/
|
|
799
799
|
resources?: Resource[];
|
|
800
800
|
/**
|
|
801
|
-
* @public
|
|
802
801
|
* <p>The unique identifier of the offer in AWS Marketplace.</p>
|
|
802
|
+
* @public
|
|
803
803
|
*/
|
|
804
804
|
offerId?: string;
|
|
805
805
|
}
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>Details of the party proposing the agreement terms,. This is commonly the seller for
|
|
809
808
|
* <code>PurchaseAgreement</code>. </p>
|
|
809
|
+
* @public
|
|
810
810
|
*/
|
|
811
811
|
export interface Proposer {
|
|
812
812
|
/**
|
|
813
|
-
* @public
|
|
814
813
|
* <p>The AWS account ID of the proposer.</p>
|
|
814
|
+
* @public
|
|
815
815
|
*/
|
|
816
816
|
accountId?: string;
|
|
817
817
|
}
|
|
818
818
|
/**
|
|
819
|
-
* @public
|
|
820
819
|
* <p>A summary of the agreement, including top-level attributes (for example, the agreement
|
|
821
820
|
* ID, version, proposer, and acceptor).</p>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
export interface AgreementViewSummary {
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>The unique identifier of the agreement.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
agreementId?: string;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>The date and time that the agreement was accepted.</p>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
acceptanceTime?: Date;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <p>The date and time when the agreement starts.</p>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
startTime?: Date;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The date and time when the agreement ends. The field is <code>null</code> for
|
|
842
841
|
* pay-as-you-go agreements, which don’t have end dates.</p>
|
|
842
|
+
* @public
|
|
843
843
|
*/
|
|
844
844
|
endTime?: Date;
|
|
845
845
|
/**
|
|
846
|
-
* @public
|
|
847
846
|
* <p>The type of agreement. Values are <code>PurchaseAgreement</code> or
|
|
848
847
|
* <code>VendorInsightsAgreement</code>.</p>
|
|
848
|
+
* @public
|
|
849
849
|
*/
|
|
850
850
|
agreementType?: string;
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>Details of the party accepting the agreement terms. This is commonly the buyer for
|
|
854
853
|
* <code>PurchaseAgreement.</code>
|
|
855
854
|
* </p>
|
|
855
|
+
* @public
|
|
856
856
|
*/
|
|
857
857
|
acceptor?: Acceptor;
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>Details of the party proposing the agreement terms, most commonly the seller for
|
|
861
860
|
* <code>PurchaseAgreement</code>.</p>
|
|
861
|
+
* @public
|
|
862
862
|
*/
|
|
863
863
|
proposer?: Proposer;
|
|
864
864
|
/**
|
|
865
|
-
* @public
|
|
866
865
|
* <p>A summary of the proposal</p>
|
|
866
|
+
* @public
|
|
867
867
|
*/
|
|
868
868
|
proposalSummary?: ProposalSummary;
|
|
869
869
|
/**
|
|
870
|
-
* @public
|
|
871
870
|
* <p>The current status of the agreement. </p>
|
|
871
|
+
* @public
|
|
872
872
|
*/
|
|
873
873
|
status?: AgreementStatus;
|
|
874
874
|
}
|
|
@@ -877,23 +877,22 @@ export interface AgreementViewSummary {
|
|
|
877
877
|
*/
|
|
878
878
|
export interface DescribeAgreementInput {
|
|
879
879
|
/**
|
|
880
|
-
* @public
|
|
881
880
|
* <p>The unique identifier of the agreement.</p>
|
|
881
|
+
* @public
|
|
882
882
|
*/
|
|
883
883
|
agreementId: string | undefined;
|
|
884
884
|
}
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>Estimated cost of the agreement.</p>
|
|
887
|
+
* @public
|
|
888
888
|
*/
|
|
889
889
|
export interface EstimatedCharges {
|
|
890
890
|
/**
|
|
891
|
-
* @public
|
|
892
891
|
* <p>Defines the currency code for the charge.</p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
currencyCode?: string;
|
|
895
895
|
/**
|
|
896
|
-
* @public
|
|
897
896
|
* <p>The total known amount customer has to pay across the lifecycle of the agreement.</p>
|
|
898
897
|
* <note>
|
|
899
898
|
* <p>This is the total contract value if accepted terms contain
|
|
@@ -913,6 +912,7 @@ export interface EstimatedCharges {
|
|
|
913
912
|
* This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or
|
|
914
913
|
* monthly), because the exact usage is not known upfront.</p>
|
|
915
914
|
* </note>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
agreementValue?: string;
|
|
918
918
|
}
|
|
@@ -921,61 +921,60 @@ export interface EstimatedCharges {
|
|
|
921
921
|
*/
|
|
922
922
|
export interface DescribeAgreementOutput {
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>The unique identifier of the agreement.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
agreementId?: string;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The details of the party accepting the agreement terms. This is commonly the buyer for
|
|
931
930
|
* <code>PurchaseAgreement</code>.</p>
|
|
931
|
+
* @public
|
|
932
932
|
*/
|
|
933
933
|
acceptor?: Acceptor;
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>The details of the party proposing the agreement terms. This is commonly the seller for
|
|
937
936
|
* <code>PurchaseAgreement</code>.</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
proposer?: Proposer;
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>The date and time when the agreement starts.</p>
|
|
942
|
+
* @public
|
|
943
943
|
*/
|
|
944
944
|
startTime?: Date;
|
|
945
945
|
/**
|
|
946
|
-
* @public
|
|
947
946
|
* <p>The date and time when the agreement ends. The field is <code>null</code> for
|
|
948
947
|
* pay-as-you-go agreements, which don’t have end dates.</p>
|
|
948
|
+
* @public
|
|
949
949
|
*/
|
|
950
950
|
endTime?: Date;
|
|
951
951
|
/**
|
|
952
|
-
* @public
|
|
953
952
|
* <p>The date and time the offer was accepted or the agreement was created.</p>
|
|
954
953
|
* <note>
|
|
955
954
|
* <p>
|
|
956
955
|
* <code>AcceptanceTime</code> and <code>StartTime</code> can differ for future dated
|
|
957
956
|
* agreements (FDAs).</p>
|
|
958
957
|
* </note>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
acceptanceTime?: Date;
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>The type of agreement. Values are <code>PurchaseAgreement</code> or
|
|
964
963
|
* <code>VendorInsightsAgreement</code>.</p>
|
|
964
|
+
* @public
|
|
965
965
|
*/
|
|
966
966
|
agreementType?: string;
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>The estimated cost of the agreement.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
estimatedCharges?: EstimatedCharges;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>A summary of the proposal received from the proposer.</p>
|
|
974
|
+
* @public
|
|
975
975
|
*/
|
|
976
976
|
proposalSummary?: ProposalSummary;
|
|
977
977
|
/**
|
|
978
|
-
* @public
|
|
979
978
|
* <p>The current status of the agreement.</p>
|
|
980
979
|
* <p>Statuses include:</p>
|
|
981
980
|
* <ul>
|
|
@@ -1024,19 +1023,20 @@ export interface DescribeAgreementOutput {
|
|
|
1024
1023
|
* of an AWS termination (for example, a payment failure).</p>
|
|
1025
1024
|
* </li>
|
|
1026
1025
|
* </ul>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
status?: AgreementStatus;
|
|
1029
1029
|
}
|
|
1030
1030
|
/**
|
|
1031
|
-
* @public
|
|
1032
1031
|
* <p>Unexpected error during processing of request.</p>
|
|
1032
|
+
* @public
|
|
1033
1033
|
*/
|
|
1034
1034
|
export declare class InternalServerException extends __BaseException {
|
|
1035
1035
|
readonly name: "InternalServerException";
|
|
1036
1036
|
readonly $fault: "server";
|
|
1037
1037
|
/**
|
|
1038
|
-
* @public
|
|
1039
1038
|
* <p>The unique identifier for the error.</p>
|
|
1039
|
+
* @public
|
|
1040
1040
|
*/
|
|
1041
1041
|
requestId?: string;
|
|
1042
1042
|
/**
|
|
@@ -1056,25 +1056,25 @@ export declare const ResourceType: {
|
|
|
1056
1056
|
*/
|
|
1057
1057
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>Request references a resource which does not exist.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
1063
1063
|
readonly name: "ResourceNotFoundException";
|
|
1064
1064
|
readonly $fault: "client";
|
|
1065
1065
|
/**
|
|
1066
|
-
* @public
|
|
1067
1066
|
* <p>The unique identifier for the error.</p>
|
|
1067
|
+
* @public
|
|
1068
1068
|
*/
|
|
1069
1069
|
requestId?: string;
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>The unique identifier for the resource.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
resourceId?: string;
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>The type of resource.</p>
|
|
1077
|
+
* @public
|
|
1078
1078
|
*/
|
|
1079
1079
|
resourceType?: ResourceType;
|
|
1080
1080
|
/**
|
|
@@ -1083,15 +1083,15 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1083
1083
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1084
1084
|
}
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <p>Request was denied due to request throttling.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
export declare class ThrottlingException extends __BaseException {
|
|
1090
1090
|
readonly name: "ThrottlingException";
|
|
1091
1091
|
readonly $fault: "client";
|
|
1092
1092
|
/**
|
|
1093
|
-
* @public
|
|
1094
1093
|
* <p>The unique identifier for the error.</p>
|
|
1094
|
+
* @public
|
|
1095
1095
|
*/
|
|
1096
1096
|
requestId?: string;
|
|
1097
1097
|
/**
|
|
@@ -1100,18 +1100,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
1100
1100
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1101
1101
|
}
|
|
1102
1102
|
/**
|
|
1103
|
-
* @public
|
|
1104
1103
|
* <p>The input fails to satisfy the constraints specified by the service.</p>
|
|
1104
|
+
* @public
|
|
1105
1105
|
*/
|
|
1106
1106
|
export interface ValidationExceptionField {
|
|
1107
1107
|
/**
|
|
1108
|
-
* @public
|
|
1109
1108
|
* <p>The name of the field associated with the error.</p>
|
|
1109
|
+
* @public
|
|
1110
1110
|
*/
|
|
1111
1111
|
name: string | undefined;
|
|
1112
1112
|
/**
|
|
1113
|
-
* @public
|
|
1114
1113
|
* <p>See applicable actions.</p>
|
|
1114
|
+
* @public
|
|
1115
1115
|
*/
|
|
1116
1116
|
message: string | undefined;
|
|
1117
1117
|
}
|
|
@@ -1137,25 +1137,25 @@ export declare const ValidationExceptionReason: {
|
|
|
1137
1137
|
*/
|
|
1138
1138
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
1139
1139
|
/**
|
|
1140
|
-
* @public
|
|
1141
1140
|
* <p>The input fails to satisfy the constraints specified by the service.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
export declare class ValidationException extends __BaseException {
|
|
1144
1144
|
readonly name: "ValidationException";
|
|
1145
1145
|
readonly $fault: "client";
|
|
1146
1146
|
/**
|
|
1147
|
-
* @public
|
|
1148
1147
|
* <p>The unique identifier associated with the error.</p>
|
|
1148
|
+
* @public
|
|
1149
1149
|
*/
|
|
1150
1150
|
requestId?: string;
|
|
1151
1151
|
/**
|
|
1152
|
-
* @public
|
|
1153
1152
|
* <p>The reason associated with the error.</p>
|
|
1153
|
+
* @public
|
|
1154
1154
|
*/
|
|
1155
1155
|
reason?: ValidationExceptionReason;
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>The fields associated with the error.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
fields?: ValidationExceptionField[];
|
|
1161
1161
|
/**
|
|
@@ -1168,18 +1168,18 @@ export declare class ValidationException extends __BaseException {
|
|
|
1168
1168
|
*/
|
|
1169
1169
|
export interface GetAgreementTermsInput {
|
|
1170
1170
|
/**
|
|
1171
|
-
* @public
|
|
1172
1171
|
* <p>The unique identifier of the agreement.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
agreementId: string | undefined;
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The maximum number of agreements to return in the response.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
maxResults?: number;
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>A token to specify where to start pagination</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
nextToken?: string;
|
|
1185
1185
|
}
|
|
@@ -1188,32 +1188,32 @@ export interface GetAgreementTermsInput {
|
|
|
1188
1188
|
*/
|
|
1189
1189
|
export interface GetAgreementTermsOutput {
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>A subset of terms proposed by the proposer that have been accepted by the acceptor as
|
|
1193
1192
|
* part of the agreement creation.</p>
|
|
1193
|
+
* @public
|
|
1194
1194
|
*/
|
|
1195
1195
|
acceptedTerms?: AcceptedTerm[];
|
|
1196
1196
|
/**
|
|
1197
|
-
* @public
|
|
1198
1197
|
* <p>A token to specify where to start pagination</p>
|
|
1198
|
+
* @public
|
|
1199
1199
|
*/
|
|
1200
1200
|
nextToken?: string;
|
|
1201
1201
|
}
|
|
1202
1202
|
/**
|
|
1203
|
-
* @public
|
|
1204
1203
|
* <p>The filter name and value pair that is used to return a more specific list of results.
|
|
1205
1204
|
* Filters can be used to match a set of resources by various criteria, such as
|
|
1206
1205
|
* <code>offerId</code> or <code>productId</code>.</p>
|
|
1206
|
+
* @public
|
|
1207
1207
|
*/
|
|
1208
1208
|
export interface Filter {
|
|
1209
1209
|
/**
|
|
1210
|
-
* @public
|
|
1211
1210
|
* <p>The name of the filter.</p>
|
|
1211
|
+
* @public
|
|
1212
1212
|
*/
|
|
1213
1213
|
name?: string;
|
|
1214
1214
|
/**
|
|
1215
|
-
* @public
|
|
1216
1215
|
* <p>The filter value.</p>
|
|
1216
|
+
* @public
|
|
1217
1217
|
*/
|
|
1218
1218
|
values?: string[];
|
|
1219
1219
|
}
|
|
@@ -1230,21 +1230,21 @@ export declare const SortOrder: {
|
|
|
1230
1230
|
*/
|
|
1231
1231
|
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>An object that contains the <code>SortBy</code> and <code>SortOrder</code>
|
|
1235
1234
|
* attributes.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
export interface Sort {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>The attribute on which the data is grouped, which can be by <code>StartTime</code> and
|
|
1241
1240
|
* <code>EndTime</code>. The default value is <code>EndTime</code>.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
sortBy?: string;
|
|
1244
1244
|
/**
|
|
1245
|
-
* @public
|
|
1246
1245
|
* <p>The sorting order, which can be <code>ASCENDING</code> or <code>DESCENDING</code>. The
|
|
1247
1246
|
* default value is <code>DESCENDING</code>.</p>
|
|
1247
|
+
* @public
|
|
1248
1248
|
*/
|
|
1249
1249
|
sortOrder?: SortOrder;
|
|
1250
1250
|
}
|
|
@@ -1253,12 +1253,11 @@ export interface Sort {
|
|
|
1253
1253
|
*/
|
|
1254
1254
|
export interface SearchAgreementsInput {
|
|
1255
1255
|
/**
|
|
1256
|
-
* @public
|
|
1257
1256
|
* <p>The catalog in which the agreement was created.</p>
|
|
1257
|
+
* @public
|
|
1258
1258
|
*/
|
|
1259
1259
|
catalog?: string;
|
|
1260
1260
|
/**
|
|
1261
|
-
* @public
|
|
1262
1261
|
* <p>The filter name and value pair used to return a specific list of results.</p>
|
|
1263
1262
|
* <p>The following filters are supported:</p>
|
|
1264
1263
|
* <ul>
|
|
@@ -1312,22 +1311,23 @@ export interface SearchAgreementsInput {
|
|
|
1312
1311
|
* <code>PurchaseAgreement</code> or <code>VendorInsightsAgreement</code>.</p>
|
|
1313
1312
|
* </li>
|
|
1314
1313
|
* </ul>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
filters?: Filter[];
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>An object that contains the <code>SortBy</code> and <code>SortOrder</code>
|
|
1320
1319
|
* attributes.</p>
|
|
1320
|
+
* @public
|
|
1321
1321
|
*/
|
|
1322
1322
|
sort?: Sort;
|
|
1323
1323
|
/**
|
|
1324
|
-
* @public
|
|
1325
1324
|
* <p>The maximum number of agreements to return in the response.</p>
|
|
1325
|
+
* @public
|
|
1326
1326
|
*/
|
|
1327
1327
|
maxResults?: number;
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>A token to specify where to start pagination.</p>
|
|
1330
|
+
* @public
|
|
1331
1331
|
*/
|
|
1332
1332
|
nextToken?: string;
|
|
1333
1333
|
}
|
|
@@ -1336,15 +1336,15 @@ export interface SearchAgreementsInput {
|
|
|
1336
1336
|
*/
|
|
1337
1337
|
export interface SearchAgreementsOutput {
|
|
1338
1338
|
/**
|
|
1339
|
-
* @public
|
|
1340
1339
|
* <p>A summary of the agreement, including top-level attributes (for example, the agreement
|
|
1341
1340
|
* ID, version, proposer, and acceptor).</p>
|
|
1341
|
+
* @public
|
|
1342
1342
|
*/
|
|
1343
1343
|
agreementViewSummaries?: AgreementViewSummary[];
|
|
1344
1344
|
/**
|
|
1345
|
-
* @public
|
|
1346
1345
|
* <p>The token used for pagination. The field is <code>null</code> if there are no more
|
|
1347
1346
|
* results.</p>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
nextToken?: string;
|
|
1350
1350
|
}
|