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.

Documentationbreadcrumb arrow Grafana k6breadcrumb arrow JavaScript APIbreadcrumb arrow jslibbreadcrumb arrow awsbreadcrumb arrow SQSClientbreadcrumb arrow deleteMessage
Open source

deleteMessage

SQSClient.deleteMessage(queueUrl, receiptHandle) deletes a message from the specified Amazon Simple Queue Service (SQS) queue.

Parameters

NameTypeDescription
queueUrlstringThe URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive.
receiptHandlestringThe receipt handle associated with the message to delete. The receipt handle is returned when you receive a message using receiveMessages.

Returns

TypeDescription
PromiseA Promise that fulfills when the message is successfully deleted.

Example

JavaScript 
import exec from 'k6/execution';

import {
  AWSConfig,
  SQSClient,
} from 'https://jslib.k6.io/aws/0.14.0/sqs.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 sqs = new SQSClient(awsConfig);
const testQueue = 'https://sqs.us-east-1.amazonaws.com/000000000/test-queue';

export default async function () {
  // If our test queue does not exist, abort the execution.
  const queuesResponse = await sqs.listQueues();
  if (queuesResponse.urls.filter((q) => q === testQueue).length == 0) {
    exec.test.abort();
  }

  // Send a message to the queue
  await sqs.sendMessage(testQueue, JSON.stringify({ value: '123' }));

  // Receive messages from the queue
  const messages = await sqs.receiveMessages(testQueue);

  // Delete each received message
  for (const message of messages) {
    console.log('Deleting message:', message.messageId);
    await sqs.deleteMessage(testQueue, message.receiptHandle);
  }
}