Skip to content

get_request_validator

Operation

get_request_validator

get_request_validator(request: GetRequestValidatorInput | GetRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRequestValidatorInputDict]) -> GetRequestValidatorOutput

Gets a RequestValidator of a given RestApi.

Parameters:

Name Type Description Default
request GetRequestValidatorInput | GetRequestValidatorInputDict | 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[GetRequestValidatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRequestValidatorOutput

An instance of GetRequestValidatorOutput.

get_request_validator async

get_request_validator(request: GetRequestValidatorInput | GetRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRequestValidatorInputDict]) -> GetRequestValidatorOutput

Gets a RequestValidator of a given RestApi.

Parameters:

Name Type Description Default
request GetRequestValidatorInput | GetRequestValidatorInputDict | 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[GetRequestValidatorInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetRequestValidatorOutput

An instance of GetRequestValidatorOutput.

Input

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

GetRequestValidatorInputDict

Bases: TypedDict

Dictionary form of GetRequestValidatorInput.

Attributes

request_validator_id instance-attribute
request_validator_id: Required[str]

The identifier of the RequestValidator to be retrieved.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

GetRequestValidatorInput dataclass

Bases: _SerdeShape

Gets a RequestValidator of a given RestApi.

Attributes

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

The identifier of the RequestValidator to be retrieved.

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

The string identifier of the associated RestApi.

Output

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