Menu
Open source

createMultipartUpload

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

ParameterTypeDescription
bucketNamestringName of the bucket to upload the object to.
objectKeystringName of the uploaded object.

Returns

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

Example

JavaScript
import { AWSConfig, S3Client } from 'https://jslib.k6.io/aws/0.12.1/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