workflow_executions

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

Overview

Name	workflow_executions
Type	Resource
Id	aws.imagebuilder.workflow_executions

Fields

The following fields are returned by SELECT queries:

get_workflow_execution

Name	Datatype	Description
end_time	string	The timestamp when the specified runtime instance of the workflow 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 created. (pattern: <code>^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/[0-9]+.[0-9]+.[0-9]+/[0-9]+$</code>)
message	string	The output message from the specified runtime instance of the workflow, if applicable.
parallel_group	string	Test workflows are defined within named runtime groups. The parallel group is a named group that contains one or more test workflows. (pattern: <code>^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$</code>)
request_id	string	The request ID that uniquely identifies this request.
start_time	string	The timestamp when the specified runtime instance of the workflow started.
status	string	The current runtime status for the specified runtime instance of the workflow. (PENDING, SKIPPED, RUNNING, COMPLETED, FAILED, ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETED, CANCELLED)
total_step_count	integer	The total number of steps in the specified runtime instance of the workflow that ran. This number should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
total_steps_failed	integer	A runtime count for the number of steps that failed in the specified runtime instance of the workflow.
total_steps_skipped	integer	A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.
total_steps_succeeded	integer	A runtime count for the number of steps that ran successfully in the specified runtime instance of the workflow.
type_	string	The type of workflow that Image Builder ran for the specified runtime instance of the workflow. (BUILD, TEST, DISTRIBUTION)
workflow_build_version_arn	string	The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow. (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_executions

Name	Datatype	Description
end_time	string	The timestamp when this runtime instance of the workflow finished.
message	string	The runtime output message from the workflow, if applicable.
parallel_group	string	The name of the test group that included the test workflow resource at runtime. (pattern: <code>^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$</code>)
retried	boolean	Indicates retry status for this runtime instance of the workflow.
start_time	string	The timestamp when the runtime instance of this workflow started.
status	string	The current runtime status for this workflow. (PENDING, SKIPPED, RUNNING, COMPLETED, FAILED, ROLLBACK_IN_PROGRESS, ROLLBACK_COMPLETED, CANCELLED)
total_step_count	integer	The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.
total_steps_failed	integer	A runtime count for the number of steps in the workflow that failed.
total_steps_skipped	integer	A runtime count for the number of steps in the workflow that were skipped.
total_steps_succeeded	integer	A runtime count for the number of steps in the workflow that ran successfully.
type_	string	Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow. (BUILD, TEST, DISTRIBUTION)
workflow_build_version_arn	string	The Amazon Resource Name (ARN) of the workflow resource build version that ran. (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	Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a 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>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_workflow_execution	select	workflowExecutionId, region		Get the runtime information that was logged for a specific runtime instance of the workflow.
list_workflow_executions	select	region		Returns a list of workflow runtime instance metadata objects for a specific image build version.

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)
workflowExecutionId	string	Use the unique identifier for a runtime instance of the workflow to get runtime details.

SELECT examples

get_workflow_execution

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

SELECT
end_time,
image_build_version_arn,
message,
parallel_group,
request_id,
start_time,
status,
total_step_count,
total_steps_failed,
total_steps_skipped,
total_steps_succeeded,
type_,
workflow_build_version_arn,
workflow_execution_id
FROM aws.imagebuilder.workflow_executions
WHERE workflowExecutionId = '{{ workflowExecutionId }}' -- required
AND region = '{{ region }}' -- required
;

list_workflow_executions

Returns a list of workflow runtime instance metadata objects for a specific image build version.

SELECT
end_time,
message,
parallel_group,
retried,
start_time,
status,
total_step_count,
total_steps_failed,
total_steps_skipped,
total_steps_succeeded,
type_,
workflow_build_version_arn,
workflow_execution_id
FROM aws.imagebuilder.workflow_executions
WHERE region = '{{ region }}' -- required
;