Skip to content

ImageSummary

Source code in docs_src/capo_imagebuilder/types/image_summary.py
class ImageSummary(TypedDict, closed=True):
    arn: NotRequired["capo_imagebuilder.types.image_builder_arn.ImageBuilderArn"]
    """<p>The Amazon Resource Name (ARN) of the image.</p>"""
    name: NotRequired["capo_imagebuilder.types.resource_name.ResourceName"]
    """<p>The name of the image.</p>"""
    type: NotRequired["capo_imagebuilder.types.image_type.ImageType"]
    """<p>Specifies whether this image produces an AMI or a container image.</p>"""
    version: NotRequired[
        "capo_imagebuilder.types.version_number_with_build.VersionNumberWithBuild"
    ]
    """<p>The version of the image.</p>"""
    platform: NotRequired["capo_imagebuilder.types.platform.Platform"]
    """<p>The image operating system platform, such as Linux or Windows.</p>"""
    os_version: NotRequired["capo_imagebuilder.types.os_version.OsVersion"]
    """<p>The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.</p>"""
    state: NotRequired["capo_imagebuilder.types.image_state.ImageState"]
    """<p>The state of the image.</p>"""
    owner: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The owner of the image.</p>"""
    date_created: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The date on which Image Builder created this image.</p>"""
    output_resources: NotRequired[
        "capo_imagebuilder.types.output_resources.OutputResources"
    ]
    """<p>The output resources that Image Builder produced when it created this image.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags that apply to this image.</p>"""
    build_type: NotRequired["capo_imagebuilder.types.build_type.BuildType"]
    """<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> <li> <p> <b>IMPORT_ISO</b> – An ISO disk import created the image.</p> </li> </ul>"""
    image_source: NotRequired["capo_imagebuilder.types.image_source.ImageSource"]
    """<p>The origin of the base image that Image Builder used to build this image.</p>"""
    deprecation_time: NotRequired[
        "capo_imagebuilder.types.date_time_timestamp.DateTimeTimestamp"
    ]
    """<p>The time when deprecation occurs for an image resource. This can be a past or future date.</p>"""
    lifecycle_execution_id: NotRequired[
        "capo_imagebuilder.types.lifecycle_execution_id.LifecycleExecutionId"
    ]
    """<p>Identifies the last runtime instance of the lifecycle policy to take action on the image.</p>"""
    logging_configuration: NotRequired[
        "capo_imagebuilder.types.image_logging_configuration.ImageLoggingConfiguration"
    ]
    """<p>The logging configuration that's defined for the image.</p>"""

arn instance-attribute

arn: NotRequired[ImageBuilderArn]

The Amazon Resource Name (ARN) of the image.

build_type instance-attribute

build_type: NotRequired[BuildType]

Indicates the type of build that created this image. The build can be initiated in the following ways:

  • USER_INITIATED – A manual pipeline build request.

  • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

  • IMPORT – A VM import created the image to use as the base image for the recipe.

  • IMPORT_ISO – An ISO disk import created the image.

date_created instance-attribute

date_created: NotRequired[DateTime]

The date on which Image Builder created this image.

deprecation_time instance-attribute

deprecation_time: NotRequired[DateTimeTimestamp]

The time when deprecation occurs for an image resource. This can be a past or future date.

image_source instance-attribute

image_source: NotRequired[ImageSource]

The origin of the base image that Image Builder used to build this image.

lifecycle_execution_id instance-attribute

lifecycle_execution_id: NotRequired[LifecycleExecutionId]

Identifies the last runtime instance of the lifecycle policy to take action on the image.

logging_configuration instance-attribute

logging_configuration: NotRequired[ImageLoggingConfiguration]

The logging configuration that's defined for the image.

name instance-attribute

name: NotRequired[ResourceName]

The name of the image.

os_version instance-attribute

os_version: NotRequired[OsVersion]

The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

output_resources instance-attribute

output_resources: NotRequired[OutputResources]

The output resources that Image Builder produced when it created this image.

owner instance-attribute

owner: NotRequired[NonEmptyString]

The owner of the image.

platform instance-attribute

platform: NotRequired[Platform]

The image operating system platform, such as Linux or Windows.

state instance-attribute

state: NotRequired[ImageState]

The state of the image.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that apply to this image.

type instance-attribute

type: NotRequired[ImageType]

Specifies whether this image produces an AMI or a container image.

version instance-attribute

version: NotRequired[VersionNumberWithBuild]

The version of the image.