Struct bonsaidb::keystorage::s3::aws_sdk_s3::operation::complete_multipart_upload::builders::CompleteMultipartUploadFluentBuilder
pub struct CompleteMultipartUploadFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CompleteMultipartUpload
.
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag
value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK
response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents 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 throws an exception (or, for the SDKs that don't use exceptions, they return the error).
Note that if CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
You cannot use Content-Type: application/x-www-form-urlencoded
with Complete Multipart Upload requests. Also, if you do not provide a Content-Type
header, CompleteMultipartUpload
returns a 200 OK response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload.
For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions.
CompleteMultipartUpload
has the following special errors:
-
Error code:
EntityTooSmall
-
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
-
400 Bad Request
-
-
Error code:
InvalidPart
-
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
-
400 Bad Request
-
-
Error code:
InvalidPartOrder
-
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
-
400 Bad Request
-
-
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.
-
404 Not Found
-
The following operations are related to CompleteMultipartUpload
:
Implementations§
§impl CompleteMultipartUploadFluentBuilder
impl CompleteMultipartUploadFluentBuilder
pub fn as_input(&self) -> &CompleteMultipartUploadInputBuilder
pub fn as_input(&self) -> &CompleteMultipartUploadInputBuilder
Access the CompleteMultipartUpload as a reference.
pub async fn send(
self
) -> impl Future<Output = Result<CompleteMultipartUploadOutput, SdkError<CompleteMultipartUploadError, Response<SdkBody>>>>
pub async fn send( self ) -> impl Future<Output = Result<CompleteMultipartUploadOutput, SdkError<CompleteMultipartUploadError, Response<SdkBody>>>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
pub async fn customize(
self
) -> impl Future<Output = Result<CustomizableOperation<CompleteMultipartUploadOutput, CompleteMultipartUploadError, CompleteMultipartUploadFluentBuilder>, SdkError<CompleteMultipartUploadError, Response>>>
pub async fn customize( self ) -> impl Future<Output = Result<CustomizableOperation<CompleteMultipartUploadOutput, CompleteMultipartUploadError, CompleteMultipartUploadFluentBuilder>, SdkError<CompleteMultipartUploadError, Response>>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn bucket(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn bucket( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
Name of the bucket to which the multipart upload was initiated.
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 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.
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 Amazon Web Services 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.
pub fn set_bucket(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_bucket( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
Name of the bucket to which the multipart upload was initiated.
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 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.
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 Amazon Web Services 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.
pub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
Name of the bucket to which the multipart upload was initiated.
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 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.
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 Amazon Web Services 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.
pub fn key(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn key( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
Object key for which the multipart upload was initiated.
pub fn set_key(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_key( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
Object key for which the multipart upload was initiated.
pub fn multipart_upload(
self,
input: CompletedMultipartUpload
) -> CompleteMultipartUploadFluentBuilder
pub fn multipart_upload( self, input: CompletedMultipartUpload ) -> CompleteMultipartUploadFluentBuilder
The container for the multipart upload request information.
pub fn set_multipart_upload(
self,
input: Option<CompletedMultipartUpload>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_multipart_upload( self, input: Option<CompletedMultipartUpload> ) -> CompleteMultipartUploadFluentBuilder
The container for the multipart upload request information.
pub fn get_multipart_upload(&self) -> &Option<CompletedMultipartUpload>
pub fn get_multipart_upload(&self) -> &Option<CompletedMultipartUpload>
The container for the multipart upload request information.
pub fn upload_id(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn upload_id( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
ID for the initiated multipart upload.
pub fn set_upload_id(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_upload_id( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
ID for the initiated multipart upload.
pub fn get_upload_id(&self) -> &Option<String>
pub fn get_upload_id(&self) -> &Option<String>
ID for the initiated multipart upload.
pub fn checksum_crc32(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn checksum_crc32( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
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.
pub fn set_checksum_crc32(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_checksum_crc32( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
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.
pub fn get_checksum_crc32(&self) -> &Option<String>
pub fn get_checksum_crc32(&self) -> &Option<String>
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.
pub fn checksum_crc32_c(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn checksum_crc32_c( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
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.
pub fn set_checksum_crc32_c(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_checksum_crc32_c( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
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.
pub fn get_checksum_crc32_c(&self) -> &Option<String>
pub fn get_checksum_crc32_c(&self) -> &Option<String>
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.
pub fn checksum_sha1(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn checksum_sha1( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
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 SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn set_checksum_sha1(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_checksum_sha1( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
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 SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn get_checksum_sha1(&self) -> &Option<String>
pub fn get_checksum_sha1(&self) -> &Option<String>
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 SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn checksum_sha256(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn checksum_sha256( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
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 SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn set_checksum_sha256(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_checksum_sha256( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
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 SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn get_checksum_sha256(&self) -> &Option<String>
pub fn get_checksum_sha256(&self) -> &Option<String>
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 SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
pub fn request_payer(
self,
input: RequestPayer
) -> CompleteMultipartUploadFluentBuilder
pub fn request_payer( self, input: RequestPayer ) -> CompleteMultipartUploadFluentBuilder
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 Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn set_request_payer(
self,
input: Option<RequestPayer>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_request_payer( self, input: Option<RequestPayer> ) -> CompleteMultipartUploadFluentBuilder
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 Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
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 Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
pub fn expected_bucket_owner(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn expected_bucket_owner( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn set_expected_bucket_owner(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_expected_bucket_owner( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
pub fn sse_customer_algorithm(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn sse_customer_algorithm( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn set_sse_customer_algorithm(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_sse_customer_algorithm( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn sse_customer_key(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn sse_customer_key( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn set_sse_customer_key(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_sse_customer_key( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn get_sse_customer_key(&self) -> &Option<String>
pub fn get_sse_customer_key(&self) -> &Option<String>
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn sse_customer_key_md5(
self,
input: impl Into<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn sse_customer_key_md5( self, input: impl Into<String> ) -> CompleteMultipartUploadFluentBuilder
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn set_sse_customer_key_md5(
self,
input: Option<String>
) -> CompleteMultipartUploadFluentBuilder
pub fn set_sse_customer_key_md5( self, input: Option<String> ) -> CompleteMultipartUploadFluentBuilder
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
Trait Implementations§
§impl Clone for CompleteMultipartUploadFluentBuilder
impl Clone for CompleteMultipartUploadFluentBuilder
§fn clone(&self) -> CompleteMultipartUploadFluentBuilder
fn clone(&self) -> CompleteMultipartUploadFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more