This is documentation for the next version of K6. For the latest stable release, go to the latest version.

Documentation

aws

deleteObject

Open source

deleteObject

S3Client.deleteObject deletes an object from a bucket.

Parameters

Parameter	Type	Description
bucketName	string	Name of the bucket to delete the object from.
objectKey	string	Name of the object to delete.

Returns

Type	Description
`Promise<void>`	A promise that fulfills when the object has been deleted from S3.

Example

import exec from 'k6/execution';

import {
  AWSConfig,
  S3Client,
} from 'https://jslib.k6.io/aws/0.12.3/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 () {
  // Let's delete our test object
  await s3.deleteObject(testBucketName, testFileKey);

  // And make sure it was indeed deleted
  const objects = await s3.listObjects();
  if (objects.filter((o) => o.name === testBucketName).length != 0) {
    exec.test.abort();
  }
}

A k6 script that will delete an object from a S3 bucket