Node.js

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. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    var http = new chilkat.Http();

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

    // Insert your secret key here:
    http.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
    var strXml = http.S3_ListBucketObjects("chilkat100?prefix=images/&delimiter=/");
    if (http.LastMethodSuccess !== true) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Response status code = " + http.LastStatus);

    var xml = new chilkat.Xml();
    success = xml.LoadXml(strXml);
    if (success !== true) {
        console.log(xml.LastErrorText);
        return;
    }

    // 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.LastStatus !== 200) {
        console.log(xml.GetXml());
        console.log("Failed.");
        return;
    }

    // A sample response is shown below.
    console.log(xml.GetXml());
    console.log("----");

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

    var Prefix;

    // The XML can be parsed like this:
    var i = 0;
    var count_i = xml.NumChildrenHavingTag("CommonPrefixes");
    while (i < count_i) {
        xml.I = i;
        Prefix = xml.GetChildContent("CommonPrefixes[i]|Prefix");
        console.log("Prefix = " + Prefix);
        i = i+1;
    }


}

chilkatExample();