create_request_validator¶
Operation¶
create_request_validator
¶
create_request_validator(request: CreateRequestValidatorInput | CreateRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRequestValidatorInputDict]) -> CreateRequestValidatorOutput
Creates a RequestValidator of a given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRequestValidatorInput | CreateRequestValidatorInputDict | 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[CreateRequestValidatorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRequestValidatorOutput
|
An instance of |
create_request_validator
async
¶
create_request_validator(request: CreateRequestValidatorInput | CreateRequestValidatorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateRequestValidatorInputDict]) -> CreateRequestValidatorOutput
Creates a RequestValidator of a given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateRequestValidatorInput | CreateRequestValidatorInputDict | 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[CreateRequestValidatorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateRequestValidatorOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateRequestValidatorInputDict
¶
Bases: TypedDict
Dictionary form of CreateRequestValidatorInput.
Attributes¶
rest_api_id
instance-attribute
¶
The string identifier of the associated RestApi.
CreateRequestValidatorInput
dataclass
¶
Bases: _SerdeShape
Creates a RequestValidator of a given RestApi.
Attributes¶
name
class-attribute
instance-attribute
¶
name: str | None = ...
The name of the to-be-created RequestValidator.
rest_api_id
class-attribute
instance-attribute
¶
rest_api_id: str | None = ...
The string identifier of the associated RestApi.
Output¶
CreateRequestValidatorOutput
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.
response_metadata
class-attribute
instance-attribute
¶
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.