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
{
"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 to filter the
ListTaskDefinitions
results with. Specifying afamilyPrefix
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 that
ListTaskDefinitions
returned in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.Type: Integer
Required: No
- nextToken
-
The
nextToken
value returned from aListTaskDefinitions
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
- sort
-
The order to sort the results in. Valid values are
ASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision. This is 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 to filter the
ListTaskDefinitions
results with. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.Type: String
Valid Values:
ACTIVE | INACTIVE | DELETE_IN_PROGRESS
Required: No
Response Syntax
{
"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 futureListTaskDefinitions
request. When the results of aListTaskDefinitions
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
- 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. 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.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- InvalidParameterException
-
The specified parameter isn't valid. 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
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an Amazon Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the
Amazon General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the Amazon Command Line Interface
Example
This example request lists all of the task definitions in the hello_world
family.
Sample Request
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
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 Amazon SDKs, see the following: