Skip to content

GetWorkflowExecutionResponse

Source code in docs_src/capo_imagebuilder/types/get_workflow_execution_response.py
class GetWorkflowExecutionResponse(TypedDict, closed=True):
    request_id: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The request ID that uniquely identifies this request.</p>"""
    workflow_build_version_arn: NotRequired[
        "capo_imagebuilder.types.workflow_build_version_arn.WorkflowBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.</p>"""
    workflow_execution_id: NotRequired[
        "capo_imagebuilder.types.workflow_execution_id.WorkflowExecutionId"
    ]
    """<p>The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.</p>"""
    image_build_version_arn: NotRequired[
        "capo_imagebuilder.types.image_build_version_arn.ImageBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.</p>"""
    type: NotRequired["capo_imagebuilder.types.workflow_type.WorkflowType"]
    """<p>The type of workflow that Image Builder ran for the specified runtime instance of the workflow.</p>"""
    status: NotRequired[
        "capo_imagebuilder.types.workflow_execution_status.WorkflowExecutionStatus"
    ]
    """<p>The current runtime status for the specified runtime instance of the workflow. <code>COMPLETED</code>, <code>FAILED</code>, <code>ROLLBACK_COMPLETED</code>, <code>CANCELLED</code>, and <code>SKIPPED</code> are terminal states.</p>"""
    message: NotRequired[
        "capo_imagebuilder.types.workflow_execution_message.WorkflowExecutionMessage"
    ]
    """<p>The output message from the specified runtime instance of 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 that ran successfully in the specified runtime instance of the workflow.</p>"""
    total_steps_failed: "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    """<p>A runtime count for the number of steps that failed in the specified runtime instance of the workflow.</p>"""
    total_steps_skipped: "capo_imagebuilder.types.workflow_step_count.WorkflowStepCount"
    """<p>A runtime count for the number of steps that were skipped in the specified runtime instance of the workflow.</p>"""
    start_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when the specified runtime instance of the workflow started.</p>"""
    end_time: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The timestamp when the specified runtime instance of the workflow finished.</p>"""
    parallel_group: NotRequired["capo_imagebuilder.types.parallel_group.ParallelGroup"]
    """<p>The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.</p>"""

end_time instance-attribute

end_time: NotRequired[DateTime]

The timestamp when the specified runtime instance of the workflow finished.

image_build_version_arn instance-attribute

image_build_version_arn: NotRequired[ImageBuildVersionArn]

The Amazon Resource Name (ARN) of the image build version that owns the specified runtime instance of the workflow.

message instance-attribute

message: NotRequired[WorkflowExecutionMessage]

The output message from the specified runtime instance of the workflow, if applicable.

parallel_group instance-attribute

parallel_group: NotRequired[ParallelGroup]

The name of the parallel group that this runtime instance of the workflow ran in, if configured. Parallel groups apply only to test workflows.

request_id instance-attribute

request_id: NotRequired[NonEmptyString]

The request ID that uniquely identifies this request.

start_time instance-attribute

start_time: NotRequired[DateTime]

The timestamp when the specified runtime instance of the workflow started.

status instance-attribute

status: NotRequired[WorkflowExecutionStatus]

The current runtime status for the specified runtime instance of the workflow. COMPLETED, FAILED, ROLLBACK_COMPLETED, CANCELLED, and SKIPPED are terminal states.

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 that failed in the specified runtime instance of the workflow.

total_steps_skipped instance-attribute

total_steps_skipped: WorkflowStepCount

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

total_steps_succeeded instance-attribute

total_steps_succeeded: WorkflowStepCount

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

type instance-attribute

type: NotRequired[WorkflowType]

The type of workflow that Image Builder ran for the specified runtime instance of the workflow.

workflow_build_version_arn instance-attribute

workflow_build_version_arn: NotRequired[WorkflowBuildVersionArn]

The Amazon Resource Name (ARN) of the build version for the Image Builder workflow resource that defines the specified runtime instance of the workflow.

workflow_execution_id instance-attribute

workflow_execution_id: NotRequired[WorkflowExecutionId]

The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.