workflow_step_executions

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

Overview

Name	workflow_step_executions
Type	Resource
Id	aws.imagebuilder.workflow_step_executions

Fields

The following fields are returned by SELECT queries:

get_workflow_step_execution

Name	Datatype	Description
name	string	The name of the specified runtime instance of the workflow step. (pattern: <code>^[A-Za-z][A-Za-z0-9-_]{1,99}$</code>)
action	string	The name of the action that the specified step performs. (pattern: <code>^[A-Za-z][A-Za-z0-9-_]{1,99}$</code>)
description	string	Describes the specified workflow step.
end_time	string	The timestamp when the specified runtime instance of the workflow step finished.
image_build_version_arn	string	The Amazon Resource Name (ARN) of the image resource build version that the specified runtime instance of the workflow step creates. (pattern: <code>^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+.[0-9]+.[0-9]+/[0-9]+$</code>)
inputs	string	Input parameters that Image Builder provided for the specified runtime instance of the workflow step.
message	string	The output message from the specified runtime instance of the workflow step, if applicable.
on_failure	string	The action to perform if the workflow step fails.
outputs	string	The file names that the specified runtime version of the workflow step created as output.
request_id	string	The request ID that uniquely identifies this request.
rollback_status	string	Reports on the rollback status of the specified runtime version of the workflow step, if applicable. (RUNNING, COMPLETED, SKIPPED, FAILED)
start_time	string	The timestamp when the specified runtime version of the workflow step started.
status	string	The current status for the specified runtime version of the workflow step. (PENDING, SKIPPED, RUNNING, COMPLETED, FAILED, CANCELLED)
step_execution_id	string	The unique identifier for the runtime version of the workflow step that you specified in the request. (pattern: <code>^step-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)
timeout_seconds	integer	The maximum duration in seconds for this step to complete its action.
workflow_build_version_arn	string	The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines this workflow step. (pattern: <code>^arn:aws(?:-[a-z]+)*:imagebuilder:[a-z]{2,}(?:-[a-z]+)+-[0-9]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):workflow/(build|test|distribution)/[a-z0-9-_]+/[0-9]+.[0-9]+.[0-9]+/[0-9]+$</code>)
workflow_execution_id	string	The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow. (pattern: <code>^wf-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)

list_workflow_step_executions

Name	Datatype	Description
name	string	The name of the workflow step. (pattern: <code>^[A-Za-z][A-Za-z0-9-_]{1,99}$</code>)
action	string	The step action name. (pattern: <code>^[A-Za-z][A-Za-z0-9-_]{1,99}$</code>)
description	string	Description of the workflow step.
end_time	string	The timestamp when the workflow step finished.
inputs	string	Input parameters that Image Builder provides for the workflow step.
message	string	Detailed output message that the workflow step provides at runtime.
outputs	string	The file names that the workflow step created as output for this runtime instance of the workflow.
rollback_status	string	Reports on the rollback status of the step, if applicable. (RUNNING, COMPLETED, SKIPPED, FAILED)
start_time	string	The timestamp when the workflow step started.
status	string	Runtime status for the workflow step. (PENDING, SKIPPED, RUNNING, COMPLETED, FAILED, CANCELLED)
step_execution_id	string	A unique identifier for the workflow step, assigned at runtime. (pattern: <code>^step-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_step_execution	select	stepExecutionId, region		Get the runtime information that was logged for a specific runtime instance of the workflow step.
list_workflow_step_executions	select	region		Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

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
region	string	AWS region (default: us-east-1)
stepExecutionId	string	Use the unique identifier for a specific runtime instance of the workflow step to get runtime details for that step.

SELECT examples

get_workflow_step_execution

Get the runtime information that was logged for a specific runtime instance of the workflow step.

SELECT
name,
action,
description,
end_time,
image_build_version_arn,
inputs,
message,
on_failure,
outputs,
request_id,
rollback_status,
start_time,
status,
step_execution_id,
timeout_seconds,
workflow_build_version_arn,
workflow_execution_id
FROM aws.imagebuilder.workflow_step_executions
WHERE stepExecutionId = '{{ stepExecutionId }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_step_executions

Returns runtime data for each step in a runtime instance of the workflow that you specify in the request.

SELECT
name,
action,
description,
end_time,
inputs,
message,
outputs,
rollback_status,
start_time,
status,
step_execution_id
FROM aws.imagebuilder.workflow_step_executions
WHERE region = '{{ region }}' -- required
;