awssns

package
v0.5.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2020 License: BSD-3-Clause Imports: 7 Imported by: 0

README


title: Amazon SNS weight: 4606

Amazon SNS

This activity allows you to send SMS text messages using Amazon Simple Notification Services.

Installation

Flogo Web

This activity comes out of the box with the Flogo Web UI

Flogo CLI

flogo add activity github.com/TIBCOSoftware/flogo-contrib/activity/awssns

Schema

Inputs and Outputs:

{
  "input":[
    {
      "name": "accessKey",
      "type": "string",
      "required": "true"
    },
    {
      "name": "secretKey",
      "type": "string",
      "required": "true"
    },
    {
      "name": "region",
      "type": "string",
      "required": "true",
      "allowed" : ["us-east-2","us-east-1","us-west-1","us-west-2","ap-south-1","ap-northeast-2","ap-southeast-1","ap-southeast-2","ap-northeast-1","cn-northwest-1","ca-central-1","eu-central-1","eu-west-1","eu-west-2","sa-east-1"]
    },
    {
      "name": "smsType",
      "type": "string",
      "allowed" : ["Promotional", "Transactional"],
	  "value": "Promotional"
    },
    {
      "name": "from",
      "type": "string",
      "required": "true"
    },
    {
      "name": "to",
      "type": "string",
      "required": "true"
    },
    {
      "name": "message",
      "type": "string",
      "required": "true"
    }
  ],
  "output": [
    {
      "name": "messageId",
      "type": "string"
    }
  ]
}

Settings

Setting Required Description
accessKey True Your Amazon access key ID
secretKey True Your Amazon secret sccess Key
region True The default AWS region to use. See here for more detailed information on supported regions
smsType True The type of SMS to be sent (This can be either Promotional or Transactional)
from True The Sender ID for the SMS
to True The phone number (in international format) to which to send the SMS
message True The message you want to send
messageId False The unique message ID returned by AWS SNS

Example

Coming soon...

Documentation

Index

Constants

View Source
const (
	ConfAWSAccessKeyID     = "accessKey"
	ConfAWSSecretAccessKey = "secretKey"
	ConfAWSDefaultRegion   = "region"
	ConfSMSType            = "smsType"
	ConfSMSFrom            = "from"
	ConfSMSTo              = "to"
	ConfSMSMessage         = "message"
	OUTMessageID           = "messageId"
)

List of input and output variables names

Variables

This section is empty.

Functions

func NewActivity

func NewActivity(metadata *activity.Metadata) activity.Activity

NewActivity creates a new activity

Types

type AWSSNS

type AWSSNS struct {
	// contains filtered or unexported fields
}

AWSSNS Structure for the AWSNS activity

func (*AWSSNS) Eval

func (a *AWSSNS) Eval(context activity.Context) (done bool, err error)

Eval implements activity.Activity.Eval

func (*AWSSNS) Metadata

func (a *AWSSNS) Metadata() *activity.Metadata

Metadata implements activity.Activity.Metadata

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL