Skip to content

ECS  >  Operations  >  describe_clusters

describe_clusters

Operation

describe_clusters async 

describe_clusters(input: DescribeClustersInput, plugins: list[Plugin] | None = None) -> DescribeClustersOutput

Describes one or more of your clusters.

For CLI examples, see describe-clusters.rst on GitHub.

Parameters:

Name Type Description Default
input DescribeClustersInput

An instance of DescribeClustersInput.

 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
DescribeClustersOutput

An instance of DescribeClustersOutput.

Input

DescribeClustersInput dataclass

Bases: _SerdeShape

Attributes

clusters class-attribute instance-attribute 
clusters: list[str] | None = ...

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

include class-attribute instance-attribute 
include: list[str] | None = ...

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

Output

DescribeClustersOutput dataclass

Bases: _SerdeShape

Attributes

clusters class-attribute instance-attribute 
clusters: list[Cluster] | None = ...

The list of clusters.

failures class-attribute instance-attribute 
failures: list[Failure] | None = ...

Any failures associated with the call.

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.