SQSClient on Grafana Labs

deleteMessage

Mon, 21 Sep 2026 15:16:28 +0000

deleteMessage

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

Parameters

Name	Type	Description
queueUrl	string	The URL of the Amazon SQS queue from which messages are deleted. Queue URLs and names are case-sensitive.
receiptHandle	string	The receipt handle associated with the message to delete. The receipt handle is returned when you receive a message using `receiveMessages`.

Returns

Type	Description
Promise	A Promise that fulfills when the message is successfully deleted.

Example

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);
  }
}

listQueues

Mon, 21 Sep 2026 15:16:28 +0000

listQueues

SQSClient.listQueues(options) retrieves a list of available Amazon Simple Queue Service (SQS) queues.

Parameters

Name	Type	Description
options	object (optional)	Options for the request. Accepted properties are: `queueNamePrefix` (optional string) setting the prefix filter for the returned queue list, `maxResults` (optional number) setting the maximum number of results to include in the response (1 <= `maxResults` <= 1000>), and `nextToken` (optional string) setting the pagination token to request the next set of results.

Returns

Type	Description
Promise	A Promise that fulfills with an object with an `urls` property containing an array of queue URLs, and an optional `nextToken` containing a pagination token to include in the next request when relevant.

Example

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 () {
  // List all queues in the AWS account
  const queuesResponse = await sqs.listQueues();

  // If our test queue does not exist, abort the execution.
  if (queuesResponse.urls.filter((q) => q === testQueue).length == 0) {
    exec.test.abort();
  }

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

receiveMessages

Mon, 21 Sep 2026 15:16:28 +0000

receiveMessages

SQSClient.receiveMessages(queueUrl, [options]) receives messages from the specified Amazon Simple Queue Service (SQS) queue.

Parameters

Name	Type	Description
queueUrl	string	The URL of the Amazon SQS queue from which messages are received. Queue URLs and names are case-sensitive.
options	ReceiveMessageOptions (optional)	Options for the receive operation.

ReceiveMessageOptions

Name	Type	Description
maxNumberOfMessages	number (optional)	The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
visibilityTimeoutSeconds	number (optional)	The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a `receiveMessages` request. Valid values: 0 to 43200 (12 hours). Default: the queue’s default visibility timeout.
waitTimeSeconds	number (optional)	The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. Valid values: 0 to 20. Default: 0.

Returns

Type	Description
Promise<SQSMessage[]>	A Promise that fulfills with an array of received messages.

SQSMessage

Name	Type	Description
messageId	string	A unique identifier for the message.
body	string	The message’s contents (not URL-encoded).
receiptHandle	string	An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
md5OfBody	string	An MD5 digest of the non-URL-encoded message body string.

Example

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();
  }

  // Receive messages from the queue
  const messages = await sqs.receiveMessages(testQueue, {
    maxNumberOfMessages: 10,
    waitTimeSeconds: 2,
  });

  // Process received messages
  for (const message of messages) {
    console.log('Received message:', message.body);
    console.log('Message ID:', message.messageId);
    console.log('Receipt handle:', message.receiptHandle);
  }
}

sendMessage

Mon, 21 Sep 2026 15:16:28 +0000

sendMessage

SQSClient.sendMessage(queueUrl, messageBody, options) sends a message to the specified Amazon Simple Queue Service (SQS) queue.

Parameters

Name	Type	Description
queueUrl	string	The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive.
messageBody	string	The message to send. The minimum size is one character. The maximum size is 256 KB.
options	SendMessageOptions (optional)	Options for the request.

SendMessageOptions

Name	Type	Description
messageDeduplicationId	string (optional)	The token used for deduplication of sent messages. This parameter applies only to FIFO (first-in-first-out) queues. If a message with a particular MessageDeduplicationId is sent successfully, any messages with the same MessageDeduplicationId are accepted but not delivered during the 5-minute deduplication interval.
messageGroupId	string (optional)	The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner. Messages in different message groups might be processed out of order.
messageAttributes	object (optional)	Each message attribute consists of a `Name`, `Type`, and `Value`. For more information, see Amazon SQS Message Attributes.
delaySeconds	number (optional)	The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive `delaySeconds` value become available for processing after the delay period is finished. If you don’t specify a value, the default value for the queue applies.

Returns

Type	Description
Promise	A Promise that fulfills with the message that was sent, as an object containing an `id` string property holding the unique identifier for the message, and a `bodyMD5` string property holding the MD5 digest of the non-URL-encoded message body string.

Example

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 message to test queue
  await sqs.sendMessage(testQueue, 'test', {
    messageAttributes: {
      'test-string': {
        type: 'String',
        value: 'test',
      },
      'test-number': {
        type: 'Number',
        value: '23',
      },
      'test-binary': {
        type: 'Binary',
        value: 'dGVzdA==',
      },
    },
  });
}

sendMessageBatch

Mon, 21 Sep 2026 15:16:28 +0000

sendMessageBatch

SQSClient.sendMessageBatch(queueUrl, entries) delivers up to ten messages to the specified Amazon Simple Queue Service (SQS) queue.

Parameters

Name	Type	Description
queueUrl	string	The URL of the Amazon SQS queue to which a message is sent. Queue URLs and names are case-sensitive.
entries	SendMessageBatchEntry	A list of up to ten messages to send.

SendMessageBatchEntry

Name	Type	Description
messageId	string	The identifier of the batch entry message.
messageBody	string	The message to send. The minimum size is one character. The maximum size is 256 KB.
messageOptions?	SendMessageOptions>) (optional)	Options for the request.

Returns

Type	Description
Promise<MessageBatchResponse>	A Promise that fulfills with a batch message creation response.

MessageBatchResponse

Name	Type	Description
successful	object[]	A list of succesful messages as objects containing an `id` string property holding the unique identifier for the message, and a `bodyMD5` string property holding the MD5 digest of the non-URL-encoded message body string..
failed	SQSServiceError[]	A list of error responses.

Example

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.queueUrls.filter((q) => q === testQueue).length == 0) {
    exec.test.abort();
  }

  // Prepare a bunch of batch messages to add to the queue
  const messageBatch = [
    { messageId: '0', messageBody: 'test0' },
    { messageId: '1', messageBody: 'test1' },
  ];

  // Send the batch of messages to the queue
  await sqs.sendMessageBatch(testQueue, messageBatch);
}