Api Gateway  >  Operations  >  get_request_validator

get_request_validator

Operation

get_request_validator async

get_request_validator(input: GetRequestValidatorInput, plugins: list[Plugin] | None = None) -> GetRequestValidatorOutput

Gets a RequestValidator of a given RestApi.

Parameters:

Name	Type	Description	Default
input	GetRequestValidatorInput	An instance of GetRequestValidatorInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetRequestValidatorOutput	An instance of GetRequestValidatorOutput.

Input

GetRequestValidatorInput dataclass

Gets a RequestValidator of a given RestApi.

Attributes

request_validator_id class-attribute instance-attribute

request_validator_id: str | None = None

The identifier of the RequestValidator to be retrieved.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

GetRequestValidatorOutput dataclass

A set of validation rules for incoming Method requests.

Attributes

id class-attribute instance-attribute

id: str | None = None

The identifier of this RequestValidator.

name class-attribute instance-attribute

name: str | None = None

The name of this RequestValidator

validate_request_body class-attribute instance-attribute

validate_request_body: bool = False

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

validate_request_parameters class-attribute instance-attribute

validate_request_parameters: bool = False

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