Skip to content

Commit 5b26c72

Browse files
author
awstools
committed
docs(client-pricing): Add examples for API operations in model.
1 parent 5b4334c commit 5b26c72

File tree

5 files changed

+54
-5
lines changed

5 files changed

+54
-5
lines changed

clients/client-pricing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ the SKU level. You can use the Amazon Web Services Price List to do the followin
2525
</li>
2626
</ul>
2727
<p>Use <code>GetServices</code> without a service code to retrieve the service codes for
28-
all Amazon Web Services, then <code>GetServices</code> with a service code to
28+
all Amazon Web Services services, then <code>GetServices</code> with a service code to
2929
retrieve the attribute names for that service. After you have the service code and
3030
attribute names, you can use <code>GetAttributeValues</code> to see what values are
3131
available for an attribute. With the service code and an attribute name and value, you can

clients/client-pricing/src/Pricing.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ export interface Pricing {
132132
* </li>
133133
* </ul>
134134
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
135-
* all Amazon Web Services, then <code>GetServices</code> with a service code to
135+
* all Amazon Web Services services, then <code>GetServices</code> with a service code to
136136
* retrieve the attribute names for that service. After you have the service code and
137137
* attribute names, you can use <code>GetAttributeValues</code> to see what values are
138138
* available for an attribute. With the service code and an attribute name and value, you can

clients/client-pricing/src/PricingClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ export interface PricingClientResolvedConfig extends PricingClientResolvedConfig
283283
* </li>
284284
* </ul>
285285
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
286-
* all Amazon Web Services, then <code>GetServices</code> with a service code to
286+
* all Amazon Web Services services, then <code>GetServices</code> with a service code to
287287
* retrieve the attribute names for that service. After you have the service code and
288288
* attribute names, you can use <code>GetAttributeValues</code> to see what values are
289289
* available for an attribute. With the service code and an attribute name and value, you can

clients/client-pricing/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* </li>
2121
* </ul>
2222
* <p>Use <code>GetServices</code> without a service code to retrieve the service codes for
23-
* all Amazon Web Services, then <code>GetServices</code> with a service code to
23+
* all Amazon Web Services services, then <code>GetServices</code> with a service code to
2424
* retrieve the attribute names for that service. After you have the service code and
2525
* attribute names, you can use <code>GetAttributeValues</code> to see what values are
2626
* available for an attribute. With the service code and an attribute name and value, you can

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

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
"name": "pricing"
3434
},
3535
"aws.protocols#awsJson1_1": {},
36-
"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>",
36+
"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>",
3737
"smithy.api#title": "AWS Price List Service",
3838
"smithy.rules#endpointRuleSet": {
3939
"version": "1.0",
@@ -788,6 +788,33 @@
788788
],
789789
"traits": {
790790
"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>",
791+
"smithy.api#examples": [
792+
{
793+
"title": "To retrieve a list of services and service codes",
794+
"documentation": "Retrieves the service for the given Service Code.",
795+
"input": {
796+
"ServiceCode": "AmazonEC2",
797+
"FormatVersion": "aws_v1",
798+
"MaxResults": 1
799+
},
800+
"output": {
801+
"FormatVersion": "aws_v1",
802+
"NextToken": "abcdefg123",
803+
"Services": [
804+
{
805+
"AttributeNames": [
806+
"volumeType",
807+
"maxIopsvolume",
808+
"instanceCapacity10xlarge",
809+
"locationType",
810+
"operation"
811+
],
812+
"ServiceCode": "AmazonEC2"
813+
}
814+
]
815+
}
816+
}
817+
],
791818
"smithy.api#paginated": {
792819
"inputToken": "NextToken",
793820
"outputToken": "NextToken",
@@ -962,6 +989,28 @@
962989
],
963990
"traits": {
964991
"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>",
992+
"smithy.api#examples": [
993+
{
994+
"title": "To retrieve a list of attribute values",
995+
"documentation": "This operation returns a list of values available for the given attribute.",
996+
"input": {
997+
"ServiceCode": "AmazonEC2",
998+
"AttributeName": "volumeType",
999+
"MaxResults": 2
1000+
},
1001+
"output": {
1002+
"NextToken": "GpgauEXAMPLEezucl5LV0w==:7GzYJ0nw0DBTJ2J66EoTIIynE6O1uXwQtTRqioJzQadBnDVgHPzI1en4BUQnPCLpzeBk9RQQAWaFieA4+DapFAGLgk+Z/9/cTw9GldnPOHN98+FdmJP7wKU3QQpQ8MQr5KOeBkIsAqvAQYdL0DkL7tHwPtE5iCEByAmg9gcC/yBU1vAOsf7R3VaNN4M5jMDv3woSWqASSIlBVB6tgW78YL22KhssoItM/jWW+aP6Jqtq4mldxp/ct6DWAl+xLFwHU/CbketimPPXyqHF3/UXDw==",
1003+
"AttributeValues": [
1004+
{
1005+
"Value": "Throughput Optimized HDD"
1006+
},
1007+
{
1008+
"Value": "Provisioned IOPS"
1009+
}
1010+
]
1011+
}
1012+
}
1013+
],
9651014
"smithy.api#paginated": {
9661015
"inputToken": "NextToken",
9671016
"outputToken": "NextToken",

0 commit comments

Comments
 (0)