@aws-sdk/client-marketplace-agreement 3.463.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/LICENSE +201 -0
- package/README.md +249 -0
- package/dist-cjs/MarketplaceAgreement.js +17 -0
- package/dist-cjs/MarketplaceAgreementClient.js +43 -0
- package/dist-cjs/commands/DescribeAgreementCommand.js +51 -0
- package/dist-cjs/commands/GetAgreementTermsCommand.js +51 -0
- package/dist-cjs/commands/SearchAgreementsCommand.js +51 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +12 -0
- package/dist-cjs/models/MarketplaceAgreementServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +137 -0
- package/dist-cjs/pagination/GetAgreementTermsPaginator.js +29 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/SearchAgreementsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +6 -0
- package/dist-cjs/protocols/Aws_json1_0.js +420 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +50 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +24 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/MarketplaceAgreement.js +13 -0
- package/dist-es/MarketplaceAgreementClient.js +39 -0
- package/dist-es/commands/DescribeAgreementCommand.js +47 -0
- package/dist-es/commands/GetAgreementTermsCommand.js +47 -0
- package/dist-es/commands/SearchAgreementsCommand.js +47 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +7 -0
- package/dist-es/models/MarketplaceAgreementServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +129 -0
- package/dist-es/pagination/GetAgreementTermsPaginator.js +25 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/SearchAgreementsPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_0.js +411 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +45 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +20 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/MarketplaceAgreement.d.ts +51 -0
- package/dist-types/MarketplaceAgreementClient.d.ts +192 -0
- package/dist-types/commands/DescribeAgreementCommand.d.ts +112 -0
- package/dist-types/commands/GetAgreementTermsCommand.d.ts +235 -0
- package/dist-types/commands/SearchAgreementsCommand.d.ts +213 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +35 -0
- package/dist-types/models/MarketplaceAgreementServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1350 -0
- package/dist-types/pagination/GetAgreementTermsPaginator.d.ts +7 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/SearchAgreementsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +29 -0
- package/dist-types/runtimeConfig.browser.d.ts +46 -0
- package/dist-types/runtimeConfig.d.ts +46 -0
- package/dist-types/runtimeConfig.native.d.ts +45 -0
- package/dist-types/runtimeConfig.shared.d.ts +19 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/ts3.4/MarketplaceAgreement.d.ts +58 -0
- package/dist-types/ts3.4/MarketplaceAgreementClient.d.ts +139 -0
- package/dist-types/ts3.4/commands/DescribeAgreementCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetAgreementTermsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/SearchAgreementsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
- package/dist-types/ts3.4/index.d.ts +10 -0
- package/dist-types/ts3.4/models/MarketplaceAgreementServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +458 -0
- package/dist-types/ts3.4/pagination/GetAgreementTermsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/SearchAgreementsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +41 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +99 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +90 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +21 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +13 -0
- package/package.json +102 -0
|
@@ -0,0 +1,1350 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { MarketplaceAgreementServiceException as __BaseException } from "./MarketplaceAgreementServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>Enables you and your customers to move your existing agreements to AWS Marketplace. The
|
|
6
|
+
* customer won't be charged for product usage in AWS Marketplace because they already paid
|
|
7
|
+
* for the product outside of AWS Marketplace.</p>
|
|
8
|
+
*/
|
|
9
|
+
export interface ByolPricingTerm {
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
* <p>Type of the term being updated.</p>
|
|
13
|
+
*/
|
|
14
|
+
type?: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* <p>Defines the dimensions that the acceptor has purchased from the overall set of
|
|
19
|
+
* dimensions presented in the rate card.</p>
|
|
20
|
+
*/
|
|
21
|
+
export interface Dimension {
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
* <p>The name of key value of the dimension.</p>
|
|
25
|
+
*/
|
|
26
|
+
dimensionKey: string | undefined;
|
|
27
|
+
/**
|
|
28
|
+
* @public
|
|
29
|
+
* <p>The number of units of the dimension the acceptor has purchased.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>For Agreements with <code>ConfigurableUpfrontPricingTerm</code>, the
|
|
32
|
+
* <code>RateCard</code> section will define the prices and dimensions defined by the
|
|
33
|
+
* seller (proposer), whereas the <code>Configuration</code> section will define the actual
|
|
34
|
+
* dimensions, prices, and units the buyer has chosen to accept.</p>
|
|
35
|
+
* </note>
|
|
36
|
+
*/
|
|
37
|
+
dimensionValue: number | undefined;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they
|
|
42
|
+
* want to purchase and the duration.</p>
|
|
43
|
+
*/
|
|
44
|
+
export interface ConfigurableUpfrontPricingTermConfiguration {
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
* <p>Defines the length of time for which the particular pricing/dimension is being purchased
|
|
48
|
+
* by the acceptor.</p>
|
|
49
|
+
*/
|
|
50
|
+
selectorValue: string | undefined;
|
|
51
|
+
/**
|
|
52
|
+
* @public
|
|
53
|
+
* <p>Defines the dimensions that the acceptor has purchased from the overall set of
|
|
54
|
+
* dimensions presented in the rate card.</p>
|
|
55
|
+
*/
|
|
56
|
+
dimensions: Dimension[] | undefined;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
* <p>Defines limits on how the term can be configured by acceptors. </p>
|
|
61
|
+
*/
|
|
62
|
+
export interface Constraints {
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
* <p>Determines if buyers are allowed to select multiple dimensions in the rate card. The
|
|
66
|
+
* possible values are <code>Allowed</code> and <code>Disallowed</code>. The default value is
|
|
67
|
+
* <code>Allowed</code>.</p>
|
|
68
|
+
*/
|
|
69
|
+
multipleDimensionSelection?: string;
|
|
70
|
+
/**
|
|
71
|
+
* @public
|
|
72
|
+
* <p>Determines if acceptors are allowed to configure quantity for each dimension in rate
|
|
73
|
+
* card. The possible values are <code>Allowed</code> and <code>Disallowed</code>. The default
|
|
74
|
+
* value is <code>Allowed</code>.</p>
|
|
75
|
+
*/
|
|
76
|
+
quantityConfiguration?: string;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
* <p>Defines the per unit rates for each individual product dimension.</p>
|
|
81
|
+
*/
|
|
82
|
+
export interface RateCardItem {
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
* <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>
|
|
86
|
+
*/
|
|
87
|
+
dimensionKey?: string;
|
|
88
|
+
/**
|
|
89
|
+
* @public
|
|
90
|
+
* <p>Per unit price for the product dimension that’s used for calculating the amount to be charged.</p>
|
|
91
|
+
*/
|
|
92
|
+
price?: string;
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
* <p>Differentiates between the mutually exclusive rate cards in the same pricing term to be
|
|
97
|
+
* selected by the buyer.</p>
|
|
98
|
+
*/
|
|
99
|
+
export interface Selector {
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
* <p>Category of selector.</p>
|
|
103
|
+
*/
|
|
104
|
+
type?: string;
|
|
105
|
+
/**
|
|
106
|
+
* @public
|
|
107
|
+
* <p>Contract duration. This field supports the ISO 8601 format. </p>
|
|
108
|
+
*/
|
|
109
|
+
value?: string;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
* <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>
|
|
114
|
+
*/
|
|
115
|
+
export interface ConfigurableUpfrontRateCardItem {
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
* <p>Differentiates between the mutually exclusive rate cards in the same pricing term to be selected by the buyer.</p>
|
|
119
|
+
*/
|
|
120
|
+
selector?: Selector;
|
|
121
|
+
/**
|
|
122
|
+
* @public
|
|
123
|
+
* <p>Defines limits on how the term can be configured by acceptors.</p>
|
|
124
|
+
*/
|
|
125
|
+
constraints?: Constraints;
|
|
126
|
+
/**
|
|
127
|
+
* @public
|
|
128
|
+
* <p>Defines the per unit rates for product dimensions.</p>
|
|
129
|
+
*/
|
|
130
|
+
rateCard?: RateCardItem[];
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they
|
|
135
|
+
* want to purchase and the duration.</p>
|
|
136
|
+
*/
|
|
137
|
+
export interface ConfigurableUpfrontPricingTerm {
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
* <p>Category of selector.</p>
|
|
141
|
+
*/
|
|
142
|
+
type?: string;
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>Defines the currency for the prices mentioned in the term.</p>
|
|
146
|
+
*/
|
|
147
|
+
currencyCode?: string;
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* <p>A rate card defines the per unit rates for product dimensions.</p>
|
|
151
|
+
*/
|
|
152
|
+
rateCards?: ConfigurableUpfrontRateCardItem[];
|
|
153
|
+
/**
|
|
154
|
+
* @public
|
|
155
|
+
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
156
|
+
*/
|
|
157
|
+
configuration?: ConfigurableUpfrontPricingTermConfiguration;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* @public
|
|
161
|
+
* <p>Entitlements granted to the acceptor of fixed upfront as part of agreement execution.</p>
|
|
162
|
+
*/
|
|
163
|
+
export interface GrantItem {
|
|
164
|
+
/**
|
|
165
|
+
* @public
|
|
166
|
+
* <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>
|
|
167
|
+
*/
|
|
168
|
+
dimensionKey?: string;
|
|
169
|
+
/**
|
|
170
|
+
* @public
|
|
171
|
+
* <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>
|
|
172
|
+
*/
|
|
173
|
+
maxQuantity?: number;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
* <p>Defines a prepaid pricing model where the customers are charged a fixed upfront
|
|
178
|
+
* amount.</p>
|
|
179
|
+
*/
|
|
180
|
+
export interface FixedUpfrontPricingTerm {
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
* <p>Category of the term being updated.</p>
|
|
184
|
+
*/
|
|
185
|
+
type?: string;
|
|
186
|
+
/**
|
|
187
|
+
* @public
|
|
188
|
+
* <p>Defines the currency for the prices mentioned in this term. </p>
|
|
189
|
+
*/
|
|
190
|
+
currencyCode?: string;
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
* <p>Contract duration for the terms.</p>
|
|
194
|
+
*/
|
|
195
|
+
duration?: string;
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
* <p>Fixed amount to be charged to the customer when this term is accepted.</p>
|
|
199
|
+
*/
|
|
200
|
+
price?: string;
|
|
201
|
+
/**
|
|
202
|
+
* @public
|
|
203
|
+
* <p>Entitlements granted to the acceptor of fixed upfront as part of agreement
|
|
204
|
+
* execution.</p>
|
|
205
|
+
*/
|
|
206
|
+
grants?: GrantItem[];
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* @public
|
|
210
|
+
* <p>Defines a short-term free pricing model where the buyers aren’t charged anything within
|
|
211
|
+
* a specified limit.</p>
|
|
212
|
+
*/
|
|
213
|
+
export interface FreeTrialPricingTerm {
|
|
214
|
+
/**
|
|
215
|
+
* @public
|
|
216
|
+
* <p>Category of the term.</p>
|
|
217
|
+
*/
|
|
218
|
+
type?: string;
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* <p>Duration of the free trial period (5–31 days). </p>
|
|
222
|
+
*/
|
|
223
|
+
duration?: string;
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
* <p>Entitlements granted to the acceptor of a free trial as part of an agreement
|
|
227
|
+
* execution.</p>
|
|
228
|
+
*/
|
|
229
|
+
grants?: GrantItem[];
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* @public
|
|
233
|
+
* <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>
|
|
234
|
+
*/
|
|
235
|
+
export interface DocumentItem {
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
* <p>Category of the document. Document types include:</p>
|
|
239
|
+
* <ul>
|
|
240
|
+
* <li>
|
|
241
|
+
* <p>
|
|
242
|
+
* <code>CustomEula</code> – A custom EULA provided by you as seller. A URL for a
|
|
243
|
+
* EULA stored in an accessible Amazon S3 bucket is required for this document
|
|
244
|
+
* type.</p>
|
|
245
|
+
* </li>
|
|
246
|
+
* <li>
|
|
247
|
+
* <p>
|
|
248
|
+
* <code>CustomDsa</code> – A custom Data Subscription Agreement (DSA) provided by
|
|
249
|
+
* you as seller. A URL for a DSA stored in an accessible Amazon S3 bucket is required
|
|
250
|
+
* for this document type.</p>
|
|
251
|
+
* </li>
|
|
252
|
+
* <li>
|
|
253
|
+
* <p>
|
|
254
|
+
* <code>StandardEula</code> – The Standard Contract for AWS Marketplace (SCMP). For
|
|
255
|
+
* more information about SCMP, see the AWS Marketplace Seller Guide. You don’t provide
|
|
256
|
+
* a URL for this type because it’s managed by AWS Marketplace.</p>
|
|
257
|
+
* </li>
|
|
258
|
+
* <li>
|
|
259
|
+
* <p>
|
|
260
|
+
* <code>StandardDsa</code> – DSA for AWS Marketplace. For more information about the
|
|
261
|
+
* DSA, see the AWS Data Exchange User Guide. You don’t provide a URL for this type
|
|
262
|
+
* because it’s managed by AWS Marketplace.</p>
|
|
263
|
+
* </li>
|
|
264
|
+
* </ul>
|
|
265
|
+
*/
|
|
266
|
+
type?: string;
|
|
267
|
+
/**
|
|
268
|
+
* @public
|
|
269
|
+
* <p>A URL to the legal document for buyers to read. Required when <code>Type</code> is <code>CustomEula</code>.</p>
|
|
270
|
+
*/
|
|
271
|
+
url?: string;
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
* <p>Version of standard contracts provided by AWS Marketplace. Required when Type is <code>StandardEula</code> or <code>StandardDsa</code>. </p>
|
|
275
|
+
*/
|
|
276
|
+
version?: string;
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* @public
|
|
280
|
+
* <p>Defines the list of text agreements proposed to the acceptors. An example is the end
|
|
281
|
+
* user license agreement (EULA).</p>
|
|
282
|
+
*/
|
|
283
|
+
export interface LegalTerm {
|
|
284
|
+
/**
|
|
285
|
+
* @public
|
|
286
|
+
* <p>Category of the term being updated.</p>
|
|
287
|
+
*/
|
|
288
|
+
type?: string;
|
|
289
|
+
/**
|
|
290
|
+
* @public
|
|
291
|
+
* <p>List of references to legal resources proposed to the buyers. An example is the
|
|
292
|
+
* EULA.</p>
|
|
293
|
+
*/
|
|
294
|
+
documents?: DocumentItem[];
|
|
295
|
+
}
|
|
296
|
+
/**
|
|
297
|
+
* @public
|
|
298
|
+
* <p>An individual installment of the payment that includes the date and amount of the charge.</p>
|
|
299
|
+
*/
|
|
300
|
+
export interface ScheduleItem {
|
|
301
|
+
/**
|
|
302
|
+
* @public
|
|
303
|
+
* <p>The date that the customer would pay the price defined in this payment schedule term. Invoices are generated on the date provided.</p>
|
|
304
|
+
*/
|
|
305
|
+
chargeDate?: Date;
|
|
306
|
+
/**
|
|
307
|
+
* @public
|
|
308
|
+
* <p>The price that the customer would pay on the scheduled date (chargeDate).</p>
|
|
309
|
+
*/
|
|
310
|
+
chargeAmount?: string;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
* <p>Defines an installment-based pricing model where customers are charged a fixed price on
|
|
315
|
+
* different dates during the agreement validity period. This is used most commonly for
|
|
316
|
+
* flexible payment schedule pricing.</p>
|
|
317
|
+
*/
|
|
318
|
+
export interface PaymentScheduleTerm {
|
|
319
|
+
/**
|
|
320
|
+
* @public
|
|
321
|
+
* <p>Type of the term.</p>
|
|
322
|
+
*/
|
|
323
|
+
type?: string;
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
* <p>Defines the currency for the prices mentioned in the term. </p>
|
|
327
|
+
*/
|
|
328
|
+
currencyCode?: string;
|
|
329
|
+
/**
|
|
330
|
+
* @public
|
|
331
|
+
* <p>List of the payment schedule where each element defines one installment of payment. It
|
|
332
|
+
* contains the information necessary for calculating the price.</p>
|
|
333
|
+
*/
|
|
334
|
+
schedule?: ScheduleItem[];
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* <p>Defines a pricing model where customers are charged a fixed recurring price at the end
|
|
339
|
+
* of each billing period.</p>
|
|
340
|
+
*/
|
|
341
|
+
export interface RecurringPaymentTerm {
|
|
342
|
+
/**
|
|
343
|
+
* @public
|
|
344
|
+
* <p>Type of the term being updated.</p>
|
|
345
|
+
*/
|
|
346
|
+
type?: string;
|
|
347
|
+
/**
|
|
348
|
+
* @public
|
|
349
|
+
* <p>Defines the currency for the prices mentioned in this term. </p>
|
|
350
|
+
*/
|
|
351
|
+
currencyCode?: string;
|
|
352
|
+
/**
|
|
353
|
+
* @public
|
|
354
|
+
* <p>Defines the recurrence at which buyers are charged.</p>
|
|
355
|
+
*/
|
|
356
|
+
billingPeriod?: string;
|
|
357
|
+
/**
|
|
358
|
+
* @public
|
|
359
|
+
* <p>Amount charged to the buyer every billing period.</p>
|
|
360
|
+
*/
|
|
361
|
+
price?: string;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* @public
|
|
365
|
+
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
366
|
+
*/
|
|
367
|
+
export interface RenewalTermConfiguration {
|
|
368
|
+
/**
|
|
369
|
+
* @public
|
|
370
|
+
* <p>Defines whether the acceptor has chosen to auto-renew the agreement at the end of its
|
|
371
|
+
* lifecycle. Can be set to <code>True</code> or <code>False</code>.</p>
|
|
372
|
+
*/
|
|
373
|
+
enableAutoRenew: boolean | undefined;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
* <p>Defines that on graceful expiration of the agreement (when the agreement ends on its
|
|
378
|
+
* pre-defined end date), a new agreement will be created using the accepted terms on the
|
|
379
|
+
* existing agreement. In other words, the agreement will be renewed. The presence of
|
|
380
|
+
* <code>RenewalTerm</code> in the offer document means that auto-renewal is allowed.
|
|
381
|
+
* Buyers will have the option to accept or decline auto-renewal at the offer
|
|
382
|
+
* acceptance/agreement creation. Buyers can also change this flag from <code>True</code> to
|
|
383
|
+
* <code>False</code> or <code>False</code> to <code>True</code> at anytime during the
|
|
384
|
+
* agreement's lifecycle.</p>
|
|
385
|
+
*/
|
|
386
|
+
export interface RenewalTerm {
|
|
387
|
+
/**
|
|
388
|
+
* @public
|
|
389
|
+
* <p>Category of the term being updated. </p>
|
|
390
|
+
*/
|
|
391
|
+
type?: string;
|
|
392
|
+
/**
|
|
393
|
+
* @public
|
|
394
|
+
* <p>Additional parameters specified by the acceptor while accepting the term.</p>
|
|
395
|
+
*/
|
|
396
|
+
configuration?: RenewalTermConfiguration;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* @public
|
|
400
|
+
* <p>Defines the customer support available for the acceptors when they purchase the
|
|
401
|
+
* software.</p>
|
|
402
|
+
*/
|
|
403
|
+
export interface SupportTerm {
|
|
404
|
+
/**
|
|
405
|
+
* @public
|
|
406
|
+
* <p>Category of the term being updated.</p>
|
|
407
|
+
*/
|
|
408
|
+
type?: string;
|
|
409
|
+
/**
|
|
410
|
+
* @public
|
|
411
|
+
* <p>Free-text field about the refund policy description that will be shown to customers as
|
|
412
|
+
* is on the website and console.</p>
|
|
413
|
+
*/
|
|
414
|
+
refundPolicy?: string;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
* <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>
|
|
419
|
+
*/
|
|
420
|
+
export interface UsageBasedRateCardItem {
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
* <p>Defines the per unit rates for product dimensions.</p>
|
|
424
|
+
*/
|
|
425
|
+
rateCard?: RateCardItem[];
|
|
426
|
+
}
|
|
427
|
+
/**
|
|
428
|
+
* @public
|
|
429
|
+
* <p>Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the
|
|
430
|
+
* customers are charged based on product usage.</p>
|
|
431
|
+
*/
|
|
432
|
+
export interface UsageBasedPricingTerm {
|
|
433
|
+
/**
|
|
434
|
+
* @public
|
|
435
|
+
* <p>Category of the term.</p>
|
|
436
|
+
*/
|
|
437
|
+
type?: string;
|
|
438
|
+
/**
|
|
439
|
+
* @public
|
|
440
|
+
* <p>Defines the currency for the prices mentioned in the term. </p>
|
|
441
|
+
*/
|
|
442
|
+
currencyCode?: string;
|
|
443
|
+
/**
|
|
444
|
+
* @public
|
|
445
|
+
* <p>List of rate cards.</p>
|
|
446
|
+
*/
|
|
447
|
+
rateCards?: UsageBasedRateCardItem[];
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* @public
|
|
451
|
+
* <p>Defines the conditions that will keep an agreement created from this offer valid. </p>
|
|
452
|
+
*/
|
|
453
|
+
export interface ValidityTerm {
|
|
454
|
+
/**
|
|
455
|
+
* @public
|
|
456
|
+
* <p>Category of the term being updated. </p>
|
|
457
|
+
*/
|
|
458
|
+
type?: string;
|
|
459
|
+
/**
|
|
460
|
+
* @public
|
|
461
|
+
* <p>Defines the duration that the agreement remains active. If
|
|
462
|
+
* <code>AgreementStartDate</code> isn’t provided, the agreement duration is relative to
|
|
463
|
+
* the agreement signature time. The duration is represented in the ISO_8601 format.</p>
|
|
464
|
+
*/
|
|
465
|
+
agreementDuration?: string;
|
|
466
|
+
/**
|
|
467
|
+
* @public
|
|
468
|
+
* <p>Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the
|
|
469
|
+
* date provided. If <code>AgreementStartDate</code> isn’t provided, the agreement start date
|
|
470
|
+
* is determined based on agreement signature time.</p>
|
|
471
|
+
*/
|
|
472
|
+
agreementStartDate?: Date;
|
|
473
|
+
/**
|
|
474
|
+
* @public
|
|
475
|
+
* <p>Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the
|
|
476
|
+
* date provided. If <code>AgreementEndDate</code> isn’t provided, the agreement end date is
|
|
477
|
+
* determined by the validity of individual terms.</p>
|
|
478
|
+
*/
|
|
479
|
+
agreementEndDate?: Date;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
* <p>A subset of terms proposed by the proposer, which have been accepted by the acceptor as part of agreement creation.</p>
|
|
484
|
+
*/
|
|
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
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
export declare namespace AcceptedTerm {
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
* <p>Defines the list of text agreements proposed to the acceptors. An example is the end user license agreement (EULA).</p>
|
|
493
|
+
*/
|
|
494
|
+
interface LegalTermMember {
|
|
495
|
+
legalTerm: LegalTerm;
|
|
496
|
+
supportTerm?: never;
|
|
497
|
+
renewalTerm?: never;
|
|
498
|
+
usageBasedPricingTerm?: never;
|
|
499
|
+
configurableUpfrontPricingTerm?: never;
|
|
500
|
+
byolPricingTerm?: never;
|
|
501
|
+
recurringPaymentTerm?: never;
|
|
502
|
+
validityTerm?: never;
|
|
503
|
+
paymentScheduleTerm?: never;
|
|
504
|
+
freeTrialPricingTerm?: never;
|
|
505
|
+
fixedUpfrontPricingTerm?: never;
|
|
506
|
+
$unknown?: never;
|
|
507
|
+
}
|
|
508
|
+
/**
|
|
509
|
+
* @public
|
|
510
|
+
* <p>Defines the customer support available for the acceptors when they purchase the software.</p>
|
|
511
|
+
*/
|
|
512
|
+
interface SupportTermMember {
|
|
513
|
+
legalTerm?: never;
|
|
514
|
+
supportTerm: SupportTerm;
|
|
515
|
+
renewalTerm?: never;
|
|
516
|
+
usageBasedPricingTerm?: never;
|
|
517
|
+
configurableUpfrontPricingTerm?: never;
|
|
518
|
+
byolPricingTerm?: never;
|
|
519
|
+
recurringPaymentTerm?: never;
|
|
520
|
+
validityTerm?: never;
|
|
521
|
+
paymentScheduleTerm?: never;
|
|
522
|
+
freeTrialPricingTerm?: never;
|
|
523
|
+
fixedUpfrontPricingTerm?: never;
|
|
524
|
+
$unknown?: never;
|
|
525
|
+
}
|
|
526
|
+
/**
|
|
527
|
+
* @public
|
|
528
|
+
* <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>
|
|
529
|
+
*/
|
|
530
|
+
interface RenewalTermMember {
|
|
531
|
+
legalTerm?: never;
|
|
532
|
+
supportTerm?: never;
|
|
533
|
+
renewalTerm: RenewalTerm;
|
|
534
|
+
usageBasedPricingTerm?: never;
|
|
535
|
+
configurableUpfrontPricingTerm?: never;
|
|
536
|
+
byolPricingTerm?: never;
|
|
537
|
+
recurringPaymentTerm?: never;
|
|
538
|
+
validityTerm?: never;
|
|
539
|
+
paymentScheduleTerm?: never;
|
|
540
|
+
freeTrialPricingTerm?: never;
|
|
541
|
+
fixedUpfrontPricingTerm?: never;
|
|
542
|
+
$unknown?: never;
|
|
543
|
+
}
|
|
544
|
+
/**
|
|
545
|
+
* @public
|
|
546
|
+
* <p>Defines a usage-based pricing model (typically, pay-as-you-go pricing), where the customers are charged based on product usage.</p>
|
|
547
|
+
*/
|
|
548
|
+
interface UsageBasedPricingTermMember {
|
|
549
|
+
legalTerm?: never;
|
|
550
|
+
supportTerm?: never;
|
|
551
|
+
renewalTerm?: never;
|
|
552
|
+
usageBasedPricingTerm: UsageBasedPricingTerm;
|
|
553
|
+
configurableUpfrontPricingTerm?: never;
|
|
554
|
+
byolPricingTerm?: never;
|
|
555
|
+
recurringPaymentTerm?: never;
|
|
556
|
+
validityTerm?: never;
|
|
557
|
+
paymentScheduleTerm?: never;
|
|
558
|
+
freeTrialPricingTerm?: never;
|
|
559
|
+
fixedUpfrontPricingTerm?: never;
|
|
560
|
+
$unknown?: never;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* @public
|
|
564
|
+
* <p>Defines a prepaid payment model that allows buyers to configure the entitlements they want to purchase and the duration.</p>
|
|
565
|
+
*/
|
|
566
|
+
interface ConfigurableUpfrontPricingTermMember {
|
|
567
|
+
legalTerm?: never;
|
|
568
|
+
supportTerm?: never;
|
|
569
|
+
renewalTerm?: never;
|
|
570
|
+
usageBasedPricingTerm?: never;
|
|
571
|
+
configurableUpfrontPricingTerm: ConfigurableUpfrontPricingTerm;
|
|
572
|
+
byolPricingTerm?: never;
|
|
573
|
+
recurringPaymentTerm?: never;
|
|
574
|
+
validityTerm?: never;
|
|
575
|
+
paymentScheduleTerm?: never;
|
|
576
|
+
freeTrialPricingTerm?: never;
|
|
577
|
+
fixedUpfrontPricingTerm?: never;
|
|
578
|
+
$unknown?: never;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* @public
|
|
582
|
+
* <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>
|
|
583
|
+
*/
|
|
584
|
+
interface ByolPricingTermMember {
|
|
585
|
+
legalTerm?: never;
|
|
586
|
+
supportTerm?: never;
|
|
587
|
+
renewalTerm?: never;
|
|
588
|
+
usageBasedPricingTerm?: never;
|
|
589
|
+
configurableUpfrontPricingTerm?: never;
|
|
590
|
+
byolPricingTerm: ByolPricingTerm;
|
|
591
|
+
recurringPaymentTerm?: never;
|
|
592
|
+
validityTerm?: never;
|
|
593
|
+
paymentScheduleTerm?: never;
|
|
594
|
+
freeTrialPricingTerm?: never;
|
|
595
|
+
fixedUpfrontPricingTerm?: never;
|
|
596
|
+
$unknown?: never;
|
|
597
|
+
}
|
|
598
|
+
/**
|
|
599
|
+
* @public
|
|
600
|
+
* <p>Defines a pricing model where customers are charged a fixed recurring price at the end of each billing period.</p>
|
|
601
|
+
*/
|
|
602
|
+
interface RecurringPaymentTermMember {
|
|
603
|
+
legalTerm?: never;
|
|
604
|
+
supportTerm?: never;
|
|
605
|
+
renewalTerm?: never;
|
|
606
|
+
usageBasedPricingTerm?: never;
|
|
607
|
+
configurableUpfrontPricingTerm?: never;
|
|
608
|
+
byolPricingTerm?: never;
|
|
609
|
+
recurringPaymentTerm: RecurringPaymentTerm;
|
|
610
|
+
validityTerm?: never;
|
|
611
|
+
paymentScheduleTerm?: never;
|
|
612
|
+
freeTrialPricingTerm?: never;
|
|
613
|
+
fixedUpfrontPricingTerm?: never;
|
|
614
|
+
$unknown?: never;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
* <p>Defines the conditions that will keep an agreement created from this offer valid.</p>
|
|
619
|
+
*/
|
|
620
|
+
interface ValidityTermMember {
|
|
621
|
+
legalTerm?: never;
|
|
622
|
+
supportTerm?: never;
|
|
623
|
+
renewalTerm?: never;
|
|
624
|
+
usageBasedPricingTerm?: never;
|
|
625
|
+
configurableUpfrontPricingTerm?: never;
|
|
626
|
+
byolPricingTerm?: never;
|
|
627
|
+
recurringPaymentTerm?: never;
|
|
628
|
+
validityTerm: ValidityTerm;
|
|
629
|
+
paymentScheduleTerm?: never;
|
|
630
|
+
freeTrialPricingTerm?: never;
|
|
631
|
+
fixedUpfrontPricingTerm?: never;
|
|
632
|
+
$unknown?: never;
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* @public
|
|
636
|
+
* <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>
|
|
637
|
+
*/
|
|
638
|
+
interface PaymentScheduleTermMember {
|
|
639
|
+
legalTerm?: never;
|
|
640
|
+
supportTerm?: never;
|
|
641
|
+
renewalTerm?: never;
|
|
642
|
+
usageBasedPricingTerm?: never;
|
|
643
|
+
configurableUpfrontPricingTerm?: never;
|
|
644
|
+
byolPricingTerm?: never;
|
|
645
|
+
recurringPaymentTerm?: never;
|
|
646
|
+
validityTerm?: never;
|
|
647
|
+
paymentScheduleTerm: PaymentScheduleTerm;
|
|
648
|
+
freeTrialPricingTerm?: never;
|
|
649
|
+
fixedUpfrontPricingTerm?: never;
|
|
650
|
+
$unknown?: never;
|
|
651
|
+
}
|
|
652
|
+
/**
|
|
653
|
+
* @public
|
|
654
|
+
* <p>Defines a short-term free pricing model where the buyers aren’t charged anything within a specified limit.</p>
|
|
655
|
+
*/
|
|
656
|
+
interface FreeTrialPricingTermMember {
|
|
657
|
+
legalTerm?: never;
|
|
658
|
+
supportTerm?: never;
|
|
659
|
+
renewalTerm?: never;
|
|
660
|
+
usageBasedPricingTerm?: never;
|
|
661
|
+
configurableUpfrontPricingTerm?: never;
|
|
662
|
+
byolPricingTerm?: never;
|
|
663
|
+
recurringPaymentTerm?: never;
|
|
664
|
+
validityTerm?: never;
|
|
665
|
+
paymentScheduleTerm?: never;
|
|
666
|
+
freeTrialPricingTerm: FreeTrialPricingTerm;
|
|
667
|
+
fixedUpfrontPricingTerm?: never;
|
|
668
|
+
$unknown?: never;
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
* <p>Defines a pre-paid pricing model where the customers are charged a fixed upfront amount.</p>
|
|
673
|
+
*/
|
|
674
|
+
interface FixedUpfrontPricingTermMember {
|
|
675
|
+
legalTerm?: never;
|
|
676
|
+
supportTerm?: never;
|
|
677
|
+
renewalTerm?: never;
|
|
678
|
+
usageBasedPricingTerm?: never;
|
|
679
|
+
configurableUpfrontPricingTerm?: never;
|
|
680
|
+
byolPricingTerm?: never;
|
|
681
|
+
recurringPaymentTerm?: never;
|
|
682
|
+
validityTerm?: never;
|
|
683
|
+
paymentScheduleTerm?: never;
|
|
684
|
+
freeTrialPricingTerm?: never;
|
|
685
|
+
fixedUpfrontPricingTerm: FixedUpfrontPricingTerm;
|
|
686
|
+
$unknown?: never;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
interface $UnknownMember {
|
|
692
|
+
legalTerm?: never;
|
|
693
|
+
supportTerm?: never;
|
|
694
|
+
renewalTerm?: never;
|
|
695
|
+
usageBasedPricingTerm?: never;
|
|
696
|
+
configurableUpfrontPricingTerm?: never;
|
|
697
|
+
byolPricingTerm?: never;
|
|
698
|
+
recurringPaymentTerm?: never;
|
|
699
|
+
validityTerm?: never;
|
|
700
|
+
paymentScheduleTerm?: never;
|
|
701
|
+
freeTrialPricingTerm?: never;
|
|
702
|
+
fixedUpfrontPricingTerm?: never;
|
|
703
|
+
$unknown: [string, any];
|
|
704
|
+
}
|
|
705
|
+
interface Visitor<T> {
|
|
706
|
+
legalTerm: (value: LegalTerm) => T;
|
|
707
|
+
supportTerm: (value: SupportTerm) => T;
|
|
708
|
+
renewalTerm: (value: RenewalTerm) => T;
|
|
709
|
+
usageBasedPricingTerm: (value: UsageBasedPricingTerm) => T;
|
|
710
|
+
configurableUpfrontPricingTerm: (value: ConfigurableUpfrontPricingTerm) => T;
|
|
711
|
+
byolPricingTerm: (value: ByolPricingTerm) => T;
|
|
712
|
+
recurringPaymentTerm: (value: RecurringPaymentTerm) => T;
|
|
713
|
+
validityTerm: (value: ValidityTerm) => T;
|
|
714
|
+
paymentScheduleTerm: (value: PaymentScheduleTerm) => T;
|
|
715
|
+
freeTrialPricingTerm: (value: FreeTrialPricingTerm) => T;
|
|
716
|
+
fixedUpfrontPricingTerm: (value: FixedUpfrontPricingTerm) => T;
|
|
717
|
+
_: (name: string, value: any) => T;
|
|
718
|
+
}
|
|
719
|
+
const visit: <T>(value: AcceptedTerm, visitor: Visitor<T>) => T;
|
|
720
|
+
}
|
|
721
|
+
/**
|
|
722
|
+
* @public
|
|
723
|
+
* <p>The details of the party accepting the agreement terms. This is commonly the buyer for
|
|
724
|
+
* <code>PurchaseAgreement</code>.</p>
|
|
725
|
+
*/
|
|
726
|
+
export interface Acceptor {
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
* <p>The AWS account ID of the acceptor.</p>
|
|
730
|
+
*/
|
|
731
|
+
accountId?: string;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* @public
|
|
735
|
+
* <p>User does not have sufficient access to perform this action.</p>
|
|
736
|
+
*/
|
|
737
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
738
|
+
readonly name: "AccessDeniedException";
|
|
739
|
+
readonly $fault: "client";
|
|
740
|
+
/**
|
|
741
|
+
* @public
|
|
742
|
+
* <p>The unique identifier for the error.</p>
|
|
743
|
+
*/
|
|
744
|
+
requestId?: string;
|
|
745
|
+
/**
|
|
746
|
+
* @internal
|
|
747
|
+
*/
|
|
748
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
749
|
+
}
|
|
750
|
+
/**
|
|
751
|
+
* @public
|
|
752
|
+
* @enum
|
|
753
|
+
*/
|
|
754
|
+
export declare const AgreementStatus: {
|
|
755
|
+
readonly ACTIVE: "ACTIVE";
|
|
756
|
+
readonly ARCHIVED: "ARCHIVED";
|
|
757
|
+
readonly CANCELLED: "CANCELLED";
|
|
758
|
+
readonly EXPIRED: "EXPIRED";
|
|
759
|
+
readonly RENEWED: "RENEWED";
|
|
760
|
+
readonly REPLACED: "REPLACED";
|
|
761
|
+
readonly ROLLED_BACK: "ROLLED_BACK";
|
|
762
|
+
readonly SUPERSEDED: "SUPERSEDED";
|
|
763
|
+
readonly TERMINATED: "TERMINATED";
|
|
764
|
+
};
|
|
765
|
+
/**
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
export type AgreementStatus = (typeof AgreementStatus)[keyof typeof AgreementStatus];
|
|
769
|
+
/**
|
|
770
|
+
* @public
|
|
771
|
+
* <p>The list of resources involved in the agreement.</p>
|
|
772
|
+
*/
|
|
773
|
+
export interface Resource {
|
|
774
|
+
/**
|
|
775
|
+
* @public
|
|
776
|
+
* <p>The unique identifier of the resource.</p>
|
|
777
|
+
* <note>
|
|
778
|
+
* <p>We mention the term resource, which is most commonly a product, so a
|
|
779
|
+
* <code>resourceId</code> is also a <code>productId</code>.</p>
|
|
780
|
+
* </note>
|
|
781
|
+
*/
|
|
782
|
+
id?: string;
|
|
783
|
+
/**
|
|
784
|
+
* @public
|
|
785
|
+
* <p>Type of the resource, which is the product. Values include <code>SaaSProduct</code> or
|
|
786
|
+
* <code>AmiProduct</code>.</p>
|
|
787
|
+
*/
|
|
788
|
+
type?: string;
|
|
789
|
+
}
|
|
790
|
+
/**
|
|
791
|
+
* @public
|
|
792
|
+
* <p>A summary of the proposal received from the proposer.</p>
|
|
793
|
+
*/
|
|
794
|
+
export interface ProposalSummary {
|
|
795
|
+
/**
|
|
796
|
+
* @public
|
|
797
|
+
* <p>The list of resources involved in the agreement.</p>
|
|
798
|
+
*/
|
|
799
|
+
resources?: Resource[];
|
|
800
|
+
/**
|
|
801
|
+
* @public
|
|
802
|
+
* <p>The unique identifier of the offer in AWS Marketplace.</p>
|
|
803
|
+
*/
|
|
804
|
+
offerId?: string;
|
|
805
|
+
}
|
|
806
|
+
/**
|
|
807
|
+
* @public
|
|
808
|
+
* <p>Details of the party proposing the agreement terms,. This is commonly the seller for
|
|
809
|
+
* <code>PurchaseAgreement</code>. </p>
|
|
810
|
+
*/
|
|
811
|
+
export interface Proposer {
|
|
812
|
+
/**
|
|
813
|
+
* @public
|
|
814
|
+
* <p>The AWS account ID of the proposer.</p>
|
|
815
|
+
*/
|
|
816
|
+
accountId?: string;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* @public
|
|
820
|
+
* <p>A summary of the agreement, including top-level attributes (for example, the agreement
|
|
821
|
+
* ID, version, proposer, and acceptor).</p>
|
|
822
|
+
*/
|
|
823
|
+
export interface AgreementViewSummary {
|
|
824
|
+
/**
|
|
825
|
+
* @public
|
|
826
|
+
* <p>The unique identifier of the agreement.</p>
|
|
827
|
+
*/
|
|
828
|
+
agreementId?: string;
|
|
829
|
+
/**
|
|
830
|
+
* @public
|
|
831
|
+
* <p>The date and time that the agreement was accepted.</p>
|
|
832
|
+
*/
|
|
833
|
+
acceptanceTime?: Date;
|
|
834
|
+
/**
|
|
835
|
+
* @public
|
|
836
|
+
* <p>The date and time when the agreement starts.</p>
|
|
837
|
+
*/
|
|
838
|
+
startTime?: Date;
|
|
839
|
+
/**
|
|
840
|
+
* @public
|
|
841
|
+
* <p>The date and time when the agreement ends. The field is <code>null</code> for
|
|
842
|
+
* pay-as-you-go agreements, which don’t have end dates.</p>
|
|
843
|
+
*/
|
|
844
|
+
endTime?: Date;
|
|
845
|
+
/**
|
|
846
|
+
* @public
|
|
847
|
+
* <p>The type of agreement. Values are <code>PurchaseAgreement</code> or
|
|
848
|
+
* <code>VendorInsightsAgreement</code>.</p>
|
|
849
|
+
*/
|
|
850
|
+
agreementType?: string;
|
|
851
|
+
/**
|
|
852
|
+
* @public
|
|
853
|
+
* <p>Details of the party accepting the agreement terms. This is commonly the buyer for
|
|
854
|
+
* <code>PurchaseAgreement.</code>
|
|
855
|
+
* </p>
|
|
856
|
+
*/
|
|
857
|
+
acceptor?: Acceptor;
|
|
858
|
+
/**
|
|
859
|
+
* @public
|
|
860
|
+
* <p>Details of the party proposing the agreement terms, most commonly the seller for
|
|
861
|
+
* <code>PurchaseAgreement</code>.</p>
|
|
862
|
+
*/
|
|
863
|
+
proposer?: Proposer;
|
|
864
|
+
/**
|
|
865
|
+
* @public
|
|
866
|
+
* <p>A summary of the proposal</p>
|
|
867
|
+
*/
|
|
868
|
+
proposalSummary?: ProposalSummary;
|
|
869
|
+
/**
|
|
870
|
+
* @public
|
|
871
|
+
* <p>The current status of the agreement. </p>
|
|
872
|
+
*/
|
|
873
|
+
status?: AgreementStatus;
|
|
874
|
+
}
|
|
875
|
+
/**
|
|
876
|
+
* @public
|
|
877
|
+
*/
|
|
878
|
+
export interface DescribeAgreementInput {
|
|
879
|
+
/**
|
|
880
|
+
* @public
|
|
881
|
+
* <p>The unique identifier of the agreement.</p>
|
|
882
|
+
*/
|
|
883
|
+
agreementId: string | undefined;
|
|
884
|
+
}
|
|
885
|
+
/**
|
|
886
|
+
* @public
|
|
887
|
+
* <p>Estimated cost of the agreement.</p>
|
|
888
|
+
*/
|
|
889
|
+
export interface EstimatedCharges {
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
* <p>Defines the currency code for the charge.</p>
|
|
893
|
+
*/
|
|
894
|
+
currencyCode?: string;
|
|
895
|
+
/**
|
|
896
|
+
* @public
|
|
897
|
+
* <p>The total known amount customer has to pay across the lifecycle of the agreement.</p>
|
|
898
|
+
* <note>
|
|
899
|
+
* <p>This is the total contract value if accepted terms contain
|
|
900
|
+
* <code>ConfigurableUpfrontPricingTerm</code> or <code>FixedUpfrontPricingTerm</code>.
|
|
901
|
+
* In the case of pure contract pricing, this will be the total value of the contract. In
|
|
902
|
+
* the case of contracts with consumption pricing, this will only include the committed
|
|
903
|
+
* value and not include any overages that occur.</p>
|
|
904
|
+
* <p>If the accepted terms contain <code>PaymentScheduleTerm</code>, it will be the total
|
|
905
|
+
* payment schedule amount. This occurs when flexible payment schedule is used, and is the
|
|
906
|
+
* sum of all invoice charges in the payment schedule.</p>
|
|
907
|
+
* <p>In case a customer has amended an agreement, by purchasing more units of any
|
|
908
|
+
* dimension, this will include both the original cost as well as the added cost incurred
|
|
909
|
+
* due to addition of new units. </p>
|
|
910
|
+
* <p>This is <code>0</code> if the accepted terms contain
|
|
911
|
+
* <code>UsageBasedPricingTerm</code> without
|
|
912
|
+
* <code>ConfigurableUpfrontPricingTerm</code> or <code>RecurringPaymentTerm</code>.
|
|
913
|
+
* This occurs for usage-based pricing (such as SaaS metered or AMI/container hourly or
|
|
914
|
+
* monthly), because the exact usage is not known upfront.</p>
|
|
915
|
+
* </note>
|
|
916
|
+
*/
|
|
917
|
+
agreementValue?: string;
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
export interface DescribeAgreementOutput {
|
|
923
|
+
/**
|
|
924
|
+
* @public
|
|
925
|
+
* <p>The unique identifier of the agreement.</p>
|
|
926
|
+
*/
|
|
927
|
+
agreementId?: string;
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
* <p>The details of the party accepting the agreement terms. This is commonly the buyer for
|
|
931
|
+
* <code>PurchaseAgreement</code>.</p>
|
|
932
|
+
*/
|
|
933
|
+
acceptor?: Acceptor;
|
|
934
|
+
/**
|
|
935
|
+
* @public
|
|
936
|
+
* <p>The details of the party proposing the agreement terms. This is commonly the seller for
|
|
937
|
+
* <code>PurchaseAgreement</code>.</p>
|
|
938
|
+
*/
|
|
939
|
+
proposer?: Proposer;
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
* <p>The date and time when the agreement starts.</p>
|
|
943
|
+
*/
|
|
944
|
+
startTime?: Date;
|
|
945
|
+
/**
|
|
946
|
+
* @public
|
|
947
|
+
* <p>The date and time when the agreement ends. The field is <code>null</code> for
|
|
948
|
+
* pay-as-you-go agreements, which don’t have end dates.</p>
|
|
949
|
+
*/
|
|
950
|
+
endTime?: Date;
|
|
951
|
+
/**
|
|
952
|
+
* @public
|
|
953
|
+
* <p>The date and time the offer was accepted or the agreement was created.</p>
|
|
954
|
+
* <note>
|
|
955
|
+
* <p>
|
|
956
|
+
* <code>AcceptanceTime</code> and <code>StartTime</code> can differ for future dated
|
|
957
|
+
* agreements (FDAs).</p>
|
|
958
|
+
* </note>
|
|
959
|
+
*/
|
|
960
|
+
acceptanceTime?: Date;
|
|
961
|
+
/**
|
|
962
|
+
* @public
|
|
963
|
+
* <p>The type of agreement. Values are <code>PurchaseAgreement</code> or
|
|
964
|
+
* <code>VendorInsightsAgreement</code>.</p>
|
|
965
|
+
*/
|
|
966
|
+
agreementType?: string;
|
|
967
|
+
/**
|
|
968
|
+
* @public
|
|
969
|
+
* <p>The estimated cost of the agreement.</p>
|
|
970
|
+
*/
|
|
971
|
+
estimatedCharges?: EstimatedCharges;
|
|
972
|
+
/**
|
|
973
|
+
* @public
|
|
974
|
+
* <p>A summary of the proposal received from the proposer.</p>
|
|
975
|
+
*/
|
|
976
|
+
proposalSummary?: ProposalSummary;
|
|
977
|
+
/**
|
|
978
|
+
* @public
|
|
979
|
+
* <p>The current status of the agreement.</p>
|
|
980
|
+
* <p>Statuses include:</p>
|
|
981
|
+
* <ul>
|
|
982
|
+
* <li>
|
|
983
|
+
* <p>
|
|
984
|
+
* <code>ACTIVE</code> – The terms of the agreement are active.</p>
|
|
985
|
+
* </li>
|
|
986
|
+
* <li>
|
|
987
|
+
* <p>
|
|
988
|
+
* <code>ARCHIVED</code> – The agreement ended without a specified reason.</p>
|
|
989
|
+
* </li>
|
|
990
|
+
* <li>
|
|
991
|
+
* <p>
|
|
992
|
+
* <code>CANCELLED</code> – The acceptor ended the agreement before the defined end
|
|
993
|
+
* date.</p>
|
|
994
|
+
* </li>
|
|
995
|
+
* <li>
|
|
996
|
+
* <p>
|
|
997
|
+
* <code>EXPIRED</code> – The agreement ended on the defined end date.</p>
|
|
998
|
+
* </li>
|
|
999
|
+
* <li>
|
|
1000
|
+
* <p>
|
|
1001
|
+
* <code>RENEWED</code> – The agreement was renewed into a new agreement (for
|
|
1002
|
+
* example, an auto-renewal).</p>
|
|
1003
|
+
* </li>
|
|
1004
|
+
* <li>
|
|
1005
|
+
* <p>
|
|
1006
|
+
* <code>REPLACED</code> – The agreement was replaced using an agreement replacement
|
|
1007
|
+
* offer.</p>
|
|
1008
|
+
* </li>
|
|
1009
|
+
* <li>
|
|
1010
|
+
* <p>
|
|
1011
|
+
* <code>ROLLED_BACK</code> (Only applicable to inactive agreement revisions) – The
|
|
1012
|
+
* agreement revision has been rolled back because of an error. An earlier revision is
|
|
1013
|
+
* now active.</p>
|
|
1014
|
+
* </li>
|
|
1015
|
+
* <li>
|
|
1016
|
+
* <p>
|
|
1017
|
+
* <code>SUPERCEDED</code> (Only applicable to inactive agreement revisions) – The
|
|
1018
|
+
* agreement revision is no longer active and another agreement revision is now
|
|
1019
|
+
* active.</p>
|
|
1020
|
+
* </li>
|
|
1021
|
+
* <li>
|
|
1022
|
+
* <p>
|
|
1023
|
+
* <code>TERMINATED</code> – The agreement ended before the defined end date because
|
|
1024
|
+
* of an AWS termination (for example, a payment failure).</p>
|
|
1025
|
+
* </li>
|
|
1026
|
+
* </ul>
|
|
1027
|
+
*/
|
|
1028
|
+
status?: AgreementStatus;
|
|
1029
|
+
}
|
|
1030
|
+
/**
|
|
1031
|
+
* @public
|
|
1032
|
+
* <p>Unexpected error during processing of request.</p>
|
|
1033
|
+
*/
|
|
1034
|
+
export declare class InternalServerException extends __BaseException {
|
|
1035
|
+
readonly name: "InternalServerException";
|
|
1036
|
+
readonly $fault: "server";
|
|
1037
|
+
/**
|
|
1038
|
+
* @public
|
|
1039
|
+
* <p>The unique identifier for the error.</p>
|
|
1040
|
+
*/
|
|
1041
|
+
requestId?: string;
|
|
1042
|
+
/**
|
|
1043
|
+
* @internal
|
|
1044
|
+
*/
|
|
1045
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* @public
|
|
1049
|
+
* @enum
|
|
1050
|
+
*/
|
|
1051
|
+
export declare const ResourceType: {
|
|
1052
|
+
readonly AGREEMENT: "Agreement";
|
|
1053
|
+
};
|
|
1054
|
+
/**
|
|
1055
|
+
* @public
|
|
1056
|
+
*/
|
|
1057
|
+
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
1058
|
+
/**
|
|
1059
|
+
* @public
|
|
1060
|
+
* <p>Request references a resource which does not exist.</p>
|
|
1061
|
+
*/
|
|
1062
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
1063
|
+
readonly name: "ResourceNotFoundException";
|
|
1064
|
+
readonly $fault: "client";
|
|
1065
|
+
/**
|
|
1066
|
+
* @public
|
|
1067
|
+
* <p>The unique identifier for the error.</p>
|
|
1068
|
+
*/
|
|
1069
|
+
requestId?: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* @public
|
|
1072
|
+
* <p>The unique identifier for the resource.</p>
|
|
1073
|
+
*/
|
|
1074
|
+
resourceId?: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* @public
|
|
1077
|
+
* <p>The type of resource.</p>
|
|
1078
|
+
*/
|
|
1079
|
+
resourceType?: ResourceType;
|
|
1080
|
+
/**
|
|
1081
|
+
* @internal
|
|
1082
|
+
*/
|
|
1083
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1084
|
+
}
|
|
1085
|
+
/**
|
|
1086
|
+
* @public
|
|
1087
|
+
* <p>Request was denied due to request throttling.</p>
|
|
1088
|
+
*/
|
|
1089
|
+
export declare class ThrottlingException extends __BaseException {
|
|
1090
|
+
readonly name: "ThrottlingException";
|
|
1091
|
+
readonly $fault: "client";
|
|
1092
|
+
/**
|
|
1093
|
+
* @public
|
|
1094
|
+
* <p>The unique identifier for the error.</p>
|
|
1095
|
+
*/
|
|
1096
|
+
requestId?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* @internal
|
|
1099
|
+
*/
|
|
1100
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1101
|
+
}
|
|
1102
|
+
/**
|
|
1103
|
+
* @public
|
|
1104
|
+
* <p>The input fails to satisfy the constraints specified by the service.</p>
|
|
1105
|
+
*/
|
|
1106
|
+
export interface ValidationExceptionField {
|
|
1107
|
+
/**
|
|
1108
|
+
* @public
|
|
1109
|
+
* <p>The name of the field associated with the error.</p>
|
|
1110
|
+
*/
|
|
1111
|
+
name: string | undefined;
|
|
1112
|
+
/**
|
|
1113
|
+
* @public
|
|
1114
|
+
* <p>See applicable actions.</p>
|
|
1115
|
+
*/
|
|
1116
|
+
message: string | undefined;
|
|
1117
|
+
}
|
|
1118
|
+
/**
|
|
1119
|
+
* @public
|
|
1120
|
+
* @enum
|
|
1121
|
+
*/
|
|
1122
|
+
export declare const ValidationExceptionReason: {
|
|
1123
|
+
readonly INVALID_AGREEMENT_ID: "INVALID_AGREEMENT_ID";
|
|
1124
|
+
readonly INVALID_CATALOG: "INVALID_CATALOG";
|
|
1125
|
+
readonly INVALID_FILTER_NAME: "INVALID_FILTER_NAME";
|
|
1126
|
+
readonly INVALID_FILTER_VALUES: "INVALID_FILTER_VALUES";
|
|
1127
|
+
readonly INVALID_MAX_RESULTS: "INVALID_MAX_RESULTS";
|
|
1128
|
+
readonly INVALID_NEXT_TOKEN: "INVALID_NEXT_TOKEN";
|
|
1129
|
+
readonly INVALID_SORT_BY: "INVALID_SORT_BY";
|
|
1130
|
+
readonly INVALID_SORT_ORDER: "INVALID_SORT_ORDER";
|
|
1131
|
+
readonly MISSING_AGREEMENT_ID: "MISSING_AGREEMENT_ID";
|
|
1132
|
+
readonly OTHER: "OTHER";
|
|
1133
|
+
readonly UNSUPPORTED_FILTERS: "UNSUPPORTED_FILTERS";
|
|
1134
|
+
};
|
|
1135
|
+
/**
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
1139
|
+
/**
|
|
1140
|
+
* @public
|
|
1141
|
+
* <p>The input fails to satisfy the constraints specified by the service.</p>
|
|
1142
|
+
*/
|
|
1143
|
+
export declare class ValidationException extends __BaseException {
|
|
1144
|
+
readonly name: "ValidationException";
|
|
1145
|
+
readonly $fault: "client";
|
|
1146
|
+
/**
|
|
1147
|
+
* @public
|
|
1148
|
+
* <p>The unique identifier associated with the error.</p>
|
|
1149
|
+
*/
|
|
1150
|
+
requestId?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* @public
|
|
1153
|
+
* <p>The reason associated with the error.</p>
|
|
1154
|
+
*/
|
|
1155
|
+
reason?: ValidationExceptionReason;
|
|
1156
|
+
/**
|
|
1157
|
+
* @public
|
|
1158
|
+
* <p>The fields associated with the error.</p>
|
|
1159
|
+
*/
|
|
1160
|
+
fields?: ValidationExceptionField[];
|
|
1161
|
+
/**
|
|
1162
|
+
* @internal
|
|
1163
|
+
*/
|
|
1164
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
1165
|
+
}
|
|
1166
|
+
/**
|
|
1167
|
+
* @public
|
|
1168
|
+
*/
|
|
1169
|
+
export interface GetAgreementTermsInput {
|
|
1170
|
+
/**
|
|
1171
|
+
* @public
|
|
1172
|
+
* <p>The unique identifier of the agreement.</p>
|
|
1173
|
+
*/
|
|
1174
|
+
agreementId: string | undefined;
|
|
1175
|
+
/**
|
|
1176
|
+
* @public
|
|
1177
|
+
* <p>The maximum number of agreements to return in the response.</p>
|
|
1178
|
+
*/
|
|
1179
|
+
maxResults?: number;
|
|
1180
|
+
/**
|
|
1181
|
+
* @public
|
|
1182
|
+
* <p>A token to specify where to start pagination</p>
|
|
1183
|
+
*/
|
|
1184
|
+
nextToken?: string;
|
|
1185
|
+
}
|
|
1186
|
+
/**
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
export interface GetAgreementTermsOutput {
|
|
1190
|
+
/**
|
|
1191
|
+
* @public
|
|
1192
|
+
* <p>A subset of terms proposed by the proposer that have been accepted by the acceptor as
|
|
1193
|
+
* part of the agreement creation.</p>
|
|
1194
|
+
*/
|
|
1195
|
+
acceptedTerms?: AcceptedTerm[];
|
|
1196
|
+
/**
|
|
1197
|
+
* @public
|
|
1198
|
+
* <p>A token to specify where to start pagination</p>
|
|
1199
|
+
*/
|
|
1200
|
+
nextToken?: string;
|
|
1201
|
+
}
|
|
1202
|
+
/**
|
|
1203
|
+
* @public
|
|
1204
|
+
* <p>The filter name and value pair that is used to return a more specific list of results.
|
|
1205
|
+
* Filters can be used to match a set of resources by various criteria, such as
|
|
1206
|
+
* <code>offerId</code> or <code>productId</code>.</p>
|
|
1207
|
+
*/
|
|
1208
|
+
export interface Filter {
|
|
1209
|
+
/**
|
|
1210
|
+
* @public
|
|
1211
|
+
* <p>The name of the filter.</p>
|
|
1212
|
+
*/
|
|
1213
|
+
name?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* @public
|
|
1216
|
+
* <p>The filter value.</p>
|
|
1217
|
+
*/
|
|
1218
|
+
values?: string[];
|
|
1219
|
+
}
|
|
1220
|
+
/**
|
|
1221
|
+
* @public
|
|
1222
|
+
* @enum
|
|
1223
|
+
*/
|
|
1224
|
+
export declare const SortOrder: {
|
|
1225
|
+
readonly ASCENDING: "ASCENDING";
|
|
1226
|
+
readonly DESCENDING: "DESCENDING";
|
|
1227
|
+
};
|
|
1228
|
+
/**
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
1232
|
+
/**
|
|
1233
|
+
* @public
|
|
1234
|
+
* <p>An object that contains the <code>SortBy</code> and <code>SortOrder</code>
|
|
1235
|
+
* attributes.</p>
|
|
1236
|
+
*/
|
|
1237
|
+
export interface Sort {
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
* <p>The attribute on which the data is grouped, which can be by <code>StartTime</code> and
|
|
1241
|
+
* <code>EndTime</code>. The default value is <code>EndTime</code>.</p>
|
|
1242
|
+
*/
|
|
1243
|
+
sortBy?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* @public
|
|
1246
|
+
* <p>The sorting order, which can be <code>ASCENDING</code> or <code>DESCENDING</code>. The
|
|
1247
|
+
* default value is <code>DESCENDING</code>.</p>
|
|
1248
|
+
*/
|
|
1249
|
+
sortOrder?: SortOrder;
|
|
1250
|
+
}
|
|
1251
|
+
/**
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
export interface SearchAgreementsInput {
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
* <p>The catalog in which the agreement was created.</p>
|
|
1258
|
+
*/
|
|
1259
|
+
catalog?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* @public
|
|
1262
|
+
* <p>The filter name and value pair used to return a specific list of results.</p>
|
|
1263
|
+
* <p>The following filters are supported:</p>
|
|
1264
|
+
* <ul>
|
|
1265
|
+
* <li>
|
|
1266
|
+
* <p>
|
|
1267
|
+
* <code>ResourceIdentifier</code> – The unique identifier of the resource.</p>
|
|
1268
|
+
* </li>
|
|
1269
|
+
* <li>
|
|
1270
|
+
* <p>
|
|
1271
|
+
* <code>ResourceType</code> – Type of the resource, which is the product
|
|
1272
|
+
* (<code>AmiProduct</code>, <code>ContainerProduct</code>, or
|
|
1273
|
+
* <code>SaaSProduct</code>).</p>
|
|
1274
|
+
* </li>
|
|
1275
|
+
* <li>
|
|
1276
|
+
* <p>
|
|
1277
|
+
* <code>PartyType</code> – The party type (either <code>Acceptor</code> or
|
|
1278
|
+
* <code>Proposer</code>) of the caller. For agreements where the caller is the
|
|
1279
|
+
* proposer, use the <code>Proposer</code> filter. For agreements where the caller is
|
|
1280
|
+
* the acceptor, use the <code>Acceptor</code> filter.</p>
|
|
1281
|
+
* </li>
|
|
1282
|
+
* <li>
|
|
1283
|
+
* <p>
|
|
1284
|
+
* <code>AcceptorAccountId</code> – The AWS account ID of the party accepting the
|
|
1285
|
+
* agreement terms.</p>
|
|
1286
|
+
* </li>
|
|
1287
|
+
* <li>
|
|
1288
|
+
* <p>
|
|
1289
|
+
* <code>OfferId</code> – The unique identifier of the offer in which the terms are
|
|
1290
|
+
* registered in the agreement token.</p>
|
|
1291
|
+
* </li>
|
|
1292
|
+
* <li>
|
|
1293
|
+
* <p>
|
|
1294
|
+
* <code>Status</code> – The current status of the agreement. Values include
|
|
1295
|
+
* <code>ACTIVE</code>, <code>ARCHIVED</code>, <code>CANCELLED</code>,
|
|
1296
|
+
* <code>EXPIRED</code>, <code>RENEWED</code>, <code>REPLACED</code>, and
|
|
1297
|
+
* <code>TERMINATED</code>.</p>
|
|
1298
|
+
* </li>
|
|
1299
|
+
* <li>
|
|
1300
|
+
* <p>
|
|
1301
|
+
* <code>BeforeEndTime</code> – A date used to filter agreements with a date before
|
|
1302
|
+
* the <code>endTime</code> of an agreement.</p>
|
|
1303
|
+
* </li>
|
|
1304
|
+
* <li>
|
|
1305
|
+
* <p>
|
|
1306
|
+
* <code>AfterEndTime</code> – A date used to filter agreements with a date after the
|
|
1307
|
+
* <code>endTime</code> of an agreement.</p>
|
|
1308
|
+
* </li>
|
|
1309
|
+
* <li>
|
|
1310
|
+
* <p>
|
|
1311
|
+
* <code>AgreementType</code> – The type of agreement. Values include
|
|
1312
|
+
* <code>PurchaseAgreement</code> or <code>VendorInsightsAgreement</code>.</p>
|
|
1313
|
+
* </li>
|
|
1314
|
+
* </ul>
|
|
1315
|
+
*/
|
|
1316
|
+
filters?: Filter[];
|
|
1317
|
+
/**
|
|
1318
|
+
* @public
|
|
1319
|
+
* <p>An object that contains the <code>SortBy</code> and <code>SortOrder</code>
|
|
1320
|
+
* attributes.</p>
|
|
1321
|
+
*/
|
|
1322
|
+
sort?: Sort;
|
|
1323
|
+
/**
|
|
1324
|
+
* @public
|
|
1325
|
+
* <p>The maximum number of agreements to return in the response.</p>
|
|
1326
|
+
*/
|
|
1327
|
+
maxResults?: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* @public
|
|
1330
|
+
* <p>A token to specify where to start pagination.</p>
|
|
1331
|
+
*/
|
|
1332
|
+
nextToken?: string;
|
|
1333
|
+
}
|
|
1334
|
+
/**
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
export interface SearchAgreementsOutput {
|
|
1338
|
+
/**
|
|
1339
|
+
* @public
|
|
1340
|
+
* <p>A summary of the agreement, including top-level attributes (for example, the agreement
|
|
1341
|
+
* ID, version, proposer, and acceptor).</p>
|
|
1342
|
+
*/
|
|
1343
|
+
agreementViewSummaries?: AgreementViewSummary[];
|
|
1344
|
+
/**
|
|
1345
|
+
* @public
|
|
1346
|
+
* <p>The token used for pagination. The field is <code>null</code> if there are no more
|
|
1347
|
+
* results.</p>
|
|
1348
|
+
*/
|
|
1349
|
+
nextToken?: string;
|
|
1350
|
+
}
|