S3 / Client / copy_object
copy_object#
- S3.Client.copy_object(**kwargs)#
Creates a copy of an object that is already stored in Amazon S3.
Note
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 action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.
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.
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 action 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 a200 OK
response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an exception (or, for the SDKs that don’t use exceptions, they return the error).If the copy is successful, you receive a response with information about the copied object.
Note
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.
The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. For pricing information, see Amazon S3 pricing.
Warning
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, see Transfer Acceleration.Metadata
When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access control list (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.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the
x-amz-metadata-directive
header. When you grant permissions, you can use thes3:x-amz-metadata-directive
condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.Note
x-amz-website-redirect-location
is unique to each object and must be specified in the request headers to copy the value.x-amz-copy-source-if Headers
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 following request parameters:x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns200 OK
and copies the data:x-amz-copy-source-if-match
condition evaluates to truex-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the412 Precondition Failed
response code:x-amz-copy-source-if-none-match
condition evaluates to falsex-amz-copy-source-if-modified-since
condition evaluates to true
Note
All headers with the
x-amz-
prefix, includingx-amz-copy-source
, must be signed.Server-side encryption
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don’t specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.
When you perform a
CopyObject
operation, if you want to use a different type of encryption setting for the target object, you can use other appropriate encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side Encryption.If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
If the bucket that you’re copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
PUT
requests that don’t specify an ACL orPUT
requests that specify bucket owner full control ACLs, such as thebucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format.For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
Note
If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
Checksums
When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you can optionally specify a different checksum algorithm to use with the
x-amz-checksum-algorithm
header.Storage Class Options
You can use the
CopyObject
action to change the storage class of an object that is already stored in Amazon S3 by using theStorageClass
parameter. For more information, see Storage Classes in the Amazon S3 User Guide.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 RestoreObject. For more information, see Copying Objects.
Versioning
By default,
x-amz-copy-source
header 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 theversionId
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.
The following operations are related to
CopyObject
:See also: AWS API Documentation
Request Syntax
response = client.copy_object( ACL='private'|'public-read'|'public-read-write'|'authenticated-read'|'aws-exec-read'|'bucket-owner-read'|'bucket-owner-full-control', Bucket='string', CacheControl='string', ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256', ContentDisposition='string', ContentEncoding='string', ContentLanguage='string', ContentType='string', CopySource='string' or {'Bucket': 'string', 'Key': 'string', 'VersionId': 'string'}, CopySourceIfMatch='string', CopySourceIfModifiedSince=datetime(2015, 1, 1), CopySourceIfNoneMatch='string', CopySourceIfUnmodifiedSince=datetime(2015, 1, 1), Expires=datetime(2015, 1, 1), GrantFullControl='string', GrantRead='string', GrantReadACP='string', GrantWriteACP='string', Key='string', Metadata={ 'string': 'string' }, MetadataDirective='COPY'|'REPLACE', TaggingDirective='COPY'|'REPLACE', ServerSideEncryption='AES256'|'aws:kms'|'aws:kms:dsse', StorageClass='STANDARD'|'REDUCED_REDUNDANCY'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_IR'|'SNOW', WebsiteRedirectLocation='string', SSECustomerAlgorithm='string', SSECustomerKey='string', SSEKMSKeyId='string', SSEKMSEncryptionContext='string', BucketKeyEnabled=True|False, CopySourceSSECustomerAlgorithm='string', CopySourceSSECustomerKey='string', RequestPayer='requester', Tagging='string', ObjectLockMode='GOVERNANCE'|'COMPLIANCE', ObjectLockRetainUntilDate=datetime(2015, 1, 1), ObjectLockLegalHoldStatus='ON'|'OFF', ExpectedBucketOwner='string', ExpectedSourceBucketOwner='string' )
- Parameters:
ACL (string) –
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
Bucket (string) –
[REQUIRED]
The name of the destination bucket.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.*Region*.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.CacheControl (string) – Specifies caching behavior along the request/reply chain.
ChecksumAlgorithm (string) – Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
ContentDisposition (string) – Specifies presentational information for the object.
ContentEncoding (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.
ContentLanguage (string) – The language the content is in.
ContentType (string) – A standard MIME type describing the format of the object data.
CopySource (str or dict) – [REQUIRED] The name of the source bucket, key name of the source object, and optional version ID of the source object. You can either provide this value as a string or a dictionary. The string form is {bucket}/{key} or {bucket}/{key}?versionId={versionId} if you want to copy a specific version. You can also provide this value as a dictionary. The dictionary format is recommended over the string format because it is more explicit. The dictionary format is: {‘Bucket’: ‘bucket’, ‘Key’: ‘key’, ‘VersionId’: ‘id’}. Note that the VersionId key is optional and may be omitted. To specify an S3 access point, provide the access point ARN for the
Bucket
key in the copy source dictionary. If you want to provide the copy source for an S3 access point as a string instead of a dictionary, the ARN provided must be the full S3 access point object ARN (i.e. {accesspoint_arn}/object/{key})CopySourceIfMatch (string) – Copies the object if its entity tag (ETag) matches the specified tag.
CopySourceIfModifiedSince (datetime) – Copies the object if it has been modified since the specified time.
CopySourceIfNoneMatch (string) – Copies the object if its entity tag (ETag) is different than the specified ETag.
CopySourceIfUnmodifiedSince (datetime) – Copies the object if it hasn’t been modified since the specified time.
Expires (datetime) – The date and time at which the object is no longer cacheable.
GrantFullControl (string) –
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
GrantRead (string) –
Allows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
GrantReadACP (string) –
Allows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
GrantWriteACP (string) –
Allows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
Key (string) –
[REQUIRED]
The key of the destination object.
Metadata (dict) –
A map of metadata to store with the object in S3.
(string) –
(string) –
MetadataDirective (string) – Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
TaggingDirective (string) – Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
ServerSideEncryption (string) – The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).StorageClass (string) – By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
WebsiteRedirectLocation (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. This value is unique to each object and is not copied when using the
x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the directive.SSECustomerAlgorithm (string) – Specifies the algorithm to use to when encrypting the object (for example, AES256).
SSECustomerKey (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.SSECustomerKeyMD5 (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.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
SSEKMSKeyId (string) – Specifies the KMS key ID to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they’re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
SSEKMSEncryptionContext (string) – Specifies the Amazon Web Services 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.
BucketKeyEnabled (boolean) –
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to
true
causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
CopySourceSSECustomerAlgorithm (string) – Specifies the algorithm to use when decrypting the source object (for example, AES256).
CopySourceSSECustomerKey (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.
CopySourceSSECustomerKeyMD5 (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.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
RequestPayer (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 Requester Pays Buckets in the Amazon S3 User Guide.
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.ObjectLockMode (string) – The Object Lock mode that you want to apply to the copied object.
ObjectLockRetainUntilDate (datetime) – The date and time when you want the copied object’s Object Lock to expire.
ObjectLockLegalHoldStatus (string) – Specifies whether you want to apply a legal hold to the copied object.
ExpectedBucketOwner (string) – The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code
403 Forbidden
(access denied).ExpectedSourceBucketOwner (string) – The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code
403 Forbidden
(access denied).
- Return type:
dict
- Returns:
Response Syntax
{ 'CopyObjectResult': { 'ETag': 'string', 'LastModified': datetime(2015, 1, 1), 'ChecksumCRC32': 'string', 'ChecksumCRC32C': 'string', 'ChecksumSHA1': 'string', 'ChecksumSHA256': 'string' }, 'Expiration': 'string', 'CopySourceVersionId': 'string', 'VersionId': 'string', 'ServerSideEncryption': 'AES256'|'aws:kms'|'aws:kms:dsse', 'SSECustomerAlgorithm': 'string', 'SSECustomerKeyMD5': 'string', 'SSEKMSKeyId': 'string', 'SSEKMSEncryptionContext': 'string', 'BucketKeyEnabled': True|False, 'RequestCharged': 'requester' }
Response Structure
(dict) –
CopyObjectResult (dict) –
Container for all response elements.
ETag (string) –
Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.
LastModified (datetime) –
Creation date of the object.
ChecksumCRC32 (string) –
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
ChecksumCRC32C (string) –
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
ChecksumSHA1 (string) –
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
ChecksumSHA256 (string) –
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
Expiration (string) –
If the object expiration is configured, the response includes this header.
CopySourceVersionId (string) –
Version of the copied object in the destination bucket.
VersionId (string) –
Version ID of the newly created copy.
ServerSideEncryption (string) –
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).SSECustomerAlgorithm (string) –
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
SSECustomerKeyMD5 (string) –
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
SSEKMSKeyId (string) –
If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
SSEKMSEncryptionContext (string) –
If present, specifies the Amazon Web Services 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.
BucketKeyEnabled (boolean) –
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
RequestCharged (string) –
If present, indicates that the requester was successfully charged for the request.
Exceptions
S3.Client.exceptions.ObjectNotInActiveTierError
Examples
The following example copies an object from one bucket to another.
response = client.copy_object( Bucket='destinationbucket', CopySource='/sourcebucket/HappyFacejpg', Key='HappyFaceCopyjpg', ) print(response)
Expected Output:
{ 'CopyObjectResult': { 'ETag': '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified': datetime(2016, 12, 15, 17, 38, 53, 3, 350, 0), }, 'ResponseMetadata': { '...': '...', }, }