GetRequestValidators

class APIGateway.Paginator.GetRequestValidators
paginator = client.get_paginator('get_request_validators')
paginate(**kwargs)

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

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': [
        {
            'id': 'string',
            'name': 'string',
            'validateRequestBody': True|False,
            'validateRequestParameters': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    A collection of RequestValidator resources of a given RestApi.

    • items (list) --

      The current page of elements from this collection.

      • (dict) --

        A set of validation rules for incoming Method requests.

        • id (string) --

          The identifier of this RequestValidator.

        • name (string) --

          The name of this RequestValidator

        • validateRequestBody (boolean) --

          A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

        • validateRequestParameters (boolean) --

          A Boolean flag to indicate whether to validate request parameters ( true ) or not ( false ).

    • NextToken (string) --

      A token to resume pagination.