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

createMultipartUpload

Open source

createMultipartUpload

S3Client.createMultipartUpload creates a new multipart upload for a given an object key in a bucket.

Parameter	Type	Description
bucketName	string	Name of the bucket to upload the object to.
objectKey	string	Name of the uploaded object.

Returns

Type	Description
Promise<S3MultipartUpload>	A Promise that fulfills with a S3MultipartUpload representing a S3 Multipart Upload.

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,
  sessionToken: __ENV.AWS_SESSION_TOKEN,
});

const s3 = new S3Client(awsConfig);

const testBucketName = 'test-jslib-aws';
const testFileKey = 'multipart.txt';

export default async function () {
  // Initialize a multipart upload
  const multipartUpload = await s3.createMultipartUpload(testBucketName, testFileKey);

  // Abort multipart upload
  await s3.abortMultipartUpload(testBucketName, testFileKey, multipartUpload.uploadId);
}

A k6 script that will create a multipart upload to an S3 bucket