Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465336243.7 KB

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 Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.

post/#X-Amz-Target=WorkspacesService.ImportWorkspaceImage

Headers

X-Amz-Target'WorkspacesService.ImportWorkspaceImage' required

Request body

Ec2ImageIdstring required

The identifier of the EC2 image.

IngestionProcess'BYOL_REGULAR' | 'BYOL_GRAPHICS' | 'BYOL_GRAPHICSPRO' | 'BYOL_GRAPHICS_G4DN' | 'BYOL_REGULAR_WSP' | 'BYOL_REGULAR_BYOP' | 'BYOL_GRAPHICS_G4DN_BYOP' required
<p>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, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in <code>_WSP</code>. To use PCoIP, specify a value that does not end in <code>_WSP</code>. To use BYOP, specify a value that ends in <code>_BYOP</code>.</p> <p>For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify <code>BYOL_REGULAR</code>, <code>BYOL_REGULAR_WSP</code>, or <code>BYOL_REGULAR_BYOP</code>, depending on the protocol.</p> <note> <p>The <code>BYOL_REGULAR_BYOP</code> and <code>BYOL_GRAPHICS_G4DN_BYOP</code> values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see <a href="http://aws.amazon.com/workspaces/core/">Amazon WorkSpaces Core</a>.</p> </note>
ImageNamestring required

The name of the WorkSpace image.

ImageDescriptionstring required

The description of the WorkSpace image.

ApplicationsApplication[]
<p>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 <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html"> Bring Your Own Windows Desktop Licenses</a>.</p> <note> <p>Although this parameter is an array, only one item is allowed at this time.</p> </note>

Response

Success

ImageIdstring

The identifier of the WorkSpace image.