upload_part_copy¶
Operation¶
upload_part_copy
async
¶
upload_part_copy(request: UploadPartCopyInput | UploadPartCopyInputDict, /, *, plugins: list[Plugin] | None = None) -> UploadPartCopyOutput
upload_part_copy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UploadPartCopyInputDict]) -> UploadPartCopyOutput
Uploads a part by copying data from an existing object as data source.
To specify the data source, you add the request header
x-amz-copy-source in your request. To specify a byte range, you add
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 copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload 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.
Note
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.
- Authentication and authorization
-
All
UploadPartCopyrequests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with thex-amz-prefix, includingx-amz-copy-source, must be signed. For more information, see REST Authentication.Directory buckets - You must use IAM credentials to authenticate and authorize your access to the
UploadPartCopyAPI operation, instead of using the temporary security credentials through theCreateSessionAPI operation.Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
- Permissions
-
You must have
READaccess to the source object andWRITEaccess to the destination bucket.-
General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an
UploadPartCopyoperation. -
If the source object is in a general purpose bucket, you must have the
s3:GetObjectpermission to read the source object that is being copied. -
If the destination bucket is a general purpose bucket, you must have the
s3:PutObjectpermission to write the object copy to the destination bucket. -
To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the
kms:Decryptandkms:GenerateDataKeyactions on the key. The requester must also have permissions for thekms:GenerateDataKeyaction for theCreateMultipartUploadAPI. Then, the requester needs permissions for thekms:Decryptaction on theUploadPartandUploadPartCopyAPIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide. -
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 an
UploadPartCopyoperation. -
If the source object that you want to copy is in a directory bucket, you must have the
s3express:CreateSessionpermission in theActionelement of a policy to read the object. If no session mode is specified, the session will be created with the maximum allowable privilege, attemptingReadWritefirst, thenReadOnlyifReadWriteis not permitted. If you want to explicitly restrict the access to be read-only, you can set thes3express:SessionModecondition key toReadOnlyon the copy source bucket. -
If the copy destination is a directory bucket, you must have the
s3express:CreateSessionpermission in theActionelement of a policy to write the object to the destination. Thes3express:SessionModecondition key cannot be set toReadOnlyon the copy destination.
If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKeyandkms:Decryptpermissions 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.
-
- Encryption
-
- General purpose buckets - For information about using
server-side encryption with customer-provided encryption keys with
the
UploadPartCopyoperation, see CopyObject and UploadPart.
Note: If you have server-side encryption with customer-provided keys (SSE-C) blocked for your general purpose bucket, you will get an HTTP 403 Access Denied error when you specify the SSE-C request headers while writing new data to your bucket. For more information, see Blocking or unblocking SSE-C for a general purpose bucket.
- Directory buckets - For directory buckets, there are only two
supported options for server-side encryption: server-side
encryption with Amazon S3 managed keys (SSE-S3) (
AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
Note: For directory buckets, when you perform a
CreateMultipartUploadoperation and anUploadPartCopyoperation, the request headers you provide in theCreateMultipartUploadrequest must match the default encryption configuration of the destination bucket.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 UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
- General purpose buckets - For information about using
server-side encryption with customer-provided encryption keys with
the
- Special errors
-
-
Error Code:
NoSuchUpload -
Description: 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
-
Error Code:
InvalidRequest -
Description: The specified copy source is not supported as a byte-range copy source.
-
HTTP Status Code: 400 Bad Request
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to UploadPartCopy:
Warning
You must URL encode any signed header values that contain spaces. For
example, if your header value is my file.txt, containing two spaces
after my, you must URL encode this value to my%20%20file.txt.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UploadPartCopyOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
UploadPartCopyInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UploadPartCopyInput structure.
Attributes¶
bucket
class-attribute
instance-attribute
¶
bucket: str | None = ...
The bucket name.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com.
Path-style requests are not supported. Directory bucket names must be
unique in the chosen Zone (Availability Zone or Local Zone). Bucket
names must follow the format
bucket-base-name--zone-id--x-s3 (for example,
amzn-s3-demo-bucket--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide.
Note
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
400 Bad Request error with the error code InvalidRequest.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.
Note
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket
must be the Outposts access point ARN or the access point alias. For
more information about S3 on Outposts, see What is S3 on
Outposts?
in the Amazon S3 User Guide.
copy_source
class-attribute
instance-attribute
¶
copy_source: str | None = ...
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.pdffrom 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.pdfthrough access pointmy-access-pointowned by account123456789012in 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 Amazon Web Services Region.
- Access points are not supported by directory buckets.
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 object reports/january.pdf through outpost
my-outpost owned by account 123456789012 in Region us-west-2,
use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
The value must be URL-encoded.
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 source object to copy. To copy a specific version
of the source object to copy, append ?versionId=``<version-id>
to the x-amz-copy-source request header (for example,
x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).
If the current version is a delete marker and you don't specify a
versionId in the x-amz-copy-source request header, Amazon S3 returns a
404 Not Found 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 Bad Request error, because you
are not allowed to specify a delete marker as a version for the
x-amz-copy-source.
Note
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
copy_source_if_match
class-attribute
instance-attribute
¶
copy_source_if_match: str | None = ...
Copies the object if its entity tag (ETag) matches the specified tag.
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.
copy_source_if_modified_since
class-attribute
instance-attribute
¶
copy_source_if_modified_since: datetime | None = ...
Copies the object if it has been modified since the specified time.
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.
copy_source_if_none_match
class-attribute
instance-attribute
¶
copy_source_if_none_match: str | None = ...
Copies the object if its entity tag (ETag) is different than the specified ETag.
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.
copy_source_if_unmodified_since
class-attribute
instance-attribute
¶
copy_source_if_unmodified_since: datetime | None = ...
Copies the object if it hasn't been modified since the specified time.
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.
copy_source_range
class-attribute
instance-attribute
¶
copy_source_range: str | None = ...
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.
copy_source_sse_customer_algorithm
class-attribute
instance-attribute
¶
copy_source_sse_customer_algorithm: str | None = ...
Specifies the algorithm to use when decrypting the source object (for
example, AES256).
Note
This functionality is not supported when the source object is in a directory bucket.
copy_source_sse_customer_key
class-attribute
instance-attribute
¶
copy_source_sse_customer_key: str | None = ...
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.
Note
This functionality is not supported when the source object is in a directory bucket.
copy_source_sse_customer_key_md5
class-attribute
instance-attribute
¶
copy_source_sse_customer_key_md5: str | None = ...
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.
Note
This functionality is not supported when the source object is in a directory bucket.
expected_bucket_owner
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
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 403 Forbidden
(access denied).
expected_source_bucket_owner
class-attribute
instance-attribute
¶
expected_source_bucket_owner: str | None = ...
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 403 Forbidden (access
denied).
key
class-attribute
instance-attribute
¶
key: str | None = ...
Object key for which the multipart upload was initiated.
part_number
class-attribute
instance-attribute
¶
part_number: int | None = ...
Part number of part being copied. This is a positive integer between 1 and 10,000.
request_payer
class-attribute
instance-attribute
¶
request_payer: str | None = ...
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
sse_customer_algorithm
class-attribute
instance-attribute
¶
sse_customer_algorithm: str | None = ...
Specifies the algorithm to use when encrypting the object (for example, AES256).
Note
This functionality is not supported when the destination bucket is a directory bucket.
sse_customer_key
class-attribute
instance-attribute
¶
sse_customer_key: str | None = ...
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.
Note
This functionality is not supported when the destination bucket is a directory bucket.
sse_customer_key_md5
class-attribute
instance-attribute
¶
sse_customer_key_md5: str | None = ...
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.
Note
This functionality is not supported when the destination bucket is a directory bucket.
Dictionaries¶
UploadPartCopyInputDict
¶
Bases: TypedDict
Dictionary form of UploadPartCopyInput.
Attributes¶
bucket
instance-attribute
¶
The bucket name.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com.
Path-style requests are not supported. Directory bucket names must be
unique in the chosen Zone (Availability Zone or Local Zone). Bucket
names must follow the format
bucket-base-name--zone-id--x-s3 (for example,
amzn-s3-demo-bucket--usw2-az1--x-s3). For information
about bucket naming restrictions, see Directory bucket naming
rules
in the Amazon S3 User Guide.
Note
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
400 Bad Request error with the error code InvalidRequest.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.
Note
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket
must be the Outposts access point ARN or the access point alias. For
more information about S3 on Outposts, see What is S3 on
Outposts?
in the Amazon S3 User Guide.
copy_source
instance-attribute
¶
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.pdffrom 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.pdfthrough access pointmy-access-pointowned by account123456789012in 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 Amazon Web Services Region.
- Access points are not supported by directory buckets.
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 object reports/january.pdf through outpost
my-outpost owned by account 123456789012 in Region us-west-2,
use the URL encoding of
arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
The value must be URL-encoded.
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 source object to copy. To copy a specific version
of the source object to copy, append ?versionId=``<version-id>
to the x-amz-copy-source request header (for example,
x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).
If the current version is a delete marker and you don't specify a
versionId in the x-amz-copy-source request header, Amazon S3 returns a
404 Not Found 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 Bad Request error, because you
are not allowed to specify a delete marker as a version for the
x-amz-copy-source.
Note
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
copy_source_if_match
instance-attribute
¶
copy_source_if_match: str | None
Copies the object if its entity tag (ETag) matches the specified tag.
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.
copy_source_if_modified_since
instance-attribute
¶
copy_source_if_modified_since: datetime | None
Copies the object if it has been modified since the specified time.
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.
copy_source_if_none_match
instance-attribute
¶
copy_source_if_none_match: str | None
Copies the object if its entity tag (ETag) is different than the specified ETag.
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.
copy_source_if_unmodified_since
instance-attribute
¶
copy_source_if_unmodified_since: datetime | None
Copies the object if it hasn't been modified since the specified time.
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.
copy_source_range
instance-attribute
¶
copy_source_range: str | None
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.
copy_source_sse_customer_algorithm
instance-attribute
¶
copy_source_sse_customer_algorithm: str | None
Specifies the algorithm to use when decrypting the source object (for
example, AES256).
Note
This functionality is not supported when the source object is in a directory bucket.
copy_source_sse_customer_key
instance-attribute
¶
copy_source_sse_customer_key: str | None
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.
Note
This functionality is not supported when the source object is in a directory bucket.
copy_source_sse_customer_key_md5
instance-attribute
¶
copy_source_sse_customer_key_md5: str | None
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.
Note
This functionality is not supported when the source object is in a directory bucket.
expected_bucket_owner
instance-attribute
¶
expected_bucket_owner: str | None
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 403 Forbidden
(access denied).
expected_source_bucket_owner
instance-attribute
¶
expected_source_bucket_owner: str | None
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 403 Forbidden (access
denied).
key
instance-attribute
¶
Object key for which the multipart upload was initiated.
part_number
instance-attribute
¶
Part number of part being copied. This is a positive integer between 1 and 10,000.
request_payer
instance-attribute
¶
request_payer: str | None
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for the corresponding charges. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
sse_customer_algorithm
instance-attribute
¶
sse_customer_algorithm: str | None
Specifies the algorithm to use when encrypting the object (for example, AES256).
Note
This functionality is not supported when the destination bucket is a directory bucket.
sse_customer_key
instance-attribute
¶
sse_customer_key: str | None
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.
Note
This functionality is not supported when the destination bucket is a directory bucket.
sse_customer_key_md5
instance-attribute
¶
sse_customer_key_md5: str | None
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.
Note
This functionality is not supported when the destination bucket is a directory bucket.
Output¶
UploadPartCopyOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UploadPartCopyOutput structure.
Attributes¶
bucket_key_enabled
class-attribute
instance-attribute
¶
bucket_key_enabled: bool | None = ...
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
copy_part_result
class-attribute
instance-attribute
¶
copy_part_result: CopyPartResult | None = ...
Container for all response elements.
copy_source_version_id
class-attribute
instance-attribute
¶
copy_source_version_id: str | None = ...
The version of the source object that was copied, if you have enabled versioning on the source bucket.
Note
This functionality is not supported when the source object is in a directory bucket.
request_charged
class-attribute
instance-attribute
¶
request_charged: str | None = ...
If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.
Note
This functionality is not supported for directory buckets.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
server_side_encryption
class-attribute
instance-attribute
¶
server_side_encryption: str | None = ...
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
Note
When accessing data stored in Amazon FSx file systems using S3 access
points, the only valid server side encryption option is aws:fsx.
sse_customer_algorithm
class-attribute
instance-attribute
¶
sse_customer_algorithm: str | None = ...
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
Note
This functionality is not supported for directory buckets.
sse_customer_key_md5
class-attribute
instance-attribute
¶
sse_customer_key_md5: str | None = ...
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
Note
This functionality is not supported for directory buckets.