DataZone / Client / list_lineage_node_history

list_lineage_node_history#

DataZone.Client.list_lineage_node_history(**kwargs)#

Lists the history of the specified data lineage node.

See also: AWS API Documentation

Request Syntax

response = client.list_lineage_node_history(
    direction='UPSTREAM'|'DOWNSTREAM',
    domainIdentifier='string',
    eventTimestampGTE=datetime(2015, 1, 1),
    eventTimestampLTE=datetime(2015, 1, 1),
    identifier='string',
    maxResults=123,
    nextToken='string',
    sortOrder='ASCENDING'|'DESCENDING'
)
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.

  • maxResults (integer) – The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

  • nextToken (string) – When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

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

Exceptions

  • DataZone.Client.exceptions.InternalServerException

  • DataZone.Client.exceptions.ResourceNotFoundException

  • DataZone.Client.exceptions.AccessDeniedException

  • DataZone.Client.exceptions.ThrottlingException

  • DataZone.Client.exceptions.ValidationException

  • DataZone.Client.exceptions.UnauthorizedException