@aws-sdk/client-pricing 3.1022.0 → 3.1023.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/README.md CHANGED
@@ -6,35 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript Pricing Client for Node.js, Browser and React Native.
8
8
 
9
- <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically
10
- query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>,
11
- <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at
12
- the SKU level. You can use the Amazon Web Services Price List to do the following:</p>
13
- <ul>
14
- <li>
15
- <p>Build cost control and scenario planning tools</p>
16
- </li>
17
- <li>
18
- <p>Reconcile billing data</p>
19
- </li>
20
- <li>
21
- <p>Forecast future spend for budgeting purposes</p>
22
- </li>
23
- <li>
24
- <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>
25
- </li>
26
- </ul>
27
- <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
28
- all Amazon Web Services services, then <code>GetServices</code> with a service code to
29
- retrieve the attribute names for that service. After you have the service code and
30
- attribute names, you can use <code>GetAttributeValues</code> to see what values are
31
- available for an attribute. With the service code and an attribute name and value, you can
32
- use <code>GetProducts</code> to find specific products that you're interested in, such as
33
- an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code>
34
- <code>volumeType</code>.</p>
35
- <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the
36
- Amazon Web Services Price List API</a> in the <i>Billing User
37
- Guide</i>.</p>
9
+ <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:</p> <ul> <li> <p>Build cost control and scenario planning tools</p> </li> <li> <p>Reconcile billing data</p> </li> <li> <p>Forecast future spend for budgeting purposes</p> </li> <li> <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p> </li> </ul> <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all Amazon Web Services services, then <code>GetServices</code> with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the Amazon Web Services Price List API</a> in the <i>Billing User Guide</i>.</p>
38
10
 
39
11
  ## Installing
40
12
 
