Skip to content

Commit

Permalink
docs(client-pricing): Add examples for API operations in model.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Sep 30, 2024
1 parent 5b4334c commit 5b26c72
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 5 deletions.
2 changes: 1 addition & 1 deletion clients/client-pricing/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ the SKU level. You can use the Amazon Web Services Price List to do the followin
</li>
</ul>
<p>Use <code>GetServices</code> without a service code to retrieve the service codes for
all Amazon Web Services, then <code>GetServices</code> with a service code to
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
Expand Down
2 changes: 1 addition & 1 deletion clients/client-pricing/src/Pricing.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export interface Pricing {
* </li>
* </ul>
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
* all Amazon Web Services, then <code>GetServices</code> with a service code to
* 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
Expand Down
2 changes: 1 addition & 1 deletion clients/client-pricing/src/PricingClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ export interface PricingClientResolvedConfig extends PricingClientResolvedConfig
* </li>
* </ul>
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
* all Amazon Web Services, then <code>GetServices</code> with a service code to
* 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
Expand Down
2 changes: 1 addition & 1 deletion clients/client-pricing/src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
* </li>
* </ul>
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
* all Amazon Web Services, then <code>GetServices</code> with a service code to
* 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
Expand Down
51 changes: 50 additions & 1 deletion codegen/sdk-codegen/aws-models/pricing.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"name": "pricing"
},
"aws.protocols#awsJson1_1": {},
"smithy.api#documentation": "<p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n 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>,\n <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:</p>\n <ul>\n <li>\n <p>Build cost control and scenario planning tools</p>\n </li>\n <li>\n <p>Reconcile billing data</p>\n </li>\n <li>\n <p>Forecast future spend for budgeting purposes</p>\n </li>\n <li>\n <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>\n </li>\n </ul>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for\n all Amazon Web Services, then <code>GetServices</code> with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use <code>GetAttributeValues</code> to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n 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>For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html\">Using the\n Amazon Web Services Price List API</a> in the <i>Billing User\n Guide</i>.</p>",
"smithy.api#documentation": "<p>The Amazon Web Services Price List API is a centralized and convenient way to programmatically\n 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>,\n <code>Storage Class</code>, and <code>Operating System</code>, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:</p>\n <ul>\n <li>\n <p>Build cost control and scenario planning tools</p>\n </li>\n <li>\n <p>Reconcile billing data</p>\n </li>\n <li>\n <p>Forecast future spend for budgeting purposes</p>\n </li>\n <li>\n <p>Provide cost benefit analysis that compare your internal workloads with Amazon Web Services</p>\n </li>\n </ul>\n <p>Use <code>GetServices</code> without a service code to retrieve the service codes for\n all Amazon Web Services services, then <code>GetServices</code> with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use <code>GetAttributeValues</code> to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n 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>For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html\">Using the\n Amazon Web Services Price List API</a> in the <i>Billing User\n Guide</i>.</p>",
"smithy.api#title": "AWS Price List Service",
"smithy.rules#endpointRuleSet": {
"version": "1.0",
Expand Down Expand Up @@ -788,6 +788,33 @@
],
"traits": {
"smithy.api#documentation": "<p>Returns the metadata for one service or a list of the metadata for all services. Use\n this without a service code to get the service codes for all services.\n Use it with a service code, such as <code>AmazonEC2</code>, to get information specific to \n that service, such as the attribute \n names available for that service. For example, some of the attribute names available for EC2 are \n <code>volumeType</code>, <code>maxIopsVolume</code>, <code>operation</code>,\n <code>locationType</code>, and <code>instanceCapacity10xlarge</code>.</p>",
"smithy.api#examples": [
{
"title": "To retrieve a list of services and service codes",
"documentation": "Retrieves the service for the given Service Code.",
"input": {
"ServiceCode": "AmazonEC2",
"FormatVersion": "aws_v1",
"MaxResults": 1
},
"output": {
"FormatVersion": "aws_v1",
"NextToken": "abcdefg123",
"Services": [
{
"AttributeNames": [
"volumeType",
"maxIopsvolume",
"instanceCapacity10xlarge",
"locationType",
"operation"
],
"ServiceCode": "AmazonEC2"
}
]
}
}
],
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
Expand Down Expand Up @@ -962,6 +989,28 @@
],
"traits": {
"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\">Billing and Cost Management User Guide</a>.</p>",
"smithy.api#examples": [
{
"title": "To retrieve a list of attribute values",
"documentation": "This operation returns a list of values available for the given attribute.",
"input": {
"ServiceCode": "AmazonEC2",
"AttributeName": "volumeType",
"MaxResults": 2
},
"output": {
"NextToken": "GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==",
"AttributeValues": [
{
"Value": "Throughput Optimized HDD"
},
{
"Value": "Provisioned IOPS"
}
]
}
}
],
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
Expand Down

0 comments on commit 5b26c72

Please sign in to comment.