SageMaker / Paginator / ListLineageGroups

ListLineageGroups

class SageMaker.Paginator.ListLineageGroups

paginator = client.get_paginator('list_lineage_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_lineage_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreatedAfter=datetime(2015, 1, 1),
    CreatedBefore=datetime(2015, 1, 1),
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• CreatedAfter (datetime) – A timestamp to filter against lineage groups created after a certain point in time.

• CreatedBefore (datetime) – A timestamp to filter against lineage groups created before a certain point in time.

• SortBy (string) – The parameter by which to sort the results. The default is CreationTime.

• SortOrder (string) – The sort order for the results. The default is Ascending.

• 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

{
    'LineageGroupSummaries': [
        {
            'LineageGroupArn': 'string',
            'LineageGroupName': 'string',
            'DisplayName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • LineageGroupSummaries (list) –

    A list of lineage groups and their properties.

    • (dict) –

      Lists a summary of the properties of a lineage group. A lineage group provides a group of shareable lineage entity resources.

      • LineageGroupArn (string) –

        The Amazon Resource Name (ARN) of the lineage group resource.

      • LineageGroupName (string) –

        The name or Amazon Resource Name (ARN) of the lineage group.

      • DisplayName (string) –

        The display name of the lineage group summary.

      • CreationTime (datetime) –

        The creation time of the lineage group summary.

      • LastModifiedTime (datetime) –

        The last modified time of the lineage group summary.