import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { CompleteMultipartUploadOutput, CompleteMultipartUploadRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public * * The input for {@link CompleteMultipartUploadCommand}. */ export interface CompleteMultipartUploadCommandInput extends CompleteMultipartUploadRequest { } /** * @public * * The output of {@link CompleteMultipartUploadCommand}. */ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartUploadOutput, __MetadataBearer { } /** * @public *

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. 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.

* *

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:

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, CompleteMultipartUploadCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, CompleteMultipartUploadCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // CompleteMultipartUploadRequest * Bucket: "STRING_VALUE", // required * Key: "STRING_VALUE", // required * MultipartUpload: { // CompletedMultipartUpload * Parts: [ // CompletedPartList * { // CompletedPart * ETag: "STRING_VALUE", * ChecksumCRC32: "STRING_VALUE", * ChecksumCRC32C: "STRING_VALUE", * ChecksumSHA1: "STRING_VALUE", * ChecksumSHA256: "STRING_VALUE", * PartNumber: Number("int"), * }, * ], * }, * UploadId: "STRING_VALUE", // required * ChecksumCRC32: "STRING_VALUE", * ChecksumCRC32C: "STRING_VALUE", * ChecksumSHA1: "STRING_VALUE", * ChecksumSHA256: "STRING_VALUE", * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", * SSECustomerAlgorithm: "STRING_VALUE", * SSECustomerKey: "STRING_VALUE", * SSECustomerKeyMD5: "STRING_VALUE", * }; * const command = new CompleteMultipartUploadCommand(input); * const response = await client.send(command); * ``` * * @param CompleteMultipartUploadCommandInput - {@link CompleteMultipartUploadCommandInput} * @returns {@link CompleteMultipartUploadCommandOutput} * @see {@link CompleteMultipartUploadCommandInput} for command's `input` shape. * @see {@link CompleteMultipartUploadCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * * @example To complete multipart upload * ```javascript * // The following example completes a multipart upload. * const input = { * "Bucket": "examplebucket", * "Key": "bigobject", * "MultipartUpload": { * "Parts": [ * { * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", * "PartNumber": "1" * }, * { * "ETag": "\"d8c2eafd90c266e19ab9dcacc479f8af\"", * "PartNumber": "2" * } * ] * }, * "UploadId": "7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--" * }; * const command = new CompleteMultipartUploadCommand(input); * const response = await client.send(command); * /* response == * { * "Bucket": "acexamplebucket", * "ETag": "\"4d9031c7644d8081c2829f4ea23c55f7-2\"", * "Key": "bigobject", * "Location": "https://examplebucket.s3..amazonaws.com/bigobject" * } * *\/ * // example id: to-complete-multipart-upload-1481851590483 * ``` * */ export declare class CompleteMultipartUploadCommand extends $Command { readonly input: CompleteMultipartUploadCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; /** * @public */ constructor(input: CompleteMultipartUploadCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler; /** * @internal */ private serialize; /** * @internal */ private deserialize; }