Method: Aws::S3::Client#copy_object

Defined in:: lib/aws-sdk-s3/client.rb

#copy_object(params = {}) ⇒ `Types::CopyObjectOutput`

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

<note markdown=“1”> You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see [Copy Object Using the REST Multipart Upload API].

</note>

When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see [Using ACLs].

Amazon S3 transfer acceleration does not support cross-region copies. If you request a cross-region copy using a transfer acceleration endpoint, you get a 400 ‘Bad Request` error. For more information about transfer acceleration, see [Transfer Acceleration].

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see [REST Authentication]. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

To only copy an object under certain conditions, such as whether the ‘Etag` matches or whether the object was modified before or after a specified date, use the request parameters `x-amz-copy-source-if-match`, `x-amz-copy-source-if-none-match`, `x-amz-copy-source-if-unmodified-since`, or ` x-amz-copy-source-if-modified-since`.

<note markdown=“1”> All headers with the ‘x-amz-` prefix, including `x-amz-copy-source`, must be signed.

</note>

You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the ‘StorageClass` parameter. For more information, see [Storage Classes].

The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see [Using Server-Side Encryption].

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the ‘200 OK` response. This means that a `200 OK` response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.

If the copy is successful, you receive a response with information about the copied object.

<note markdown=“1”> If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

</note>

Consider the following when using request headers:

Consideration 1 – If both the ‘x-amz-copy-source-if-match` and `x-amz-copy-source-if-unmodified-since` headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
- ‘x-amz-copy-source-if-match` condition evaluates to true
- ‘x-amz-copy-source-if-unmodified-since` condition evaluates to false
Consideration 2 – If both of the ‘x-amz-copy-source-if-none-match` and `x-amz-copy-source-if-modified-since` headers are present in the request and evaluate as follows, Amazon S3 returns the `412 Precondition Failed` response code:
- ‘x-amz-copy-source-if-none-match` condition evaluates to false
- ‘x-amz-copy-source-if-modified-since` condition evaluates to true

The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see [Amazon S3 Pricing].

Following are other considerations when using ‘CopyObject`:

Versioning

