You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ECS::Types::ListContainerInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListContainerInstancesRequest
- Defined in:
- (unknown)
Overview
When passing ListContainerInstancesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
cluster: "String",
filter: "String",
next_token: "String",
max_results: 1,
status: "ACTIVE", # accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
}
Instance Attribute Summary collapse
-
#cluster ⇒ String
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list.
-
#filter ⇒ String
You can filter the results of a
ListContainerInstances
operation with cluster query language statements. -
#max_results ⇒ Integer
The maximum number of container instance results returned by
ListContainerInstances
in paginated output. -
#next_token ⇒ String
The
nextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls will be needed. -
#status ⇒ String
Filters the container instances by status.
Instance Attribute Details
#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 ListContainerInstances
operation with
cluster query language statements. For more information, see Cluster
Query Language in the Amazon Elastic Container Service Developer
Guide.
#max_results ⇒ Integer
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.
#next_token ⇒ String
The nextToken
value returned from a ListContainerInstances
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
.
#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 UpdateContainerInstancesState.
If you do not specify this parameter, the default is to include
container instances set to all states other than INACTIVE
.
Possible values:
- ACTIVE
- DRAINING
- REGISTERING
- DEREGISTERING
- REGISTRATION_FAILED