Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ecs ]

list-container-instances

Description

Returns a list of container instances in a specified cluster. You can filter the results of a list-container-instances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .

See also: AWS API Documentation

list-container-instances is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: containerInstanceArns

Synopsis

  list-container-instances
[--cluster <value>]
[--filter <value>]
[--status <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cluster (string)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

--filter (string)

You can filter the results of a list-container-instances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide .

--status (string)

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using update-container-instances-state . If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING .

Possible values:

  • ACTIVE
  • DRAINING

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

--page-size (integer)

The size of each page.

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination. This NextToken response element should not be used directly outside of the AWS CLI.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Examples

To list your available container instances in a cluster

This example command lists all of your available container instances in the specified cluster in your default region.

Command:

aws ecs list-container-instances --cluster default

Output:

{
    "containerInstanceArns": [
        "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f",
        "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb"
    ]
}

Output

containerInstanceArns -> (list)

The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

(string)

nextToken -> (string)

The nextToken value to include in a future list-container-instances request. When the results of a list-container-instances request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.