@aws-sdk/client-sqs

What is @aws-sdk/client-sqs?

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.

What are @aws-sdk/client-sqs's main functionalities?

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.'));"}

Other packages similar to @aws-sdk/client-sqs

aws-sdk

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.

sqs-consumer

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.

sqs-producer

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.

README

@aws-sdk/client-sqs

For SDK usage, please step to SDK reademe.