AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Initiates an AMI copy operation. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.

When you copy an AMI from one Region to another, the destination Region is the current Region.

When you copy an AMI from a Region to an Outpost, specify the ARN of the Outpost as the destination. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots.

For information about the prerequisites when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CopyImageAsync.

Namespace: Amazon.EC2
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public virtual CopyImageResponse CopyImage(
         CopyImageRequest request
)

Parameters

request
Type: Amazon.EC2.Model.CopyImageRequest

Container for the necessary parameters to execute the CopyImage service method.

Return Value


The response from the CopyImage service method, as returned by EC2.

Examples

This example copies the specified AMI from the us-east-1 region to the current region.

To copy an AMI to another region


var client = new AmazonEC2Client();
var response = client.CopyImage(new CopyImageRequest 
{
    Description = "",
    Name = "My server",
    SourceImageId = "ami-5731123e",
    SourceRegion = "us-east-1"
});

string imageId = response.ImageId;

            

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also