DataZone / Paginator / ListLineageNodeHistory

ListLineageNodeHistory

class DataZone.Paginator.ListLineageNodeHistory

paginator = client.get_paginator('list_lineage_node_history')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataZone.Client.list_lineage_node_history().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    direction='UPSTREAM'|'DOWNSTREAM',
    domainIdentifier='string',
    eventTimestampGTE=datetime(2015, 1, 1),
    eventTimestampLTE=datetime(2015, 1, 1),
    identifier='string',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• direction (string) – The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

• domainIdentifier (string) –

  [REQUIRED]

  The ID of the domain where you want to list the history of the specified data lineage node.

• eventTimestampGTE (datetime) – Specifies whether the action is to return data lineage node history from the time after the event timestamp.

• eventTimestampLTE (datetime) – Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

• identifier (string) –

  [REQUIRED]

  The ID of the data lineage node whose history you want to list.

• sortOrder (string) – The order by which you want data lineage node history to be sorted.

• 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

{
    'nodes': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'description': 'string',
            'domainId': 'string',
            'eventTimestamp': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'sourceIdentifier': 'string',
            'typeName': 'string',
            'typeRevision': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'updatedBy': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • nodes (list) –

    The nodes returned by the ListLineageNodeHistory action.

    • (dict) –

      The summary of the data lineage node.

      • createdAt (datetime) –

        The timestamp at which the data lineage node was created.

      • createdBy (string) –

        The user who created the data lineage node.

      • description (string) –

        The description of the data lineage node.

      • domainId (string) –

        The ID of the domain of the data lineage node.

      • eventTimestamp (datetime) –

        The event timestamp of the data lineage node.

      • id (string) –

        The ID of the data lineage node.

      • name (string) –

        The name of the data lineage node.

      • sourceIdentifier (string) –

        The alternate ID of the data lineage node.

      • typeName (string) –

        The name of the type of the data lineage node.

      • typeRevision (string) –

        The type of the revision of the data lineage node.

      • updatedAt (datetime) –

        The timestamp at which the data lineage node was updated.

      • updatedBy (string) –

        The user who updated the data lineage node.

  • NextToken (string) –

    A token to resume pagination.