Api Gateway  >  Operations  >  delete_gateway_response

delete_gateway_response

Operation

delete_gateway_response async

delete_gateway_response(input: DeleteGatewayResponseInput, plugins: list[Plugin] | None = None) -> 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
input	DeleteGatewayResponseInput	An instance of DeleteGatewayResponseInput.	required
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

Returns:

Type	Description
DeleteGatewayResponseOutput	An instance of DeleteGatewayResponseOutput.

Input

DeleteGatewayResponseInput dataclass

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: GatewayResponseType | None = None

The response type of the associated GatewayResponse.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

DeleteGatewayResponseOutput dataclass

Dataclass for DeleteGatewayResponseOutput structure.