@aws-sdk/client-sns-browser

Description

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 https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see 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 the this package using NPM, simply type the following into a terminal window:

npm install @aws-sdk/client-sns-browser

Getting Started

Import

The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(SNSClient) and the commands you need, for example AddPermissionCommand:

//JavaScript
const { SNSClient } = require("@aws-sdk/client-sns-browser/SNSClient");
const {
  AddPermissionCommand
} = require("@aws-sdk/client-sns-browser/commands/AddPermissionCommand");

//TypeScript
import { SNSClient } from "@aws-sdk/client-sns-browser/SNSClient";
import { AddPermissionCommand } from "@aws-sdk/client-sns-browser/commands/AddPermissionCommand";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region). For more information you can refer to the API reference.
• 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.

const sNS = new SNSClient({region: 'region'});
//clients can be shared by different commands
const params = {
  TopicArn: /**a string value*/,
  Label: /**a string value*/,
  AWSAccountId: [ /**a list of string*/ ],
  ActionName: [ /**a list of string*/ ],
};
const addPermissionCommand = new AddPermissionCommand(params);
sNS.send(addPermissionCommand).then(data => {
    // do something
}).catch(error => {
    // error handling
})

In addition to using promises, there are 2 other ways to send a request:

// async/await
try {
  const data = await sNS.send(addPermissionCommand);
  // do something
} catch (error) {
  // error handling
}

// callback
sNS.send(addPermissionCommand, (err, data) => {
  //do something
});

The SDK can also send requests using the simplified callback style from version 2 of the SDK.

import * as AWS from "@aws-sdk/@aws-sdk/client-sns-browser/SNS";
const sNS = new AWS.SNS({ region: "region" });
sNS.addPermission(params, (err, data) => {
  //do something
});

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 sNS.send(addPermissionCommand);
  // do something
} catch (error) {
  const metadata = error.$metadata;
  console.log(
    `requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.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 and have limited bandwidth to address them.

• Ask a question on StackOverflow and tag it with aws-sdk-js
• Come join the AWS JavaScript community on gitter
• If it turns out that you may have found a bug, please open an issue

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-sns-browser' package is updated. To contribute to SDK you can checkout our code generator package.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.