ImportWorkspaceImage
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 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
{
"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 and 11 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.
-
During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only
Microsoft_Office_2019
. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.
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, WSP, or bring your own protocol (BYOP). To use DCV, specify a value that ends in
_WSP
. To use PCoIP, specify a value that does not end in_WSP
. To use BYOP, specify a value that ends in_BYOP
.For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify
BYOL_REGULAR
,BYOL_REGULAR_WSP
, orBYOL_REGULAR_BYOP
, depending on the protocol.Note
The
BYOL_REGULAR_BYOP
andBYOL_GRAPHICS_G4DN_BYOP
values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core. Type: String
Valid Values:
BYOL_REGULAR | BYOL_GRAPHICS | BYOL_GRAPHICSPRO | BYOL_GRAPHICS_G4DN | BYOL_REGULAR_WSP | BYOL_GRAPHICS_G4DN_WSP | BYOL_REGULAR_BYOP | BYOL_GRAPHICS_G4DN_BYOP
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 Amazon SDKs, see the following: