ApiGatewayV2 / Client / list_product_rest_endpoint_pages

list_product_rest_endpoint_pages

ApiGatewayV2.Client.list_product_rest_endpoint_pages(**kwargs)

Lists the product REST endpoint pages of a portal product.

See also: AWS API Documentation

Request Syntax

response = client.list_product_rest_endpoint_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': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

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

Exceptions