(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// Insert your access key here:
loHttp.AwsAccessKey = "AWS_ACCESS_KEY"

// Insert your secret key here:
loHttp.AwsSecretKey = "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
lcStrXml = loHttp.S3_ListBucketObjects("chilkat100?prefix=images/&delimiter=/")
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loHttp
    return
endif

? "Response status code = " + str(loHttp.LastStatus)

loXml = createobject("CkXml")
llSuccess = loXml.LoadXml(lcStrXml)
if (llSuccess <> .T.) then
    ? loXml.LastErrorText
    release loHttp
    release loXml
    return
endif

// If the response status code was not 200, then the XML response is not a 
// listing of objects, but instead contains error information.
if (loHttp.LastStatus <> 200) then
    ? loXml.GetXml()
    ? "Failed."
    release loHttp
    release loXml
    return
endif

// A sample response is shown below.
? loXml.GetXml()
? "----"

// 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:
i = 0
lnCount_i = loXml.NumChildrenHavingTag("CommonPrefixes")
do while i < lnCount_i
    loXml.I = i
    lcPrefix = loXml.GetChildContent("CommonPrefixes[i]|Prefix")
    ? "Prefix = " + lcPrefix
    i = i + 1
enddo


release loHttp
release loXml