class Aws::ECS::Types::ListTasksRequest

@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
      launch_type: "EC2", # accepts EC2, FARGATE, EXTERNAL
    }

@!attribute [rw] cluster

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.
@return [String]

@!attribute [rw] container_instance

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.
@return [String]

@!attribute [rw] family

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.
@return [String]

@!attribute [rw] next_token

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 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>
@return [String]

@!attribute [rw] max_results

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.
@return [Integer]

@!attribute [rw] started_by

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.
@return [String]

@!attribute [rw] service_name

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.
@return [String]

@!attribute [rw] desired_status

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

<note markdown="1"> Although you can filter results based on a desired status of
`PENDING`, this does not 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`).

 </note>
@return [String]

@!attribute [rw] launch_type

The launch type to use when filtering the `ListTasks` results.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasksRequest AWS API Documentation

Constants

SENSITIVE