CopyObjectRequest Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
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.dll
Version: 2.0.0.3

Syntax

C# 
public class CopyObjectRequest : PutWithACLRequest
         IRequestEvents

The CopyObjectRequest type exposes the following members

Constructors

  Name Description
Public Method CopyObjectRequest()

Properties

  Name Description
Public Property CannedACL A canned access control list (CACL) to apply to the object. Please refer to for information on S3 Canned ACLs.
Public Property ContentType This is a convenience property for Headers.ContentType.
Public Property DestinationBucket The name of the bucket to contain the copy of the source object.
Public Property DestinationKey The key to be given to the copy of the source object.
Public Property ETagToMatch ETag to be matched as a pre-condition for copying the source object otherwise returns a PreconditionFailed.
Public Property ETagToNotMatch ETag that must not be matched as a pre-condition for copying the source object, otherwise returns a PreconditionFailed.
Public Property Grants Gets the access control lists (ACLs) for this request. Please refer to for information on S3 Grants.
Public Property Headers The collection of headers for the request.
Public Property MetaData The collection of meta data for the request.
Public Property MetadataDirective Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
Public Property ModifiedSinceDate Copies the object if it has been modified since the specified time, otherwise returns a PreconditionFailed.
Public Property ServerSideEncryptionMethod The Server-side encryption algorithm used when storing this object in S3.
Public Property SourceBucket The name of the bucket containing the object to copy.
Public Property SourceKey The key of the object to copy.
Public Property SourceVersionId Specifies a particular version of the source object to copy. By default the latest version is copied.
Public Property StorageClass The type of storage to use for the object. Defaults to 'STANDARD'.
Public Property UnmodifiedSinceDate Copies the object if it has not been modified since the specified time, otherwise returns a PreconditionFailed.
Public Property WebsiteRedirectLocation 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 Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8

.NET for Windows Phone:
Supported in: Window Phone 8