@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

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:

• Cryptographically sign your service requests

• Retry requests

• Handle error responses

Additional information

• Amazon SQS Product Page

• Amazon SQS Developer Guide

  • Making API Requests

  • Amazon SQS Message Attributes

  • Amazon SQS Dead-Letter Queues

• Amazon SQS in the Command Line Interface

• Amazon Web Services General Reference

  • Regions and Endpoints

Installing

To install 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:

// ES5 example
const { SQSClient, ListQueuesCommand } = require("@aws-sdk/client-sqs");

// ES6+ example
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.

// a client can be shared by different commands.
const client = new SQSClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListQueuesCommand(params);

Async/await

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.

Promises

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

Callbacks

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

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

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

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);
  // 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;
   * }
   */
}

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.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

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

Changelog

3.699.0 (2024-11-22)

Bug Fixes

• credential-provider-ini: pass clientConfig to sso and sso-oidc inner clients (#6688) (0ca3da3)

Features

• client-auto-scaling: Now, Amazon EC2 Auto Scaling customers can enable target tracking policies to take quicker scaling decisions, enhancing their application performance and EC2 utilization. To get started, specify target tracking to monitor a metric that is available on Amazon CloudWatch at seconds-level interval. (26d5f85)
• client-bcm-pricing-calculator: Initial release of the AWS Billing and Cost Management Pricing Calculator API. (13fd8a4)
• client-bedrock-agent-runtime: InvokeInlineAgent API release to help invoke runtime agents without any dependency on preconfigured agents. (372482a)
• client-chatbot: Adds support for programmatic management of custom actions and aliases which can be associated with channel configurations. (acdb624)
• client-codepipeline: AWS CodePipeline V2 type pipelines now support ECRBuildAndPublish and InspectorScan actions. (cce4188)
• client-cognito-identity-provider: Add support for users to sign up and sign in without passwords, using email and SMS OTPs and Passkeys. Add support for Passkeys based on WebAuthn. Add support for enhanced branding customization for hosted authentication pages with Amazon Cognito Managed Login. Add feature tiers with new pricing. (3ef966f)
• client-connect: Amazon Connect Service Feature: Add APIs for Amazon Connect Email Channel (a83926c)
• client-cost-explorer: This release adds the Impact field(contains Contribution field) to the GetAnomalies API response under RootCause (af7c9b2)
• client-elastic-load-balancing-v2: This release adds support for advertising trusted CA certificate names in associated trust stores. (5e46efc)
• client-emr: Advanced Scaling in Amazon EMR Managed Scaling (4092279)
• client-inspector2: Extend inspector2 service model to include ServiceQuotaExceededException. (dc13e07)
• client-lambda: Add ProvisionedPollerConfig to Lambda event-source-mapping API. (511ab41)
• client-mailmanager: Added new "DeliverToQBusiness" rule action to MailManager RulesSet for ingesting email data into Amazon Q Business customer applications (048d165)
• client-neptune-graph: Add 4 new APIs to support new Export features, allowing Parquet and CSV formats. Add new arguments in Import APIs to support Parquet import. Add a new query "neptune.read" to run algorithms without loading data into database (48054dc)
• client-omics: This release adds support for resource policy based cross account S3 access to sequence store read sets. (dbe3f07)
• client-quicksight: This release includes: Update APIs to support Image, Layer Map, font customization, and Plugin Visual. Add Identity center related information in ListNamsespace API. Update API for restrictedFolder support in topics and add API for SearchTopics, Describe/Update DashboardsQA Configration. (df75ca5)
• client-sagemaker: This release adds APIs for new features for SageMaker endpoint to scale down to zero instances, native support for multi-adapter inference, and endpoint scaling improvements. (f082da5)
• client-ses: This release adds support for starting email contacts in your Amazon Connect instance as an email receiving action. (14fc94c)
• client-sfn: Add support for variables and JSONata in TestState, GetExecutionHistory, DescribeStateMachine, and DescribeStateMachineForExecution (c9c278a)
• clients: update client endpoints as of 2024-11-22 (bcd27a2)