Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

TypeScript environment for Amazon Simple Notification Service (SNS) examples

This is a workspace where you can find working AWS SDK for JavaScript version 3 (v3) Amazon SNS examples.

The preview version of the AWS SDK for JavaScript v3 is available.

The AWS SDK for JavaScript v3 Developer Guide contains these examples.

Amazon SNS is a fully managed messaging service for both system-to-system and app-to-person (A2P) communication.

NOTE: The AWS SDK for JavaScript v3 is written in TypeScript so, for consistency, these examples are also in TypeScript. TypeScript extends of JavaScript so these examples can also be run as JavaScript. For more information, see TypeScript homepage.

Getting started

  1. Clone the AWS SDK Code Samples repo to your local environment. See the Github documentation for instructions.

  2. Install the dependencies listed in the package.json.

Note: These include the client module for the AWS services required in these example, which is "@aws-sdk/client-sns".

npm install ts-node -g // If using JavaScript, enter 'npm install node -g' instead
cd javascriptv3/example_code/sns
npm install
  1. If you're using JavaScript, change the sample file extension from .ts to .js.

  2. In your text editor, update user variables specified in the Inputs section of the sample file.

  3. Run sample code:

cd src
ts-node [example name].ts // e.g., ts-node sns_checkphoneoptout.ts