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.

Open source

deleteStream

KinesisClient.deleteStream(streamName) deletes a Kinesis stream.

Parameters

ParameterTypeDescription
streamNamestringThe name of the Kinesis stream to delete.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the stream deletion request is complete.

Example

JavaScript
import {
  AWSConfig,
  KinesisClient,
} from 'https://jslib.k6.io/aws/0.14.0/kinesis.js';

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

const kinesis = new KinesisClient(awsConfig);

export default async function () {
  const streamName = 'my-test-stream';

  // Delete the stream
  await kinesis.deleteStream(streamName);
  console.log(`Stream ${streamName} deleted`);
}