Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CopyWorkspaceImage

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 AWS GovCloud (US), to copy images to and from other Regions, contact AWS Support.

Important

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

Request Syntax


{
   "Description": "string",
   "Name": "string",
   "SourceImageId": "string",
   "SourceRegion": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

The request accepts the following data in JSON format.

Description

A description of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[a-zA-Z0-9_./() -]+$

Required: No

Name

The name of the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_./()\\-]+$

Required: Yes

SourceImageId

The identifier of the source image.

Type: String

Pattern: wsi-[0-9a-z]{9,63}$

Required: Yes

SourceRegion

The identifier of the source Region.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 31.

Pattern: ^[-0-9a-z]{1,31}$

Required: Yes

Tags

The tags for the image.

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 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

ResourceUnavailableException

The specified resource is not available.

HTTP Status Code: 400