APIGateway / Paginator / GetGatewayResponses


class APIGateway.Paginator.GetGatewayResponses#
paginator = client.get_paginator('get_gateway_responses')

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(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • restApiId (string) –


    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:



Response Syntax

    'items': [
            '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.