: By default, ‘x-amz-copy-source` identifies the current version of an

object to copy. (If the current version is a delete marker, Amazon
S3 behaves as if the object was deleted.) To copy a different
version, use the `versionId` subresource.

If you enable versioning on the target bucket, Amazon S3 generates a
unique version ID for the object being copied. This version ID is
different from the version ID of the source object. Amazon S3
returns the version ID of the copied object in the
`x-amz-version-id` response header in the response.

If you do not enable versioning or suspend it on the target bucket,
the version ID that Amazon S3 generates is always null.

If the source object's storage class is GLACIER, you must restore a
copy of this object before you can use it as a source object for the
copy operation. For more information, see .

Access Permissions

: When copying an object, you can optionally specify the accounts or

groups that should be granted specific permissions on the new
object. There are two ways to grant the permissions using the
request headers:

* Specify a canned ACL with the `x-amz-acl` request header. For more
  information, see [Canned ACL][8].

* Specify access permissions explicitly with the `x-amz-grant-read`,
  `x-amz-grant-read-acp`, `x-amz-grant-write-acp`, and
  `x-amz-grant-full-control` headers. These parameters map to the
  set of permissions that Amazon S3 supports in an ACL. For more
  information, see [Access Control List (ACL) Overview][9].

You can use either a canned ACL or specify access permissions
explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

: To encrypt the target object, you must provide the appropriate

encryption-related request headers. The one you use depends on
whether you want to use AWS managed encryption keys or provide your
own encryption key.

* To encrypt the target object using server-side encryption with an
  AWS managed encryption key, provide the following request headers,
  as appropriate.

  * `x-amz-server-side-encryption`

  * `x-amz-server-side-encryption-aws-kms-key-id`

  * `x-amz-server-side-encryption-context`

  <note markdown="1"> If you specify `x-amz-server-side-encryption:aws:kms`, but don't
  provide `x-amz-server-side-encryption-aws-kms-key-id`, Amazon S3
  uses the AWS managed CMK in AWS KMS to protect the data. If you
  want to use a customer managed AWS KMS CMK, you must provide the
  `x-amz-server-side-encryption-aws-kms-key-id` of the symmetric
  customer managed CMK. Amazon S3 only supports symmetric CMKs and
  not asymmetric CMKs. For more information, see [Using Symmetric
  and Asymmetric Keys][10] in the *AWS Key Management Service
  Developer Guide*.

   </note>

  All GET and PUT requests for an object protected by AWS KMS fail
  if you don't make them with SSL or by using SigV4.

  For more information about server-side encryption with CMKs stored
  in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in KMS][11].

* To encrypt the target object using server-side encryption with an
  encryption key that you provide, use the following headers.

  * x-amz-server-side-encryption-customer-algorithm

  * x-amz-server-side-encryption-customer-key

  * x-amz-server-side-encryption-customer-key-MD5

* If the source object is encrypted using server-side encryption
  with customer-provided encryption keys, you must use the following
  headers.

  * x-amz-copy-source-server-side-encryption-customer-algorithm

  * x-amz-copy-source-server-side-encryption-customer-key

  * x-amz-copy-source-server-side-encryption-customer-key-MD5

  For more information about server-side encryption with CMKs stored
  in AWS KMS (SSE-KMS), see [Protecting Data Using Server-Side
  Encryption with CMKs stored in Amazon KMS][11].

Access-Control-List (ACL)-Specific Request Headers

: You also can use the following access control–related headers with

this operation. By default, all objects are private. Only the owner
has full access control. When adding a new object, you can grant
permissions to individual AWS accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the access
control list (ACL) on the object. For more information, see [Using
ACLs][2]. With this operation, you can grant access permissions
using one of the following two methods:

* Specify a canned ACL (`x-amz-acl`) — Amazon S3 supports a set of
  predefined ACLs, known as *canned ACLs*. Each canned ACL has a
  predefined set of grantees and permissions. For more information,
  see [Canned ACL][8].

* Specify access permissions explicitly — To explicitly grant access
  permissions to specific AWS accounts or groups, use the following
  headers. Each header maps to specific permissions that Amazon S3
  supports in an ACL. For more information, see [Access Control List
  (ACL) Overview][9]. In the header, you specify a list of grantees
  who get the specific permission. To grant permissions explicitly,
  use:

  * x-amz-grant-read

  * x-amz-grant-write

  * x-amz-grant-read-acp

  * x-amz-grant-write-acp

  * x-amz-grant-full-control

  You specify each grantee as a type=value pair, where the type is
  one of the following:

  * `emailAddress` – if the value specified is the email address of
    an AWS account

  * `id` – if the value specified is the canonical user ID of an AWS
    account

  * `uri` – if you are granting permissions to a predefined group

  For example, the following `x-amz-grant-read` header grants the
  AWS accounts identified by email addresses permissions to read
  object data and its metadata:

  `x-amz-grant-read: emailAddress="[email protected]",
  emailAddress="[email protected]" `

The following operations are related to ‘CopyObject`:

PutObject
GetObject

For more information, see [Copying Objects].

Examples:

Example: To copy an object


# The following example copies an object from one bucket to another.

resp = client.copy_object({
  bucket: "destinationbucket", 
  copy_source: "/sourcebucket/HappyFacejpg", 
  key: "HappyFaceCopyjpg", 
})

resp.to_h outputs the following:
{
  copy_object_result: {
    etag: "\"6805f2cfc46c0f04559748bb039d69ae\"", 
    last_modified: Time.parse("2016-12-15T17:38:53.000Z"), 
  }, 
}

Request syntax with placeholder values


