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.

JavaScript API

jslib

aws

S3Client

getObject

Open source

getObject

S3Client.getObject downloads an object from a bucket.

As a default, the object’s data will be treated as a string. In order to treat the object’s data as binary content, and receive the data as an ArrayBuffer, you can pass additionalHeaders to getObject, with the Accept header set to application/octet-stream.

Parameters

Parameter	Type	Description
bucketName	string	Name of the bucket to fetch the object from.
objectKey	string	Name of the object to download.
additionalHeaders	Object	Additional headers to send with the request.

Returns

Type	Description
Promise< Object>	A Promise that fulfills with an Object describing and holding the downloaded content.

Example

Downloading a text file from AWS S3

JavaScript
import exec from 'k6/execution';

import {
  AWSConfig,
  S3Client,
} from 'https://jslib.k6.io/aws/0.13.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);
const testBucketName = 'test-jslib-aws';
const testFileKey = 'bonjour.txt';

export default async function () {
  const objects = await s3.listObjects(testBucketName);

  // If our test object does not exist, abort the execution.
  if (objects.filter((o) => o.key === testFileKey).length == 0) {
    exec.test.abort();
  }

  // Let's download our test object and print its content
  const object = await s3.getObject(testBucketName, testFileKey);
  console.log(JSON.stringify(object));
}

A k6 script that will download an object from a bucket

Downloading a binary file from AWS S3

JavaScript
import exec from 'k6/execution';

import {
  AWSConfig,
  S3Client,
} from 'https://jslib.k6.io/aws/0.13.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);
const testBucketName = 'test-jslib-aws';
const testFileKey = 'quick.pdf';

export default async function () {
  // Download an object from S3, and require from the `getObject` operation
  // to treat it as a binary content's file, and return an Object who's data
  // parameter is an ArrayBuffer.
  const s3Object = await s3.getObject(testBucketName, testFileKey, {
    Accept: 'application/octet-stream',
  });

  console.log(`Successfully downloaded a binary file of size ${s3Object.data.byteLength} bytes`);
}