Class: Aws::ECS::Types::ListContainerInstancesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListContainerInstancesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
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 that ‘ListContainerInstances` returned in paginated output.
-
#next_token ⇒ String
The ‘nextToken` value returned from a `ListContainerInstances` request indicating that more results are available to fulfill the request and further calls are 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.
5893 5894 5895 5896 5897 5898 5899 5900 5901 |
# File 'lib/aws-sdk-ecs/types.rb', line 5893 class ListContainerInstancesRequest < Struct.new( :cluster, :filter, :next_token, :max_results, :status) SENSITIVE = [] include Aws::Structure end |
#filter ⇒ String
You can filter the results of a ‘ListContainerInstances` operation with cluster query language statements. For more information, see
- Cluster Query Language][1
-
in the *Amazon Elastic Container Service
Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
5893 5894 5895 5896 5897 5898 5899 5900 5901 |
# File 'lib/aws-sdk-ecs/types.rb', line 5893 class ListContainerInstancesRequest < Struct.new( :cluster, :filter, :next_token, :max_results, :status) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of container instance results that ‘ListContainerInstances` returned 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 isn’t used, then ‘ListContainerInstances` returns up to 100 results and a `nextToken` value if applicable.
5893 5894 5895 5896 5897 5898 5899 5900 5901 |
# File 'lib/aws-sdk-ecs/types.rb', line 5893 class ListContainerInstancesRequest < Struct.new( :cluster, :filter, :next_token, :max_results, :status) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ String
The ‘nextToken` value returned from a `ListContainerInstances` request indicating that more results are available to fulfill the request and further calls are needed. If `maxResults` was provided, it’s possible the number of results to be fewer than ‘maxResults`.
<note markdown=“1”> 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.
</note>
5893 5894 5895 5896 5897 5898 5899 5900 5901 |
# File 'lib/aws-sdk-ecs/types.rb', line 5893 class ListContainerInstancesRequest < Struct.new( :cluster, :filter, :next_token, :max_results, :status) SENSITIVE = [] include Aws::Structure end |
#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 don’t specify this parameter, the default is to include container instances set to all states other than ‘INACTIVE`.
[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateContainerInstancesState.html
5893 5894 5895 5896 5897 5898 5899 5900 5901 |
# File 'lib/aws-sdk-ecs/types.rb', line 5893 class ListContainerInstancesRequest < Struct.new( :cluster, :filter, :next_token, :max_results, :status) SENSITIVE = [] include Aws::Structure end |