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

ListTaskDefinitionFamilies

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

Request Syntax

Copy
{ "familyPrefix": "string", "maxResults": number, "nextToken": "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 familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Type: String

Required: No

maxResults

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

Type: Integer

Required: No

nextToken

The nextToken value returned from a previous paginated ListTaskDefinitionFamilies 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

status

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Type: String

Valid Values: ACTIVE | INACTIVE | ALL

Required: No

Response Syntax

Copy
{ "families": [ "string" ], "nextToken": "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.

families

The list of task definition family names that match the ListTaskDefinitionFamilies request.

Type: array of Strings

nextToken

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies 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

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

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 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 definition families in your account in the current region.

Sample Request

Copy
POST / HTTP/1.1 Host: ecs.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: AmazonEC2ContainerServiceV20141113.ListTaskDefinitionFamilies X-Amz-Date: 20150429T191650Z Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS {}

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Wed, 29 Apr 2015 19:16:51 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 270 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "families": [ "console-sample-app", "ecs-demo", "ecs-private", "hello_world", "hpcc", "hpcc-t2-medium", "image-dedupe", "node-dedupe", "port-mappings", "redis-volumes-from", "sleep360", "terrible-timer", "test-volumes-from", "tt-empty", "tt-empty-2vol", "tt-empty-volumes", "web-timer" ] }

Example

This example request lists all of the task definition families in your account in the current region that begin with hpcc.

Sample Request

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

Sample Response

Copy
HTTP/1.1 200 OK Server: Server Date: Wed, 29 Apr 2015 19:18:25 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 38 Connection: keep-alive x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f { "families": [ "hpcc", "hpcc-t2-medium" ] }

See Also

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