Lua

S3 Get Bucket Objects with CommonPrefixes

See more Amazon S3 Examples

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

local chilkat = require("chilkat")

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

local http = chilkat.Http.new()

-- Insert your access key here:
http.aws_access_key = "AWS_ACCESS_KEY"

-- Insert your secret key here:
http.aws_secret_key = "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
local strXml = http:s3_list_bucket_objects("chilkat100?prefix=images/&delimiter=/")
if not http.last_method_success then
    print(http.last_error_text)
    return
end

print("Response status code = " .. http.last_status)

local xml = chilkat.Xml.new()
local success = xml:load_xml(strXml)
if not success then
    print(xml.last_error_text)
    return
end

-- If the response status code was not 200, then the XML response is not a
-- listing of objects, but instead contains error information.
if http.last_status ~= 200 then
    print(xml:get_xml())
    print("Failed.")
    return
end

-- A sample response is shown below.
print(xml:get_xml())
print("----")

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

local Prefix = ""

-- The XML can be parsed like this:
local i = 0
local count_i = xml:num_children_having_tag("CommonPrefixes")
while i < count_i do
    xml.i = i
    Prefix = xml:get_child_content("CommonPrefixes[i]|Prefix")
    print("Prefix = " .. Prefix)
    i = i + 1
end