Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListLineageNodeHistory

Lists the history of the specified data lineage node.

Request Syntax


GET /v2/domains/domainIdentifier/lineage/nodes/identifier/history?direction=direction&maxResults=maxResults&nextToken=nextToken&sortOrder=sortOrder&timestampGTE=eventTimestampGTE&timestampLTE=eventTimestampLTE HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

direction

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.

Valid Values: UPSTREAM | DOWNSTREAM

domainIdentifier

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

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

Required: Yes

eventTimestampGTE

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

eventTimestampLTE

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

identifier

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

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

Required: Yes

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

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.

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

sortOrder

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

Valid Values: ASCENDING | DESCENDING

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "nodes": [ 
      { 
         "createdAt": number,
         "createdBy": "string",
         "description": "string",
         "domainId": "string",
         "eventTimestamp": number,
         "id": "string",
         "name": "string",
         "sourceIdentifier": "string",
         "typeName": "string",
         "typeRevision": "string",
         "updatedAt": number,
         "updatedBy": "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.

nextToken

Type: String

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

nodes

The nodes returned by the ListLineageNodeHistory action.

Type: Array of LineageNodeSummary objects

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