Skip to content

ECS  >  Operations  >  disassociate_gateway_from_cluster

disassociate_gateway_from_cluster

Operation

disassociate_gateway_from_cluster async

disassociate_gateway_from_cluster(request: DisassociateGatewayFromClusterInput | DisassociateGatewayFromClusterInputDict, /, *, plugins: list[Plugin] | None = None) -> DisassociateGatewayFromClusterOutput
disassociate_gateway_from_cluster(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateGatewayFromClusterInputDict]) -> DisassociateGatewayFromClusterOutput

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.

Parameters:

Name Type Description Default
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
DisassociateGatewayFromClusterOutput

An instance of DisassociateGatewayFromClusterOutput.

Input

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

Model

DisassociateGatewayFromClusterInput dataclass

Bases: _SerdeShape

Dataclass for DisassociateGatewayFromClusterInput structure.

Attributes
cluster class-attribute instance-attribute
cluster: str | None = ...

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

gateway class-attribute instance-attribute
gateway: str | None = ...

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

Dictionaries

DisassociateGatewayFromClusterInputDict

Bases: TypedDict

Dictionary form of DisassociateGatewayFromClusterInput.

Attributes
cluster instance-attribute
cluster: Required[str]

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

gateway instance-attribute
gateway: Required[str]

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

Output

DisassociateGatewayFromClusterOutput dataclass

Bases: _SerdeShape

Dataclass for DisassociateGatewayFromClusterOutput structure.

Attributes

cluster_arn class-attribute instance-attribute
cluster_arn: str | None = ...

The Amazon Resource Name (ARN) of the cluster.

gateway_arn class-attribute instance-attribute
gateway_arn: str | None = ...

The Amazon Resource Name (ARN) of the gateway.

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.

status class-attribute instance-attribute
status: str | None = ...

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