Skip to content

update_gateway_response

Operation

update_gateway_response

update_gateway_response(request: UpdateGatewayResponseInput | UpdateGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayResponseInputDict]) -> UpdateGatewayResponseOutput

Updates a GatewayResponse of a specified response type on the given RestApi.

Parameters:

Name Type Description Default
request UpdateGatewayResponseInput | UpdateGatewayResponseInputDict | 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[UpdateGatewayResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGatewayResponseOutput

An instance of UpdateGatewayResponseOutput.

update_gateway_response async

update_gateway_response(request: UpdateGatewayResponseInput | UpdateGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGatewayResponseInputDict]) -> UpdateGatewayResponseOutput

Updates a GatewayResponse of a specified response type on the given RestApi.

Parameters:

Name Type Description Default
request UpdateGatewayResponseInput | UpdateGatewayResponseInputDict | 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[UpdateGatewayResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGatewayResponseOutput

An instance of UpdateGatewayResponseOutput.

Input

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

UpdateGatewayResponseInputDict

Bases: TypedDict

Dictionary form of UpdateGatewayResponseInput.

Attributes

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

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

response_type instance-attribute
response_type: Required[str]

The response type of the associated GatewayResponse.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

UpdateGatewayResponseInput dataclass

Bases: _SerdeShape

Updates a GatewayResponse of a specified response type on the given RestApi.

Attributes

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

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

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

The response type of the associated GatewayResponse.

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

The string identifier of the associated RestApi.

Output

UpdateGatewayResponseOutput dataclass

Bases: _SerdeShape

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

Attributes

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

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

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.

response_parameters class-attribute instance-attribute
response_parameters: dict[str, str] | None = ...

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

response_templates class-attribute instance-attribute
response_templates: dict[str, str] | None = ...

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

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

The response type of the associated GatewayResponse.

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

The HTTP status code for this GatewayResponse.