pipeline_executions

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

Overview

Name	pipeline_executions
Type	Resource
Id	aws.iotsitewise.pipeline_executions

Fields

The following fields are returned by SELECT queries:

describe_pipeline_execution

Name	Datatype	Description
compute_node_name	string	Reusable resource name with alphanumeric, hyphen, and underscore characters. (pattern: <code>[a-zA-Z0-9_-]+</code>)
depends_on	array	A list of compute node names that this node depends on.
end_time	string (date-time)	The time the compute node execution completed, in Unix epoch time.
execution_environment_variables	object	The fully resolved environment variables used for this compute node execution.
start_time	string (date-time)	The time the compute node execution started, in Unix epoch time.
status	object	The current execution status of the compute node.
task_arn	string	The ARN of the task. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
task_name	string	Reusable resource name with alphanumeric, hyphen, and underscore characters. (pattern: <code>[a-zA-Z0-9_-]+</code>)
task_version	string	The task version that executed for this compute node. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)

list_pipeline_executions

Name	Datatype	Description
end_time	string (date-time)	The time the pipeline execution completed, in Unix epoch time.
execution_priority	integer	Scheduling priority for the execution. When not specified, defaults to lowest priority.
pipeline_execution_id	string	The unique identifier of the pipeline execution. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
pipeline_version	string	The pipeline version this execution ran against. (pattern: <code>^(0|([1-9]{1}\d*))$</code>)
start_time	string (date-time)	The time the pipeline execution started, in Unix epoch time.
status	object	The current execution status of the pipeline.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_pipeline_execution	select	workspace_name, pipeline_name, pipeline_execution_id, region	nextToken, maxResults	Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.
list_pipeline_executions	select	workspace_name, pipeline_name, region	nextToken, maxResults, state, startTimeAfter, startTimeBefore, endTimeAfter, endTimeBefore	Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

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
pipeline_execution_id	string	The unique identifier of the pipeline execution.
pipeline_name	string	The name of the pipeline.
region	string	AWS region (default: us-east-1)
workspace_name	string	The name of the workspace.
endTimeAfter	string (date-time)	Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.
endTimeBefore	string (date-time)	Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.
maxResults	integer	The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.
nextToken	string	The token to be used for the next set of paginated results.
startTimeAfter	string (date-time)	Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.
startTimeBefore	string (date-time)	Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.
state	string	Filter by execution state. If not specified, executions in all states are returned.

SELECT examples

describe_pipeline_execution

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

SELECT
compute_node_name,
depends_on,
end_time,
execution_environment_variables,
start_time,
status,
task_arn,
task_name,
task_version
FROM aws.iotsitewise.pipeline_executions
WHERE workspace_name = '{{ workspace_name }}' -- required
AND pipeline_name = '{{ pipeline_name }}' -- required
AND pipeline_execution_id = '{{ pipeline_execution_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

list_pipeline_executions

Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

SELECT
end_time,
execution_priority,
pipeline_execution_id,
pipeline_version,
start_time,
status
FROM aws.iotsitewise.pipeline_executions
WHERE workspace_name = '{{ workspace_name }}' -- required
AND pipeline_name = '{{ pipeline_name }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND state = '{{ state }}'
AND startTimeAfter = '{{ startTimeAfter }}'
AND startTimeBefore = '{{ startTimeBefore }}'
AND endTimeAfter = '{{ endTimeAfter }}'
AND endTimeBefore = '{{ endTimeBefore }}'
;