Skip to content

Commit 34b8325

Browse files
author
awstools
committed
docs(client-pricing): Documentation updates for Price List API
1 parent a57a464 commit 34b8325

File tree

6 files changed

+22
-22
lines changed

6 files changed

+22
-22
lines changed

clients/client-pricing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ level. You can use the Amazon Web Services Price List Service to build cost cont
1515
billing data, forecast future spend for budgeting purposes, and provide cost benefit
1616
analysis that compare your internal workloads with Amazon Web Services.</p>
1717
<p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then
18-
<code>GetServices</code> with a service code to retreive the attribute names for
18+
<code>GetServices</code> with a service code to retrieve the attribute names for
1919
that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code>
2020
to see what values are available for an attribute. With the service code and an attribute name and value,
2121
you can use <code>GetProducts</code> to find specific products that you're interested in, such as

clients/client-pricing/src/Pricing.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { PricingClient } from "./PricingClient";
2222
* billing data, forecast future spend for budgeting purposes, and provide cost benefit
2323
* analysis that compare your internal workloads with Amazon Web Services.</p>
2424
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then
25-
* <code>GetServices</code> with a service code to retreive the attribute names for
25+
* <code>GetServices</code> with a service code to retrieve the attribute names for
2626
* that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code>
2727
* to see what values are available for an attribute. With the service code and an attribute name and value,
2828
* you can use <code>GetProducts</code> to find specific products that you're interested in, such as
@@ -79,7 +79,7 @@ export class Pricing extends PricingClient {
7979
}
8080

8181
/**
82-
* <p>Returns a list of attribute values. Attibutes are similar to the details
82+
* <p>Returns a list of attribute values. Attributes are similar to the details
8383
* in a Price List API offer file. For a list of available attributes, see
8484
* <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a>
8585
* in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">Amazon Web Services Billing and Cost Management User Guide</a>.</p>

clients/client-pricing/src/PricingClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ export interface PricingClientResolvedConfig extends PricingClientResolvedConfig
225225
* billing data, forecast future spend for budgeting purposes, and provide cost benefit
226226
* analysis that compare your internal workloads with Amazon Web Services.</p>
227227
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then
228-
* <code>GetServices</code> with a service code to retreive the attribute names for
228+
* <code>GetServices</code> with a service code to retrieve the attribute names for
229229
* that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code>
230230
* to see what values are available for an attribute. With the service code and an attribute name and value,
231231
* you can use <code>GetProducts</code> to find specific products that you're interested in, such as

clients/client-pricing/src/commands/GetAttributeValuesCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface GetAttributeValuesCommandInput extends GetAttributeValuesReques
2222
export interface GetAttributeValuesCommandOutput extends GetAttributeValuesResponse, __MetadataBearer {}
2323

2424
/**
25-
* <p>Returns a list of attribute values. Attibutes are similar to the details
25+
* <p>Returns a list of attribute values. Attributes are similar to the details
2626
* in a Price List API offer file. For a list of available attributes, see
2727
* <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs">Offer File Definitions</a>
2828
* in the <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html">Amazon Web Services Billing and Cost Management User Guide</a>.</p>

clients/client-pricing/src/models/models_0.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ export interface DescribeServicesResponse {
9999
FormatVersion?: string;
100100

101101
/**
102-
* <p>The pagination token for the next set of retreivable results.</p>
102+
* <p>The pagination token for the next set of retrievable results.</p>
103103
*/
104104
NextToken?: string;
105105
}

