delete_gateway¶
Operation¶
async
¶
delete_gateway(input: DeleteGatewayInput, plugins: list[Plugin] | None = None) -> DeleteGatewayOutput
Deletes a gateway. Before you can delete a gateway, deletion protection
must be disabled and the gateway must not have any cluster associations
that are in the ACTIVE or DISASSOCIATING state. If associations
exist, the operation fails; disassociate all clusters first.
DeleteGateway is a synchronous operation. After you delete a gateway,
subsequent requests for it return a GatewayNotFoundException.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DeleteGatewayInput
|
An instance of |
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 |
|---|---|
DeleteGatewayOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteGatewayOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
gateway_arn: str | None = ...
The Amazon Resource Name (ARN) of the deleted gateway.
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.