UploadPartCopy
Uploads a part by copying data from an existing object as data source. You specify the
data source by adding the request header x-amz-copy-source
in your request and
a byte range by adding the request header x-amz-copy-source-range
in your
request.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
Note
Instead of using an existing object as part data, you might use the UploadPart action and provide data in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.
For more information about using the UploadPartCopy
operation, see the
following:
-
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
-
For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
-
For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.
-
For information about using server-side encryption with customer-provided encryption keys with the
UploadPartCopy
operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers
x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
,
x-amz-copy-source-if-unmodified-since
, and
x-amz-copy-source-if-modified-since
:
-
Consideration 1 - If both of the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request as follows:x-amz-copy-source-if-match
condition evaluates totrue
, and;x-amz-copy-source-if-unmodified-since
condition evaluates tofalse
;Amazon S3 returns
200 OK
and copies the data. -
Consideration 2 - If both of the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request as follows:x-amz-copy-source-if-none-match
condition evaluates tofalse
, and;x-amz-copy-source-if-modified-since
condition evaluates totrue
;Amazon S3 returns
412 Precondition Failed
response code.
- Versioning
-
If your bucket has versioning enabled, you could have multiple versions of the same object. By default,
x-amz-copy-source
identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in thex-amz-copy-source
, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in thex-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for thex-amz-copy-source
.You can optionally specify a specific version of the source object to copy by adding the
versionId
subresource as shown in the following example:x-amz-copy-source: /bucket/object?versionId=version id
- Special errors
-
-
-
Code: NoSuchUpload
-
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
-
HTTP Status Code: 404 Not Found
-
-
-
Code: InvalidRequest
-
Cause: The specified copy source is not supported as a byte-range copy source.
-
HTTP Status Code: 400 Bad Request
-
-
The following operations are related to UploadPartCopy
:
Request Syntax
PUT /Key+
?partNumber=PartNumber
&uploadId=UploadId
HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-copy-source: CopySource
x-amz-copy-source-if-match: CopySourceIfMatch
x-amz-copy-source-if-modified-since: CopySourceIfModifiedSince
x-amz-copy-source-if-none-match: CopySourceIfNoneMatch
x-amz-copy-source-if-unmodified-since: CopySourceIfUnmodifiedSince
x-amz-copy-source-range: CopySourceRange
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key: SSECustomerKey
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-copy-source-server-side-encryption-customer-algorithm: CopySourceSSECustomerAlgorithm
x-amz-copy-source-server-side-encryption-customer-key: CopySourceSSECustomerKey
x-amz-copy-source-server-side-encryption-customer-key-MD5: CopySourceSSECustomerKeyMD5
x-amz-request-payer: RequestPayer
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-source-expected-bucket-owner: ExpectedSourceBucketOwner
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The bucket name.
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 AWS 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 AWS 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.Required: Yes
- Key
-
Object key for which the multipart upload was initiated.
Length Constraints: Minimum length of 1.
Required: Yes
- partNumber
-
Part number of part being copied. This is a positive integer between 1 and 10,000.
Required: Yes
- uploadId
-
Upload ID identifying the multipart upload whose part is being copied.
Required: Yes
- x-amz-copy-source
-
Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. -
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format
arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>
. For example, to copy the objectreports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.Note
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>
. For example, to copy the objectreports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
To copy a specific version of an object, append
?versionId=<version-id>
to the value (for example,awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.Pattern:
\/.+\/.+
Required: Yes
-
- x-amz-copy-source-if-match
-
Copies the object if its entity tag (ETag) matches the specified tag.
- x-amz-copy-source-if-modified-since
-
Copies the object if it has been modified since the specified time.
- x-amz-copy-source-if-none-match
-
Copies the object if its entity tag (ETag) is different than the specified ETag.
- x-amz-copy-source-if-unmodified-since
-
Copies the object if it hasn't been modified since the specified time.
- x-amz-copy-source-range
-
The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
- x-amz-copy-source-server-side-encryption-customer-algorithm
-
Specifies the algorithm to use when decrypting the source object (for example, AES256).
- x-amz-copy-source-server-side-encryption-customer-key
-
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.
- x-amz-copy-source-server-side-encryption-customer-key-MD5
-
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.
- x-amz-expected-bucket-owner
-
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). - x-amz-request-payer
-
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.
Valid Values:
requester
- x-amz-server-side-encryption-customer-algorithm
-
Specifies the algorithm to use to when encrypting the object (for example, AES256).
- x-amz-server-side-encryption-customer-key
-
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. This must be the same encryption key specified in the initiate multipart upload request. - x-amz-server-side-encryption-customer-key-MD5
-
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.
- x-amz-source-expected-bucket-owner
-
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).
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
x-amz-copy-source-version-id: CopySourceVersionId
x-amz-server-side-encryption: ServerSideEncryption
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-request-charged: RequestCharged
<?xml version="1.0" encoding="UTF-8"?>
<CopyPartResult>
<ETag>string</ETag>
<LastModified>timestamp</LastModified>
<ChecksumCRC32>string</ChecksumCRC32>
<ChecksumCRC32C>string</ChecksumCRC32C>
<ChecksumSHA1>string</ChecksumSHA1>
<ChecksumSHA256>string</ChecksumSHA256>
</CopyPartResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- x-amz-copy-source-version-id
-
The version of the source object that was copied, if you have enabled versioning on the source bucket.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Valid Values:
requester
- x-amz-server-side-encryption
-
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).Valid Values:
AES256 | aws:kms
- x-amz-server-side-encryption-aws-kms-key-id
-
If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object.
- x-amz-server-side-encryption-bucket-key-enabled
-
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
- x-amz-server-side-encryption-customer-algorithm
-
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
- x-amz-server-side-encryption-customer-key-MD5
-
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.
The following data is returned in XML format by the service.
- CopyPartResult
-
Root level tag for the CopyPartResult parameters.
Required: Yes
- ChecksumCRC32
-
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.
Type: String
- ChecksumCRC32C
-
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.
Type: String
- ChecksumSHA1
-
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.
Type: String
- ChecksumSHA256
-
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.
Type: String
- ETag
-
Entity tag of the object.
Type: String
- LastModified
-
Date and time at which the object was uploaded.
Type: Timestamp
Examples
Sample Request
The following PUT request uploads a part (part number 2) in a multipart upload. The request specifies a byte range from an existing object as the source of this upload. The request includes the upload ID that you get in response to your Initiate Multipart Upload request.
PUT /newobject?partNumber=2&uploadId=VCVsb2FkIElEIGZvciBlbZZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZR HTTP/1.1 Host: target-bucket.s3.<Region>.amazonaws.com Date: Mon, 11 Apr 2011 20:34:56 GMT x-amz-copy-source: /source-bucket/sourceobject x-amz-copy-source-range:bytes=500-6291456 Authorization: authorization string
Sample Response
The response includes the ETag value. You need to retain this value to use when you send the Complete Multipart Upload request.
HTTP/1.1 200 OK x-amz-id-2: Vvag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 Date: Mon, 11 Apr 2011 20:34:56 GMT Server: AmazonS3 <CopyPartResult> <LastModified>2011-04-11T20:34:56.000Z</LastModified> <ETag>"9b2cf535f27731c974343645a3985328"</ETag> </CopyPartResult>
Sample Request
The following PUT request uploads a part (part number 2) in a multipart upload. The request does not specify the optional byte range header, but requests the entire source object copy as part 2. The request includes the upload ID that you got in response to your Initiate Multipart Upload request.
PUT /newobject?partNumber=2&uploadId=VCVsb2FkIElEIGZvciBlbZZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZR HTTP/1.1 Host: target-bucket.s3.<Region>.amazonaws.com Date: Mon, 11 Apr 2011 20:34:56 GMT x-amz-copy-source: /source-bucket/sourceobject?versionId=3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo Authorization: authorization string
Sample Response
The response includes the ETag value. You need to retain this value to use when you send the Complete Multipart Upload request.
HTTP/1.1 200 OK x-amz-id-2: Vvag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 x-amz-copy-source-version-id: 3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo Date: Mon, 11 Apr 2011 20:34:56 GMT Server: AmazonS3 <CopyPartResult> <LastModified>2011-04-11T20:34:56.000Z</LastModified> <ETag>"9b2cf535f27731c974343645a3985328"</ETag> </CopyPartResult>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: