Skip to content

WorkflowExecutionMetadata

Source code in docs_src/capo_imagebuilder/types/workflow_execution_metadata.py
class WorkflowExecutionMetadata(TypedDict, closed=True):
    workflow_build_version_arn: NotRequired[
        "capo_imagebuilder.types.workflow_build_version_arn.WorkflowBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the workflow resource build version that ran.</p>"""
    workflow_execution_id: NotRequired[
        "capo_imagebuilder.types.workflow_execution_id.WorkflowExecutionId"
    ]
    """<p>Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.</p>"""
    type: NotRequired["capo_imagebuilder.types.workflow_type.WorkflowType"]
    """<p>Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.</p>"""
    status: NotRequired[
        "capo_imagebuilder.types.workflow_execution_status.WorkflowExecutionStatus"
    ]
    """<p>The current runtime status for this workflow.</p>"""
    message: NotRequired[
        "capo_imagebuilder.types.workflow_execution_message.WorkflowExecutionMessage"
    ]
    """<p>The runtime output message from the workflow, if applicable.</p>"""
    total_step_count: "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    """<p>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.</p>"""
    total_steps_succeeded: (
        "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    )
    """<p>A runtime count for the number of steps in the workflow that ran successfully.</p>"""
    total_steps_failed: "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    """<p>A runtime count for the number of steps in the workflow that failed.</p>"""
    total_steps_skipped: "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    """<p>A runtime count for the number of steps in the workflow that were skipped.</p>"""
    start_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when the runtime instance of this workflow started.</p>"""
    end_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when this runtime instance of the workflow finished.</p>"""
    parallel_group: NotRequired["capo_imagebuilder.types.parallel_group.ParallelGroup"]
    """<p>The name of the test group that included the test workflow resource at runtime.</p>"""
    retried: NotRequired["capo_imagebuilder.types.nullable_boolean.NullableBoolean"]
    """<p>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 <code>true</code> on the original workflow executions that the retry re-ran.</p>"""

end_time instance-attribute

end_time: NotRequired[DateTime]

The timestamp when this runtime instance of the workflow finished.

message instance-attribute

message: NotRequired[WorkflowExecutionMessage]

The runtime output message from the workflow, if applicable.

parallel_group instance-attribute

parallel_group: NotRequired[ParallelGroup]

The name of the test group that included the test workflow resource at runtime.

retried instance-attribute

retried: NotRequired[NullableBoolean]

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 true on the original workflow executions that the retry re-ran.

start_time instance-attribute

start_time: NotRequired[DateTime]

The timestamp when the runtime instance of this workflow started.

status instance-attribute

status: NotRequired[WorkflowExecutionStatus]

The current runtime status for this workflow.

total_step_count instance-attribute

total_step_count: WorkflowStepCount

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.

total_steps_failed instance-attribute

total_steps_failed: WorkflowStepCount

A runtime count for the number of steps in the workflow that failed.

total_steps_skipped instance-attribute

total_steps_skipped: WorkflowStepCount

A runtime count for the number of steps in the workflow that were skipped.

total_steps_succeeded instance-attribute

total_steps_succeeded: WorkflowStepCount

A runtime count for the number of steps in the workflow that ran successfully.

type instance-attribute

type: NotRequired[WorkflowType]

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

workflow_build_version_arn instance-attribute

workflow_build_version_arn: NotRequired[WorkflowBuildVersionArn]

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

workflow_execution_id instance-attribute

workflow_execution_id: NotRequired[WorkflowExecutionId]

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.