Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

ListTasksCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ECSClient, ListTasksCommand } from "@aws-sdk/client-ecs"; // ES Modules import
// const { ECSClient, ListTasksCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
const client = new ECSClient(config);
const input = { // ListTasksRequest
  cluster: "STRING_VALUE",
  containerInstance: "STRING_VALUE",
  family: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  startedBy: "STRING_VALUE",
  serviceName: "STRING_VALUE",
  desiredStatus: "RUNNING" || "PENDING" || "STOPPED",
  launchType: "EC2" || "FARGATE" || "EXTERNAL",
};
const command = new ListTasksCommand(input);
const response = await client.send(command);
// { // ListTasksResponse
//   taskArns: [ // StringList
//     "STRING_VALUE",
//   ],
//   nextToken: "STRING_VALUE",
// };

Example Usage

There was an error loading the code editor. Retry

ListTasksCommand Input

See ListTasksCommandInput for more details

Parameter	Type	Description
`cluster`	`string \| undefined`	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.
`containerInstance`	`string \| undefined`	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.
`desiredStatus`	`DesiredStatus \| undefined`	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`).
`family`	`string \| undefined`	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.
`launchType`	`LaunchType \| undefined`	The launch type to use when filtering the `ListTasks` results.
`maxResults`	`number \| undefined`	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.
`nextToken`	`string \| undefined`	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.
`serviceName`	`string \| undefined`	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.
`startedBy`	`string \| undefined`	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.

ListTasksCommand Output

See ListTasksCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`nextToken`	`string \| undefined`	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.
`taskArns`	`string[] \| undefined`	The list of task ARN entries for the `ListTasks` request.

Throws

Name	Fault	Details
ClientException	client	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	client	The specified cluster wasn't found. You can view your available clusters with ListClusters . Amazon ECS clusters are Region specific.
InvalidParameterException	client	The specified parameter isn't valid. Review the available parameters for the API request. For more information about service event errors, see Amazon ECS service event messages .
ServerException	server	These errors are usually caused by a server issue.
ServiceNotFoundException	client	The specified service wasn't found. You can view your available services with ListServices . Amazon ECS services are cluster specific and Region specific.
ECSServiceException		Base exception class for all service exceptions from ECS service.

Getting Started