You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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
}

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)


2018
2019
2020
2021
2022
2023
2024
2025
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2018

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  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 in the Amazon EC2 Container Service Developer Guide.

Returns:

  • (String)


2018
2019
2020
2021
2022
2023
2024
2025
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2018

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  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)


2018
2019
2020
2021
2022
2023
2024
2025
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2018

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

#next_tokenString

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 value is null when there are no more results to return.

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.

Returns:

  • (String)


2018
2019
2020
2021
2022
2023
2024
2025
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2018

class ListContainerInstancesRequest < Struct.new(
  :cluster,
  :filter,
  :next_token,
  :max_results,
  :status)
  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 ACTIVE and DRAINING.

Returns:

  • (String)


2018
2019
2020
2021
2022
2023
2024
2025
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2018

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