codegen/sdk-codegen/aws-models/pricing.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,6 @@
3131
"shapes": {
3232
"com.amazonaws.pricing#AWSPriceListService": {
3333
"type": "service",
34-
"version": "2017-10-15",
35-
"operations": [
36-
{
37-
"target": "com.amazonaws.pricing#DescribeServices"
38-
},
39-
{
40-
"target": "com.amazonaws.pricing#GetAttributeValues"
41-
},
42-
{
43-
"target": "com.amazonaws.pricing#GetProducts"
44-
}
45-
],
4634
"traits": {
4735
"aws.api#service": {
4836
"sdkId": "Pricing",
@@ -55,9 +43,21 @@
5543
"name": "pricing"
5644
},
5745
"aws.protocols#awsJson1_1": {},
58-
"smithy.api#documentation": "<p>Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to\n programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service\n uses standardized product attributes such as <code>Location</code>, <code>Storage\n Class</code>, and <code>Operating System</code>, and provides prices at the SKU\n level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile\n billing data, forecast future spend for budgeting purposes, and provide cost benefit\n analysis that compare your internal workloads with Amazon Web Services.</p>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then \n <code>GetServices</code> with a service code to retreive the attribute names for \n that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code>\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use <code>GetProducts</code> to find specific products that you're interested in, such as \n an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> \n <code>volumeType</code>.</p>\n <p>Service Endpoint</p>\n <p>Amazon Web Services Price List Service API provides the following two endpoints:</p>\n <ul>\n <li>\n <p>https://api.pricing.us-east-1.amazonaws.com</p>\n </li>\n <li>\n <p>https://api.pricing.ap-south-1.amazonaws.com</p>\n </li>\n </ul>",
46+
"smithy.api#documentation": "<p>Amazon Web Services Price List Service API (Amazon Web Services Price List Service) is a centralized and convenient way to\n programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List Service\n uses standardized product attributes such as <code>Location</code>, <code>Storage\n Class</code>, and <code>Operating System</code>, and provides prices at the SKU\n level. You can use the Amazon Web Services Price List Service to build cost control and scenario planning tools, reconcile\n billing data, forecast future spend for budgeting purposes, and provide cost benefit\n analysis that compare your internal workloads with Amazon Web Services.</p>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for all AWS services, then \n <code>GetServices</code> with a service code to retrieve the attribute names for \n that service. After you have the service code and attribute names, you can use <code>GetAttributeValues</code>\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use <code>GetProducts</code> to find specific products that you're interested in, such as \n an <code>AmazonEC2</code> instance, with a <code>Provisioned IOPS</code> \n <code>volumeType</code>.</p>\n <p>Service Endpoint</p>\n <p>Amazon Web Services Price List Service API provides the following two endpoints:</p>\n <ul>\n <li>\n <p>https://api.pricing.us-east-1.amazonaws.com</p>\n </li>\n <li>\n <p>https://api.pricing.ap-south-1.amazonaws.com</p>\n </li>\n </ul>",
5947
"smithy.api#title": "AWS Price List Service"
60-
}
48+
},
49+
"version": "2017-10-15",
50+
"operations": [
51+
{
52+
"target": "com.amazonaws.pricing#DescribeServices"
53+
},
54+
{
55+
"target": "com.amazonaws.pricing#GetAttributeValues"
56+
},
57+
{
58+
"target": "com.amazonaws.pricing#GetProducts"
59+
}
60+
]
6161
},
6262
"com.amazonaws.pricing#AttributeNameList": {
6363
"type": "list",
@@ -176,7 +176,7 @@
176176
"NextToken": {
177177
"target": "com.amazonaws.pricing#String",
178178
"traits": {
179-
"smithy.api#documentation": "<p>The pagination token for the next set of retreivable results.</p>"
179+
"smithy.api#documentation": "<p>The pagination token for the next set of retrievable results.</p>"
180180
}
181181
}
182182
}
@@ -266,7 +266,7 @@
266266
}
267267
],
268268
"traits": {
269-
"smithy.api#documentation": "<p>Returns a list of attribute values. Attibutes are similar to the details \n in a Price List API offer file. For a list of available attributes, see \n <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a>\n in the <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">Amazon Web Services Billing and Cost Management User Guide</a>.</p>",
269+
"smithy.api#documentation": "<p>Returns a list of attribute values. Attributes are similar to the details \n in a Price List API offer file. For a list of available attributes, see \n <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/reading-an-offer.html#pps-defs\">Offer File Definitions</a>\n in the <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/billing-what-is.html\">Amazon Web Services Billing and Cost Management User Guide</a>.</p>",
270270
"smithy.api#paginated": {
271271
"inputToken": "NextToken",
272272
"outputToken": "NextToken",

0 commit comments

Comments
 (0)