ECS / Paginator / ListTaskDefinitions

ListTaskDefinitions#

class ECS.Paginator.ListTaskDefinitions#
paginator = client.get_paginator('list_task_definitions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ECS.Client.list_task_definitions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    familyPrefix='string',
    status='ACTIVE'|'INACTIVE'|'DELETE_IN_PROGRESS',
    sort='ASC'|'DESC',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • familyPrefix (string) – The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix 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, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

  • sort (string) – The order to sort the results in. Valid values are ASC and DESC. 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 to DESC reverses the sort order on family name and revision. This is so that the newest task definitions in a family are listed first.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (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.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

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

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) –

      A token to resume pagination.