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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ListTasksRequest

Defined in:

gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cluster ⇒ String

  The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results.

• #container_instance ⇒ String

  The container instance ID or full ARN of the container instance to use when filtering the ListTasks results.

• #desired_status ⇒ String

  The task desired status to use when filtering the ListTasks results.

• #family ⇒ String

  The name of the task definition family to use when filtering the ListTasks results.

• #launch_type ⇒ String

  The launch type to use when filtering the ListTasks results.

• #max_results ⇒ Integer

  The maximum number of task results that ListTasks returned in paginated output.

• #next_token ⇒ String

  The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed.

• #service_name ⇒ String

  The name of the service to use when filtering the ListTasks results.

• #started_by ⇒ String

  The startedBy value to filter the task results with.

Instance Attribute Details

#cluster ⇒ String

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#container_instance ⇒ String

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#desired_status ⇒ String

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that aren't starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this doesn't return any results. Amazon 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)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#family ⇒ String

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#launch_type ⇒ String

The launch type to use when filtering the ListTasks results.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#max_results ⇒ Integer

The maximum number of task results that ListTasks returned 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 isn't used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Returns:

• (Integer)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#next_token ⇒ String

The nextToken value returned from a ListTasks request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

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)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#service_name ⇒ String

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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

#started_by ⇒ String

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

When you specify startedBy as the filter, it must be the only filter that you use.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6405

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