@aws-sdk/client-sqs
Description
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:
Additional information
Installing
To install the this package, simply type add or install @aws-sdk/client-sqs
using your favorite package manager:
npm install @aws-sdk/client-sqs
yarn add @aws-sdk/client-sqs
pnpm add @aws-sdk/client-sqs
Getting Started
Import
The 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
:
const { SQSClient, ListQueuesCommand } = require("@aws-sdk/client-sqs");
import { SQSClient, ListQueuesCommand } from "@aws-sdk/client-sqs";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new SQSClient({ region: "REGION" });
const params = {
};
const command = new ListQueuesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
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" });
try {
const data = await client.listQueues(params);
} catch (error) {
}
client
.listQueues(params)
.then((data) => {
})
.catch((error) => {
});
client.listQueues(params, (err, data) => {
});
Troubleshooting
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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
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.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
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.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AddPermission
Command API Reference / Input / Output
CancelMessageMoveTask
Command API Reference / Input / Output
ChangeMessageVisibility
Command API Reference / Input / Output
ChangeMessageVisibilityBatch
Command API Reference / Input / Output
CreateQueue
Command API Reference / Input / Output
DeleteMessage
Command API Reference / Input / Output
DeleteMessageBatch
Command API Reference / Input / Output
DeleteQueue
Command API Reference / Input / Output
GetQueueAttributes
Command API Reference / Input / Output
GetQueueUrl
Command API Reference / Input / Output
ListDeadLetterSourceQueues
Command API Reference / Input / Output
ListMessageMoveTasks
Command API Reference / Input / Output
ListQueues
Command API Reference / Input / Output
ListQueueTags
Command API Reference / Input / Output
PurgeQueue
Command API Reference / Input / Output
ReceiveMessage
Command API Reference / Input / Output
RemovePermission
Command API Reference / Input / Output
SendMessage
Command API Reference / Input / Output
SendMessageBatch
Command API Reference / Input / Output
SetQueueAttributes
Command API Reference / Input / Output
StartMessageMoveTask
Command API Reference / Input / Output
TagQueue
Command API Reference / Input / Output
UntagQueue
Command API Reference / Input / Output