Dart

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

import 'package:chilkat/chilkat.dart';

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

  final http = CkHttp();

  // 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
  final String strXml;
  try {
    strXml = http.s3ListBucketObjects('chilkat100?prefix=images/&delimiter=/');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Response status code = ${http.lastStatus}');

  final xml = CkXml();
  try {
    xml.loadXml(strXml);
  } on ChilkatException catch (e) {
    print(e.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) {
    print(xml.getXml());
    print('Failed.');
    return;
  }

  // A sample response is shown below.
  print(xml.getXml());
  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>

  var prefix = '';

  // The XML can be parsed like this:
  var i = 0;
  final countI = xml.numChildrenHavingTag('CommonPrefixes');
  while (i < countI) {
    xml.i = i;
    prefix = xml.getChildContent('CommonPrefixes[i]|Prefix');
    print('Prefix = $prefix');
    i++;
  }
}