WorkSpaces / Client / import_custom_workspace_image

import_custom_workspace_image

WorkSpaces.Client.import_custom_workspace_image(**kwargs)

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

See also: AWS API Documentation

Request Syntax

response = client.import_custom_workspace_image(
    ImageName='string',
    ImageDescription='string',
    ComputeType='BASE'|'GRAPHICS_G4DN'|'GRAPHICS_G6',
    Protocol='PCOIP'|'DCV'|'BYOP',
    ImageSource={
        'Ec2ImportTaskId': 'string',
        'ImageBuildVersionArn': 'string',
        'Ec2ImageId': 'string'
    },
    InfrastructureConfigurationArn='string',
    Platform='WINDOWS',
    OsVersion='Windows_10'|'Windows_11',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• ImageName (string) –

  [REQUIRED]

  The name of the WorkSpace image.

• ImageDescription (string) –

  [REQUIRED]

  The description of the WorkSpace image.

• ComputeType (string) –

  [REQUIRED]

  The supported compute type for the WorkSpace image.

• Protocol (string) –

  [REQUIRED]

  The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.

• ImageSource (dict) –

  [REQUIRED]

  The options for image import source.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: Ec2ImportTaskId, ImageBuildVersionArn, Ec2ImageId.

  • Ec2ImportTaskId (string) –

    The EC2 import task ID to import the image from the Amazon EC2 VM import process.

  • ImageBuildVersionArn (string) –

    The ARN of the EC2 Image Builder image.

  • Ec2ImageId (string) –

    The identifier of the EC2 image.

• InfrastructureConfigurationArn (string) –

  [REQUIRED]

  The infrastructure configuration ARN that specifies how the WorkSpace image is built.

• Platform (string) –

  [REQUIRED]

  The platform for the WorkSpace image source.

• OsVersion (string) –

  [REQUIRED]

  The OS version for the WorkSpace image source.

• Tags (list) –

  The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.

  • (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',
    'State': 'PENDING'|'IN_PROGRESS'|'PROCESSING_SOURCE_IMAGE'|'IMAGE_TESTING_START'|'UPDATING_OPERATING_SYSTEM'|'IMAGE_COMPATIBILITY_CHECKING'|'IMAGE_TESTING_GENERALIZATION'|'CREATING_TEST_INSTANCE'|'INSTALLING_COMPONENTS'|'GENERALIZING'|'VALIDATING'|'PUBLISHING'|'COMPLETED'|'ERROR'
}

Response Structure

• (dict) –

  • ImageId (string) –

    The identifier of the WorkSpace image.

  • State (string) –

    The state of the WorkSpace image.

Exceptions

• WorkSpaces.Client.exceptions.AccessDeniedException

• WorkSpaces.Client.exceptions.InvalidParameterValuesException

• WorkSpaces.Client.exceptions.OperationNotSupportedException

• WorkSpaces.Client.exceptions.ResourceNotFoundException

• WorkSpaces.Client.exceptions.ResourceAlreadyExistsException

• WorkSpaces.Client.exceptions.ResourceLimitExceededException