Describes one or more of your clusters.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-clusters
[--clusters <value>]
[--include <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--clusters
(list)
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.
(string)
Syntax:
"string" "string" ...
--include
(list)
Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.
If
ATTACHMENTS
is specified, the attachments for the container instances or tasks within the cluster are included.If
SETTINGS
is specified, the settings for the cluster are included.If
STATISTICS
is specified, the following additional information, separated by launch type, is included:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
If
TAGS
is specified, the metadata tags associated with the cluster are included.(string)
Syntax:
"string" "string" ...
Where valid values are:
ATTACHMENTS
SETTINGS
STATISTICS
TAGS
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe a cluster
The following describe-clusters
example retrieves details about the specified cluster.
aws ecs describe-clusters --cluster default
Output:
{
"clusters": [
{
"status": "ACTIVE",
"clusterName": "default",
"registeredContainerInstancesCount": 0,
"pendingTasksCount": 0,
"runningTasksCount": 0,
"activeServicesCount": 1,
"clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default"
}
],
"failures": []
}
For more information, see Amazon ECS Clusters in the Amazon ECS Developer Guide.
clusters -> (list)
The list of clusters.
(structure)
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
clusterArn -> (string)
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, thecluster
namespace, and then the cluster name. For example,arn:aws:ecs:region:012345678910:cluster/test
.clusterName -> (string)
A user-generated string that you use to identify your cluster.
status -> (string)
The status of the cluster. The following are the possible states that will be returned.
ACTIVE
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
PROVISIONING
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
DEPROVISIONING
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
FAILED
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
INACTIVE
The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely onINACTIVE
clusters persisting.registeredContainerInstancesCount -> (integer)
The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
andDRAINING
status.runningTasksCount -> (integer)
The number of tasks in the cluster that are in the
RUNNING
state.pendingTasksCount -> (integer)
The number of tasks in the cluster that are in the
PENDING
state.activeServicesCount -> (integer)
The number of services that are running on the cluster in an
ACTIVE
state. You can view these services with ListServices .statistics -> (list)
Additional information about your clusters that are separated by launch type, including:
runningEC2TasksCount
RunningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.
tags -> (list)
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.(structure)
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.key -> (string)
One part of a key-value pair that make up a tag. A
key
is a general label that acts like a category for more specific tag values.value -> (string)
The optional part of a key-value pair that make up a tag. A
value
acts as a descriptor within a tag category (key).settings -> (list)
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
(structure)
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
name -> (string)
The name of the cluster setting. The only supported value is
containerInsights
.value -> (string)
The value to set for the cluster setting. The supported values are
enabled
anddisabled
. Ifenabled
is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless thecontainerInsights
account setting is enabled. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault .capacityProviders -> (list)
The capacity providers associated with the cluster.
(string)
defaultCapacityProviderStrategy -> (list)
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
(structure)
The details of a capacity provider strategy.
capacityProvider -> (string)
The short name of the capacity provider.
weight -> (integer)
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .base -> (integer)
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
attachments -> (list)
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
(structure)
An object representing a container instance or task attachment.
id -> (string)
The unique identifier for the attachment.
type -> (string)
The type of the attachment, such as
ElasticNetworkInterface
.status -> (string)
The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
, andDELETED
.details -> (list)
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
(structure)
A key-value pair object.
name -> (string)
The name of the key-value pair. For environment variables, this is the name of the environment variable.
value -> (string)
The value of the key-value pair. For environment variables, this is the value of the environment variable.
attachmentsStatus -> (string)
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
UPDATE_IN_PROGRESS
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
UPDATE_COMPLETE
The capacity providers have successfully updated.
UPDATE_FAILED
The capacity provider updates failed.
failures -> (list)
Any failures associated with the call.
(structure)
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide .
arn -> (string)
The Amazon Resource Name (ARN) of the failed resource.
reason -> (string)
The reason for the failure.
detail -> (string)
The details of the failure.