Returns a list of container instances in a specified cluster. You can
filter the results of a ListContainerInstances
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.
ecs_list_container_instances(cluster, filter, nextToken, maxResults,
status)
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.
You can filter the results of a ListContainerInstances
operation with
cluster query language statements. For more information, see Cluster Query Language
in the Amazon Elastic Container Service Developer Guide.
The nextToken
value returned from a previous paginated
ListContainerInstances
request where maxResults
was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken
value.
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.
The maximum number of container instance results returned by
ListContainerInstances
in paginated output. When this parameter is
used, ListContainerInstances
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
ListContainerInstances
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used, then
ListContainerInstances
returns up to 100 results and a nextToken
value if applicable.
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 UpdateContainerInstancesState. If you
do not specify this parameter, the default is to include container
instances set to ACTIVE
and DRAINING
.
svc$list_container_instances( cluster = "string", filter = "string", nextToken = "string", maxResults = 123, status = "ACTIVE"|"DRAINING" )
# NOT RUN {
# This example lists all of your available container instances in the
# specified cluster in your default region.
# }
# NOT RUN {
svc$list_container_instances(
cluster = "default"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab