Amazon Simple Notification Service (Amazon SNS) is a web service that enables you\nto build distributed web-enabled applications. Applications can use Amazon SNS to easily push\nreal-time notification messages to interested subscribers over multiple delivery\nprotocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features\nand their associated API calls, see the Amazon SNS Developer Guide.
\nFor information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer\nGuide.\n
\nWe also provide SDKs that enable you to access Amazon SNS from your preferred programming\nlanguage. The SDKs contain functionality that automatically takes care of tasks such as:\ncryptographically signing your service requests, retrying requests, and handling error\nresponses. For a list of available SDKs, go to Tools for Amazon Web Services.
\n\n## Installing\nTo install this package, simply type add or install @aws-sdk/client-sns\nusing your favorite package manager:\n- `npm install @aws-sdk/client-sns`\n- `yarn add @aws-sdk/client-sns`\n- `pnpm add @aws-sdk/client-sns`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `SNSClient` and\nthe commands you need, for example `ListTopicsCommand`:\n\n```js\n// ES5 example\nconst { SNSClient, ListTopicsCommand } = require(\"@aws-sdk/client-sns\");\n```\n\n```ts\n// ES6+ example\nimport { SNSClient, ListTopicsCommand } from \"@aws-sdk/client-sns\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region).\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```js\n// a client can be shared by different commands.\nconst client = new SNSClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new ListTopicsCommand(params);\n```\n\n#### Async/await\n\nWe recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\nAsync-await is clean, concise, intuitive, easy to debug and has better error handling\nas compared to using Promise chains or callbacks.\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)\nto execute send operation.\n\n```js\nclient.send(command).then(\n (data) => {\n // process data.\n },\n (error) => {\n // error handling.\n }\n);\n```\n\nPromises can also be called using `.catch()` and `.finally()` as follows:\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Callbacks\n\nWe do not recommend using callbacks because of [callback hell](http://callbackhell.com/),\nbut they are supported by the send operation.\n\n```js\n// callbacks.\nclient.send(command, (err, data) => {\n // process err and data.\n});\n```\n\n#### v2 compatible style\n\nThe client can also send requests using v2 compatible style.\nHowever, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post\non [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)\n\n```ts\nimport * as AWS from \"@aws-sdk/client-sns\";\nconst client = new AWS.SNS({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.listTopics(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .listTopics(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks.\nclient.listTopics(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-sns` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n