@aws-lite/sns

0.0.6 • Public • Published

Official aws-lite plugin for SNS

Maintained by: @architect

Install

npm i @aws-lite/sns

Optionally install types:

npm i -D @aws-lite/sns-types

Reference

Reference documentation with examples at aws-lite.org

Methods

Publish

Canonical AWS API doc

Properties:

  • Message (string) [required]
    • Message payload to send
  • MessageAttributes (string)
    • String to MessageAttributeValue object map
  • MessageDeduplicationId (string)
    • Ensures request is idempotent; may only be used for FIFO topics
  • MessageGroupId (string)
    • Tag specifying a specific message group; may only be used for FIFO topics
  • MessageStructure (string)
    • May be set to json publish JSON payloads
  • PhoneNumber (string)
    • SMS recipient phone number in E.164 format; if not specified, you must specify TargetArn or TargetArn
  • Subject (string)
    • Email subject line
  • TargetArn (string)
    • If not specified, you must specify PhoneNumber or TopicArn
  • TopicArn (string)
    • ARN of the the topic to publish to; if not specified, you must specify PhoneNumber or TargetArn

Methods yet to be implemented

Please help out by opening a PR!

Learn more

Readme

Keywords

none

Package Sidebar

Install

npm i @aws-lite/sns

Weekly Downloads

539

Version

0.0.6

License

Apache-2.0

Unpacked Size

12.9 kB

Total Files

4

Last publish

Collaborators

  • brianleroux
  • architectci
  • ryanblock