ListLineageNodeHistoryCommand

Suggest an Edit

Lists the history of the specified data lineage node.

Example Syntax

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

import { DataZoneClient, ListLineageNodeHistoryCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListLineageNodeHistoryCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListLineageNodeHistoryInput
  domainIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"),
  nextToken: "STRING_VALUE",
  identifier: "STRING_VALUE", // required
  direction: "UPSTREAM" || "DOWNSTREAM",
  eventTimestampGTE: new Date("TIMESTAMP"),
  eventTimestampLTE: new Date("TIMESTAMP"),
  sortOrder: "ASCENDING" || "DESCENDING",
};
const command = new ListLineageNodeHistoryCommand(input);
const response = await client.send(command);
// { // ListLineageNodeHistoryOutput
//   nodes: [ // LineageNodeSummaries
//     { // LineageNodeSummary
//       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"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListLineageNodeHistoryCommand Input

See ListLineageNodeHistoryCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

identifier
Required
string | undefined

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

direction
EdgeDirection | undefined

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.

eventTimestampGTE
Date | undefined

Specifies whether the action is to return data lineage node history from the time after the event timestamp.

eventTimestampLTE
Date | undefined

Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

maxResults
number | undefined

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

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

The order by which you want data lineage node history to be sorted.

ListLineageNodeHistoryCommand Output

See ListLineageNodeHistoryCommandOutput for details

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

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
LineageNodeSummary[] | undefined

The nodes returned by the ListLineageNodeHistory action.

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.