DescribeContainerInstances - Amazon Elastic Container Service


Describes one or more container instances. Returns metadata about each container instance requested.

Request Syntax

{ "cluster": "string", "containerInstances": [ "string" ], "include": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

Type: String

Required: No


A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

Type: Array of strings

Required: Yes


Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If CONTAINER_INSTANCE_HEALTH is specified, the container instance health is included in the response. If this field is omitted, tags and container instance health status aren't included in the response.

Type: Array of strings


Required: No

Response Syntax

{ "containerInstances": [ { "agentConnected": boolean, "agentUpdateStatus": "string", "attachments": [ { "details": [ { "name": "string", "value": "string" } ], "id": "string", "status": "string", "type": "string" } ], "attributes": [ { "name": "string", "targetId": "string", "targetType": "string", "value": "string" } ], "capacityProviderName": "string", "containerInstanceArn": "string", "ec2InstanceId": "string", "healthStatus": { "details": [ { "lastStatusChange": number, "lastUpdated": number, "status": "string", "type": "string" } ], "overallStatus": "string" }, "pendingTasksCount": number, "registeredAt": number, "registeredResources": [ { "doubleValue": number, "integerValue": number, "longValue": number, "name": "string", "stringSetValue": [ "string" ], "type": "string" } ], "remainingResources": [ { "doubleValue": number, "integerValue": number, "longValue": number, "name": "string", "stringSetValue": [ "string" ], "type": "string" } ], "runningTasksCount": number, "status": "string", "statusReason": "string", "tags": [ { "key": "string", "value": "string" } ], "version": number, "versionInfo": { "agentHash": "string", "agentVersion": "string", "dockerVersion": "string" } } ], "failures": [ { "arn": "string", "detail": "string", "reason": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The list of container instances.

Type: Array of ContainerInstance objects


Any failures associated with the call.

Type: Array of Failure objects


For information about the errors that are common to all actions, see Common Errors.


These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

The following list includes additional causes for the error:

  • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

HTTP Status Code: 400


The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.

HTTP Status Code: 400


The specified parameter isn't valid. Review the available parameters for the API request.

HTTP Status Code: 400


These errors are usually caused by a server issue.

HTTP Status Code: 500


In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to create them manually. When you use the AWS Command Line Interface or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you, with the access key that you specify when you configure the tools. When you use these tools, you don't have to sign requests yourself.


This example request provides descriptive information about a container instance with an ID of f9cc75bb-0c94-46b9-bf6d-49d320bc1551 in the default cluster.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 64 X-Amz-Target: AmazonEC2ContainerServiceV20141113.DescribeContainerInstances X-Amz-Date: 20160520T171518Z User-Agent: aws-cli/1.10.30 Python/2.7.11 Darwin/15.4.0 botocore/1.4.17 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "containerInstances": [ "f9cc75bb-0c94-46b9-bf6d-49d320bc1551" ] }

Sample Response

{ "containerInstances": [ { "agentConnected": true, "attributes": [ { "name": "com.amazonaws.ecs.capability.privileged-container" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" }, { "name": "com.amazonaws.ecs.capability.logging-driver.json-file" }, { "name": "com.amazonaws.ecs.capability.logging-driver.syslog" }, { "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" }, { "name": "com.amazonaws.ecs.capability.ecr-auth" } ], "containerInstanceArn": "arn:aws:ecs:us-west-2:012345678910:container-instance/default/f9cc75bb-0c94-46b9-bf6d-49d320bc1551", "ec2InstanceId": "i-042f39dc", "pendingTasksCount": 0, "registeredResources": [ { "doubleValue": 0, "integerValue": 1024, "longValue": 0, "name": "CPU", "type": "INTEGER" }, { "doubleValue": 0, "integerValue": 995, "longValue": 0, "name": "MEMORY", "type": "INTEGER" }, { "doubleValue": 0, "integerValue": 0, "longValue": 0, "name": "PORTS", "stringSetValue": [ "22", "2376", "2375", "51678" ], "type": "STRINGSET" }, { "doubleValue": 0, "integerValue": 0, "longValue": 0, "name": "PORTS_UDP", "stringSetValue": [], "type": "STRINGSET" } ], "remainingResources": [ { "doubleValue": 0, "integerValue": 1024, "longValue": 0, "name": "CPU", "type": "INTEGER" }, { "doubleValue": 0, "integerValue": 995, "longValue": 0, "name": "MEMORY", "type": "INTEGER" }, { "doubleValue": 0, "integerValue": 0, "longValue": 0, "name": "PORTS", "stringSetValue": [ "22", "2376", "2375", "51678" ], "type": "STRINGSET" }, { "doubleValue": 0, "integerValue": 0, "longValue": 0, "name": "PORTS_UDP", "stringSetValue": [], "type": "STRINGSET" } ], "runningTasksCount": 0, "status": "ACTIVE", "version": 850, "versionInfo": { "agentHash": "0931217", "agentVersion": "1.9.0", "dockerVersion": "DockerVersion: 1.9.1" } } ], "failures": [] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: