docs(client-pricing): Documentation updates for Price List

aws · Oct 12, 2023 · ec57e77 · ec57e77
1 parent f71b216
commit ec57e77
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 72 deletions.
diff --git a/clients/client-pricing/README.md b/clients/client-pricing/README.md
@@ -32,15 +32,9 @@ available for an attribute. With the service code and an attribute name and valu
 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>You can use the following endpoints for the Amazon Web Services Price List API:</p>
-<ul>
-<li>
-<p>https://api.pricing.us-east-1.amazonaws.com</p>
-</li>
-<li>
-<p>https://api.pricing.ap-south-1.amazonaws.com</p>
-</li>
-</ul>
+<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>
 
 ## Installing
 

diff --git a/clients/client-pricing/src/Pricing.ts b/clients/client-pricing/src/Pricing.ts
@@ -139,15 +139,9 @@ export interface Pricing {
  *          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>You can use the following endpoints for the Amazon Web Services Price List API:</p>
- *          <ul>
- *             <li>
- *                <p>https://api.pricing.us-east-1.amazonaws.com</p>
- *             </li>
- *             <li>
- *                <p>https://api.pricing.ap-south-1.amazonaws.com</p>
- *             </li>
- *          </ul>
+ *          <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>
  */
 export class Pricing extends PricingClient implements Pricing {}
 createAggregatedClient(commands, Pricing);
diff --git a/clients/client-pricing/src/PricingClient.ts b/clients/client-pricing/src/PricingClient.ts
@@ -287,15 +287,9 @@ export interface PricingClientResolvedConfig extends PricingClientResolvedConfig
  *          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>You can use the following endpoints for the Amazon Web Services Price List API:</p>
- *          <ul>
- *             <li>
- *                <p>https://api.pricing.us-east-1.amazonaws.com</p>
- *             </li>
- *             <li>
- *                <p>https://api.pricing.ap-south-1.amazonaws.com</p>
- *             </li>
- *          </ul>
+ *          <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>
  */
 export class PricingClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-pricing/src/commands/GetPriceListFileUrlCommand.ts b/clients/client-pricing/src/commands/GetPriceListFileUrlCommand.ts
@@ -42,10 +42,9 @@ export interface GetPriceListFileUrlCommandOutput extends GetPriceListFileUrlRes
  *                <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">
- *                <code>ListPriceLists</code>
- *             </a> response. </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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-pricing/src/commands/ListPriceListsCommand.ts b/clients/client-pricing/src/commands/ListPriceListsCommand.ts
@@ -42,14 +42,13 @@ export interface ListPriceListsCommandOutput extends ListPriceListsResponse, __M
  *                <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">
- *                <code>GetPriceListFileUrl</code>
- *             </a> API.</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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-pricing/src/index.ts b/clients/client-pricing/src/index.ts
@@ -27,15 +27,9 @@
  *          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>You can use the following endpoints for the Amazon Web Services Price List API:</p>
- *          <ul>
- *             <li>
- *                <p>https://api.pricing.us-east-1.amazonaws.com</p>
- *             </li>
- *             <li>
- *                <p>https://api.pricing.ap-south-1.amazonaws.com</p>
- *             </li>
- *          </ul>
+ *          <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>
  *
  * @packageDocumentation
  */

diff --git a/clients/client-pricing/src/models/models_0.ts b/clients/client-pricing/src/models/models_0.ts
@@ -283,18 +283,14 @@ export interface GetPriceListFileUrlRequest {
   /**
    * @public
    * <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>ListPriceLists</code>
-   *             </a> response. </p>
+   *             <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>
    */
   PriceListArn: string | undefined;
 
   /**
    * @public
    * <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">
-   *                <code>ListPriceLists</code>
-   *             </a> response. </p>
+   *             <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>
    */
   FileFormat: string | undefined;
 }
@@ -427,13 +423,13 @@ export interface ListPriceListsRequest {
   /**
    * @public
    * <p>The service code or the Savings Plan 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">
-   *                <code>DescribeServices</code>
-   *             </a> API.</p>
-   *          <p>To retrieve the Compute Savings Plan price lists, use <code>ComputeSavingsPlans</code>. To retrieve Machine Learning Savings Plans price lists, use <code>MachineLearningSavingsPlans</code>.
-   *       </p>
+   *          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 Plan price lists,
+   *          use <code>ComputeSavingsPlans</code>. </p>
+   *          <p>To retrieve Machine Learning Savings Plans price lists, use
+   *             <code>MachineLearningSavingsPlans</code>. </p>
    */
   ServiceCode: string | undefined;
 
@@ -448,9 +444,7 @@ export interface ListPriceListsRequest {
    * <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>
+   *          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>
    */
   RegionCode?: string;