(Tcl) S3 Complete a Multipart Upload

This operation completes a multipart upload by assembling previously uploaded parts.

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

This example sends a POST request to complete a multipart upload, which looks like this:

POST /ObjectName?uploadId=UploadId HTTP/1.1
Host: BucketName.s3.amazonaws.com
Date: Date
Content-Length: Size
Authorization: authorization string

<CompleteMultipartUpload>
  <Part>
    <PartNumber>PartNumber</PartNumber>
    <ETag>ETag</ETag>
  </Part>
  ...
</CompleteMultipartUpload>

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# The 1st step in an S3 multipart upload is to initiate it,
# as shown here: Initiate S3 Multipart Upload

# The 2nd step is to upload the parts
# as shown here: S3 Upload Parts

# The 3rd and final step (this example) is to complete the multipart upload.

# Other S3 Multipart Upload Examples:
# Abort Multipart Upload
# List Parts

# When the multipart upload was initiated, an UploadId was provided in the XML response, and it 
# was saved to a file.  Steps 2 and 3 begin by loading the XML and getting
# the Upload ID.

set xmlInit [new_CkXml]

set success [CkXml_LoadXmlFile $xmlInit "s3_multipart_uploads/initiate.xml"]
if {$success != 1} then {
    puts "Did not find the initiate.xml XML file."
    delete_CkXml $xmlInit
    exit
}

set uploadId [CkXml_getChildContent $xmlInit "UploadId"]
puts "UploadId = $uploadId"

# We'll also need the XML file that contains a record of the parts
# with part numbers and ETags.  (This file was produced when parts were being uploaded.)
set xmlPartsList [new_CkXml]

set success [CkXml_LoadXmlFile $xmlPartsList "s3_multipart_uploads/partsList.xml"]
if {$success != 1} then {
    puts "Did not find the partsList.xml XML file."
    delete_CkXml $xmlInit
    delete_CkXml $xmlPartsList
    exit
}

set rest [new_CkRest]

# Connect to the Amazon AWS REST server.
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "s3.amazonaws.com" $port $bTls $bAutoReconnect]

# ----------------------------------------------------------------------------
# Important: For buckets created in regions outside us-east-1,
# there are three important changes that need to be made.
# See Working with S3 Buckets in Non-us-east-1 Regions for the details.
# ----------------------------------------------------------------------------

# Provide AWS credentials for the REST call.
set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
CkAuthAws_put_ServiceName $authAws "s3"

set success [CkRest_SetAuthAws $rest $authAws]

# Set the bucket name via the HOST header.
# In this case, the bucket name is "chilkat100".
CkRest_put_Host $rest "chilkat100.s3.amazonaws.com"

# The "uploadId=UploadId" must be added as a query parameter.  This allows it to be 
# incorporated into the AWS signature calculation, which is a requirement.
# Therefore, we use AddQueryParam:
CkRest_AddQueryParam $rest "uploadId" $uploadId

# Our ObjectName in this case is "somethingBig.zip".
set responseXml [CkRest_fullRequestString $rest "POST" "/somethingBig.zip" [CkXml_getXml $xmlPartsList]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkXml $xmlInit
    delete_CkXml $xmlPartsList
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# When successful, the S3 Storage service will respond with a 200 response code,
# with an XML body.  
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    # Examine the request/response to see what happened.
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: $responseXml"
    puts "---"
    puts "LastRequestStartLine: [CkRest_lastRequestStartLine $rest]"
    puts "LastRequestHeader: [CkRest_lastRequestHeader $rest]"
}

# Load the XML response into Chilkat XMl and emit via GetXml to see the XML in a pretty-printed (indented) readable format.
set xml [new_CkXml]

CkXml_LoadXml $xml $responseXml
puts [CkXml_getXml $xml]
puts "----"

puts "Multipart upload completed."

delete_CkXml $xmlInit
delete_CkXml $xmlPartsList
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkXml $xml