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

Grafana k6

JavaScript API

jslib

aws

SQSClient

Open source

SQSClient

SQSClient interacts with the AWS Simple Queue Service (SQS).

With it, the user can send messages to specified queues and list available queues in the current region.

SQSClient is included in both the dedicated sqs.js jslib bundle and the all-encompassing aws.js one, containing all the services clients.

Methods

Function	Description
`sendMessage`	Delivers a message to the specified queue.
`listQueues`	Returns a list of your queues in the current region.

Throws

SQSClient methods throw errors in case of failure.

Error	Condition
`InvalidSignatureError`	when using invalid credentials
`SQSServiceError`	when AWS replied to the requested operation with an error

Example

import exec from 'k6/execution';

import { AWSConfig, SQSClient } from 'https://jslib.k6.io/aws/0.11.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();
  }

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