Image ¶

class Image(TypedDict, closed=True):
    name: NotRequired["capo_appstream.types.string.String"]
    """<p>The name of the image.</p>"""
    arn: NotRequired["capo_appstream.types.arn.Arn"]
    """<p>The ARN of the image.</p>"""
    base_image_arn: NotRequired["capo_appstream.types.arn.Arn"]
    """<p>The ARN of the image from which this image was created.</p>"""
    display_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The image name to display.</p>"""
    state: NotRequired["capo_appstream.types.image_state.ImageState"]
    """<p>The image starts in the <code>PENDING</code> state. If image creation succeeds, the state is <code>AVAILABLE</code>. If image creation fails, the state is <code>FAILED</code>.</p>"""
    visibility: NotRequired["capo_appstream.types.visibility_type.VisibilityType"]
    """<p>Indicates whether the image is public or private.</p>"""
    image_builder_supported: NotRequired["capo_appstream.types.boolean.Boolean"]
    """<p>Indicates whether an image builder can be launched from this image.</p>"""
    image_builder_name: NotRequired["capo_appstream.types.string.String"]
    """<p>The name of the image builder that was used to create the private image. If the image is shared, copied, or updated by using Managed Image Updates, this value is null.</p>"""
    platform: NotRequired["capo_appstream.types.platform_type.PlatformType"]
    """<p>The operating system platform of the image.</p>"""
    description: NotRequired["capo_appstream.types.string.String"]
    """<p>The description to display.</p>"""
    state_change_reason: NotRequired[
        "capo_appstream.types.image_state_change_reason.ImageStateChangeReason"
    ]
    """<p>The reason why the last state change occurred.</p>"""
    applications: NotRequired["capo_appstream.types.applications.Applications"]
    """<p>The applications associated with the image.</p>"""
    created_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The time the image was created.</p>"""
    public_base_image_released_date: NotRequired[
        "capo_appstream.types.timestamp.Timestamp"
    ]
    """<p>The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>"""
    appstream_agent_version: NotRequired[
        "capo_appstream.types.appstream_agent_version.AppstreamAgentVersion"
    ]
    """<p>The version of the WorkSpaces Applications agent to use for instances that are launched from this image. </p>"""
    image_permissions: NotRequired[
        "capo_appstream.types.image_permissions.ImagePermissions"
    ]
    """<p>The permissions to provide to the destination AWS account for the specified image.</p>"""
    image_errors: NotRequired["capo_appstream.types.resource_errors.ResourceErrors"]
    """<p>Describes the errors that are returned when a new image can't be created.</p>"""
    latest_appstream_agent_version: NotRequired[
        "capo_appstream.types.latest_appstream_agent_version.LatestAppstreamAgentVersion"
    ]
    """<p>Indicates whether the image is using the latest WorkSpaces Applications agent version or not.</p>"""
    supported_instance_families: NotRequired[
        "capo_appstream.types.string_list.StringList"
    ]
    """<p>The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:</p> <ul> <li> <p>General Purpose</p> </li> <li> <p>Compute Optimized</p> </li> <li> <p>Memory Optimized</p> </li> <li> <p>Graphics G4</p> </li> <li> <p>Graphics G5</p> </li> <li> <p>Graphics G6</p> </li> </ul>"""
    dynamic_app_providers_enabled: NotRequired[
        "capo_appstream.types.dynamic_app_providers_enabled.DynamicAppProvidersEnabled"
    ]
    """<p>Indicates whether dynamic app providers are enabled within an WorkSpaces Applications image or not.</p>"""
    image_shared_with_others: NotRequired[
        "capo_appstream.types.image_shared_with_others.ImageSharedWithOthers"
    ]
    """<p>Indicates whether the image is shared with another account ID.</p>"""
    managed_software_included: NotRequired["capo_appstream.types.boolean.Boolean"]
    """<p>Indicates whether the image includes license-included applications.</p>"""
    image_type: NotRequired["capo_appstream.types.image_type.ImageType"]
    """<p>The type of the image. Images created through AMI import have type "custom", while WorkSpaces Applications provided images have type "native". Custom images support additional instance types including GeneralPurpose, MemoryOptimized, ComputeOptimized, and Accelerated instance families.</p>"""
    image_software_metadata: NotRequired[
        "capo_appstream.types.image_software_metadata.ImageSoftwareMetadata"
    ]
    """<p>The software metadata associated with the image.</p>"""