@aws-sdk/client-sns

What is @aws-sdk/client-sns?

@aws-sdk/client-sns is an AWS SDK for JavaScript package that allows you to interact with the Amazon Simple Notification Service (SNS). SNS is a fully managed messaging service that enables you to decouple and scale microservices, distributed systems, and serverless applications. With this package, you can publish messages to SNS topics, manage topics and subscriptions, and more.

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

Publish a Message

This feature allows you to publish a message to an SNS topic. The code sample demonstrates how to create an SNS client, define the message and topic ARN, and send the message using the PublishCommand.

const { SNSClient, PublishCommand } = require('@aws-sdk/client-sns');

const client = new SNSClient({ region: 'us-east-1' });

const params = {
  Message: 'Hello, world!',
  TopicArn: 'arn:aws:sns:us-east-1:123456789012:MyTopic'
};

const run = async () => {
  try {
    const data = await client.send(new PublishCommand(params));
    console.log('Message sent:', data);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

Create a Topic

This feature allows you to create a new SNS topic. The code sample demonstrates how to create an SNS client, define the topic name, and create the topic using the CreateTopicCommand.

const { SNSClient, CreateTopicCommand } = require('@aws-sdk/client-sns');

const client = new SNSClient({ region: 'us-east-1' });

const params = {
  Name: 'MyNewTopic'
};

const run = async () => {
  try {
    const data = await client.send(new CreateTopicCommand(params));
    console.log('Topic ARN:', data.TopicArn);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

Subscribe to a Topic

This feature allows you to subscribe an endpoint to an SNS topic. The code sample demonstrates how to create an SNS client, define the subscription parameters (protocol, topic ARN, and endpoint), and create the subscription using the SubscribeCommand.

const { SNSClient, SubscribeCommand } = require('@aws-sdk/client-sns');

const client = new SNSClient({ region: 'us-east-1' });

const params = {
  Protocol: 'email',
  TopicArn: 'arn:aws:sns:us-east-1:123456789012:MyTopic',
  Endpoint: '[e-mail]'
};

const run = async () => {
  try {
    const data = await client.send(new SubscribeCommand(params));
    console.log('Subscription ARN:', data.SubscriptionArn);
  } catch (err) {
    console.error('Error:', err);
  }
};

run();

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

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript, which includes support for SNS along with many other AWS services. It provides a comprehensive set of features for interacting with AWS services, but it is larger in size compared to the modular @aws-sdk/client-sns package.

aws-sns-publish

The aws-sns-publish package is another lightweight utility specifically for publishing messages to SNS topics. It is easy to use and has fewer dependencies, but it does not offer the full range of SNS management features available in @aws-sdk/client-sns.

README

@aws-sdk/client-sns

Description

AWS SDK for JavaScript SNS Client for Node.js, Browser and React Native.

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

Installing

To install this package, simply type add or install @aws-sdk/client-sns using your favorite package manager:

• npm install @aws-sdk/client-sns
• yarn add @aws-sdk/client-sns
• pnpm add @aws-sdk/client-sns

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the SNSClient and the commands you need, for example ListTopicsCommand:

// ES5 example
const { SNSClient, ListTopicsCommand } = require("@aws-sdk/client-sns");

// ES6+ example
import { SNSClient, ListTopicsCommand } from "@aws-sdk/client-sns";

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 SNSClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListTopicsCommand(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-sns";
const client = new AWS.SNS({ region: "REGION" });

// async/await.
try {
  const data = await client.listTopics(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTopics(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.listTopics(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-sns 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

CheckIfPhoneNumberIsOptedOut

Command API Reference / Input / Output

ConfirmSubscription

Command API Reference / Input / Output

CreatePlatformApplication

Command API Reference / Input / Output

CreatePlatformEndpoint

Command API Reference / Input / Output

CreateSMSSandboxPhoneNumber

Command API Reference / Input / Output

CreateTopic

Command API Reference / Input / Output

DeleteEndpoint

Command API Reference / Input / Output

DeletePlatformApplication

Command API Reference / Input / Output

DeleteSMSSandboxPhoneNumber

Command API Reference / Input / Output

DeleteTopic

Command API Reference / Input / Output

GetDataProtectionPolicy

Command API Reference / Input / Output

GetEndpointAttributes

Command API Reference / Input / Output

GetPlatformApplicationAttributes

Command API Reference / Input / Output

GetSMSAttributes

Command API Reference / Input / Output

GetSMSSandboxAccountStatus

Command API Reference / Input / Output

GetSubscriptionAttributes

Command API Reference / Input / Output

GetTopicAttributes

Command API Reference / Input / Output

ListEndpointsByPlatformApplication

Command API Reference / Input / Output

ListOriginationNumbers

Command API Reference / Input / Output

ListPhoneNumbersOptedOut

Command API Reference / Input / Output

ListPlatformApplications

Command API Reference / Input / Output

ListSMSSandboxPhoneNumbers

Command API Reference / Input / Output

ListSubscriptions

Command API Reference / Input / Output

ListSubscriptionsByTopic

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTopics

Command API Reference / Input / Output

OptInPhoneNumber

Command API Reference / Input / Output

Publish

Command API Reference / Input / Output

PublishBatch

Command API Reference / Input / Output

PutDataProtectionPolicy

Command API Reference / Input / Output

RemovePermission

Command API Reference / Input / Output

SetEndpointAttributes

Command API Reference / Input / Output

SetPlatformApplicationAttributes

Command API Reference / Input / Output

SetSMSAttributes

Command API Reference / Input / Output

SetSubscriptionAttributes

Command API Reference / Input / Output

SetTopicAttributes

Command API Reference / Input / Output

Subscribe

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

Unsubscribe

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

VerifySMSSandboxPhoneNumber

Command API Reference / Input / Output

Changelog

3.732.0 (2025-01-21)

Bug Fixes

• middleware-flexible-checksums: skip checksum validation if CRC64NVME dependency is absent (#6835) (7dbc1c9)

Features

• client-cognito-identity-provider: corrects the dual-stack endpoint configuration for cognitoidp (757843c)
• client-connect: Added DeleteContactFlowVersion API and the CAMPAIGN flow type (c6e07aa)
• client-emr-serverless: Increasing entryPoint in SparkSubmit to accept longer script paths. New limit is 4kb. (14a89bc)
• client-iotsitewise: AWS IoT SiteWise now supports ingestion and querying of Null (all data types) and NaN (double type) values of bad or uncertain data quality. New partial error handling prevents data loss during ingestion. Enabled by default for new customers; existing customers can opt-in. (a0e3771)
• client-quicksight: Added DigitGroupingStyle in ThousandsSeparator to allow grouping by LAKH( Indian Grouping system ) currency. Support LAKH and CRORE currency types in Column Formatting. (a009440)
• clients: update client endpoints as of 2025-01-21 (0d212b4)