paws.compute (version 0.1.12)

ecs_list_tasks: Returns a list of tasks for a specified cluster

Description

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

Usage

ecs_list_tasks(cluster, containerInstance, family, nextToken,
  maxResults, startedBy, serviceName, desiredStatus, launchType)

Value

A list with the following syntax:

list(
  taskArns = list(
    "string"
  ),
  nextToken = "string"
)

Arguments

cluster

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.

containerInstance

The container instance ID or full ARN of the container instance with which to filter the list_tasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

family

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

nextToken

The nextToken value returned from a list_tasks 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.

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.

maxResults

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

startedBy

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.

serviceName

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

desiredStatus

The task desired status with which to filter the list_tasks 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.

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).

launchType

The launch type for services to list.

Request syntax

svc$list_tasks(
  cluster = "string",
  containerInstance = "string",
  family = "string",
  nextToken = "string",
  maxResults = 123,
  startedBy = "string",
  serviceName = "string",
  desiredStatus = "RUNNING"|"PENDING"|"STOPPED",
  launchType = "EC2"|"FARGATE"
)

Examples

if (FALSE) {
# This example lists all of the tasks in a cluster.
svc$list_tasks(
  cluster = "default"
)

# This example lists the tasks of a specified container instance.
# Specifying a `containerInstance` value limits  the  results  to  tasks
#  that belong to that container instance.
svc$list_tasks(
  cluster = "default",
  containerInstance = "f6bbb147-5370-4ace-8c73-c7181ded911f"
)
}