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.

Container for the parameters to the CopyObject operation.

Creates a copy of an object that is already stored in Amazon S3.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.PutWithACLRequest
      Amazon.S3.Model.CopyObjectRequest

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

Syntax

C#
public class CopyObjectRequest : PutWithACLRequest
         IAmazonWebServiceRequest

The CopyObjectRequest type exposes the following members

Constructors

NameDescription
Public Method CopyObjectRequest()

Properties

NameTypeDescription
Public Property CannedACL Amazon.S3.S3CannedACL

A canned access control list (CACL) to apply to the object. Please refer to Amazon.S3.S3CannedACL for information on S3 Canned ACLs.

Public Property ContentType System.String

This is a convenience property for Headers.ContentType.

Public Property CopySourceServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod

The Server-side encryption algorithm to be used with the customer provided key.

Public Property CopySourceServerSideEncryptionCustomerProvidedKey System.String

The customer provided encryption key for the source object of the copy.

Important: Amazon S3 does not store the encryption key you provide.

Public Property CopySourceServerSideEncryptionCustomerProvidedKeyMD5 System.String

The MD5 of the customer encryption key specified in the CopySourceServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.

Public Property DestinationBucket System.String

The name of the bucket to contain the copy of the source object.

Public Property DestinationKey System.String

The key to be given to the copy of the source object.

Public Property ETagToMatch System.String

ETag to be matched as a pre-condition for copying the source object otherwise returns a PreconditionFailed.

Public Property ETagToNotMatch System.String

ETag that must not be matched as a pre-condition for copying the source object, otherwise returns a PreconditionFailed.

Public Property Grants System.Collections.Generic.List<Amazon.S3.Model.S3Grant> Inherited from Amazon.S3.Model.PutWithACLRequest.
Public Property Headers Amazon.S3.Model.HeadersCollection

The collection of headers for the request.

Public Property Metadata Amazon.S3.Model.MetadataCollection

The collection of meta data for the request.

Public Property MetadataDirective Amazon.S3.S3MetadataDirective

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Public Property ModifiedSinceDate System.DateTime

Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property ReadWriteTimeout System.Nullable<System.TimeSpan>

Overrides the default ReadWriteTimeout value.

Public Property RequestPayer Amazon.S3.RequestPayer

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Public Property ServerSideEncryptionCustomerMethod Amazon.S3.ServerSideEncryptionCustomerMethod

The Server-side encryption algorithm to be used with the customer provided key.

Public Property ServerSideEncryptionCustomerProvidedKey System.String

The base64-encoded encryption key for Amazon S3 to use to encrypt the object

Using the encryption key you provide as part of your request Amazon S3 manages both the encryption, as it writes to disks, and decryption, when you access your objects. Therefore, you don't need to maintain any data encryption code. The only thing you do is manage the encryption keys you provide.

///

When you retrieve an object, you must provide the same encryption key as part of your request. Amazon S3 first verifies the encryption key you provided matches, and then decrypts the object before returning the object data to you.

Important: Amazon S3 does not store the encryption key you provide.

Public Property ServerSideEncryptionCustomerProvidedKeyMD5 System.String

The MD5 of the customer encryption key specified in the ServerSideEncryptionCustomerProvidedKey property. The MD5 is base 64 encoded. This field is optional, the SDK will calculate the MD5 if this is not set.

Public Property ServerSideEncryptionKeyManagementServiceKeyId System.String

The id of the AWS Key Management Service key that Amazon S3 should use to encrypt and decrypt the object. If a key id is not specified, the default key will be used for encryption and decryption.

Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod

The Server-side encryption algorithm used when storing this object in S3.

Public Property SourceBucket System.String

The name of the bucket containing the object to copy.

Public Property SourceKey System.String

The key of the object to copy.

Public Property SourceVersionId System.String

Specifies a particular version of the source object to copy. By default the latest version is copied.

Public Property StorageClass Amazon.S3.S3StorageClass

The type of storage to use for the object. Defaults to 'STANDARD'.

Public Property TagSet System.Collections.Generic.List<Amazon.S3.Model.Tag>

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Public Property Timeout System.Nullable<System.TimeSpan>

Overrides the default request timeout value.

Public Property UnmodifiedSinceDate System.DateTime

Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed.

Public Property WebsiteRedirectLocation System.String

If the bucketName is configured as a website, redirects requests for this object to another object in the same bucketName or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Examples

This example shows how to copy an object from one bucket/key to a different bucket/key.

CopyObject sample


// Create a client
AmazonS3Client client = new AmazonS3Client();

// Create a CopyObject request
CopyObjectRequest request = new CopyObjectRequest
{
    SourceBucket = "SampleBucket",
    SourceKey = "Item1",
    DestinationBucket = "AnotherBucket",
    DestinationKey = "Copy1",
    CannedACL = S3CannedACL.PublicRead
};

// Issue request
client.CopyObject(request);

                

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone