WorkSpaces / Client / import_workspace_image

import_workspace_image#

WorkSpaces.Client.import_workspace_image(**kwargs)#

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 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_workspace_image(
    Ec2ImageId='string',
    IngestionProcess='BYOL_REGULAR'|'BYOL_GRAPHICS'|'BYOL_GRAPHICSPRO'|'BYOL_GRAPHICS_G4DN'|'BYOL_REGULAR_WSP'|'BYOL_GRAPHICS_G4DN_WSP'|'BYOL_REGULAR_BYOP'|'BYOL_GRAPHICS_G4DN_BYOP',
    ImageName='string',
    ImageDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Applications=[
        'Microsoft_Office_2016'|'Microsoft_Office_2019',
    ]
)
Parameters:

  • Ec2ImageId (string) –

    [REQUIRED]

    The identifier of the EC2 image.

  • IngestionProcess (string) –

    [REQUIRED]

    The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

    For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

    Note

    The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

  • ImageName (string) –

    [REQUIRED]

    The name of the WorkSpace image.

  • ImageDescription (string) –

    [REQUIRED]

    The description of the WorkSpace image.

  • Tags (list) –

    The 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.

  • Applications (list) –

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

    Note

    • Although this parameter is an array, only one item is allowed at this time.

    • During the image import process, non-GPU WSP WorkSpaces with Windows 11 support only Microsoft_Office_2019. GPU WSP WorkSpaces with Windows 11 do not support Office installation.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

  • (dict) –

    • ImageId (string) –

      The identifier of the WorkSpace image.

Exceptions

  • WorkSpaces.Client.exceptions.ResourceLimitExceededException

  • WorkSpaces.Client.exceptions.ResourceAlreadyExistsException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.OperationNotSupportedException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException