list_tasks¶
Operation¶
async
¶
list_tasks(input: ListTasksInput, plugins: list[Plugin] | None = None) -> ListTasksOutput
Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.
Recently stopped tasks might appear in the returned results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ListTasksInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ListTasksOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
cluster: str | None = ...
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.
class-attribute
instance-attribute
¶
container_instance: str | None = ...
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.
class-attribute
instance-attribute
¶
daemon_name: str | None = ...
The name of the daemon to use when filtering the ListTasks results.
Specifying a daemonName limits the results to tasks that belong to
that daemon.
class-attribute
instance-attribute
¶
desired_status: str | None = ...
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.
Note
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).
class-attribute
instance-attribute
¶
family: str | None = ...
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.
class-attribute
instance-attribute
¶
launch_type: str | None = ...
The launch type to use when filtering the ListTasks results.
class-attribute
instance-attribute
¶
max_results: int | None = ...
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.
class-attribute
instance-attribute
¶
next_token: str | None = ...
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.
Note
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.
class-attribute
instance-attribute
¶
service_name: str | None = ...
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.
class-attribute
instance-attribute
¶
started_by: str | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Attributes¶
class-attribute
instance-attribute
¶
next_token: str | None = ...
The nextToken value to include in a future ListTasks request. When
the results of a ListTasks request exceed maxResults, this value can
be used to retrieve the next page of results. This value is null when
there are no more results to return.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.