Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ecs ]



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.

See also: AWS API Documentation

list-task-definition-families is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: families


[--family-prefix <value>]
[--status <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--family-prefix (string)

The familyPrefix is a string that is used to filter the results of list-task-definition-families . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.

--status (string)

The task definition family status with which to filter the list-task-definition-families 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.

Possible values:

  • ALL

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

--page-size (integer)

The size of each page.

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination. This NextToken response element should not be used directly outside of the AWS CLI.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.


To list your registered task definition families

This example command lists all of your registered task definition families.


aws ecs list-task-definition-families


    "families": [

To filter your registered task definition families

This example command lists the task definition revisions that start with "hpcc".


aws ecs list-task-definition-families --family-prefix hpcc


    "families": [


families -> (list)

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


nextToken -> (string)

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