@aws-sdk/client-sns
Advanced tools
AWS SDK for JavaScript Sns Client for Node.js, Browser and React Native
@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.
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: 'example@example.com'
};
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();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.
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.
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.
To install the this package, simply type add or install @aws-sdk/client-sns using your favorite package manager:
npm install @aws-sdk/client-snsyarn add @aws-sdk/client-snspnpm add @aws-sdk/client-snsThe 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";
To send a request, you:
send operation on client with command object as input.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);
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.
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.
});
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.
});
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.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.662.0 (2024-10-01)
FAQs
AWS SDK for JavaScript Sns Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-sns receives a total of 1,121,206 weekly downloads. As such, @aws-sdk/client-sns popularity was classified as popular.
We found that @aws-sdk/client-sns demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.