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:
Request Syntax
POST /Key+?uploadId=UploadId HTTP/1.1 Host: Bucket.s3.amazonaws.com x-amz-request-payer: RequestPayer <?xml version="1.0" encoding="UTF-8"?> <CompleteMultipartUpload xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Part> <ETag>string</ETag> <PartNumber>integer</PartNumber> </Part> ... </CompleteMultipartUpload>
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
Name of the bucket to which the multipart upload was initiated.
Required: Yes
- Key
-
Object key for which the multipart upload was initiated.
Length Constraints: Minimum length of 1.
Required: Yes
- uploadId
-
ID for the initiated multipart upload.
Required: Yes
- x-amz-request-payer
-
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
Valid Values: requester
Request Body
The request accepts the following data in XML format.
- CompleteMultipartUpload
-
Root level tag for the CompleteMultipartUpload parameters.
Required: Yes
- Part
-
Array of CompletedPart data types.
Type: Array of CompletedPart data types
Required: No
Response Syntax
HTTP/1.1 200 x-amz-expiration: Expiration x-amz-server-side-encryption: ServerSideEncryption x-amz-version-id: VersionId x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId x-amz-request-charged: RequestCharged <?xml version="1.0" encoding="UTF-8"?> <CompleteMultipartUploadResult> <Location>string</Location> <Bucket>string</Bucket> <Key>string</Key> <ETag>string</ETag> </CompleteMultipartUploadResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- x-amz-expiration
-
If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Valid Values: requester
- x-amz-server-side-encryption
-
If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
Valid Values: AES256 | aws:kms
- x-amz-server-side-encryption-aws-kms-key-id
-
If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
- x-amz-version-id
-
Version ID of the newly created object, in case the bucket has versioning turned on.
The following data is returned in XML format by the service.
- CompleteMultipartUploadResult
-
Root level tag for the CompleteMultipartUploadResult parameters.
Required: Yes
- Bucket
-
The name of the bucket that contains the newly created object.
Type: String
- ETag
-
Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.
Type: String
- Key
-
The object key of the newly created object.
Type: String
Length Constraints: Minimum length of 1.
- Location
-
The URI that identifies the newly created object.
Type: String
Examples
Sample Request
The following Complete Multipart Upload request specifies three parts in the CompleteMultipartUpload element.
POST /example-object?uploadId=AAAsb2FkIElEIGZvciBlbHZpbmcncyWeeS1tb3ZpZS5tMnRzIRRwbG9hZA HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Date: Mon, 1 Nov 2010 20:34:56 GMT Content-Length: 391 Authorization: authorization string <CompleteMultipartUpload> <Part> <PartNumber>1</PartNumber> <ETag>"a54357aff0632cce46d942af68356b38"</ETag> </Part> <Part> <PartNumber>2</PartNumber> <ETag>"0c78aef83f66abc1fa1e8477f296d394"</ETag> </Part> <Part> <PartNumber>3</PartNumber> <ETag>"acbd18db4cc2f85cedef654fccc4a4d8"</ETag> </Part> </CompleteMultipartUpload>
Sample Response
The following response indicates that an object was successfully assembled.
HTTP/1.1 200 OK x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 Date: Mon, 1 Nov 2010 20:34:56 GMT Connection: close Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <CompleteMultipartUploadResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"> <Location>http://Example-Bucket.s3.<Region>.amazonaws.com/Example-Object</Location> <Bucket>Example-Bucket</Bucket> <Key>Example-Object</Key> <ETag>"3858f62230ac3c915f300c664312c11f-9"</ETag> </CompleteMultipartUploadResult>
Sample Response: Error specified in header
The following response indicates that an error occurred before the HTTP response header was sent.
HTTP/1.1 403 Forbidden x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 Date: Mon, 1 Nov 2010 20:34:56 GMT Content-Length: 237 Connection: keep-alive Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <Error> <Code>AccessDenied</Code> <Message>Access Denied</Message> <RequestId>656c76696e6727732072657175657374</RequestId> <HostId>Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg==</HostId> </Error>
Sample Response: Error specified in body
The following response indicates that an error occurred after the HTTP response header was sent. Note that while the HTTP status code is 200 OK, the request actually failed as described in the Error element.
HTTP/1.1 200 OK x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374 Date: Mon, 1 Nov 2010 20:34:56 GMT Connection: close Server: AmazonS3 <?xml version="1.0" encoding="UTF-8"?> <Error> <Code>InternalError</Code> <Message>We encountered an internal error. Please try again.</Message> <RequestId>656c76696e6727732072657175657374</RequestId> <HostId>Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg==</HostId> </Error>