Table Of Contents


User Guide

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

[ aws . workspaces ]



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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--ec2-image-id (string)

The identifier of the EC2 image.

--ingestion-process (string)

The ingestion process to be used when importing the image.

Possible values:


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

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

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


ImageId -> (string)

The identifier of the WorkSpace image.