Skip to main content

Amazon SNS Component

Manage subscriptions, topics, and messages within Amazon (AWS) SNS

Component key: aws-sns

Description#

Amazon SNS is a service for both application-to-application (A2A) and application-to-person (A2P) communication. The Amazon SNS component allows you to interact with an SNS Topic.

Authorization Methods#

Amazon SNS requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

An AWS IAM access key pair is required to interact with Amazon SNS. The AWS access_key_id serves as the API Key, and the secret_access_key serves as the API Secret. Make sure that the key pair you generate in AWS has proper permissions to the SNS resources you want to access.

Actions#

Create Topic#

Create an Amazon SNS Topic | key: createTopic

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Name

string
/ Required
name

Output Example Payload#

{  "data": {    "TopicArn": "arn:aws:Example Topic Arn"  }}

Delete Topic#

Delete an Amazon SNS Topic | key: deleteTopic

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Topic Arn

string
/ Required
topicArn

Get Topic Attributes#

Retrieves the attributes of an Amazon SNS Topic. | key: getTopicAttributes

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Topic Arn

string
/ Required
topicArn

Output Example Payload#

{  "data": {    "Attributes": {      "Policy": "Example Policy",      "Owner": "Example Owner",      "topicArn": "arn:aws:Example Topic Arn",      "SubscriptionsPending": "0",      "EffectiveDeliveryPolicy": "Example Delivery Policy",      "SubscriptionsConfirmed": "1",      "DisplayName": "Example Display Name",      "SubscriptionsDeleted": "5"    }  }}

List Opt Out Numbers#

Create an Amazon SNS Topic | key: listOptOutNumbers

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Output Example Payload#

{  "data": {    "phoneNumbers": [      "15556164096",      "18980994152",      "18008988422"    ]  }}

List Subscriptions#

Retrieve the subscriptions of an Amazon SNS Topic | key: listSubscriptions

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Topic Arn

string
/ Required
topicArn

Output Example Payload#

{  "data": {    "Subscriptions": [      {        "SubscriptionArn": "arn:aws:Example Subscription Arn",        "Owner": "example_owner",        "Protocol": "EMAIL",        "Endpoint": "admin@example.io"      }    ]  }}

List Topics#

List available Amazon SNS Topics | key: listTopics

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Output Example Payload#

{  "data": {    "Topics": [      {        "TopicArn": "arn:aws:Example Topic Arn"      }    ]  }}

Publish Message#

Publish a message to an Amazon SNS Topic | key: publishMessage

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Message

string
/ Required
message

Topic Arn

string
/ Required
topicArn

Output Example Payload#

{  "data": {    "MessageId": "Example Message Id"  }}

Publish SMS#

Publish an SMS message to an Amazon SNS Topic | key: publishSms

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Message

string
/ Required
message

Phone Number

string
/ Required
phoneNumber12345678901

Output Example Payload#

{  "data": {    "MessageId": "Example Message Id"  }}

Subscribe to Topic#

Subscribe to an Amazon SNS Topic | key: subscribe

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Endpoint

string
/ Required
endpointexample@prismatic.io

protocol

string
/ Required
protocolEMAILEMAIL

Topic Arn

string
/ Required
topicArn

Output Example Payload#

{  "data": {    "SubscriptionArn": "Example SubscriptionArn"  }}

Unsubscribe from a Topic#

Unsubscribe from an Amazon SNS Topic | key: unsubscribe

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your bucket(s) are stored.us-east-1

Subscription Arn

string
/ Required
subscriptionArn1234567890