APIGateway / Client / get_request_validators

get_request_validators#

APIGateway.Client.get_request_validators(**kwargs)#

Gets the RequestValidators collection of a given RestApi.

Request Syntax

response = client.get_request_validators(
    restApiId='string',
    position='string',
    limit=123
)

Parameters:

restApiId (string) –
[REQUIRED]

The string identifier of the associated RestApi.
position (string) – The current pagination position in the paged result set.
limit (integer) – The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Return type:

dict

Returns:

Response Syntax

{
    'position': 'string',
    'items': [
        {
            'id': 'string',
            'name': 'string',
            'validateRequestBody': True|False,
            'validateRequestParameters': True|False
        },
    ]
}

Response Structure

(dict) –

A collection of RequestValidator resources of a given RestApi.
- position (string) –
- 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).

Exceptions

APIGateway.Client.exceptions.BadRequestException
APIGateway.Client.exceptions.NotFoundException
APIGateway.Client.exceptions.UnauthorizedException
APIGateway.Client.exceptions.TooManyRequestsException