Post x amz targetworkspacesservice.createworkspaceimage

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465336243.7 KB

Creates a new WorkSpace image from an existing WorkSpace.

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

Headers

X-Amz-Target'WorkspacesService.CreateWorkspaceImage' required

Request body

Namestring required

The name of the new WorkSpace image.

Descriptionstring required

The description of the new WorkSpace image.

WorkspaceIdstring required

The identifier of the source WorkSpace

Response

Success

ImageIdstring

The identifier of the new WorkSpace image.

Namestring

The name of the image.

Descriptionstring

The description of the image.

State'AVAILABLE' | 'PENDING' | 'ERROR'

The availability status of the image.

RequiredTenancy'DEFAULT' | 'DEDICATED'

Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm"> Bring Your Own Windows Desktop Images.</a>.

Createdstring date-time

The date when the image was created.

OwnerAccountIdstring

The identifier of the Amazon Web Services account that owns the image.