Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . workspaces ]

import-workspace-image

Description

Imports the specified Windows 10 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

See 'aws help' for descriptions of global parameters.

Synopsis

  import-workspace-image
--ec2-image-id <value>
--ingestion-process <value>
--image-name <value>
--image-description <value>
[--tags <value>]
[--applications <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--ec2-image-id (string)

The identifier of the EC2 image.

--ingestion-process (string)

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 or WorkSpaces Streaming Protocol (WSP). To use WSP, specify a value that ends in _WSP . To use PCoIP, specify a value that does not end in _WSP .

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

Possible values:

  • BYOL_REGULAR
  • BYOL_GRAPHICS
  • BYOL_GRAPHICSPRO
  • BYOL_REGULAR_WSP

--image-name (string)

The name of the WorkSpace image.

--image-description (string)

The description of the WorkSpace image.

--tags (list)

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

(structure)

Describes a tag.

Key -> (string)

The key of the tag.

Value -> (string)

The value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--applications (list)

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 .

Note

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

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Microsoft_Office_2016
  Microsoft_Office_2019

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ImageId -> (string)

The identifier of the WorkSpace image.