Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation

aws

Bucket

Open source

Bucket

Bucket is returned by the S3Client.* methods that query S3 buckets. Namely, listBuckets() returns an array of Bucket objects. The Bucket object describes an Amazon S3 bucket.

Name	Type	Description
`Bucket.name`	string	The S3 bucket’s name
`Bucket.creationDate`	Date	The S3 bucket’s creationDate

Example

import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.11.0/s3.js';

const awsConfig = new AWSConfig({
  region: __ENV.AWS_REGION,
  accessKeyId: __ENV.AWS_ACCESS_KEY_ID,
  secretAccessKey: __ENV.AWS_SECRET_ACCESS_KEY,
});

const s3 = new S3Client(awsConfig);

export default async function () {
  // List the buckets the AWS authentication configuration
  // gives us access to.
  const buckets = await s3.listBuckets();
  console.log(JSON.stringify(buckets));
}

A k6 script that will query the user’s S3 buckets and print all of their metadata