Menu
Amazon EC2 Container Service
API Reference (API Version 2014-11-13)

ListTaskDefinitions

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

Request Syntax

Copy
{ "familyPrefix": "string", "maxResults": number, "nextToken": "string", "sort": "string", "status": "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.

familyPrefix

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Type: String

Required: No

maxResults

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

Type: Integer

Required: No

nextToken

The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

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

sort

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Type: String

Valid Values: ASC | DESC

Required: No

status

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Type: String

Valid Values: ACTIVE | INACTIVE

Required: No

Response Syntax

Copy
{ "nextToken": "string", "taskDefinitionArns": [ "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 future ListTaskDefinitions request. When the results of a ListTaskDefinitions 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.

Type: String

taskDefinitionArns

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions 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 permission to use the action or resource, or specifying an identifier that is not valid.

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

Example

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, 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 manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

This example request lists all of the task definitions in the hello_world family.

Sample Request

Copy
POST / HTTP/1.1 Host: ecs.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 31 X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListTaskDefinitions X-Amz-Date: 20150429T192041Z Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "familyPrefix": "hello_world" }

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Wed, 29 Apr 2015 19:20:41 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 695 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "taskDefinitionArns": [ "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:1", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:2", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:3", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:4", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:5", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:7", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:8", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:9", "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:10" ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: