lineage_events

Creates, updates, deletes, gets or lists a lineage_events resource.

Overview

Name	lineage_events
Type	Resource
Id	aws.datazone.lineage_events

Fields

The following fields are returned by SELECT queries:

get_lineage_event

Name	Datatype	Description
id	string	The ID of the lineage event. (pattern: <code>[a-z0-9]{14}</code>)
created_at	string (date-time)	The timestamp of when the lineage event was created.
created_by	string	The user who created the lineage event.
domain_id	string	The ID of the domain. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
event	string (byte)	The lineage event details.
event_time	string (date-time)	The time of the lineage event.
processing_status	string	The progressing status of the lineage event. (REQUESTED, PROCESSING, SUCCESS, FAILED)

list_lineage_events

Name	Datatype	Description
id	string	The ID of the data lineage event. (pattern: <code>[a-z0-9]{14}</code>)
created_at	string (date-time)	The timestamp at which data lineage event was created.
created_by	string	The user who created the data lineage event.
domain_id	string	The domain ID of the lineage event. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
event_summary	object	The summary of the data lineate event.
event_time	string (date-time)	The time of the data lineage event.
processing_status	string	The processing status of the data lineage event. (REQUESTED, PROCESSING, SUCCESS, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_lineage_event	select	domain_identifier, identifier, region		Describes the lineage event.
list_lineage_events	select	domain_identifier, region	maxResults, timestampAfter, timestampBefore, processingStatus, sortOrder, nextToken	Lists lineage events.
delete_lineage_event	delete	domain_identifier, identifier, region		Deletes the specified lineage event.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the domain.
identifier	string	The ID of the lineage event.
region	string	AWS region (default: us-east-1)
maxResults	integer	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	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	string	The processing status of a lineage event.
sortOrder	string	The sort order of the lineage events.
timestampAfter	string (date-time)	The after timestamp of a lineage event.
timestampBefore	string (date-time)	The before timestamp of a lineage event.

SELECT examples

get_lineage_event

Describes the lineage event.

SELECT
id,
created_at,
created_by,
domain_id,
event,
event_time,
processing_status
FROM aws.datazone.lineage_events
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_lineage_events

Lists lineage events.

SELECT
id,
created_at,
created_by,
domain_id,
event_summary,
event_time,
processing_status
FROM aws.datazone.lineage_events
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND timestampAfter = '{{ timestampAfter }}'
AND timestampBefore = '{{ timestampBefore }}'
AND processingStatus = '{{ processingStatus }}'
AND sortOrder = '{{ sortOrder }}'
AND nextToken = '{{ nextToken }}'
;

DELETE examples

delete_lineage_event

Deletes the specified lineage event.

DELETE FROM aws.datazone.lineage_events
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;