ApiGatewayV2 / Paginator / ListProductPages

ListProductPages

class ApiGatewayV2.Paginator.ListProductPages

paginator = client.get_paginator('list_product_pages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.list_product_pages().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PortalProductId='string',
    ResourceOwnerAccountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PortalProductId (string) –

  [REQUIRED]

  The portal product identifier.

• ResourceOwnerAccountId (string) – The account ID of the resource owner of the portal product.

• 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

{
    'Items': [
        {
            'LastModified': datetime(2015, 1, 1),
            'PageTitle': 'string',
            'ProductPageArn': 'string',
            'ProductPageId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Success

  • Items (list) –

    The elements from this collection.

    • (dict) –

      Represents a product page summary without listing any page content.

      • LastModified (datetime) –

        The timestamp when the product page was last modified.

      • PageTitle (string) –

        The page title.

      • ProductPageArn (string) –

        The ARN of the product page.

      • ProductPageId (string) –

        The product page identifier.