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-custom-workspace-image

Description

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

Synopsis

  import-custom-workspace-image
--image-name <value>
--image-description <value>
--compute-type <value>
--protocol <value>
--image-source <value>
--infrastructure-configuration-arn <value>
--platform <value>
--os-version <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--image-name (string)

The name of the WorkSpace image.

--image-description (string)

The description of the WorkSpace image.

--compute-type (string)

The supported compute type for the WorkSpace image.

Possible values:

• BASE
• GRAPHICS_G4DN

--protocol (string)

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

Possible values:

• PCOIP
• DCV
• BYOP

--image-source (tagged union structure)

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.

Shorthand Syntax:

Ec2ImportTaskId=string,ImageBuildVersionArn=string,Ec2ImageId=string

JSON Syntax:

{
  "Ec2ImportTaskId": "string",
  "ImageBuildVersionArn": "string",
  "Ec2ImageId": "string"
}

--infrastructure-configuration-arn (string)

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

--platform (string)

The platform for the WorkSpace image source.

Possible values:

• WINDOWS

--os-version (string)

The OS version for the WorkSpace image source.

Possible values:

• Windows_10
• Windows_11

--tags (list)

The resource 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"
  }
  ...
]

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ImageId -> (string)

The identifier of the WorkSpace image.

State -> (string)

The state of the WorkSpace image.