upload_part¶
Operation¶
async
¶
upload_part(input: UploadPartInput, plugins: list[Plugin] | None = None) -> UploadPartOutput
Uploads a part in a multipart upload.
Note
In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
Note
After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview 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.
- Permissions
-
- General purpose bucket permissions - 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.
- General purpose bucket permissions - To perform a multipart
upload with encryption using an Key Management Service key, the
requester must have permission to the
-
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the
CreateSessionAPI operation for session-based authorization. Specifically, you grant thes3express:CreateSessionpermission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSessionAPI call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSessionAPI call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession.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.
- Data integrity
-
General purpose bucket - To ensure that data is not corrupted traversing the network, specify the
Content-MD5header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses thex-amz-content-sha256header as a checksum instead ofContent-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
Note: Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
- Encryption
-
- General purpose bucket - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).
Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.
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.
If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request headers.
-
x-amz-server-side-encryption-customer-algorithm
-
x-amz-server-side-encryption-customer-key
-
x-amz-server-side-encryption-customer-key-MD5
For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
- 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).
- 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
-
SOAP Fault Code Prefix: Client
-
- 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 UploadPart:
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 |
|---|---|---|---|
input
|
UploadPartInput
|
An instance of |
required |
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 |
|---|---|
UploadPartOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UploadPartInput structure.
Attributes¶
class-attribute
instance-attribute
¶
bucket: str | None = ...
The name of the bucket to which the multipart upload was initiated.
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.
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.
class-attribute
instance-attribute
¶
checksum_algorithm: str | None = ...
Indicates the algorithm used to create the checksum for the object when
you use the SDK. This header will not provide any additional
functionality if you don't use the SDK. When you send this header,
there must be a corresponding x-amz-checksum or x-amz-trailer header
sent. Otherwise, Amazon S3 fails the request with the HTTP status code
400 Bad Request. For more information, see Checking object
integrity
in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the
checksum value supplied in the CreateMultipartUpload request.
class-attribute
instance-attribute
¶
checksum_crc32: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 32-bit CRC32 checksum of the object. For
more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_crc32_c: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 32-bit CRC32C checksum of the object.
For more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_crc64_nvme: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part.
For more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_md5: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 128-bit MD5 digest of the part. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha1: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 160-bit SHA1 digest of the object. For
more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha256: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 256-bit SHA256 digest of the object. For
more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha512: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 512-bit SHA512 digest of the part. For
more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash128: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 128-bit XXHASH128 checksum of the part.
For more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash3: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 64-bit XXHASH3 checksum of the part. For
more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash64: str | None = ...
This header can be used as a data integrity check to verify that the
data received is the same data that was originally sent. This header
specifies the Base64 encoded, 64-bit XXHASH64 checksum of the part.
For more information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
content_length: int | None = ...
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
class-attribute
instance-attribute
¶
content_md5: str | None = ...
The Base64 encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
Note
This functionality is not supported for directory buckets.
class-attribute
instance-attribute
¶
expected_bucket_owner: str | None = ...
The account ID of the expected bucket owner. If the account ID that you
provide does not match the actual owner of the bucket, the request fails
with the HTTP status code 403 Forbidden (access denied).
class-attribute
instance-attribute
¶
key: str | None = ...
Object key for which the multipart upload was initiated.
class-attribute
instance-attribute
¶
part_number: int | None = ...
Part number of part being uploaded. This is a positive integer between 1 and 10,000.
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.
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 for directory buckets.
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 for directory buckets.
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 for directory buckets.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for UploadPartOutput structure.
Attributes¶
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).
class-attribute
instance-attribute
¶
checksum_crc32: str | None = ...
The Base64 encoded, 32-bit CRC32 checksum of the part. This will only
be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_crc32_c: str | None = ...
The Base64 encoded, 32-bit CRC32C checksum of the part. This will only
be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_crc64_nvme: str | None = ...
The Base64 encoded, 64-bit CRC64NVME checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_md5: str | None = ...
The Base64 encoded, 128-bit MD5 checksum of the part. This will only
be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha1: str | None = ...
The Base64 encoded, 160-bit SHA1 checksum of the part. This will only
be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha256: str | None = ...
The Base64 encoded, 256-bit SHA256 checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_sha512: str | None = ...
The Base64 encoded, 512-bit SHA512 checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash128: str | None = ...
The Base64 encoded, 128-bit XXHASH128 checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash3: str | None = ...
The Base64 encoded, 64-bit XXHASH3 checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
checksum_xxhash64: str | None = ...
The Base64 encoded, 64-bit XXHASH64 checksum of the part. This will
only be present if the checksum was provided in the request. For more
information, see Checking object
integrity
in the Amazon S3 User Guide.
class-attribute
instance-attribute
¶
e_tag: str | None = ...
Entity tag for the uploaded object.
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.
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.
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.
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.
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.