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

Class: Aws::ECS::Types::ListTasksRequest

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 ListTasksRequest data as a hash:

{
  cluster: "String",
  container_instance: "String",
  family: "String",
  next_token: "String",
  max_results: 1,
  started_by: "String",
  service_name: "String",
  desired_status: "RUNNING", # accepts RUNNING, PENDING, STOPPED
}

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#container_instanceString

The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#desired_statusString

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#familyString

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Returns:

  • (Integer)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#next_tokenString

The nextToken value returned from a previous paginated ListTasks 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)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#service_nameString

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end

#started_byString

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Returns:

  • (String)


2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2485

class ListTasksRequest < Struct.new(
  :cluster,
  :container_instance,
  :family,
  :next_token,
  :max_results,
  :started_by,
  :service_name,
  :desired_status)
  include Aws::Structure
end