(Tcl) S3 Get Bucket Objects with CommonPrefixes

Demonstrates how to get a list of bucket objects using the prefix and delimiter query params to get an XML result with CommonPrefixes.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# Insert your access key here:
CkHttp_put_AwsAccessKey $http "AWS_ACCESS_KEY"

# Insert your secret key here:
CkHttp_put_AwsSecretKey $http "AWS_SECRET_KEY"

# In this example, my bucket is "chilkat100".
# It contains a number of folders, one of which is named "images".
# I want to get a list of all sub-folders under the "images" folder
set strXml [CkHttp_s3_ListBucketObjects $http "chilkat100?prefix=images/&delimiter=/"]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

puts "Response status code = [CkHttp_get_LastStatus $http]"

set xml [new_CkXml]

set success [CkXml_LoadXml $xml $strXml]
if {$success != 1} then {
    puts [CkXml_lastErrorText $xml]
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# If the response status code was not 200, then the XML response is not a 
# listing of objects, but instead contains error information.
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkXml_getXml $xml]
    puts "Failed."
    delete_CkHttp $http
    delete_CkXml $xml
    exit
}

# A sample response is shown below.
puts [CkXml_getXml $xml]
puts "----"

# Here is the list of sub-folders (i.e. CommonPrefixes)

# <?xml version="1.0" encoding="UTF-8"?>
# <ListBucketResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
#     <Name>chilkat100</Name>
#     <Prefix>images/</Prefix>
#     <Marker/>
#     <MaxKeys>1000</MaxKeys>
#     <Delimiter>/</Delimiter>
#     <IsTruncated>false</IsTruncated>
#     <CommonPrefixes>
#         <Prefix>images/africa/</Prefix>
#     </CommonPrefixes>
#     <CommonPrefixes>
#         <Prefix>images/sea_creatures/</Prefix>
#     </CommonPrefixes>
# </ListBucketResult>

# The XML can be parsed like this:
set i 0
set count_i [CkXml_NumChildrenHavingTag $xml "CommonPrefixes"]
while {$i < $count_i} {
    CkXml_put_I $xml $i
    set Prefix [CkXml_getChildContent $xml "CommonPrefixes[i]|Prefix"]
    puts "Prefix = $Prefix"
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkXml $xml