ecs_list_container_instances: Returns a list of container instances in a specified cluster

Description Usage Arguments Value Request syntax Examples

View source: R/ecs_operations.R

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 Elastic Container Service Developer Guide.

Usage

1
2
ecs_list_container_instances(cluster, filter, nextToken, maxResults,
  status)

Arguments

cluster

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

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 Elastic Container Service Developer Guide.

nextToken

The nextToken value returned from a list_container_instances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

The maximum number of container instance results returned by list_container_instances in paginated output. When this parameter is used, list_container_instances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another list_container_instances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then list_container_instances returns up to 100 results and a nextToken value if applicable.

status

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 all states other than INACTIVE.

Value

A list with the following syntax:

1
2
3
4
5
6
list(
  containerInstanceArns = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax

1
2
3
4
5
6
7
svc$list_container_instances(
  cluster = "string",
  filter = "string",
  nextToken = "string",
  maxResults = 123,
  status = "ACTIVE"|"DRAINING"|"REGISTERING"|"DEREGISTERING"|"REGISTRATION_FAILED"
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# This example lists all of your available container instances in the
# specified cluster in your default region.
svc$list_container_instances(
  cluster = "default"
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.