Pricing / Paginator / GetProducts

GetProducts

class Pricing.Paginator.GetProducts

paginator = client.get_paginator('get_products')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ServiceCode='string',
    Filters=[
        {
            'Type': 'TERM_MATCH',
            'Field': 'string',
            'Value': 'string'
        },
    ],
    FormatVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ServiceCode (string) –

  [REQUIRED]

  The code for the service whose products you want to retrieve.

• Filters (list) –

  The list of filters that limit the returned products. only products that match all filters are returned.

  • (dict) –

    The constraints that you want all returned products to match.

    • Type (string) – [REQUIRED]

      The type of filter that you want to use.

      Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.

    • Field (string) – [REQUIRED]

      The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.

      Valid values include: ServiceCode, and all attribute names

      For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

    • Value (string) – [REQUIRED]

      The service code or attribute value that you want to filter by. If you’re filtering by service code this is the actual service code, such as AmazonEC2. If you’re filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

• FormatVersion (string) –

  The format version that you want the response to be in.

  Valid values are: aws_v1

• 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

{
    'FormatVersion': 'string',
    'PriceList': [
        'string',
    ],

}

Response Structure

• (dict) –

  • FormatVersion (string) –

    The format version of the response. For example, aws_v1.

  • PriceList (list) –

    The list of products that match your filters. The list contains both the product metadata and the price information.

    • (string) –