Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ImportCustomWorkspaceImage

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.

Request Syntax


{
   "ComputeType": "string",
   "ImageDescription": "string",
   "ImageName": "string",
   "ImageSource": { ... },
   "InfrastructureConfigurationArn": "string",
   "OsVersion": "string",
   "Platform": "string",
   "Protocol": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

The request accepts the following data in JSON format.

ComputeType

The supported compute type for the WorkSpace image.

Type: String

Valid Values: BASE | GRAPHICS_G4DN

Required: Yes

ImageDescription

The description of the WorkSpace image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: Yes

ImageName

The name of the WorkSpace image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_./()\\-]+$

Required: Yes

ImageSource

The options for image import source.

Type: ImageSourceIdentifier object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

InfrastructureConfigurationArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$

Required: Yes

OsVersion

The OS version for the WorkSpace image source.

Type: String

Valid Values: Windows_10 | Windows_11

Required: Yes

Platform

The platform for the WorkSpace image source.

Type: String

Valid Values: WINDOWS

Required: Yes

Protocol

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

Type: String

Valid Values: PCOIP | DCV | BYOP

Required: Yes

Tags

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

Type: Array of Tag objects

Required: No

Response Syntax


{
   "ImageId": "string",
   "State": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImageId

The identifier of the WorkSpace image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

State

The state of the WorkSpace image.

Type: String

Valid Values: PENDING | IN_PROGRESS | COMPLETED | ERROR

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

OperationNotSupportedException

This operation is not supported.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceLimitExceededException

Your resource limits have been exceeded.

HTTP Status Code: 400

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400