import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { CompleteMultipartUploadOutput, CompleteMultipartUploadRequest } from "../models/models_0"; import { deserializeAws_restXmlCompleteMultipartUploadCommand, serializeAws_restXmlCompleteMultipartUploadCommand, } from "../protocols/Aws_restXml"; import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint"; import { getThrow200ExceptionsPlugin } from "@aws-sdk/middleware-sdk-s3"; import { getSerdePlugin } from "@aws-sdk/middleware-serde"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { FinalizeHandlerArguments, Handler, HandlerExecutionContext, MiddlewareStack, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, SerdeContext as __SerdeContext, } from "@aws-sdk/types"; export type CompleteMultipartUploadCommandInput = CompleteMultipartUploadRequest; export type CompleteMultipartUploadCommandOutput = CompleteMultipartUploadOutput & __MetadataBearer; /** *

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 * operation 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 operation 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. Because a request could fail after * the initial 200 OK response has been sent, it is important that you check the response body * to determine whether the request succeeded.

Note that if CompleteMultipartUpload fails, applications should be prepared * to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

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 API 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:

*
* CreateMultipartUpload *
*
*
* UploadPart *
*
*
* AbortMultipartUpload *
*
*
* ListParts *
*
*
* ListMultipartUploads *
*

*/ export class CompleteMultipartUploadCommand extends $Command< CompleteMultipartUploadCommandInput, CompleteMultipartUploadCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: CompleteMultipartUploadCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getThrow200ExceptionsPlugin(configuration)); this.middlewareStack.use(getBucketEndpointPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "CompleteMultipartUploadCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: CompleteMultipartUploadRequest.filterSensitiveLog, outputFilterSensitiveLog: CompleteMultipartUploadOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: CompleteMultipartUploadCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlCompleteMultipartUploadCommand(input, context); } private deserialize(output: __HttpResponse, context: __SerdeContext): Promise { return deserializeAws_restXmlCompleteMultipartUploadCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }