GetLineageNode - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetLineageNode

Gets the data lineage node.

Request Syntax

GET /v2/domains/domainIdentifier/lineage/nodes/identifier?timestamp=eventTimestamp HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain in which you want to get the data lineage node.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

eventTimestamp

The event time stamp for which you want to get the data lineage node.

identifier

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.

Length Constraints: Minimum length of 1. Maximum length of 2086.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "downstreamNodes": [ 
      { 
         "eventTimestamp": number,
         "id": "string"
      }
   ],
   "eventTimestamp": number,
   "formsOutput": [ 
      { 
         "content": "string",
         "formName": "string",
         "typeName": "string",
         "typeRevision": "string"
      }
   ],
   "id": "string",
   "name": "string",
   "sourceIdentifier": "string",
   "typeName": "string",
   "typeRevision": "string",
   "updatedAt": number,
   "updatedBy": "string",
   "upstreamNodes": [ 
      { 
         "eventTimestamp": number,
         "id": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The timestamp at which the data lineage node was created.

Type: Timestamp

createdBy

The user who created the data lineage node.

Type: String

description

The description of the data lineage node.

Type: String

domainId

The ID of the domain where you're getting the data lineage node.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

downstreamNodes

The downsteam nodes of the specified data lineage node.

Type: Array of LineageNodeReference objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

eventTimestamp

The timestamp of the event described in the data lineage node.

Type: Timestamp

formsOutput

The metadata of the specified data lineage node.

Type: Array of FormOutput objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

id

The ID of the data lineage node.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

name

The name of the data lineage node.

Type: String

sourceIdentifier

The source identifier of the data lineage node.

Type: String

typeName

The name of the type of the specified data lineage node.

Type: String

typeRevision

The revision type of the specified data lineage node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

updatedAt

The timestamp at which the data lineage node was updated.

Type: Timestamp

updatedBy

The user who updated the data lineage node.

Type: String

upstreamNodes

The upstream nodes of the specified data lineage node.

Type: Array of LineageNodeReference objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: