ApiGatewayV2 / Paginator / ListProductRestEndpointPages

ListProductRestEndpointPages

class ApiGatewayV2.Paginator.ListProductRestEndpointPages

paginator = client.get_paginator('list_product_rest_endpoint_pages')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.list_product_rest_endpoint_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': [
        {
            'Endpoint': 'string',
            'LastModified': datetime(2015, 1, 1),
            'OperationName': 'string',
            'ProductRestEndpointPageArn': 'string',
            'ProductRestEndpointPageId': 'string',
            'RestEndpointIdentifier': {
                'IdentifierParts': {
                    'Method': 'string',
                    'Path': 'string',
                    'RestApiId': 'string',
                    'Stage': 'string'
                }
            },
            'Status': 'AVAILABLE'|'IN_PROGRESS'|'FAILED',
            'StatusException': {
                'Exception': 'string',
                'Message': 'string'
            },
            'TryItState': 'ENABLED'|'DISABLED'
        },
    ],

}

Response Structure

• (dict) –

  Success

  • Items (list) –

    The elements from this collection.

    • (dict) –

      A summary of a product REST endpoint page, without providing the page content.

      • Endpoint (string) –

        The endpoint of the product REST endpoint page.

      • LastModified (datetime) –

        The timestamp when the product REST endpoint page was last modified.

      • OperationName (string) –

        The operation name of the product REST endpoint.

      • ProductRestEndpointPageArn (string) –

        The ARN of the product REST endpoint page.

      • ProductRestEndpointPageId (string) –

        The product REST endpoint page identifier.

      • RestEndpointIdentifier (dict) –

        The REST endpoint identifier.

        • IdentifierParts (dict) –

          The identifier parts of the REST endpoint identifier.

          • Method (string) –

            The method of the product REST endpoint.

          • Path (string) –

            The path of the product REST endpoint.

          • RestApiId (string) –

            The REST API ID of the product REST endpoint.

          • Stage (string) –

            The stage of the product REST endpoint.

      • Status (string) –

        The status.

      • StatusException (dict) –

        The status exception information.

        • Exception (string) –

          The exception.

        • Message (string) –

          The error message.

      • TryItState (string) –

        The try it state of a product REST endpoint page.