Skip to content

RegionFailure

Source code in docs_src/capo_imagebuilder/types/region_failure.py
class RegionFailure(TypedDict, closed=True):
    region: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The Region where the failure occurred.</p>"""
    status: NotRequired[
        "capo_imagebuilder.types.region_failure_status.RegionFailureStatus"
    ]
    """<p>The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.</p>"""
    image_configuration_step: NotRequired[
        "capo_imagebuilder.types.image_configuration_step.ImageConfigurationStep"
    ]
    """<p>The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.</p>"""
    error_message: NotRequired[
        "capo_imagebuilder.types.non_empty_max_length_string.NonEmptyMaxLengthString"
    ]
    """<p>The error message for the failure in the Region.</p>"""
    target_account_id: NotRequired["capo_imagebuilder.types.account_id.AccountId"]
    """<p>The account ID of the account that the image was distributed to in the Region.</p>"""

error_message instance-attribute

error_message: NotRequired[NonEmptyMaxLengthString]

The error message for the failure in the Region.

image_configuration_step instance-attribute

image_configuration_step: NotRequired[ImageConfigurationStep]

The image configuration step where the failure occurred. Image Builder sets this property when the failure happened during post-distribution configuration, such as launch template updates or virtual machine (VM) export. This property doesn't appear for failures that occurred while Image Builder copied the image to the Region.

region instance-attribute

region: NotRequired[NonEmptyString]

The Region where the failure occurred.

status instance-attribute

status: NotRequired[RegionFailureStatus]

The failure status for the Region. Indicates whether the process failed, was canceled, or timed out.

target_account_id instance-attribute

target_account_id: NotRequired[AccountId]

The account ID of the account that the image was distributed to in the Region.