APIGateway / Paginator / GetGatewayResponses

GetGatewayResponses

class APIGateway.Paginator.GetGatewayResponses

paginator = client.get_paginator('get_gateway_responses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from APIGateway.Client.get_gateway_responses().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• restApiId (string) –

  [REQUIRED]

  The string identifier of the associated RestApi.

• 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': [
        {
            'responseType': 'DEFAULT_4XX'|'DEFAULT_5XX'|'RESOURCE_NOT_FOUND'|'UNAUTHORIZED'|'INVALID_API_KEY'|'ACCESS_DENIED'|'AUTHORIZER_FAILURE'|'AUTHORIZER_CONFIGURATION_ERROR'|'INVALID_SIGNATURE'|'EXPIRED_TOKEN'|'MISSING_AUTHENTICATION_TOKEN'|'INTEGRATION_FAILURE'|'INTEGRATION_TIMEOUT'|'API_CONFIGURATION_ERROR'|'UNSUPPORTED_MEDIA_TYPE'|'BAD_REQUEST_PARAMETERS'|'BAD_REQUEST_BODY'|'REQUEST_TOO_LARGE'|'THROTTLED'|'QUOTA_EXCEEDED'|'WAF_FILTERED',
            'statusCode': 'string',
            'responseParameters': {
                'string': 'string'
            },
            'responseTemplates': {
                'string': 'string'
            },
            'defaultResponse': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

  • items (list) –

    Returns the entire collection, because of no pagination support.

    • (dict) –

      A gateway response of a given response type and status code, with optional response parameters and mapping templates.

      • responseType (string) –

        The response type of the associated GatewayResponse.

      • statusCode (string) –

        The HTTP status code for this GatewayResponse.

      • responseParameters (dict) –

        Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

        • (string) –

          • (string) –

      • responseTemplates (dict) –

        Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

        • (string) –

          • (string) –

      • defaultResponse (boolean) –

        A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not ( false). A default gateway response is one generated by API Gateway without any customization by an API developer.

  • NextToken (string) –

    A token to resume pagination.