ApiGatewayV2 / Client / list_product_pages

list_product_pages

ApiGatewayV2.Client.list_product_pages(**kwargs)

Lists the product pages for a portal product.

See also: AWS API Documentation

Request Syntax

response = client.list_product_pages(
    MaxResults='string',
    NextToken='string',
    PortalProductId='string',
    ResourceOwnerAccountId='string'
)
Parameters:
  • MaxResults (string) – The maximum number of elements to be returned for this resource.

  • NextToken (string) – The next page of elements from this collection. Not valid for the last element of the collection.

  • PortalProductId (string) –

    [REQUIRED]

    The portal product identifier.

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

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'LastModified': datetime(2015, 1, 1),
            'PageTitle': 'string',
            'ProductPageArn': 'string',
            'ProductPageId': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The next page of elements from this collection. Not valid for the last element of the collection.

Exceptions

  • ApiGatewayV2.Client.exceptions.NotFoundException

  • ApiGatewayV2.Client.exceptions.TooManyRequestsException

  • ApiGatewayV2.Client.exceptions.BadRequestException

  • ApiGatewayV2.Client.exceptions.AccessDeniedException