Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ImportWorkspaceImage

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 AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

Request Syntax


{
   "Applications": [ "string" ],
   "Ec2ImageId": "string",
   "ImageDescription": "string",
   "ImageName": "string",
   "IngestionProcess": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

The request accepts the following data in JSON format.

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.

Note

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Valid Values: Microsoft_Office_2016 | Microsoft_Office_2019

Required: No

Ec2ImageId

The identifier of the EC2 image.

Type: String

Pattern: ^ami\-([a-f0-9]{8}|[a-f0-9]{17})$

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

IngestionProcess

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.

Type: String

Valid Values: BYOL_REGULAR | BYOL_GRAPHICS | BYOL_GRAPHICSPRO | BYOL_GRAPHICS_G4DN | BYOL_REGULAR_WSP

Required: Yes

Tags

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

Type: Array of Tag objects

Required: No

Response Syntax


{
   "ImageId": "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}$

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