GetLineageNodeCommand

Gets the data lineage node.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, GetLineageNodeCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetLineageNodeCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetLineageNodeInput
  domainIdentifier: "STRING_VALUE", // required
  identifier: "STRING_VALUE", // required
  eventTimestamp: new Date("TIMESTAMP"),
};
const command = new GetLineageNodeCommand(input);
const response = await client.send(command);
// { // GetLineageNodeOutput
//   domainId: "STRING_VALUE", // required
//   name: "STRING_VALUE",
//   description: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   createdBy: "STRING_VALUE",
//   updatedAt: new Date("TIMESTAMP"),
//   updatedBy: "STRING_VALUE",
//   id: "STRING_VALUE", // required
//   typeName: "STRING_VALUE", // required
//   typeRevision: "STRING_VALUE",
//   sourceIdentifier: "STRING_VALUE",
//   eventTimestamp: new Date("TIMESTAMP"),
//   formsOutput: [ // FormOutputList
//     { // FormOutput
//       formName: "STRING_VALUE", // required
//       typeName: "STRING_VALUE",
//       typeRevision: "STRING_VALUE",
//       content: "STRING_VALUE",
//     },
//   ],
//   upstreamNodes: [ // LineageNodeReferenceList
//     { // LineageNodeReference
//       id: "STRING_VALUE",
//       eventTimestamp: new Date("TIMESTAMP"),
//     },
//   ],
//   downstreamNodes: [
//     {
//       id: "STRING_VALUE",
//       eventTimestamp: new Date("TIMESTAMP"),
//     },
//   ],
// };

GetLineageNodeCommand Input

See GetLineageNodeCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

identifier
Required
string | undefined

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
Date | undefined

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

GetLineageNodeCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
Required
string | undefined

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

id
Required
string | undefined

The ID of the data lineage node.

typeName
Required
string | undefined

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

createdAt
Date | undefined

The timestamp at which the data lineage node was created.

createdBy
string | undefined

The user who created the data lineage node.

description
string | undefined

The description of the data lineage node.

downstreamNodes
LineageNodeReference[] | undefined

The downsteam nodes of the specified data lineage node.

eventTimestamp
Date | undefined

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

formsOutput
FormOutput[] | undefined

The metadata of the specified data lineage node.

name
string | undefined

The name of the data lineage node.

sourceIdentifier
string | undefined

The source identifier of the data lineage node.

typeRevision
string | undefined

The revision type of the specified data lineage node.

updatedAt
Date | undefined

The timestamp at which the data lineage node was updated.

updatedBy
string | undefined

The user who updated the data lineage node.

upstreamNodes
LineageNodeReference[] | undefined

The upstream nodes of the specified data lineage node.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.