v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465336243.7 KB

Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.

In the China (Ningxia) Region, you can copy images only within the same Region.

In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.

Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.

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

Headers

X-Amz-Target'WorkspacesService.CopyWorkspaceImage' required

Request body

Namestring required

The name of the image.

Descriptionstring

A description of the image.

SourceImageIdstring required

The identifier of the source image.

SourceRegionstring required

The identifier of the source Region.

Response

Success

ImageIdstring

The identifier of the image.