@aws-sdk/client-sqs
Advanced tools
AWS SDK for JavaScript Sqs Client for Node.js, Browser and React Native
The @aws-sdk/client-sqs npm package is a client library for interacting with Amazon Simple Queue Service (SQS). It provides methods to perform operations such as creating queues, sending messages, receiving messages, and deleting messages, among others. It is part of the AWS SDK for JavaScript (v3), which is a modular collection of clients for various AWS services.
Creating a Queue
This feature allows you to create a new queue in Amazon SQS. The code sample demonstrates how to create a queue named 'MyQueue'.
{"const { SQSClient, CreateQueueCommand } = require('@aws-sdk/client-sqs');
const client = new SQSClient({ region: 'us-west-2' });
const command = new CreateQueueCommand({ QueueName: 'MyQueue' });
client.send(command).then((data) => console.log(data.QueueUrl));"}Sending a Message
This feature allows you to send a message to a specified queue. The code sample demonstrates how to send a message with the body 'Hello, World!' to a queue with the URL 'QUEUE_URL'.
{"const { SQSClient, SendMessageCommand } = require('@aws-sdk/client-sqs');
const client = new SQSClient({ region: 'us-west-2' });
const command = new SendMessageCommand({ QueueUrl: 'QUEUE_URL', MessageBody: 'Hello, World!' });
client.send(command).then((data) => console.log(data.MessageId));"}Receiving Messages
This feature allows you to receive messages from a queue. The code sample demonstrates how to receive up to 10 messages from a queue with the URL 'QUEUE_URL'.
{"const { SQSClient, ReceiveMessageCommand } = require('@aws-sdk/client-sqs');
const client = new SQSClient({ region: 'us-west-2' });
const command = new ReceiveMessageCommand({ QueueUrl: 'QUEUE_URL', MaxNumberOfMessages: 10 });
client.send(command).then((data) => console.log(data.Messages));"}Deleting a Message
This feature allows you to delete a message from a queue using its receipt handle. The code sample demonstrates how to delete a message from a queue with the URL 'QUEUE_URL' using a receipt handle 'RECEIPT_HANDLE'.
{"const { SQSClient, DeleteMessageCommand } = require('@aws-sdk/client-sqs');
const client = new SQSClient({ region: 'us-west-2' });
const command = new DeleteMessageCommand({ QueueUrl: 'QUEUE_URL', ReceiptHandle: 'RECEIPT_HANDLE' });
client.send(command).then(() => console.log('Message deleted successfully.'));"}The 'aws-sdk' package is the previous version of the AWS SDK for JavaScript. It provides a monolithic approach compared to the modular '@aws-sdk/client-sqs' package. It includes support for all AWS services in a single package, which can lead to larger bundle sizes if only a few services are needed.
The 'sqs-consumer' package is a higher-level abstraction built on top of the AWS SDK. It provides a simple interface to consume messages from an SQS queue. It handles the message lifecycle, including polling for messages, handling errors, and deleting messages after processing. It is less flexible than '@aws-sdk/client-sqs' but can be easier to use for simple queue processing tasks.
The 'sqs-producer' package is designed to complement 'sqs-consumer' by providing a simple interface for sending messages to an SQS queue. It simplifies the process of producing messages and can be used in conjunction with 'sqs-consumer' for a complete message queue solution. It is more specialized than '@aws-sdk/client-sqs', which offers a broader range of SQS operations.
AWS SDK for JavaScript SQS Client for Node.js, Browser and React Native.
Welcome to the Amazon SQS API Reference.
Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
For information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer Guide.
You can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
Cryptographically sign your service requests
Retry requests
Handle error responses
Additional information
Amazon SQS Developer Guide
Amazon Web Services General Reference
To install the this package, simply type add or install @aws-sdk/client-sqs using your favorite package manager:
npm install @aws-sdk/client-sqsyarn add @aws-sdk/client-sqspnpm add @aws-sdk/client-sqsThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SQSClient and
the commands you need, for example ListQueuesCommand:
// ES5 example
const { SQSClient, ListQueuesCommand } = require("@aws-sdk/client-sqs");
// ES6+ example
import { SQSClient, ListQueuesCommand } from "@aws-sdk/client-sqs";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new SQSClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListQueuesCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-sqs";
const client = new AWS.SQS({ region: "REGION" });
// async/await.
try {
const data = await client.listQueues(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listQueues(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listQueues(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-sqs package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.621.0 (2024-07-30)
homepage links to use the main branch (#6336) (e332230)FAQs
AWS SDK for JavaScript Sqs Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-sqs receives a total of 1,373,528 weekly downloads. As such, @aws-sdk/client-sqs popularity was classified as popular.
We found that @aws-sdk/client-sqs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.