Amazon WorkSpaces

{'Applications': ['Microsoft_Office_2016 | Microsoft_Office_2019']}

Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS 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

client.import_workspace_image(
    Ec2ImageId='string',
    IngestionProcess='BYOL_REGULAR'|'BYOL_GRAPHICS'|'BYOL_GRAPHICSPRO',
    ImageName='string',
    ImageDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Applications=[
        'Microsoft_Office_2016'|'Microsoft_Office_2019',
    ]
)

type Ec2ImageId:

string

param Ec2ImageId:

[REQUIRED]

The identifier of the EC2 image.

type IngestionProcess:

string

param IngestionProcess:

[REQUIRED]

The ingestion process to be used when importing the image. For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR.

type ImageName:

string

param ImageName:

[REQUIRED]

The name of the WorkSpace image.

type ImageDescription:

string

param ImageDescription:

[REQUIRED]

The description of the WorkSpace image.

type Tags:

list

param Tags:

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.

type Applications:

list

param Applications:

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

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

• (dict) --

  • ImageId (string) --

    The identifier of the WorkSpace image.