3.1075.0 • Published 6d ago

@aws-sdk/client-sqs

Licence

Apache-2.0

Version

3.1075.0

Deps

Size

624 kB

Vulns

Weekly

8.8M

Summary Dependency Versions

@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
Amazon SQS in the Command Line Interface
Amazon Web Services General Reference
- Regions and Endpoints

Installing

To install this package, use the CLI of 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:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new SQSClient({ region: "REGION" });

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

Supported Message Protocols

This client supports multiple protocols.

The default for this client is AWS JSON (RPC) 1.0.

We have selected this default based on our evaluation of the performance characteristics of this protocol format in JavaScript. You don't need to change it, but you have the option to do so, for example to support existing integrations or tests. Selecting a non-default protocol changes the format of the data sent over the network, but does not affect how you interact with the client using JavaScript objects.

Install the @aws-sdk/config package to access alternate protocols.

See AWS Protocols for more information.

AWS JSON (RPC) 1.0

This protocol uses JSON payloads.

import { AwsJson1_0Protocol } from "@aws-sdk/config/protocol";

const client = new SQSClient({
  protocol: AwsJson1_0Protocol
});

AWS Query

This protocol uses query format requests and XML responses.

import { AwsQueryProtocol } from "@aws-sdk/config/protocol";

const client = new SQSClient({
  protocol: AwsQueryProtocol
});

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

SQS extends SQSClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (SQSClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { SQS } from "@aws-sdk/client-sqs";

const client = new 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 (not recommended).
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 GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the 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.

CancelMessageMoveTask