data_integration_events

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

Overview

Name	data_integration_events
Type	Resource
Id	aws.supplychain.data_integration_events

Fields

The following fields are returned by SELECT queries:

get_data_integration_event

Name	Datatype	Description
dataset_target_details	object	The target dataset details for a DATASET event type.
event_group_id	string	Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
event_id	string	The unique event identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
event_timestamp	string (date-time)	The event timestamp (in epoch seconds).
event_type	string	The data event type. (scn.data.forecast, scn.data.inventorylevel, scn.data.inboundorder, scn.data.inboundorderline, scn.data.inboundorderlineschedule, scn.data.outboundorderline, scn.data.outboundshipment, scn.data.processheader, scn.data.processoperation, scn.data.processproduct, scn.data.reservation, scn.data.shipment, scn.data.shipmentstop, scn.data.shipmentstoporder, scn.data.supplyplan, scn.data.dataset)
instance_id	string	The AWS Supply Chain instance identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)

list_data_integration_events

Name	Datatype	Description
dataset_target_details	object	The target dataset details for a DATASET event type.
event_group_id	string	Event identifier (for example, orderId for InboundOrder) used for data sharding or partitioning.
event_id	string	The unique event identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
event_timestamp	string (date-time)	The event timestamp (in epoch seconds).
event_type	string	The data event type. (scn.data.forecast, scn.data.inventorylevel, scn.data.inboundorder, scn.data.inboundorderline, scn.data.inboundorderlineschedule, scn.data.outboundorderline, scn.data.outboundshipment, scn.data.processheader, scn.data.processoperation, scn.data.processproduct, scn.data.reservation, scn.data.shipment, scn.data.shipmentstop, scn.data.shipmentstoporder, scn.data.supplyplan, scn.data.dataset)
instance_id	string	The AWS Supply Chain instance identifier. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_integration_event	select	instance_id, event_id, region		Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.
list_data_integration_events	select	instance_id, region	eventType, nextToken, maxResults	Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.

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
event_id	string	The unique event identifier.
instance_id	string	The Amazon Web Services Supply Chain instance identifier.
region	string	AWS region (default: us-east-1)
eventType	string	List data integration events for the specified eventType.
maxResults	integer	Specify the maximum number of data integration events to fetch in one paginated request.
nextToken	string	The pagination token to fetch the next page of the data integration events.

SELECT examples

get_data_integration_event

Enables you to programmatically view an Amazon Web Services Supply Chain Data Integration Event. Developers can view the eventType, eventGroupId, eventTimestamp, datasetTarget, datasetLoadExecution.

SELECT
dataset_target_details,
event_group_id,
event_id,
event_timestamp,
event_type,
instance_id
FROM aws.supplychain.data_integration_events
WHERE instance_id = '{{ instance_id }}' -- required
AND event_id = '{{ event_id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_integration_events

Enables you to programmatically list all data integration events for the provided Amazon Web Services Supply Chain instance.

SELECT
dataset_target_details,
event_group_id,
event_id,
event_timestamp,
event_type,
instance_id
FROM aws.supplychain.data_integration_events
WHERE instance_id = '{{ instance_id }}' -- required
AND region = '{{ region }}' -- required
AND eventType = '{{ eventType }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;