Skip to content

Files

Latest commit

Feb 14, 2025
9b33855 · Feb 14, 2025

History

History

README.md

Amazon SQS code examples for the SDK for JavaScript (v3)

Overview

Shows how to use the AWS SDK for JavaScript (v3) to work with Amazon Simple Queue Service (Amazon SQS).

Amazon SQS is a fully managed message queuing service that makes it easy to decouple and scale microservices, distributed systems, and serverless applications.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Code examples

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

Get started

Single actions

Code excerpts that show you how to call individual service functions.

Scenarios

Code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

Run the examples

Instructions

Note: All code examples are written in ECMAscript 6 (ES6). For guidelines on converting to CommonJS, see JavaScript ES6/CommonJS syntax.

Run a single action

node ./actions/<fileName>

Run a scenario

Most scenarios can be run with the following command:

node ./scenarios/<fileName>

Run with options

Some actions and scenarios can be run with options from the command line:

node ./scenarios/<fileName> --option1 --option2

util.parseArgs is used to configure these options. For the specific options available to each script, see the parseArgs usage for that file.

Hello Amazon SQS

This example shows you how to get started using Amazon SQS.

node ./hello.js

Publish messages to queues

This example shows you how to do the following:

  • Create topic (FIFO or non-FIFO).
  • Subscribe several queues to the topic with an option to apply a filter.
  • Publish messages to the topic.
  • Poll the queues for messages received.

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

Additional resources


Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0