@aws-sdk/client-pricing 3.379.1 → 3.382.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.
@@ -21,6 +21,7 @@ export declare class AccessDeniedException extends __BaseException {
21
21
  */
22
22
  export interface AttributeValue {
23
23
  /**
24
+ * @public
24
25
  * <p>The specific value of an <code>attributeName</code>.</p>
25
26
  */
26
27
  Value?: string;
@@ -30,6 +31,7 @@ export interface AttributeValue {
30
31
  */
31
32
  export interface DescribeServicesRequest {
32
33
  /**
34
+ * @public
33
35
  * <p>The code for the service whose information you want to retrieve, such as <code>AmazonEC2</code>.
34
36
  * You can use
35
37
  * the <code>ServiceCode</code> to filter the results in a <code>GetProducts</code> call.
@@ -37,16 +39,19 @@ export interface DescribeServicesRequest {
37
39
  */
38
40
  ServiceCode?: string;
39
41
  /**
42
+ * @public
40
43
  * <p>The format version that you want the response to be in.</p>
41
44
  * <p>Valid values are: <code>aws_v1</code>
42
45
  * </p>
43
46
  */
44
47
  FormatVersion?: string;
45
48
  /**
49
+ * @public
46
50
  * <p>The pagination token that indicates the next set of results that you want to retrieve.</p>
47
51
  */
48
52
  NextToken?: string;
49
53
  /**
54
+ * @public
50
55
  * <p>The maximum number of results that you want returned in the response.</p>
51
56
  */
52
57
  MaxResults?: number;
@@ -57,10 +62,12 @@ export interface DescribeServicesRequest {
57
62
  */
58
63
  export interface Service {
59
64
  /**
65
+ * @public
60
66
  * <p>The code for the Amazon Web Services service.</p>
61
67
  */
62
68
  ServiceCode: string | undefined;
63
69
  /**
70
+ * @public
64
71
  * <p>The attributes that are available for this service.</p>
65
72
  */
66
73
  AttributeNames?: string[];
@@ -70,14 +77,17 @@ export interface Service {
70
77
  */
71
78
  export interface DescribeServicesResponse {
72
79
  /**
80
+ * @public
73
81
  * <p>The service metadata for the service or services in the response.</p>
74
82
  */
75
83
  Services?: Service[];
76
84
  /**
85
+ * @public
77
86
  * <p>The format version of the response. For example, <code>aws_v1</code>.</p>
78
87
  */
79
88
  FormatVersion?: string;
80
89
  /**
90
+ * @public
81
91
  * <p>The pagination token for the next set of retrievable results.</p>
82
92
  */
83
93
  NextToken?: string;
@@ -152,19 +162,23 @@ export declare class NotFoundException extends __BaseException {
152
162
  */
153
163
  export interface GetAttributeValuesRequest {
154
164
  /**
165
+ * @public
155
166
  * <p>The service code for the service whose attributes you want to retrieve. For example, if you want
156
167
  * the retrieve an EC2 attribute, use <code>AmazonEC2</code>.</p>
157
168
  */
158
169
  ServiceCode: string | undefined;
159
170
  /**
171
+ * @public
160
172
  * <p>The name of the attribute that you want to retrieve the values for, such as <code>volumeType</code>.</p>
161
173
  */
162
174
  AttributeName: string | undefined;
163
175
  /**
176
+ * @public
164
177
  * <p>The pagination token that indicates the next set of results that you want to retrieve.</p>
165
178
  */
166
179
  NextToken?: string;
167
180
  /**
181
+ * @public
168
182
  * <p>The maximum number of results to return in response.</p>
169
183
  */
170
184
  MaxResults?: number;
@@ -174,12 +188,14 @@ export interface GetAttributeValuesRequest {
174
188
  */
175
189
  export interface GetAttributeValuesResponse {
176
190
  /**
191
+ * @public
177
192
  * <p>The list of values for an attribute. For example, <code>Throughput Optimized HDD</code> and
178
193
  * <code>Provisioned IOPS</code> are two available values for the <code>AmazonEC2</code>
179
194
  * <code>volumeType</code>.</p>
180
195
  */
181
196
  AttributeValues?: AttributeValue[];
182
197
  /**
198
+ * @public
183
199
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
184
200
  */
185
201
  NextToken?: string;
@@ -189,6 +205,7 @@ export interface GetAttributeValuesResponse {
189
205
  */
190
206
  export interface GetPriceListFileUrlRequest {
191
207
  /**
208
+ * @public
192
209
  * <p>The unique identifier that maps to where your Price List files are located.
193
210
  * <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
194
211
  * <code>ListPriceLists</code>
@@ -196,6 +213,7 @@ export interface GetPriceListFileUrlRequest {
196
213
  */
197
214
  PriceListArn: string | undefined;
198
215
  /**
216
+ * @public
199
217
  * <p>The format that you want to retrieve your Price List files in. The
200
218
  * <code>FileFormat</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
201
219
  * <code>ListPriceLists</code>
@@ -208,6 +226,7 @@ export interface GetPriceListFileUrlRequest {
208
226
  */
209
227
  export interface GetPriceListFileUrlResponse {
210
228
  /**
229
+ * @public
211
230
  * <p>The URL to download your Price List file from. </p>
212
231
  */
213
232
  Url?: string;
@@ -229,12 +248,14 @@ export type FilterType = (typeof FilterType)[keyof typeof FilterType];
229
248
  */
230
249
  export interface Filter {
231
250
  /**
251
+ * @public
232
252
  * <p>The type of filter that you want to use.</p>
233
253
  * <p>Valid values are: <code>TERM_MATCH</code>. <code>TERM_MATCH</code> returns only
234
254
  * products that match both the given filter field and the given value.</p>
235
255
  */
236
256
  Type: FilterType | string | undefined;
237
257
  /**
258
+ * @public
238
259
  * <p>The product metadata field that you want to filter on. You can filter by just the
239
260
  * service code to see all products for a specific service, filter
240
261
  * by just the attribute name to see a specific attribute for multiple services, or use both a service code
@@ -245,6 +266,7 @@ export interface Filter {
245
266
  */
246
267
  Field: string | undefined;
247
268
  /**
269
+ * @public
248
270
  * <p>The service code or attribute value that you want to filter by. If you're filtering
249
271
  * by service code this is the actual service code, such as <code>AmazonEC2</code>. If you're
250
272
  * filtering by attribute name, this is the attribute value that you want the returned
@@ -257,25 +279,30 @@ export interface Filter {
257
279
  */
258
280
  export interface GetProductsRequest {
259
281
  /**
282
+ * @public
260
283
  * <p>The code for the service whose products you want to retrieve. </p>
261
284
  */
262
285
  ServiceCode: string | undefined;
263
286
  /**
287
+ * @public
264
288
  * <p>The list of filters that limit the returned products. only products that match all filters
265
289
  * are returned.</p>
266
290
  */
267
291
  Filters?: Filter[];
268
292
  /**
293
+ * @public
269
294
  * <p>The format version that you want the response to be in.</p>
270
295
  * <p>Valid values are: <code>aws_v1</code>
271
296
  * </p>
272
297
  */
273
298
  FormatVersion?: string;
274
299
  /**
300
+ * @public
275
301
  * <p>The pagination token that indicates the next set of results that you want to retrieve.</p>
276
302
  */
277
303
  NextToken?: string;
278
304
  /**
305
+ * @public
279
306
  * <p>The maximum number of results to return in the response.</p>
280
307
  */
281
308
  MaxResults?: number;
@@ -285,15 +312,18 @@ export interface GetProductsRequest {
285
312
  */
286
313
  export interface GetProductsResponse {
287
314
  /**
315
+ * @public
288
316
  * <p>The format version of the response. For example, aws_v1.</p>
289
317
  */
290
318
  FormatVersion?: string;
291
319
  /**
320
+ * @public
292
321
  * <p>The list of products that match your filters. The list contains both the product metadata and
293
322
  * the price information.</p>
294
323
  */
295
324
  PriceList?: (__LazyJsonString | string)[];
296
325
  /**
326
+ * @public
297
327
  * <p>The pagination token that indicates the next set of results to retrieve.</p>
298
328
  */
299
329
  NextToken?: string;
@@ -303,6 +333,7 @@ export interface GetProductsResponse {
303
333
  */
304
334
  export interface ListPriceListsRequest {
305
335
  /**
336
+ * @public
306
337
  * <p>The service code or the Savings Plan service code for the attributes that
307
338
  * you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use
308
339
  * <code>AmazonEC2</code>. For a full list of service codes containing On-Demand and
@@ -314,10 +345,12 @@ export interface ListPriceListsRequest {
314
345
  */
315
346
  ServiceCode: string | undefined;
316
347
  /**
348
+ * @public
317
349
  * <p>The date that the Price List file prices are effective from. </p>
318
350
  */
319
351
  EffectiveDate: Date | undefined;
320
352
  /**
353
+ * @public
321
354
  * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get
322
355
  * the price list only for the <code>US East (N. Virginia)</code> Region, use
323
356
  * <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all
@@ -327,15 +360,18 @@ export interface ListPriceListsRequest {
327
360
  */
328
361
  RegionCode?: string;
329
362
  /**
363
+ * @public
330
364
  * <p>The three alphabetical character ISO-4217 currency code that the Price List files are
331
365
  * denominated in. </p>
332
366
  */
333
367
  CurrencyCode: string | undefined;
334
368
  /**
369
+ * @public
335
370
  * <p>The pagination token that indicates the next set of results that you want to retrieve. </p>
336
371
  */
337
372
  NextToken?: string;
338
373
  /**
374
+ * @public
339
375
  * <p>The maximum number of results to return in the response.
340
376
  * </p>
341
377
  */
@@ -352,6 +388,7 @@ export interface ListPriceListsRequest {
352
388
  */
353
389
  export interface PriceList {
354
390
  /**
391
+ * @public
355
392
  * <p>The unique identifier that maps to where your Price List files are located.
356
393
  * <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
357
394
  * <code>ListPriceList</code>
@@ -359,6 +396,7 @@ export interface PriceList {
359
396
  */
360
397
  PriceListArn?: string;
361
398
  /**
399
+ * @public
362
400
  * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get
363
401
  * the price list only for the <code>US East (N. Virginia)</code> Region, use
364
402
  * <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all
@@ -368,11 +406,13 @@ export interface PriceList {
368
406
  */
369
407
  RegionCode?: string;
370
408
  /**
409
+ * @public
371
410
  * <p>The three alphabetical character ISO-4217 currency code the Price List files are
372
411
  * denominated in. </p>
373
412
  */
374
413
  CurrencyCode?: string;
375
414
  /**
415
+ * @public
376
416
  * <p>The format you want to retrieve your Price List files. The <code>FileFormat</code> can
377
417
  * be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
378
418
  * <code>ListPriceList</code>
@@ -385,10 +425,12 @@ export interface PriceList {
385
425
  */
386
426
  export interface ListPriceListsResponse {
387
427
  /**
428
+ * @public
388
429
  * <p>The type of price list references that match your request. </p>
389
430
  */
390
431
  PriceLists?: PriceList[];
391
432
  /**
433
+ * @public
392
434
  * <p>The pagination token that indicates the next set of results to retrieve. </p>
393
435
  */
394
436
  NextToken?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pricing",
3
3
  "description": "AWS SDK for JavaScript Pricing Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",