Adapter - Amazon Notification
This page describes version 2.0.9 of the adapter.
Overview
This adapter uses the Amazon Web Service Simple Notification Service API (Amazon SNS) to send text messages (SMS) to mobile devices or Topic messages to preconfigured, email addresses, SMS addresses, or to other AWS services.
A valid AWS account is needed to use this adapter. To use the sendTopicMessage a topic must be pre-configured. Please refer to Amazon's Documentation for help configuring a topic and information about Amazon's SNS API.
Configuration
All of the Amazon adapters, require a region, accessKey and secretKey. The regions list can be in Amazon's documentation. The accessKey and secretKey are accessed by logging in to your amazon account.
Accessing Secret Key
The secretKey can only be accessed once, directly after the accessKey and secretKey are generated.
Properties
| Name | Display | Is Required | Comments | Type | Default Value | Maximum Value | Minimum Value | Maximum Length | Minimum Length |
|---|---|---|---|---|---|---|---|---|---|
| region | Region | True | The Amazon (AWS) region to run the commands on. | string | us-west-1 | 1024 | 1 | ||
| accessKey | Access Key | True | The Amazon account's Access Key. | password | 1024 | 1 | |||
| secretKey | Secret Key | True | The Amazon account's Secret Key. | password | 1024 | 1 | |||
| roleArn | Role ARN | False | The optional role ARN to assume. | string | 2048 | 1 | |||
| externalId | External ID | False | The external id to pass if assuming a role. | password | 1024 | 1 |
Commands
Send Text Message (sendTextMessage)
Send a text message through Amazon's notification service.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| phoneNumber | Phone Number | The phone number to send the text message to, country code is needed before phone number. | True | string |
| message | Message | The content of the text message. | True | string |
| messageType | Message Type (Promotional/Transactional) | Promotional - Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. Transactional - Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| messageId | The message Id of the message, this is returned from Amazon. | string |
Send Topic Message (sendTopicMessage)
Sends a message to a topic through Amazon's notification service.
Request Properties
| Name | Display | Description | Is Required | Type |
|---|---|---|---|---|
| subject | Subject | The subject of the message to send to the Topic. | True | string |
| message | Message | The content of the message to send to the Topic. | True | string |
| topicName | Topic Name | The name of the topic to deliver the message to. | True | string |
| messageType | Message Type (Promotional/Transactional) | Promotional - Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost. Transactional - Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability. | True | string |
Response Properties
| Name | Description | Type |
|---|---|---|
| messageId | The message Id of the message, this is returned from Amazon. | string |
| status | The general status of the executed command. Typically a success or failure message. | string |
Release History
| Version | Type | Description | Tracking # | Date |
|---|---|---|---|---|
| 2.0.1 | Initial | First release in the Adapter Type store. | ||
| 2.0.2 | Feature | Add MessageType Field to Commands | NAP-12409 | |
| 2.0.4 | Maintenance | Updated third-party components and improved maintainability. | NAP-11518 | |
| 2.0.5 | Maintenance | Updated third-party components and improved maintainability. | NAP-23945 | 2022-11-29 |