DataZone / Client / get_lineage_node

get_lineage_node¶

DataZone.Client.get_lineage_node(**kwargs)¶

Gets the data lineage node.

Request Syntax

response = client.get_lineage_node(
    domainIdentifier='string',
    identifier='string',
    eventTimestamp=datetime(2015, 1, 1)
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The ID of the domain in which you want to get the data lineage node.
identifier (string) –
[REQUIRED]

The ID of the data lineage node that you want to get.

Both, a lineage node identifier generated by Amazon DataZone and a sourceIdentifier of the lineage node are supported. If sourceIdentifier is greater than 1800 characters, you can use lineage node identifier generated by Amazon DataZone to get the node details.
eventTimestamp (datetime) – The event time stamp for which you want to get the data lineage node.

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'name': 'string',
    'description': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'updatedAt': datetime(2015, 1, 1),
    'updatedBy': 'string',
    'id': 'string',
    'typeName': 'string',
    'typeRevision': 'string',
    'sourceIdentifier': 'string',
    'eventTimestamp': datetime(2015, 1, 1),
    'formsOutput': [
        {
            'formName': 'string',
            'typeName': 'string',
            'typeRevision': 'string',
            'content': 'string'
        },
    ],
    'upstreamNodes': [
        {
            'id': 'string',
            'eventTimestamp': datetime(2015, 1, 1)
        },
    ],
    'downstreamNodes': [
        {
            'id': 'string',
            'eventTimestamp': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- domainId (string) –
  
  The ID of the domain where you’re getting the data lineage node.
- name (string) –
  
  The name of the data lineage node.
- description (string) –
  
  The description 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.
- updatedAt (datetime) –
  
  The timestamp at which the data lineage node was updated.
- updatedBy (string) –
  
  The user who updated the data lineage node.
- id (string) –
  
  The ID of the data lineage node.
- typeName (string) –
  
  The name of the type of the specified data lineage node.
- typeRevision (string) –
  
  The revision type of the specified data lineage node.
- sourceIdentifier (string) –
  
  The source identifier of the data lineage node.
- eventTimestamp (datetime) –
  
  The timestamp of the event described in the data lineage node.
- formsOutput (list) –
  
  The metadata of the specified data lineage node.
  - (dict) –
    
    The details of a metadata form.
    - formName (string) –
      
      The name of the metadata form.
    - typeName (string) –
      
      The name of the metadata form type.
    - typeRevision (string) –
      
      The revision of the metadata form type.
    - content (string) –
      
      The content of the metadata form.
- upstreamNodes (list) –
  
  The upstream nodes of the specified data lineage node.
  - (dict) –
    
    The reference details for the data lineage node.
    - id (string) –
      
      The ID of the data lineage node.
    - eventTimestamp (datetime) –
      
      The event timestamp of the data lineage node.
- downstreamNodes (list) –
  
  The downsteam nodes of the specified data lineage node.
  - (dict) –
    
    The reference details for the data lineage node.
    - id (string) –
      
      The ID of the data lineage node.
    - eventTimestamp (datetime) –
      
      The event timestamp of 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