List Container Instances
ecs_list_container_instances | R Documentation |
Returns a list of container instances in a specified cluster¶
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¶
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
|
nextToken |
The 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 that
|
status |
Filters the container instances by status. For example, if you
specify the |
Value¶
A list with the following syntax:
list(
containerInstanceArns = list(
"string"
),
nextToken = "string"
)
Request syntax¶
svc$list_container_instances(
cluster = "string",
filter = "string",
nextToken = "string",
maxResults = 123,
status = "ACTIVE"|"DRAINING"|"REGISTERING"|"DEREGISTERING"|"REGISTRATION_FAILED"
)
Examples¶
## 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)