Skip to content

update_request_validator

Operation

update_request_validator

update_request_validator(request: UpdateRequestValidatorInput | UpdateRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRequestValidatorInputDict]) -> UpdateRequestValidatorOutput

Updates a RequestValidator of a given RestApi.

Parameters:

Name Type Description Default
request UpdateRequestValidatorInput | UpdateRequestValidatorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRequestValidatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRequestValidatorOutput

An instance of UpdateRequestValidatorOutput.

update_request_validator async

update_request_validator(request: UpdateRequestValidatorInput | UpdateRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRequestValidatorInputDict]) -> UpdateRequestValidatorOutput

Updates a RequestValidator of a given RestApi.

Parameters:

Name Type Description Default
request UpdateRequestValidatorInput | UpdateRequestValidatorInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateRequestValidatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRequestValidatorOutput

An instance of UpdateRequestValidatorOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateRequestValidatorInputDict

Bases: TypedDict

Dictionary form of UpdateRequestValidatorInput.

Attributes

patch_operations instance-attribute
patch_operations: Sequence[PatchOperation | PatchOperationDict] | None

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

request_validator_id instance-attribute
request_validator_id: Required[str]

The identifier of RequestValidator to be updated.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

UpdateRequestValidatorInput dataclass

Bases: _SerdeShape

Updates a RequestValidator of a given RestApi.

Attributes

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

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

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

The identifier of RequestValidator to be updated.

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

The string identifier of the associated RestApi.

Output

UpdateRequestValidatorOutput dataclass

Bases: _SerdeShape

A set of validation rules for incoming Method requests.

Attributes

id class-attribute instance-attribute
id: str | None = ...

The identifier of this RequestValidator.

name class-attribute instance-attribute
name: str | None = ...

The name of this RequestValidator

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

validate_request_body class-attribute instance-attribute
validate_request_body: bool = ...

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 = ...

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