Skip to content

ImageState

Source code in docs_src/capo_imagebuilder/types/image_state.py
class ImageState(TypedDict, closed=True):
    status: NotRequired["capo_imagebuilder.types.image_status.ImageStatus"]
    """<p>The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the <code>AVAILABLE</code>, <code>FAILED</code>, or <code>CANCELLED</code> state. The <code>DEPRECATED</code>, <code>DISABLED</code>, and <code>DELETED</code> statuses come from later resource management actions.</p>"""
    reason: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The reason for the status of the image.</p>"""
    failure_context: NotRequired[
        "capo_imagebuilder.types.image_failure_context.ImageFailureContext"
    ]
    """<p>The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is <code>FAILED</code>.</p>"""

failure_context instance-attribute

failure_context: NotRequired[ImageFailureContext]

The details about the failure, for images that failed to complete. Image Builder only sets this property when the image status is FAILED.

reason instance-attribute

reason: NotRequired[NonEmptyString]

The reason for the status of the image.

status instance-attribute

status: NotRequired[ImageStatus]

The status of the image. A new image moves through build, test, and distribution statuses during creation, and ends in the AVAILABLE, FAILED, or CANCELLED state. The DEPRECATED, DISABLED, and DELETED statuses come from later resource management actions.