Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

CopyImage

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

Request Syntax

{ "DestinationImageDescription": "string", "DestinationImageName": "string", "DestinationRegion": "string", "SourceImageName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DestinationImageDescription

The description that the image will have when it is copied to the destination.

Type: String

Length Constraints: Maximum length of 256.

Required: No

DestinationImageName

The name that the image will have when it is copied to the destination.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

DestinationRegion

The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

Type: String

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

Required: Yes

SourceImageName

The name of the image to copy.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

Response Syntax

{ "DestinationImageName": "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.

DestinationImageName

The name of the destination image.

Type: String

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Errors

For information about the errors that are common to all actions, see Common Errors.

IncompatibleImageException

The image does not support storage connectors.

HTTP Status Code: 400

InvalidAccountStatusException

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

HTTP Status Code: 400

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceNotAvailableException

The specified resource exists and is not in use, but isn't available.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: