ApiGatewayV2 / Paginator / GetRouteResponses

GetRouteResponses

class ApiGatewayV2.Paginator.GetRouteResponses

paginator = client.get_paginator('get_route_responses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApiGatewayV2.Client.get_route_responses().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApiId (string) –

  [REQUIRED]

  The API identifier.

• RouteId (string) –

  [REQUIRED]

  The route ID.

• 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': [
        {
            'ModelSelectionExpression': 'string',
            'ResponseModels': {
                'string': 'string'
            },
            'ResponseParameters': {
                'string': {
                    'Required': True|False
                }
            },
            'RouteResponseId': 'string',
            'RouteResponseKey': 'string'
        },
    ],

}

Response Structure

• (dict) –

  Success

  • Items (list) –

    The elements from this collection.

    • (dict) –

      Represents a route response.

      • ModelSelectionExpression (string) –

        Represents the model selection expression of a route response. Supported only for WebSocket APIs.

      • ResponseModels (dict) –

        Represents the response models of a route response.

        • (string) –

          • (string) –

            A string with a length between [1-128].

      • ResponseParameters (dict) –

        Represents the response parameters of a route response.

        • (string) –

          • (dict) –

            Validation constraints imposed on parameters of a request (path, query string, headers).

            • Required (boolean) –

              Whether or not the parameter is required.

      • RouteResponseId (string) –

        Represents the identifier of a route response.

      • RouteResponseKey (string) –

        Represents the route response key of a route response.