ListTaskDefinitionFamilies
Returns a list of task definition families that are registered to your account. This
list includes task definition families that no longer have any ACTIVE
task
definition revisions.
You can filter out task definition families that don't 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
{
"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's used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned.Type: String
Required: No
- maxResults
-
The maximum number of task definition family results that
ListTaskDefinitionFamilies
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 anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable.Type: Integer
Required: No
- nextToken
-
The
nextToken
value returned from aListTaskDefinitionFamilies
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
- status
-
The task definition family status to filter the
ListTaskDefinitionFamilies
results with. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.Type: String
Valid Values:
ACTIVE | INACTIVE | ALL
Required: No
Response Syntax
{
"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 futureListTaskDefinitionFamilies
request. When the results of aListTaskDefinitionFamilies
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
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 definition families in your account in the current Region.
Sample Request
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
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
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
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 Amazon SDKs, see the following: