WorkflowExecutionMetadata
Metadata that includes details and status from this runtime instance of the workflow.
Contents
- endTime
-
The timestamp when this runtime instance of the workflow finished.
Type: String
Required: No
- message
-
The runtime output message from the workflow, if applicable.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Required: No
- parallelGroup
-
The name of the test group that included the test workflow resource at runtime.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[A-Za-z0-9][A-Za-z0-9-_+#]{0,99}$Required: No
- retried
-
Indicates whether a retry of the image build superseded this runtime instance of the workflow. When you retry a failed image build, Image Builder sets this flag to
trueon the original workflow executions that the retry re-ran.Type: Boolean
Required: No
- startTime
-
The timestamp when the runtime instance of this workflow started.
Type: String
Required: No
- status
-
The current runtime status for this workflow.
Type: String
Valid Values:
PENDING | SKIPPED | RUNNING | COMPLETED | FAILED | ROLLBACK_IN_PROGRESS | ROLLBACK_COMPLETED | CANCELLEDRequired: No
- totalStepCount
-
The total number of steps that the workflow document defines for this runtime instance of the workflow. Image Builder sets this count before any steps run. The sum of succeeded, skipped, and failed steps only reaches this total if every step finishes in one of those states.
Type: Integer
Required: No
- totalStepsFailed
-
A runtime count for the number of steps in the workflow that failed.
Type: Integer
Required: No
- totalStepsSkipped
-
A runtime count for the number of steps in the workflow that were skipped.
Type: Integer
Required: No
- totalStepsSucceeded
-
A runtime count for the number of steps in the workflow that ran successfully.
Type: Integer
Required: No
- type
-
Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.
Type: String
Valid Values:
BUILD | TEST | DISTRIBUTIONRequired: No
- workflowBuildVersionArn
-
The Amazon Resource Name (ARN) of the workflow resource build version that ran.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^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]+$Required: No
- workflowExecutionId
-
Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.
Type: String
Pattern:
^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}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: