class ECS.Paginator.ListTaskDefinitionFamilies
paginator = client.get_paginator('list_task_definition_families')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • familyPrefix (string) -- The familyPrefix is a string that's 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.
  • status (string) -- The task definition family status to filter the ListTaskDefinitionFamilies results with. 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.
  • 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



Response Syntax

    'families': [
    'NextToken': 'string'

Response Structure

  • (dict) --

    • families (list) --

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

      • (string) --
    • NextToken (string) --

      A token to resume pagination.