ECS / Client / list_task_definitions
list_task_definitions#
- ECS.Client.list_task_definitions(**kwargs)#
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 thestatus
parameter.See also: AWS API Documentation
Request Syntax
response = client.list_task_definitions( familyPrefix='string', status='ACTIVE'|'INACTIVE'|'DELETE_IN_PROGRESS', sort='ASC'|'DESC', nextToken='string', maxResults=123 )
- Parameters:
familyPrefix (string) – 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.status (string) – 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.sort (string) – 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.nextToken (string) –
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.
maxResults (integer) – 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.
- Return type:
dict
- Returns:
Response Syntax
{ 'taskDefinitionArns': [ 'string', ], 'nextToken': 'string' }
Response Structure
(dict) –
taskDefinitionArns (list) –
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions
request.(string) –
nextToken (string) –
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.
Exceptions
ECS.Client.exceptions.ServerException
ECS.Client.exceptions.ClientException
ECS.Client.exceptions.InvalidParameterException
Examples
This example lists all of your registered task definitions.
response = client.list_task_definitions( ) print(response)
Expected Output:
{ 'taskDefinitionArns': [ 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep300:2', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6', ], 'ResponseMetadata': { '...': '...', }, }
This example lists the task definition revisions of a specified family.
response = client.list_task_definitions( familyPrefix='wordpress', ) print(response)
Expected Output:
{ 'taskDefinitionArns': [ 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:3', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:4', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:5', 'arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/wordpress:6', ], 'ResponseMetadata': { '...': '...', }, }