Skip to content

ImageFailureContext

Source code in docs_src/capo_imagebuilder/types/image_failure_context.py
class ImageFailureContext(TypedDict, closed=True):
    image_status: NotRequired["capo_imagebuilder.types.image_status.ImageStatus"]
    """<p>The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example <code>BUILDING</code> or <code>DISTRIBUTING</code>.</p>"""
    workflow_execution_id: NotRequired[
        "capo_imagebuilder.types.workflow_execution_id.WorkflowExecutionId"
    ]
    """<p>The unique identifier of the workflow execution that was running when the image failed.</p>"""
    workflow_arn: NotRequired[
        "capo_imagebuilder.types.workflow_build_version_arn.WorkflowBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.</p>"""
    step_execution_id: NotRequired[
        "capo_imagebuilder.types.workflow_step_execution_id.WorkflowStepExecutionId"
    ]
    """<p>The unique identifier of the workflow step execution that failed.</p>"""
    failed_step: NotRequired[
        "capo_imagebuilder.types.workflow_step_name.WorkflowStepName"
    ]
    """<p>The name of the workflow step that failed, as it appears in the workflow document.</p>"""
    component_failure: NotRequired[
        "capo_imagebuilder.types.component_failure_context.ComponentFailureContext"
    ]
    """<p>The details about the component that failed, if the failure occurred while a component was running.</p>"""
    distribution_failure: NotRequired[
        "capo_imagebuilder.types.distribution_failure_context.DistributionFailureContext"
    ]
    """<p>The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.</p>"""

component_failure instance-attribute

component_failure: NotRequired[ComponentFailureContext]

The details about the component that failed, if the failure occurred while a component was running.

distribution_failure instance-attribute

distribution_failure: NotRequired[DistributionFailureContext]

The details about the distribution failure, if the failure occurred while Image Builder distributed or configured the image.

failed_step instance-attribute

failed_step: NotRequired[WorkflowStepName]

The name of the workflow step that failed, as it appears in the workflow document.

image_status instance-attribute

image_status: NotRequired[ImageStatus]

The status that the image had when the failure occurred. This indicates the stage of the image creation process where the image failed, for example BUILDING or DISTRIBUTING.

step_execution_id instance-attribute

step_execution_id: NotRequired[WorkflowStepExecutionId]

The unique identifier of the workflow step execution that failed.

workflow_arn instance-attribute

workflow_arn: NotRequired[WorkflowBuildVersionArn]

The Amazon Resource Name (ARN) of the workflow build version that was running when the image failed.

workflow_execution_id instance-attribute

workflow_execution_id: NotRequired[WorkflowExecutionId]

The unique identifier of the workflow execution that was running when the image failed.