@@ -67,35 +67,7 @@ export interface Pricing {
67
67
  paginateListPriceLists(args: ListPriceListsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListPriceListsCommandOutput>;
68
68
  }
69
69
  /**
70
- * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically
71
- * query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>,
72
- * <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at
73
- * the SKU level. You can use the Amazon Web Services Price List to do the following:</p>
74
- * <ul>
75
- * <li>
76
- * <p>Build cost control and scenario planning tools</p>
77
- * </li>
78
- * <li>
79
- * <p>Reconcile billing data</p>
80
- * </li>
81
- * <li>
82
- * <p>Forecast future spend for budgeting purposes</p>
83
- * </li>
84
- * <li>
85
- * <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>
86
- * </li>
87
- * </ul>
88
- * <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
89
- * all Amazon Web Services services, then <code>GetServices</code> with a service code to
90
- * retrieve the attribute names for that service. After you have the service code and
91
- * attribute names, you can use <code>GetAttributeValues</code> to see what values are
92
- * available for an attribute. With the service code and an attribute name and value, you can
93
- * use <code>GetProducts</code> to find specific products that you're interested in, such as
94
- * an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code>
95
- * <code>volumeType</code>.</p>
96
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the
97
- * Amazon Web Services Price List API</a> in the <i>Billing User
98
- * Guide</i>.</p>
70
+ * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:</p> <ul> <li> <p>Build cost control and scenario planning tools</p> </li> <li> <p>Reconcile billing data</p> </li> <li> <p>Forecast future spend for budgeting purposes</p> </li> <li> <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p> </li> </ul> <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all Amazon Web Services services, then <code>GetServices</code> with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the Amazon Web Services Price List API</a> in the <i>Billing User Guide</i>.</p>
99
71
  * @public
100
72
  */
101
73
  export declare class Pricing extends PricingClient implements Pricing {
@@ -174,35 +174,7 @@ export type PricingClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
174
174
  export interface PricingClientResolvedConfig extends PricingClientResolvedConfigType {
175
175
  }
176
176
  /**
177
- * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically
178
- * query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>,
179
- * <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at
180
- * the SKU level. You can use the Amazon Web Services Price List to do the following:</p>
181
- * <ul>
182
- * <li>
183
- * <p>Build cost control and scenario planning tools</p>
184
- * </li>
185
- * <li>
186
- * <p>Reconcile billing data</p>
187
- * </li>
188
- * <li>
189
- * <p>Forecast future spend for budgeting purposes</p>
190
- * </li>
191
- * <li>
192
- * <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>
193
- * </li>
194
- * </ul>
195
- * <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
196
- * all Amazon Web Services services, then <code>GetServices</code> with a service code to
197
- * retrieve the attribute names for that service. After you have the service code and
198
- * attribute names, you can use <code>GetAttributeValues</code> to see what values are
199
- * available for an attribute. With the service code and an attribute name and value, you can
200
- * use <code>GetProducts</code> to find specific products that you're interested in, such as
201
- * an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code>
202
- * <code>volumeType</code>.</p>
203
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the
204
- * Amazon Web Services Price List API</a> in the <i>Billing User
205
- * Guide</i>.</p>
177
+ * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:</p> <ul> <li> <p>Build cost control and scenario planning tools</p> </li> <li> <p>Reconcile billing data</p> </li> <li> <p>Forecast future spend for budgeting purposes</p> </li> <li> <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p> </li> </ul> <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all Amazon Web Services services, then <code>GetServices</code> with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the Amazon Web Services Price List API</a> in the <i>Billing User Guide</i>.</p>
206
178
  * @public
207
179
  */
208
180
  export declare class PricingClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PricingClientResolvedConfig> {
@@ -27,13 +27,7 @@ declare const DescribeServicesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the metadata for one service or a list of the metadata for all services. Use
31
- * this without a service code to get the service codes for all services.
32
- * Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to
33
- * that service, such as the attribute
34
- * names available for that service. For example, some of the attribute names available for EC2 are
35
- * <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>,
36
- * <code>locationType</code>, and <code>instanceCapacity10xlarge</code>.</p>
30
+ * <p>Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>, <code>locationType</code>, and <code>instanceCapacity10xlarge</code>.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -71,6 +65,9 @@ declare const DescribeServicesCommand_base: {
71
65
  * @see {@link DescribeServicesCommandOutput} for command's `response` shape.
72
66
  * @see {@link PricingClientResolvedConfig | config} for PricingClient's `config` shape.
73
67
  *
68
+ * @throws {@link AccessDeniedException} (client fault)
69
+ * <p>General authentication failure. The request wasn't signed correctly.</p>
70
+ *
74
71
  * @throws {@link ExpiredNextTokenException} (client fault)
75
72
  * <p>The pagination token expired. Try again without a pagination token.</p>
76
73
  *
@@ -87,8 +84,7 @@ declare const DescribeServicesCommand_base: {
87
84
  * <p>The requested resource can't be found.</p>
88
85
  *
89
86
  * @throws {@link ThrottlingException} (client fault)
90
- * <p>You've made too many requests exceeding service quotas.
91
- * </p>
87
+ * <p>You've made too many requests exceeding service quotas. </p>
92
88
  *
93
89
  * @throws {@link PricingServiceException}
94
90
  * <p>Base exception class for all service exceptions from Pricing service.</p>
@@ -27,10 +27,7 @@ declare const GetAttributeValuesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of attribute values. Attributes are similar to the details
31
- * in a Price List API offer file. For a list of available attributes, see
32
- * <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a>
33
- * in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">Billing and Cost Management User Guide</a>.</p>
30
+ * <p>Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a> in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">Billing and Cost Management User Guide</a>.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -64,6 +61,9 @@ declare const GetAttributeValuesCommand_base: {
64
61
  * @see {@link GetAttributeValuesCommandOutput} for command's `response` shape.
65
62
  * @see {@link PricingClientResolvedConfig | config} for PricingClient's `config` shape.
66
63
  *
64
+ * @throws {@link AccessDeniedException} (client fault)
65
+ * <p>General authentication failure. The request wasn't signed correctly.</p>
66
+ *
67
67
  * @throws {@link ExpiredNextTokenException} (client fault)
68
68
  * <p>The pagination token expired. Try again without a pagination token.</p>
69
69
  *
@@ -80,8 +80,7 @@ declare const GetAttributeValuesCommand_base: {
80
80
  * <p>The requested resource can't be found.</p>
81
81
  *
82
82
  * @throws {@link ThrottlingException} (client fault)
83
- * <p>You've made too many requests exceeding service quotas.
84
- * </p>
83
+ * <p>You've made too many requests exceeding service quotas. </p>
85
84
  *
86
85
  * @throws {@link PricingServiceException}
87
86
  * <p>Base exception class for all service exceptions from Pricing service.</p>
@@ -27,14 +27,7 @@ declare const GetPriceListFileUrlCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <i>
32
- * <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b>
33
- * </i>
34
- * </p>
35
- * <p>This returns the URL that you can retrieve your Price List file from. This URL is based
36
- * on the <code>PriceListArn</code> and <code>FileFormat</code> that you retrieve from the
37
- * <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
30
+ * <p> <i> <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i> </p> <p>This returns the URL that you can retrieve your Price List file from. This URL is based on the <code>PriceListArn</code> and <code>FileFormat</code> that you retrieve from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -77,8 +70,7 @@ declare const GetPriceListFileUrlCommand_base: {
77
70
  * <p>The requested resource can't be found.</p>
78
71
  *
79
72
  * @throws {@link ThrottlingException} (client fault)
80
- * <p>You've made too many requests exceeding service quotas.
81
- * </p>
73
+ * <p>You've made too many requests exceeding service quotas. </p>
82
74
  *
83
75
  * @throws {@link PricingServiceException}
84
76
  * <p>Base exception class for all service exceptions from Pricing service.</p>
@@ -67,6 +67,9 @@ declare const GetProductsCommand_base: {
67
67
  * @see {@link GetProductsCommandOutput} for command's `response` shape.
68
68
  * @see {@link PricingClientResolvedConfig | config} for PricingClient's `config` shape.
69
69
  *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>General authentication failure. The request wasn't signed correctly.</p>
72
+ *
70
73
  * @throws {@link ExpiredNextTokenException} (client fault)
71
74
  * <p>The pagination token expired. Try again without a pagination token.</p>
72
75
  *
@@ -83,8 +86,7 @@ declare const GetProductsCommand_base: {
83
86
  * <p>The requested resource can't be found.</p>
84
87
  *
85
88
  * @throws {@link ThrottlingException} (client fault)
86
- * <p>You've made too many requests exceeding service quotas.
87
- * </p>
89
+ * <p>You've made too many requests exceeding service quotas. </p>
88
90
  *
89
91
  * @throws {@link PricingServiceException}
90
92
  * <p>Base exception class for all service exceptions from Pricing service.</p>
@@ -27,18 +27,7 @@ declare const ListPriceListsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <i>
32
- * <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b>
33
- * </i>
34
- * </p>
35
- * <p>This returns a list of Price List references that the requester if authorized to view,
36
- * given a <code>ServiceCode</code>, <code>CurrencyCode</code>, and an
37
- * <code>EffectiveDate</code>. Use without a <code>RegionCode</code> filter to list Price
38
- * List references from all available Amazon Web Services Regions. Use with a
39
- * <code>RegionCode</code> filter to get the Price List reference that's specific to a
40
- * specific Amazon Web Services Region. You can use the <code>PriceListArn</code> from the
41
- * response to get your preferred Price List files through the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html">GetPriceListFileUrl</a> API.</p>
30
+ * <p> <i> <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i> </p> <p>This returns a list of Price List references that the requester if authorized to view, given a <code>ServiceCode</code>, <code>CurrencyCode</code>, and an <code>EffectiveDate</code>. Use without a <code>RegionCode</code> filter to list Price List references from all available Amazon Web Services Regions. Use with a <code>RegionCode</code> filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the <code>PriceListArn</code> from the response to get your preferred Price List files through the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetPriceListFileUrl.html">GetPriceListFileUrl</a> API.</p>
42
31
  * @example
43
32
  * Use a bare-bones client and the command you need to make an API call.
44
33
  * ```javascript
@@ -101,8 +90,7 @@ declare const ListPriceListsCommand_base: {
101
90
  * <p>The requested resource can't be found.</p>
102
91
  *
103
92
  * @throws {@link ThrottlingException} (client fault)
104
- * <p>You've made too many requests exceeding service quotas.
105
- * </p>
93
+ * <p>You've made too many requests exceeding service quotas. </p>
106
94
  *
107
95
  * @throws {@link PricingServiceException}
108
96
  * <p>Base exception class for all service exceptions from Pricing service.</p>
@@ -1,33 +1,5 @@
1
1
  /**
2
- * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically
3
- * query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>,
4
- * <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at
5
- * the SKU level. You can use the Amazon Web Services Price List to do the following:</p>
6
- * <ul>
7
- * <li>
8
- * <p>Build cost control and scenario planning tools</p>
9
- * </li>
10
- * <li>
11
- * <p>Reconcile billing data</p>
12
- * </li>
13
- * <li>
14
- * <p>Forecast future spend for budgeting purposes</p>
15
- * </li>
16
- * <li>
17
- * <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>
18
- * </li>
19
- * </ul>
20
- * <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
21
- * all Amazon Web Services services, then <code>GetServices</code> with a service code to
22
- * retrieve the attribute names for that service. After you have the service code and
23
- * attribute names, you can use <code>GetAttributeValues</code> to see what values are
24
- * available for an attribute. With the service code and an attribute name and value, you can
25
- * use <code>GetProducts</code> to find specific products that you're interested in, such as
26
- * an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code>
27
- * <code>volumeType</code>.</p>
28
- * <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the
29
- * Amazon Web Services Price List API</a> in the <i>Billing User
30
- * Guide</i>.</p>
2
+ * <p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as <code>Location</code>, <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:</p> <ul> <li> <p>Build cost control and scenario planning tools</p> </li> <li> <p>Reconcile billing data</p> </li> <li> <p>Forecast future spend for budgeting purposes</p> </li> <li> <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p> </li> </ul> <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all Amazon Web Services services, then <code>GetServices</code> with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code> to see what values are available for an attribute. With the service code and an attribute name and value, you can use <code>GetProducts</code> to find specific products that you're interested in, such as an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> <code>volumeType</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html">Using the Amazon Web Services Price List API</a> in the <i>Billing User Guide</i>.</p>
31
3
  *
32
4
  * @packageDocumentation
33
5
  */
@@ -80,8 +80,7 @@ export declare class NotFoundException extends __BaseException {
80
80
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
81
81
  }
82
82
  /**
83
- * <p>You've made too many requests exceeding service quotas.
84
- * </p>
83
+ * <p>You've made too many requests exceeding service quotas. </p>
85
84
  * @public
86
85
  */
87
86
  export declare class ThrottlingException extends __BaseException {
@@ -1,9 +1,7 @@
1
1
  import { AutomaticJsonStringConversion as __AutomaticJsonStringConversion } from "@smithy/smithy-client";
2
2
  import type { FilterType } from "./enums";
3
3
  /**
4
- * <p>The values of a given attribute, such as <code>Throughput Optimized HDD</code> or <code>Provisioned
5
- * IOPS</code> for the <code>Amazon EC2</code>
6
- * <code>volumeType</code> attribute.</p>
4
+ * <p>The values of a given attribute, such as <code>Throughput Optimized HDD</code> or <code>Provisioned IOPS</code> for the <code>Amazon EC2</code> <code>volumeType</code> attribute.</p>
7
5
  * @public
8
6
  */
9
7
  export interface AttributeValue {
@@ -18,17 +16,12 @@ export interface AttributeValue {
18
16
  */
19
17
  export interface DescribeServicesRequest {
20
18
  /**
21
- * <p>The code for the service whose information you want to retrieve, such as <code>AmazonEC2</code>.
22
- * You can use
23
- * the <code>ServiceCode</code> to filter the results in a <code>GetProducts</code> call.
24
- * To retrieve a list of all services, leave this blank.</p>
19
+ * <p>The code for the service whose information you want to retrieve, such as <code>AmazonEC2</code>. You can use the <code>ServiceCode</code> to filter the results in a <code>GetProducts</code> call. To retrieve a list of all services, leave this blank.</p>
25
20
  * @public
26
21
  */
27
22
  ServiceCode?: string | undefined;
28
23
  /**
29
- * <p>The format version that you want the response to be in.</p>
30
- * <p>Valid values are: <code>aws_v1</code>
31
- * </p>
24
+ * <p>The format version that you want the response to be in.</p> <p>Valid values are: <code>aws_v1</code> </p>
32
25
  * @public
33
26
  */
34
27
  FormatVersion?: string | undefined;
@@ -84,8 +77,7 @@ export interface DescribeServicesResponse {
84
77
  */
85
78
  export interface GetAttributeValuesRequest {
86
79
  /**
87
- * <p>The service code for the service whose attributes you want to retrieve. For example, if you want
88
- * the retrieve an EC2 attribute, use <code>AmazonEC2</code>.</p>
80
+ * <p>The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use <code>AmazonEC2</code>.</p>
89
81
  * @public
90
82
  */
91
83
  ServiceCode: string | undefined;
@@ -110,9 +102,7 @@ export interface GetAttributeValuesRequest {
110
102
  */
111
103
  export interface GetAttributeValuesResponse {
112
104
  /**
113
- * <p>The list of values for an attribute. For example, <code>Throughput Optimized HDD</code> and
114
- * <code>Provisioned IOPS</code> are two available values for the <code>AmazonEC2</code>
115
- * <code>volumeType</code>.</p>
105
+ * <p>The list of values for an attribute. For example, <code>Throughput Optimized HDD</code> and <code>Provisioned IOPS</code> are two available values for the <code>AmazonEC2</code> <code>volumeType</code>.</p>
116
106
  * @public
117
107
  */
118
108
  AttributeValues?: AttributeValue[] | undefined;
@@ -127,14 +117,12 @@ export interface GetAttributeValuesResponse {
127
117
  */
128
118
  export interface GetPriceListFileUrlRequest {
129
119
  /**
130
- * <p>The unique identifier that maps to where your Price List files are located.
131
- * <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
120
+ * <p>The unique identifier that maps to where your Price List files are located. <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
132
121
  * @public
133
122
  */
134
123
  PriceListArn: string | undefined;
135
124
  /**
136
- * <p>The format that you want to retrieve your Price List files in. The
137
- * <code>FileFormat</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
125
+ * <p>The format that you want to retrieve your Price List files in. The <code>FileFormat</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">ListPriceLists</a> response. </p>
138
126
  * @public
139
127
  */
140
128
  FileFormat: string | undefined;
@@ -155,51 +143,17 @@ export interface GetPriceListFileUrlResponse {
155
143
  */
156
144
  export interface Filter {
157
145
  /**
158
- * <p>The type of filter that you want to use.</p>
159
- * <p>Valid values are:</p>
160
- * <ul>
161
- * <li>
162
- * <p>
163
- * <code>TERM_MATCH</code>: Returns only
164
- * products that match both the given filter field and the given value.</p>
165
- * </li>
166
- * <li>
167
- * <p>
168
- * <code>EQUALS</code>: Returns products that have a field value exactly matching the provided value.</p>
169
- * </li>
170
- * <li>
171
- * <p>
172
- * <code>CONTAINS</code>: Returns products where the field value contains the provided value as a substring.</p>
173
- * </li>
174
- * <li>
175
- * <p>
176
- * <code>ANY_OF</code>: Returns products where the field value is any of the provided values.</p>
177
- * </li>
178
- * <li>
179
- * <p>
180
- * <code>NONE_OF</code>: Returns products where the field value is not any of the provided values.</p>
181
- * </li>
182
- * </ul>
146
+ * <p>The type of filter that you want to use.</p> <p>Valid values are:</p> <ul> <li> <p> <code>TERM_MATCH</code>: Returns only products that match both the given filter field and the given value.</p> </li> <li> <p> <code>EQUALS</code>: Returns products that have a field value exactly matching the provided value.</p> </li> <li> <p> <code>CONTAINS</code>: Returns products where the field value contains the provided value as a substring.</p> </li> <li> <p> <code>ANY_OF</code>: Returns products where the field value is any of the provided values.</p> </li> <li> <p> <code>NONE_OF</code>: Returns products where the field value is not any of the provided values.</p> </li> </ul>
183
147
  * @public
184
148
  */
185
149
  Type: FilterType | undefined;
186
150
  /**
187
- * <p>The product metadata field that you want to filter on. You can filter by just the
188
- * service code to see all products for a specific service, filter
189
- * by just the attribute name to see a specific attribute for multiple services, or use both a service code
190
- * and an attribute name to retrieve only products that match both fields.</p>
191
- * <p>Valid values include: <code>ServiceCode</code>, and all attribute names</p>
192
- * <p>For example, you can filter by the <code>AmazonEC2</code> service code and the
193
- * <code>volumeType</code> attribute name to get the prices for only Amazon EC2 volumes.</p>
151
+ * <p>The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.</p> <p>Valid values include: <code>ServiceCode</code>, and all attribute names</p> <p>For example, you can filter by the <code>AmazonEC2</code> service code and the <code>volumeType</code> attribute name to get the prices for only Amazon EC2 volumes.</p>
194
152
  * @public
195
153
  */
196
154
  Field: string | undefined;
197
155
  /**
198
- * <p>The service code or attribute value that you want to filter by. If you're filtering
199
- * by service code this is the actual service code, such as <code>AmazonEC2</code>. If you're
200
- * filtering by attribute name, this is the attribute value that you want the returned
201
- * products to match, such as a <code>Provisioned IOPS</code> volume.</p>
202
- * <p>For <code>ANY_OF</code> and <code>NONE_OF</code> filter types, you can provide multiple values as a comma-separated string. For example, <code>t2.micro,t2.small,t2.medium</code> or <code>Compute optimized, GPU instance, Micro instances</code>.</p>
156
+ * <p>The service code or attribute value that you want to filter by. If you're filtering by service code this is the actual service code, such as <code>AmazonEC2</code>. If you're filtering by attribute name, this is the attribute value that you want the returned products to match, such as a <code>Provisioned IOPS</code> volume.</p>
203
157
  * @public
204
158
  */
205
159
  Value: string | undefined;
@@ -214,15 +168,12 @@ export interface GetProductsRequest {
214
168
  */
215
169
  ServiceCode: string | undefined;
216
170
  /**
217
- * <p>The list of filters that limit the returned products. only products that match all filters
218
- * are returned.</p>
171
+ * <p>The list of filters that limit the returned products. only products that match all filters are returned.</p>
219
172
  * @public
220
173
  */
221
174
  Filters?: Filter[] | undefined;
222
175
  /**
223
- * <p>The format version that you want the response to be in.</p>
224
- * <p>Valid values are: <code>aws_v1</code>
225
- * </p>
176
+ * <p>The format version that you want the response to be in.</p> <p>Valid values are: <code>aws_v1</code> </p>
226
177
  * @public
227
178
  */
228
179
  FormatVersion?: string | undefined;
@@ -247,8 +198,7 @@ export interface GetProductsResponse {
247
198
  */
248
199
  FormatVersion?: string | undefined;
249
200
  /**
250
- * <p>The list of products that match your filters. The list contains both the product metadata and
251
- * the price information.</p>
201
+ * <p>The list of products that match your filters. The list contains both the product metadata and the price information.</p>
252
202
  * @public
253
203
  */
254
204
  PriceList?: __AutomaticJsonStringConversion | string[] | undefined;
@@ -263,14 +213,7 @@ export interface GetProductsResponse {
263
213
  */
264
214
  export interface ListPriceListsRequest {
265
215
  /**
266
- * <p>The service code or the Savings Plan service code for the attributes that
267
- * you want to retrieve. For example, to get the list of applicable Amazon EC2 price
268
- * lists, use <code>AmazonEC2</code>. For a full list of service codes containing On-Demand
269
- * and Reserved Instance (RI) pricing, use the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion">DescribeServices</a> API.</p>
270
- * <p>To retrieve the Reserved Instance and Compute Savings Plan price lists,
271
- * use <code>ComputeSavingsPlans</code>. </p>
272
- * <p>To retrieve Machine Learning Savings Plans price lists, use
273
- * <code>MachineLearningSavingsPlans</code>. </p>
216
+ * <p>The service code or the Savings Plans service code for the attributes that you want to retrieve. For example, to get the list of applicable Amazon EC2 price lists, use <code>AmazonEC2</code>. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_DescribeServices.html#awscostmanagement-pricing_DescribeServices-request-FormatVersion">DescribeServices</a> API.</p> <p>To retrieve the Reserved Instance and Compute Savings Plans price lists, use <code>ComputeSavingsPlans</code>. </p> <p>To retrieve Machine Learning Savings Plans price lists, use <code>MachineLearningSavingsPlans</code>. </p>
274
217
  * @public
275
218
  */
276
219
  ServiceCode: string | undefined;
@@ -280,16 +223,12 @@ export interface ListPriceListsRequest {
280
223
  */
281
224
  EffectiveDate: Date | undefined;
282
225
  /**
283
- * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get
284
- * the price list only for the <code>US East (N. Virginia)</code> Region, use
285
- * <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all
286
- * applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html">GetAttributeValues</a> API.</p>
226
+ * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the <code>US East (N. Virginia)</code> Region, use <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html">GetAttributeValues</a> API.</p>
287
227
  * @public
288
228
  */
289
229
  RegionCode?: string | undefined;
290
230
  /**
291
- * <p>The three alphabetical character ISO-4217 currency code that the Price List files are
292
- * denominated in. </p>
231
+ * <p>The three alphabetical character ISO-4217 currency code that the Price List files are denominated in. </p>
293
232
  * @public
294
233
  */
295
234
  CurrencyCode: string | undefined;
@@ -299,51 +238,33 @@ export interface ListPriceListsRequest {
299
238
  */
300
239
  NextToken?: string | undefined;
301
240
  /**
302
- * <p>The maximum number of results to return in the response.
303
- * </p>
241
+ * <p>The maximum number of results to return in the response. </p>
304
242
  * @public
305
243
  */
306
244
  MaxResults?: number | undefined;
307
245
  }
308
246
  /**
309
- * <p>
310
- * <i>
311
- * <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b>
312
- * </i>
313
- * </p>
314
- * <p>This is the type of price list references that match your request. </p>
247
+ * <p> <i> <b>This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the <a href="https://aws.amazon.com/service-terms/">Amazon Web Services Service Terms</a> (Section 1.10).</b> </i> </p> <p>This is the type of price list references that match your request. </p>
315
248
  * @public
316
249
  */
317
250
  export interface PriceList {
318
251
  /**
319
- * <p>The unique identifier that maps to where your Price List files are located.
320
- * <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
321
- * <code>ListPriceList</code>
322
- * </a> response. </p>
252
+ * <p>The unique identifier that maps to where your Price List files are located. <code>PriceListArn</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html"> <code>ListPriceList</code> </a> response. </p>
323
253
  * @public
324
254
  */
325
255
  PriceListArn?: string | undefined;
326
256
  /**
327
- * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get
328
- * the price list only for the <code>US East (N. Virginia)</code> Region, use
329
- * <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all
330
- * applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html">
331
- * <code>GetAttributeValues</code>
332
- * </a> API. </p>
257
+ * <p>This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the <code>US East (N. Virginia)</code> Region, use <code>us-east-1</code>. If nothing is specified, you retrieve price lists for all applicable Regions. The available <code>RegionCode</code> list can be retrieved from <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_GetAttributeValues.html"> <code>GetAttributeValues</code> </a> API. </p>
333
258
  * @public
334
259
  */
335
260
  RegionCode?: string | undefined;
336
261
  /**
337
- * <p>The three alphabetical character ISO-4217 currency code the Price List files are
338
- * denominated in. </p>
262
+ * <p>The three alphabetical character ISO-4217 currency code the Price List files are denominated in. </p>
339
263
  * @public
340
264
  */
341
265
  CurrencyCode?: string | undefined;
342
266
  /**
343
- * <p>The format you want to retrieve your Price List files. The <code>FileFormat</code> can
344
- * be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html">
345
- * <code>ListPriceList</code>
346
- * </a> response. </p>
267
+ * <p>The format you want to retrieve your Price List files. The <code>FileFormat</code> can be obtained from the <a href="https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_pricing_ListPriceLists.html"> <code>ListPriceList</code> </a> response. </p>
347
268
  * @public
348
269
  */
349
270
  FileFormats?: string[] | undefined;
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.1022.0",
4
+ "version": "3.1023.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-pricing",