Class: Aws::ECS::Types::ListContainerInstancesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ListContainerInstancesRequest data as a hash:

{
  cluster: "String",
  filter: "String",
  next_token: "String",
  max_results: 1,
  status: "ACTIVE", # accepts ACTIVE, DRAINING, REGISTERING, DEREGISTERING, REGISTRATION_FAILED
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

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.

Returns:

  • (String)

6106
6107
6108
6109
6110
6111
6112
6113
6114
# File 'lib/aws-sdk-ecs/types.rb', line 6106

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#filterString

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

Returns:

  • (String)

6106
6107
6108
6109
6110
6111
6112
6113
6114
# File 'lib/aws-sdk-ecs/types.rb', line 6106

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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.

Returns:

  • (Integer)

6106
6107
6108
6109
6110
6111
6112
6113
6114
# File 'lib/aws-sdk-ecs/types.rb', line 6106

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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`.

<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>

Returns:

  • (String)

6106
6107
6108
6109
6110
6111
6112
6113
6114
# File 'lib/aws-sdk-ecs/types.rb', line 6106

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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`.

Returns:

  • (String)

6106
6107
6108
6109
6110
6111
6112
6113
6114
# File 'lib/aws-sdk-ecs/types.rb', line 6106

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  SENSITIVE = []
  include Aws::Structure
end