Skip to content

delete_gateway_response

Operation

delete_gateway_response

delete_gateway_response(request: DeleteGatewayResponseInput | DeleteGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayResponseInputDict]) -> DeleteGatewayResponseOutput

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Parameters:

Name Type Description Default
request DeleteGatewayResponseInput | DeleteGatewayResponseInputDict | 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[DeleteGatewayResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayResponseOutput

An instance of DeleteGatewayResponseOutput.

delete_gateway_response async

delete_gateway_response(request: DeleteGatewayResponseInput | DeleteGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGatewayResponseInputDict]) -> DeleteGatewayResponseOutput

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Parameters:

Name Type Description Default
request DeleteGatewayResponseInput | DeleteGatewayResponseInputDict | 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[DeleteGatewayResponseInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGatewayResponseOutput

An instance of DeleteGatewayResponseOutput.

Input

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

DeleteGatewayResponseInputDict

Bases: TypedDict

Dictionary form of DeleteGatewayResponseInput.

Attributes

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.

DeleteGatewayResponseInput dataclass

Bases: _SerdeShape

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

Attributes

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

DeleteGatewayResponseOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteGatewayResponseOutput structure.

Attributes

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.