data_integration_flow_executions

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

Overview

Name	data_integration_flow_executions
Type	Resource
Id	aws.supplychain.data_integration_flow_executions

Fields

The following fields are returned by SELECT queries:

get_data_integration_flow_execution

Name	Datatype	Description
end_time	string (date-time)	The flow execution end timestamp.
execution_id	string	The flow executionId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
flow_name	string	The flow execution's flowName. (pattern: <code>[A-Za-z0-9-]+</code>)
instance_id	string	The flow execution's instanceId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
message	string	The failure message (if any) of failed flow execution.
output_metadata	object	The flow execution output metadata.
source_info	object	The source information for a flow execution.
start_time	string (date-time)	The flow execution start timestamp.
status	string	The status of flow execution. (SUCCEEDED, IN_PROGRESS, FAILED)

list_data_integration_flow_executions

Name	Datatype	Description
end_time	string (date-time)	The flow execution end timestamp.
execution_id	string	The flow executionId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
flow_name	string	The flow execution's flowName. (pattern: <code>[A-Za-z0-9-]+</code>)
instance_id	string	The flow execution's instanceId. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
message	string	The failure message (if any) of failed flow execution.
output_metadata	object	The flow execution output metadata.
source_info	object	The source information for a flow execution.
start_time	string (date-time)	The flow execution start timestamp.
status	string	The status of flow execution. (SUCCEEDED, IN_PROGRESS, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_integration_flow_execution	select	instance_id, flow_name, execution_id, region		Get the flow execution.
list_data_integration_flow_executions	select	instance_id, flow_name, region	nextToken, maxResults	List flow executions.

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
execution_id	string	The flow execution identifier.
flow_name	string	The flow name.
instance_id	string	The AWS Supply Chain instance identifier.
region	string	AWS region (default: us-east-1)
maxResults	integer	The number to specify the max number of flow executions to fetch in this paginated request.
nextToken	string	The pagination token to fetch next page of flow executions.

SELECT examples

get_data_integration_flow_execution

Get the flow execution.

SELECT
end_time,
execution_id,
flow_name,
instance_id,
message,
output_metadata,
source_info,
start_time,
status
FROM aws.supplychain.data_integration_flow_executions
WHERE instance_id = '{{ instance_id }}' -- required
AND flow_name = '{{ flow_name }}' -- required
AND execution_id = '{{ execution_id }}' -- required
AND region = '{{ region }}' -- required
;

list_data_integration_flow_executions

List flow executions.

SELECT
end_time,
execution_id,
flow_name,
instance_id,
message,
output_metadata,
source_info,
start_time,
status
FROM aws.supplychain.data_integration_flow_executions
WHERE instance_id = '{{ instance_id }}' -- required
AND flow_name = '{{ flow_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;