WorkSpaces / Client / create_updated_workspace_image

create_updated_workspace_image#

WorkSpaces.Client.create_updated_workspace_image(**kwargs)#

Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.

To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.

Note

  • Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

  • Microsoft Windows updates and other application updates are not included in the update process.

  • The source WorkSpace image is not deleted. You can delete the source image after you’ve verified your new updated image and created a new bundle.

See also: AWS API Documentation

Request Syntax

response = client.create_updated_workspace_image(
    Name='string',
    Description='string',
    SourceImageId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the new updated WorkSpace image.

  • Description (string) –

    [REQUIRED]

    A description of whether updates for the WorkSpace image are available.

  • SourceImageId (string) –

    [REQUIRED]

    The identifier of the source WorkSpace image.

  • Tags (list) –

    The tags that you want to add to the new updated WorkSpace image.

    Note

    To add tags at the same time when you’re creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

    • (dict) –

      Describes a tag.

      • Key (string) – [REQUIRED]

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

  • (dict) –

    • ImageId (string) –

      The identifier of the new updated WorkSpace image.

Exceptions

  • WorkSpaces.Client.exceptions.ResourceLimitExceededException

  • WorkSpaces.Client.exceptions.ResourceAlreadyExistsException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException

  • WorkSpaces.Client.exceptions.InvalidResourceStateException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException