Copy Object
s3_copy_object | R Documentation |
Creates a copy of an object that is already stored in Amazon S3¶
Description¶
Creates a copy of an object that is already stored in Amazon S3.
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.
You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.
-
Amazon S3 supports copy operations using Multi-Region Access Points only as a destination when using the Multi-Region Access Point ARN.
-
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format
https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name
. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide. -
VPC endpoints don't support cross-Region requests (including copies). If you're using VPC endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC endpoint.
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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.
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.
Authentication and authorization¶
All copy_object
requests must be authenticated and signed by using IAM
credentials (access key ID and secret access key for the IAM
identities). All headers with the x-amz-
prefix, including
x-amz-copy-source
, must be signed. For more information, see REST
Authentication.
Directory buckets - You must use the IAM credentials to authenticate
and authorize your access to the copy_object
API operation, instead of
using the temporary security credentials through the create_session
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
Permissions¶
You must have read access to the source object and write access to the destination bucket.
-
General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a
copy_object
operation.-
If the source object is in a general purpose bucket, you must have
s3:GetObject
permission to read the source object that is being copied. -
If the destination bucket is a general purpose bucket, you must have
s3:PutObject
permission to write the object copy to the destination bucket.
-
-
Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a
copy_object
operation.-
If the source object that you want to copy is in a directory bucket, you must have the
s3express:CreateSession
permission in theAction
element of a policy to read the object. By default, the session is in theReadWrite
mode. If you want to restrict the access, you can explicitly set thes3express:SessionMode
condition key toReadOnly
on the copy source bucket. -
If the copy destination is a directory bucket, you must have the
s3express:CreateSession
permission in theAction
element of a policy to write the object to the destination. Thes3express:SessionMode
condition key can't be set toReadOnly
on the copy destination bucket.
If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
-
Response and special errors¶
When the request is an HTTP 1.1 request, the response is chunk encoded.
When the request is not an HTTP 1.1 request, the response would not
contain the Content-Length
. You always need to read the entire
response body to check if the copy succeeds.
-
If the copy is successful, you receive a response with information about the copied object.
-
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A
200 OK
response can contain either a success or an error.-
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. For example, in a cross-region copy, you may encounter throttling and receive a200 OK
response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The200 OK
status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a200 OK
response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.If you call this API operation directly, make sure to design your application to parse the content 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 throw an exception (or, for the SDKs that don't use exceptions, they return an error).
-
Charge¶
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. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.
HTTP Host header syntax¶
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
. -
Amazon S3 on Outposts - When you use this action with S3 on Outposts through the REST API, 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
. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.
The following operations are related to copy_object
:
-
put_object
-
get_object
Usage¶
s3_copy_object(ACL, Bucket, CacheControl, ChecksumAlgorithm,
ContentDisposition, ContentEncoding, ContentLanguage, ContentType,
CopySource, CopySourceIfMatch, CopySourceIfModifiedSince,
CopySourceIfNoneMatch, CopySourceIfUnmodifiedSince, Expires,
GrantFullControl, GrantRead, GrantReadACP, GrantWriteACP, Key, Metadata,
MetadataDirective, TaggingDirective, ServerSideEncryption, StorageClass,
WebsiteRedirectLocation, SSECustomerAlgorithm, SSECustomerKey,
SSECustomerKeyMD5, SSEKMSKeyId, SSEKMSEncryptionContext,
BucketKeyEnabled, CopySourceSSECustomerAlgorithm,
CopySourceSSECustomerKey, CopySourceSSECustomerKeyMD5, RequestPayer,
Tagging, ObjectLockMode, ObjectLockRetainUntilDate,
ObjectLockLegalHoldStatus, ExpectedBucketOwner,
ExpectedSourceBucketOwner)
Arguments¶
ACL |
The canned access control list (ACL) to apply to the object. When you copy an object, the ACL metadata is not preserved and is set
to If the destination 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
|
Bucket |
[required] The name of the destination bucket. Directory buckets - When you use this operation with
a directory bucket, you must use virtual-hosted-style requests in the
format
Copying objects across different Amazon Web Services Regions isn't
supported when the source or destination bucket is in Amazon Web
Services Local Zones. The source and destination buckets must have the
same parent Amazon Web Services Region. Otherwise, you get an HTTP Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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. Access points and Object Lambda access points are not supported by directory buckets. S3 on Outposts - When you use this action with S3 on
Outposts, you must use the Outpost bucket access point ARN or the access
point alias for the destination bucket. You can only copy objects within
the same Outpost bucket. It's not supported to copy objects across
different Amazon Web Services Outposts, between buckets on the same
Outposts, or between Outposts buckets and any other bucket types. For
more information about S3 on Outposts, see What
is S3 on Outposts? in the S3 on Outposts guide. When you
use this action with S3 on Outposts through the REST API, you must
direct requests to the S3 on Outposts hostname, in the format
|
CacheControl |
Specifies the caching behavior along the request/reply chain. |
ChecksumAlgorithm |
Indicates the algorithm that 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. When you copy an object, if the source object has a checksum, that
checksum value will be copied to the new object by default. If the
For directory buckets, when you use Amazon Web Services SDKs,
|
ContentDisposition |
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file. |
ContentEncoding |
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. For directory buckets, only the |
ContentLanguage |
The language the content is in. |
ContentType |
A standard MIME type that describes the format of the object data. |
CopySource |
[required] Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket. You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an access point:
If your source bucket versioning is enabled, the
If you enable versioning on the destination bucket, Amazon S3
generates a unique version ID for the copied object. 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 If you do not enable versioning or suspend it on the destination
bucket, the version ID that Amazon S3 generates in the
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. |
CopySourceIfMatch |
Copies the object if its entity tag (ETag) matches the specified tag. If both the
|
CopySourceIfModifiedSince |
Copies the object if it has been modified since the specified time. If both the
|
CopySourceIfNoneMatch |
Copies the object if its entity tag (ETag) is different than the specified ETag. If both the
|
CopySourceIfUnmodifiedSince |
Copies the object if it hasn't been modified since the specified time. If both the
|
Expires |
The date and time at which the object is no longer cacheable. |
GrantFullControl |
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
GrantRead |
Allows grantee to read the object data and its metadata.
|
GrantReadACP |
Allows grantee to read the object ACL.
|
GrantWriteACP |
Allows grantee to write the ACL for the applicable object.
|
Key |
[required] The key of the destination object. |
Metadata |
A map of metadata to store with the object in S3. |
MetadataDirective |
Specifies whether the metadata is copied from the source object
or replaced with metadata that's provided in the request. When copying
an object, you can preserve all metadata (the default) or specify new
metadata. If this header isn’t specified, General purpose bucket - For general purpose
buckets, when you grant permissions, you can use the
|
TaggingDirective |
Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request. The default value is Directory buckets - For directory buckets in a
Because only the empty tag-set is supported for directory buckets in
a
|
ServerSideEncryption |
The server-side encryption algorithm used when storing this
object in Amazon S3. Unrecognized or unsupported values won’t write a
destination object and will receive a 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 different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy. 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. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide. General purpose buckets
Directory buckets
|
StorageClass |
If the
You can use the Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
For more information, see |
WebsiteRedirectLocation |
If the destination bucket is configured as a website, redirects
requests for this object copy 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 This functionality is not supported for directory buckets. |
SSECustomerAlgorithm |
Specifies the algorithm to use when encrypting the object (for
example, When you perform a This functionality is not supported when the destination bucket is a directory bucket. |
SSECustomerKey |
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
This functionality is not supported when the destination bucket is a directory bucket. |
SSECustomerKeyMD5 |
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. This functionality is not supported when the destination bucket is a directory bucket. |
SSEKMSKeyId |
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) 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. Directory buckets - To encrypt data using SSE-KMS,
it's recommended to specify the
|
SSEKMSEncryptionContext |
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. General purpose buckets - This value must be
explicitly added to specify encryption context for
Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. |
BucketKeyEnabled |
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). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. Setting this header to For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide. Directory buckets - S3 Bucket Keys aren't supported,
when you copy SSE-KMS encrypted objects from general purpose buckets to
directory buckets, from directory buckets to general purpose buckets, or
between directory buckets, through |
CopySourceSSECustomerAlgorithm |
Specifies the algorithm to use when decrypting the source object
(for example, 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. This functionality is not supported when the source object is in a directory bucket. |
CopySourceSSECustomerKey |
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 the same one that was used when the source object was created. 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. This functionality is not supported when the source object is in a directory bucket. |
CopySourceSSECustomerKeyMD5 |
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. 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. This functionality is not supported when the source object is in a directory bucket. |
RequestPayer |
|
Tagging |
The tag-set for the object copy in the destination bucket. This
value must be used in conjunction with the
The default value is the empty value. Directory buckets - For directory buckets in a
Because only the empty tag-set is supported for directory buckets in
a
|
ObjectLockMode |
The Object Lock mode that you want to apply to the object copy. This functionality is not supported for directory buckets. |
ObjectLockRetainUntilDate |
The date and time when you want the Object Lock of the object copy to expire. This functionality is not supported for directory buckets. |
ObjectLockLegalHoldStatus |
Specifies whether you want to apply a legal hold to the object copy. This functionality is not supported for directory buckets. |
ExpectedBucketOwner |
The account ID of the expected destination bucket owner. If the
account ID that you provide does not match the actual owner of the
destination bucket, the request fails with the HTTP status code |
ExpectedSourceBucketOwner |
The account ID of the expected source bucket owner. If the
account ID that you provide does not match the actual owner of the
source bucket, the request fails with the HTTP status code |
Value¶
A list with the following syntax:
list(
CopyObjectResult = list(
ETag = "string",
LastModified = as.POSIXct(
"2015-01-01"
),
ChecksumType = "COMPOSITE"|"FULL_OBJECT",
ChecksumCRC32 = "string",
ChecksumCRC32C = "string",
ChecksumCRC64NVME = "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"
)
Request syntax¶
svc$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"|"CRC64NVME",
ContentDisposition = "string",
ContentEncoding = "string",
ContentLanguage = "string",
ContentType = "string",
CopySource = "string",
CopySourceIfMatch = "string",
CopySourceIfModifiedSince = as.POSIXct(
"2015-01-01"
),
CopySourceIfNoneMatch = "string",
CopySourceIfUnmodifiedSince = as.POSIXct(
"2015-01-01"
),
Expires = as.POSIXct(
"2015-01-01"
),
GrantFullControl = "string",
GrantRead = "string",
GrantReadACP = "string",
GrantWriteACP = "string",
Key = "string",
Metadata = list(
"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"|"EXPRESS_ONEZONE",
WebsiteRedirectLocation = "string",
SSECustomerAlgorithm = "string",
SSECustomerKey = "string",
SSECustomerKeyMD5 = "string",
SSEKMSKeyId = "string",
SSEKMSEncryptionContext = "string",
BucketKeyEnabled = TRUE|FALSE,
CopySourceSSECustomerAlgorithm = "string",
CopySourceSSECustomerKey = "string",
CopySourceSSECustomerKeyMD5 = "string",
RequestPayer = "requester",
Tagging = "string",
ObjectLockMode = "GOVERNANCE"|"COMPLIANCE",
ObjectLockRetainUntilDate = as.POSIXct(
"2015-01-01"
),
ObjectLockLegalHoldStatus = "ON"|"OFF",
ExpectedBucketOwner = "string",
ExpectedSourceBucketOwner = "string"
)
Examples¶
## Not run:
# The following example copies an object from one bucket to another.
svc$copy_object(
Bucket = "destinationbucket",
CopySource = "/sourcebucket/HappyFacejpg",
Key = "HappyFaceCopyjpg"
)
## End(Not run)