Skip to content

ComponentFailureContext

Source code in docs_src/capo_imagebuilder/types/component_failure_context.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class ComponentFailureContext(TypedDict, closed=True):
    component_arn: NotRequired[
        "capo_imagebuilder.types.component_build_version_arn.ComponentBuildVersionArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the component build version that failed.</p>"""
    phase_name: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The name of the phase in the component document where the failure occurred, such as <code>build</code>, <code>validate</code>, or <code>test</code>.</p>"""
    step_name: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The name of the step in the component document that failed.</p>"""
    action: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The action that the failed step runs, for example <code>ExecuteBash</code>.</p>"""
    error_message: NotRequired[
        "capo_imagebuilder.types.non_empty_max_length_string.NonEmptyMaxLengthString"
    ]
    """<p>The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.</p>"""

action instance-attribute 

action: NotRequired[NonEmptyString]

The action that the failed step runs, for example ExecuteBash.

component_arn instance-attribute 

component_arn: NotRequired[ComponentBuildVersionArn]

The Amazon Resource Name (ARN) of the component build version that failed.

error_message instance-attribute 

error_message: NotRequired[NonEmptyMaxLengthString]

The error message from the step that failed. Image Builder truncates messages that are longer than 1024 characters. The component log in Amazon CloudWatch Logs contains the full output.

phase_name instance-attribute 

phase_name: NotRequired[NonEmptyString]

The name of the phase in the component document where the failure occurred, such as build, validate, or test.

step_name instance-attribute 

step_name: NotRequired[NonEmptyString]

The name of the step in the component document that failed.