ECS / Client / delete_gateway

delete_gateway

ECS.Client.delete_gateway(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_gateway(
    gateway='string'
)
Parameters:

gateway (string) –

[REQUIRED]

The name or Amazon Resource Name (ARN) of the gateway to delete.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayArn': 'string',
    'name': 'string',
    'status': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_FAILED'|'DELETED'
}

Response Structure

  • (dict) –

    • gatewayArn (string) –

      The Amazon Resource Name (ARN) of the deleted gateway.

    • name (string) –

      The name of the deleted gateway.

    • status (string) –

      The status of the gateway. After a successful delete, the status is DELETED.

Exceptions