WorkspaceImage ¶

class WorkspaceImage(TypedDict, closed=True):
    image_id: NotRequired["capo_workspaces.types.workspace_image_id.WorkspaceImageId"]
    """<p>The identifier of the image.</p>"""
    name: NotRequired["capo_workspaces.types.workspace_image_name.WorkspaceImageName"]
    """<p>The name of the image.</p>"""
    description: NotRequired[
        "capo_workspaces.types.workspace_image_description.WorkspaceImageDescription"
    ]
    """<p>The description of the image.</p>"""
    operating_system: NotRequired[
        "capo_workspaces.types.operating_system.OperatingSystem"
    ]
    """<p>The operating system that the image is running. </p>"""
    state: NotRequired[
        "capo_workspaces.types.workspace_image_state.WorkspaceImageState"
    ]
    """<p>The status of the image.</p>"""
    required_tenancy: NotRequired[
        "capo_workspaces.types.workspace_image_required_tenancy.WorkspaceImageRequiredTenancy"
    ]
    """<p>Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to <code>DEDICATED</code>. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html">Bring Your Own Windows Desktop Images</a>.</p>"""
    error_code: NotRequired[
        "capo_workspaces.types.workspace_image_error_code.WorkspaceImageErrorCode"
    ]
    """<p>The error code that is returned for the image.</p>"""
    error_message: NotRequired["capo_workspaces.types.description.Description"]
    """<p>The text of the error message that is returned for the image.</p>"""
    created: NotRequired["capo_workspaces.types.timestamp.Timestamp"]
    """<p>The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.</p>"""
    owner_account_id: NotRequired["capo_workspaces.types.aws_account.AwsAccount"]
    """<p>The identifier of the Amazon Web Services account that owns the image.</p>"""
    updates: NotRequired["capo_workspaces.types.update_result.UpdateResult"]
    """<p>The updates (if any) that are available for the specified image.</p>"""
    error_details: NotRequired[
        "capo_workspaces.types.error_details_list.ErrorDetailsList"
    ]
    """<p>Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.</p>"""