Sign In to the Console
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

AWS Documentation » Amazon WorkSpaces » API Reference » Actions » ImportWorkspaceImage

ImportWorkspaceImage

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.

Request Syntax

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

Request Parameters

The request accepts the following data in JSON format.

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.

Type: String

Valid Values: BYOL_REGULAR | BYOL_GRAPHICS | BYOL_GRAPHICSPRO

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: