---
title: "SQSClient | Grafana k6 documentation"
description: "SQSClient enables interaction with the AWS Simple Queue Service (SQS)"
---

# SQSClient

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

With it, the user can send messages to specified queues, receive messages from queues, delete processed messages, 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

Expand table

| Function                                                                                 | Description                                          |
|------------------------------------------------------------------------------------------|------------------------------------------------------|
| [sendMessage](/docs/k6/latest/javascript-api/jslib/aws/sqsclient/sendmessage/)           | Delivers a message to the specified queue.           |
| [sendMessageBatch](/docs/k6/latest/javascript-api/jslib/aws/sqsclient/sendmessagebatch/) | Delivers up to ten messages to the specified queue.  |
| [receiveMessages](/docs/k6/latest/javascript-api/jslib/aws/sqsclient/receivemessages/)   | Receives messages from the specified queue.          |
| [deleteMessage](/docs/k6/latest/javascript-api/jslib/aws/sqsclient/deletemessage/)       | Deletes a message from the specified queue.          |
| [listQueues](/docs/k6/latest/javascript-api/jslib/aws/sqsclient/listqueues/)             | Returns a list of your queues in the current region. |

### Throws

`SQSClient` methods throw errors in case of failure.

Expand table

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

### Example

JavaScript ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```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 message to test queue
  await sqs.sendMessage(testQueue, JSON.stringify({ value: '123' }));

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

  // Process and delete each received message
  for (const message of messages) {
    console.log('Processing message:', message.body);

    // Delete the message after processing
    await sqs.deleteMessage(testQueue, message.receiptHandle);
  }
}
```