Skip to content

delete_cluster

Operation

delete_cluster

delete_cluster(request: DeleteClusterInput | DeleteClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteClusterInputDict]) -> DeleteClusterOutput

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Parameters:

Name Type Description Default
request DeleteClusterInput | DeleteClusterInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteClusterOutput

An instance of DeleteClusterOutput.

delete_cluster async

delete_cluster(request: DeleteClusterInput | DeleteClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteClusterInputDict]) -> DeleteClusterOutput

Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Parameters:

Name Type Description Default
request DeleteClusterInput | DeleteClusterInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteClusterOutput

An instance of DeleteClusterOutput.

Input

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

DeleteClusterInputDict

Bases: TypedDict

Dictionary form of DeleteClusterInput.

Attributes

cluster instance-attribute
cluster: Required[str]

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

DeleteClusterInput dataclass

Bases: _SerdeShape

Attributes

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

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

Output

DeleteClusterOutput dataclass

Bases: _SerdeShape

Attributes

cluster class-attribute instance-attribute
cluster: Cluster | None = ...

The full description of the deleted cluster.

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.