Skip to content

API Gateway  >  Operations  >  update_request_validator

update_request_validator

Operation

update_request_validator async 

update_request_validator(input: UpdateRequestValidatorInput, plugins: list[Plugin] | None = None) -> UpdateRequestValidatorOutput

Updates a RequestValidator of a given RestApi.

Parameters:

Name Type Description Default
input UpdateRequestValidatorInput

An instance of UpdateRequestValidatorInput.

 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
UpdateRequestValidatorOutput

An instance of UpdateRequestValidatorOutput.

Input

UpdateRequestValidatorInput dataclass

Updates a RequestValidator of a given RestApi.

Attributes

patch_operations class-attribute instance-attribute 
patch_operations: list[PatchOperation] | None = None

For more information about supported patch operations, see Patch Operations.

request_validator_id class-attribute instance-attribute 
request_validator_id: str | None = None

The identifier of RequestValidator to be updated.

rest_api_id class-attribute instance-attribute 
rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

UpdateRequestValidatorOutput 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).