ECS / Client / disassociate_gateway_from_cluster

disassociate_gateway_from_cluster

ECS.Client.disassociate_gateway_from_cluster(**kwargs)

Removes the association between a gateway and an Amazon ECS cluster. The association remains in the DISASSOCIATING state until you remove all of the gateway routes for the cluster by updating the associated services. You can use ListGatewayRoutes with a cluster filter to determine which routes are preventing disassociation. No infrastructure changes are made until the affected services are updated.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_gateway_from_cluster(
    gateway='string',
    cluster='string'
)
Parameters:

  • gateway (string) –

    [REQUIRED]

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

  • cluster (string) –

    [REQUIRED]

    The name or Amazon Resource Name (ARN) of the cluster to disassociate the gateway from.

Return type:

dict

Returns:

Response Syntax

{
    'gatewayArn': 'string',
    'clusterArn': 'string',
    'status': 'ACTIVE'|'DISASSOCIATING'|'INACTIVE'
}

Response Structure

  • (dict) –

    • gatewayArn (string) –

      The Amazon Resource Name (ARN) of the gateway.

    • clusterArn (string) –

      The Amazon Resource Name (ARN) of the cluster.

    • status (string) –

      The status of the association. After a successful request, the status is DISASSOCIATING until all routes are removed, after which the association is deleted.

Exceptions