ListTasks
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.
Request Syntax
{
"cluster": "string
",
"containerInstance": "string
",
"desiredStatus": "string
",
"family": "string
",
"launchType": "string
",
"maxResults": number
,
"nextToken": "string
",
"serviceName": "string
",
"startedBy": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- 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.
Type: String
Required: No
- containerInstance
-
The container instance ID or full ARN of the container instance with which to filter the
ListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance.Type: String
Required: No
- desiredStatus
-
The task desired status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that Amazon ECS has set the desired status toSTOPPED
. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
, which shows tasks that Amazon ECS has set the desired status toRUNNING
.Note 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'slastStatus
may have a value ofPENDING
).Type: String
Valid Values:
RUNNING | PENDING | STOPPED
Required: No
- family
-
The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family.Type: String
Required: No
- launchType
-
The launch type for services to list.
Type: String
Valid Values:
EC2 | FARGATE
Required: No
- maxResults
-
The maximum number of task results returned by
ListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable.Type: Integer
Required: No
- nextToken
-
The
nextToken
value returned from aListTasks
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.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.
Type: String
Required: No
- serviceName
-
The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service.Type: String
Required: No
- startedBy
-
The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.Type: String
Required: No
Response Syntax
{
"nextToken": "string",
"taskArns": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
The
nextToken
value to include in a futureListTasks
request. When the results of aListTasks
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.Type: String
- taskArns
-
The list of task ARN entries for the
ListTasks
request.Type: Array of strings
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClientException
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
HTTP Status Code: 400
- ClusterNotFoundException
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter is invalid. Review the available parameters for the API request.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
- ServiceNotFoundException
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
HTTP Status Code: 400
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an AWS Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the AWS General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the AWS Command Line
Interface (AWS CLI)
Example
This example request lists all of the tasks in the default cluster.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListTasks
X-Amz-Date: 20150429T192615Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Wed, 29 Apr 2015 19:26:16 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 330
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"taskArns": [
"arn:aws:ecs:us-east-1:012345678910:task/0b69d5c0-d655-4695-98cd-5d2d526d9d5a",
"arn:aws:ecs:us-east-1:012345678910:task/51a01bdf-d00e-487e-ab14-7645330b6207",
"arn:aws:ecs:us-east-1:012345678910:task/b0b28bb8-2be3-4810-b52b-88df129d893c",
"arn:aws:ecs:us-east-1:012345678910:task/c09f0188-7f87-4b0f-bfc3-16296622b6fe"
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: