@aws-lite/sns
v0.0.8
Published
Official `aws-lite` plugin for SNS
Downloads
1,490
Readme
@aws-lite/sns
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
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
- May be set to
PhoneNumber
(string)- SMS recipient phone number in E.164 format; if not specified, you must specify
TargetArn
orTargetArn
- SMS recipient phone number in E.164 format; if not specified, you must specify
Subject
(string)- Email subject line
TargetArn
(string)- If not specified, you must specify
PhoneNumber
orTopicArn
- If not specified, you must specify
TopicArn
(string)- ARN of the the topic to publish to; if not specified, you must specify
PhoneNumber
orTargetArn
- ARN of the the topic to publish to; if not specified, you must specify
Methods yet to be implemented
Please help out by opening a PR!
AddPermission
CheckIfPhoneNumberIsOptedOut
ConfirmSubscription
CreatePlatformApplication
CreatePlatformEndpoint
CreateSMSSandboxPhoneNumber
CreateTopic
DeleteEndpoint
DeletePlatformApplication
DeleteSMSSandboxPhoneNumber
DeleteTopic
GetDataProtectionPolicy
GetEndpointAttributes
GetPlatformApplicationAttributes
GetSMSAttributes
GetSMSSandboxAccountStatus
GetSubscriptionAttributes
GetTopicAttributes
ListEndpointsByPlatformApplication
ListOriginationNumbers
ListPhoneNumbersOptedOut
ListPlatformApplications
ListSMSSandboxPhoneNumbers
ListSubscriptions
ListSubscriptionsByTopic
ListTagsForResource
ListTopics
OptInPhoneNumber
PublishBatch
PutDataProtectionPolicy
RemovePermission
SetEndpointAttributes
SetPlatformApplicationAttributes
SetSMSAttributes
SetSubscriptionAttributes
SetTopicAttributes
Subscribe
TagResource
Unsubscribe
UntagResource
VerifySMSSandboxPhoneNumber