copy_from¶

S3.MultipartUploadPart.copy_from(**kwargs)¶

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 and x-amz-copy-source-if-unmodified-since headers are present in the request as follows: x-amz-copy-source-if-match condition evaluates to true , and; x-amz-copy-source-if-unmodified-since condition evaluates to false ; Amazon S3 returns 200 OK and copies the data.
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 as follows: x-amz-copy-source-if-none-match condition evaluates to false , and; x-amz-copy-source-if-modified-since condition evaluates to true ; 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 the x-amz-copy-source , Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-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 the x-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
Related Resources
CreateMultipartUpload
UploadPart
CompleteMultipartUpload
AbortMultipartUpload
ListParts
ListMultipartUploads

See also: AWS API Documentation

Request Syntax

response = multipart_upload_part.copy_from(
    CopySource='string' or {'Bucket': 'string', 'Key': 'string', 'VersionId': 'string'},
    CopySourceIfMatch='string',
    CopySourceIfModifiedSince=datetime(2015, 1, 1),
    CopySourceIfNoneMatch='string',
    CopySourceIfUnmodifiedSince=datetime(2015, 1, 1),
    CopySourceRange='string',
    SSECustomerAlgorithm='string',
    SSECustomerKey='string',
    CopySourceSSECustomerAlgorithm='string',
    CopySourceSSECustomerKey='string',
    RequestPayer='requester',
    ExpectedBucketOwner='string',
    ExpectedSourceBucketOwner='string'
)

Parameters

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.
CopySourceRange (string) -- 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.
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. This must be the same encryption key specified in the initiate multipart upload request.
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
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 .
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

{
    'CopySourceVersionId': 'string',
    'CopyPartResult': {
        'ETag': 'string',
        'LastModified': datetime(2015, 1, 1),
        'ChecksumCRC32': 'string',
        'ChecksumCRC32C': 'string',
        'ChecksumSHA1': 'string',
        'ChecksumSHA256': 'string'
    },
    'ServerSideEncryption': 'AES256'|'aws:kms',
    'SSECustomerAlgorithm': 'string',
    'SSECustomerKeyMD5': 'string',
    'SSEKMSKeyId': 'string',
    'BucketKeyEnabled': True|False,
    'RequestCharged': 'requester'
}

Response Structure

(dict) --
- CopySourceVersionId (string) --
  
  The version of the source object that was copied, if you have enabled versioning on the source bucket.
- CopyPartResult (dict) --
  
  Container for all response elements.
  - ETag (string) --
    
    Entity tag of the object.
  - LastModified (datetime) --
    
    Date and time at which the object was uploaded.
  - 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 .
- ServerSideEncryption (string) --
  
  The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
- 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 Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
- BucketKeyEnabled (boolean) --
  
  Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
- RequestCharged (string) --
  
  If present, indicates that the requester was successfully charged for the request.

Table Of Contents

copy_from¶