Pricing / Paginator / ListPriceLists

ListPriceLists#

class Pricing.Paginator.ListPriceLists#
paginator = client.get_paginator('list_price_lists')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Pricing.Client.list_price_lists().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ServiceCode='string',
    EffectiveDate=datetime(2015, 1, 1),
    RegionCode='string',
    CurrencyCode='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • ServiceCode (string) –

    [REQUIRED]

    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 AmazonEC2. For a full list of service codes containing On-Demand and Reserved Instance (RI) pricing, use the DescribeServices API.

    To retrieve the Compute Savings Plan price lists, use ComputeSavingsPlans. To retrieve Machine Learning Savings Plans price lists, use MachineLearningSavingsPlans.

  • EffectiveDate (datetime) –

    [REQUIRED]

    The date that the Price List file prices are effective from.

  • RegionCode (string) – This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

  • CurrencyCode (string) –

    [REQUIRED]

    The three alphabetical character ISO-4217 currency code that the Price List files are denominated in.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'PriceLists': [
        {
            'PriceListArn': 'string',
            'RegionCode': 'string',
            'CurrencyCode': 'string',
            'FileFormats': [
                'string',
            ]
        },
    ],

}

Response Structure

  • (dict) –

    • PriceLists (list) –

      The type of price list references that match your request.

      • (dict) –

        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 Amazon Web Services Service Terms (Section 1.10).

        This is the type of price list references that match your request.

        • PriceListArn (string) –

          The unique identifier that maps to where your Price List files are located. PriceListArn can be obtained from the ListPriceList response.

        • RegionCode (string) –

          This is used to filter the Price List by Amazon Web Services Region. For example, to get the price list only for the US East (N. Virginia) Region, use us-east-1. If nothing is specified, you retrieve price lists for all applicable Regions. The available RegionCode list can be retrieved from GetAttributeValues API.

        • CurrencyCode (string) –

          The three alphabetical character ISO-4217 currency code the Price List files are denominated in.

        • FileFormats (list) –

          The format you want to retrieve your Price List files. The FileFormat can be obtained from the ListPriceList response.

          • (string) –