resp = client.copy_object({
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_type: "ContentType",
  copy_source: "CopySource", # required
  copy_source_if_match: "CopySourceIfMatch",
  copy_source_if_modified_since: Time.now,
  copy_source_if_none_match: "CopySourceIfNoneMatch",
  copy_source_if_unmodified_since: Time.now,
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  metadata_directive: "COPY", # accepts COPY, REPLACE
  tagging_directive: "COPY", # accepts COPY, REPLACE
  server_side_encryption: "AES256", # accepts AES256, aws:kms
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
})

Response structure


resp.copy_object_result.etag #=> String
resp.copy_object_result.last_modified #=> Time
resp.expiration #=> String
resp.copy_source_version_id #=> String
resp.version_id #=> String
resp.server_side_encryption #=> String, one of "AES256", "aws:kms"
resp.sse_customer_algorithm #=> String
resp.sse_customer_key_md5 #=> String
resp.ssekms_key_id #=> String
resp.ssekms_encryption_context #=> String
resp.request_charged #=> String, one of "requester"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:acl (String) —

The canned ACL to apply to the object.
:bucket (required, String) —

The name of the destination bucket.
:cache_control (String) —

Specifies caching behavior along the request/reply chain.
:content_disposition (String) —

Specifies presentational information for the object.
:content_encoding (String) —

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
:content_language (String) —

The language the content is in.
:content_type (String) —

A standard MIME type describing the format of the object data.
:copy_source (required, String) —

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
:copy_source_if_match (String) —

Copies the object if its entity tag (ETag) matches the specified tag.
:copy_source_if_modified_since (Time, DateTime, Date, Integer, String) —

Copies the object if it has been modified since the specified time.
:copy_source_if_none_match (String) —

Copies the object if its entity tag (ETag) is different than the specified ETag.
:copy_source_if_unmodified_since (Time, DateTime, Date, Integer, String) —

Copies the object if it hasn’t been modified since the specified time.
:expires (Time, DateTime, Date, Integer, String) —

The date and time at which the object is no longer cacheable.
:grant_full_control (String) —

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
:grant_read (String) —

Allows grantee to read the object data and its metadata.
:grant_read_acp (String) —

Allows grantee to read the object ACL.
:grant_write_acp (String) —

Allows grantee to write the ACL for the applicable object.
:key (required, String) —

The key of the destination object.
:metadata (Hash<String,String>) —

A map of metadata to store with the object in S3.
:metadata_directive (String) —

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
:tagging_directive (String) —

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
:server_side_encryption (String) —

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
:storage_class (String) —

The type of storage to use for the object. Defaults to ‘STANDARD’.
:website_redirect_location (String) —

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
:sse_customer_algorithm (String) —

Specifies the algorithm to use to when encrypting the object (for example, AES256).
:sse_customer_key (String) —

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the ‘x-amz-server-side-encryption-customer-algorithm` header.
:sse_customer_key_md5 (String) —

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
:ssekms_key_id (String) —

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see [Specifying the Signature Version in Request Authentication] in the *Amazon S3 Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
:ssekms_encryption_context (String) —

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
:copy_source_sse_customer_algorithm (String) —

Specifies the algorithm to use when decrypting the source object (for example, AES256).
:copy_source_sse_customer_key (String) —

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
:copy_source_sse_customer_key_md5 (String) —

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
:request_payer (String) —

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets] in the *Amazon S3 Developer Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
:tagging (String) —

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.
:object_lock_mode (String) —

The Object Lock mode that you want to apply to the copied object.
:object_lock_retain_until_date (Time, DateTime, Date, Integer, String) —

The date and time when you want the copied object’s Object Lock to expire.
:object_lock_legal_hold_status (String) —

Specifies whether you want to apply a Legal Hold to the copied object.

Returns:

(Types::CopyObjectOutput) —
Returns a response object which responds to the following methods:
- #copy_object_result => Types::CopyObjectResult
- #expiration => String
- #copy_source_version_id => String
- #version_id => String
- #server_side_encryption => String
- #sse_customer_algorithm => String
- #sse_customer_key_md5 => String
- #ssekms_key_id => String
- #ssekms_encryption_context => String
- #request_charged => String