ListLineageEventsCommand

Suggest an Edit

Lists lineage events.

Example Syntax

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

import { DataZoneClient, ListLineageEventsCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, ListLineageEventsCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // ListLineageEventsInput
  domainIdentifier: "STRING_VALUE", // required
  maxResults: Number("int"),
  timestampAfter: new Date("TIMESTAMP"),
  timestampBefore: new Date("TIMESTAMP"),
  processingStatus: "REQUESTED" || "PROCESSING" || "SUCCESS" || "FAILED",
  sortOrder: "ASCENDING" || "DESCENDING",
  nextToken: "STRING_VALUE",
};
const command = new ListLineageEventsCommand(input);
const response = await client.send(command);
// { // ListLineageEventsOutput
//   items: [ // LineageEventSummaries
//     { // LineageEventSummary
//       id: "STRING_VALUE",
//       domainId: "STRING_VALUE",
//       processingStatus: "REQUESTED" || "PROCESSING" || "SUCCESS" || "FAILED",
//       eventTime: new Date("TIMESTAMP"),
//       eventSummary: { // EventSummary Union: only one key present
//         openLineageRunEventSummary: { // OpenLineageRunEventSummary
//           eventType: "START" || "RUNNING" || "COMPLETE" || "ABORT" || "FAIL" || "OTHER",
//           runId: "STRING_VALUE",
//           job: { // NameIdentifier
//             name: "STRING_VALUE",
//             namespace: "STRING_VALUE",
//           },
//           inputs: [ // NameIdentifiers
//             {
//               name: "STRING_VALUE",
//               namespace: "STRING_VALUE",
//             },
//           ],
//           outputs: [
//             {
//               name: "STRING_VALUE",
//               namespace: "STRING_VALUE",
//             },
//           ],
//         },
//       },
//       createdBy: "STRING_VALUE",
//       createdAt: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListLineageEventsCommand Input

See ListLineageEventsCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

The ID of the domain where you want to list lineage events.

maxResults
number | undefined

The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events 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 ListLineageEvents to list the next set of lineage events.

nextToken
string | undefined

When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.

processingStatus
LineageEventProcessingStatus | undefined

The processing status of a lineage event.

sortOrder
SortOrder | undefined

The sort order of the lineage events.

timestampAfter
Date | undefined

The after timestamp of a lineage event.

timestampBefore
Date | undefined

The before timestamp of a lineage event.

ListLineageEventsCommand Output

See ListLineageEventsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
items
LineageEventSummary[] | undefined

The results of the ListLineageEvents action.

nextToken
string | undefined

When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.

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.

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.