@datafire/amazonaws_sns

Client library for Amazon Simple Notification Service

Installation and Usage

npm install --save @datafire/amazonaws_sns

let amazonaws_sns = require('@datafire/amazonaws_sns').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_sns.AddPermission({
  "TopicArn": "",
  "Label": "",
  "AWSAccountId": [],
  "ActionName": []
}).then(data => {
  console.log(data);
});

Description

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

Actions

AddPermission

amazonaws_sns.AddPermission({
  "TopicArn": "",
  "Label": "",
  "AWSAccountId": [],
  "ActionName": []
}, context)

Input

• input object
  • AWSAccountId required DelegatesList
  • ActionName required ActionsList
  • Label required label
  • TopicArn required topicARN

Output

Output schema unknown

CheckIfPhoneNumberIsOptedOut

amazonaws_sns.CheckIfPhoneNumberIsOptedOut({
  "phoneNumber": ""
}, context)

Input

• input object
  • phoneNumber required PhoneNumber

Output

• output CheckIfPhoneNumberIsOptedOutResponse

ConfirmSubscription

amazonaws_sns.ConfirmSubscription({
  "TopicArn": "",
  "Token": ""
}, context)

Input

• input object
  • AuthenticateOnUnsubscribe authenticateOnUnsubscribe
  • Token required token
  • TopicArn required topicARN

Output

• output ConfirmSubscriptionResponse

CreatePlatformApplication

amazonaws_sns.CreatePlatformApplication({
  "Name": "",
  "Platform": "",
  "Attributes": []
}, context)

Input

• input object
  • Attributes required MapStringToString
  • Name required String
  • Platform required String

Output

• output CreatePlatformApplicationResponse

CreatePlatformEndpoint

amazonaws_sns.CreatePlatformEndpoint({
  "PlatformApplicationArn": "",
  "Token": ""
}, context)

Input

• input object
  • Attributes MapStringToString
  • CustomUserData String
  • PlatformApplicationArn required String
  • Token required String

Output

• output CreateEndpointResponse

CreateTopic

amazonaws_sns.CreateTopic({
  "Name": ""
}, context)

Input

• input object
  • Name required topicName

Output

• output CreateTopicResponse

DeleteEndpoint

amazonaws_sns.DeleteEndpoint({
  "EndpointArn": ""
}, context)

Input

• input object
  • EndpointArn required String

Output

Output schema unknown

DeletePlatformApplication

amazonaws_sns.DeletePlatformApplication({
  "PlatformApplicationArn": ""
}, context)

Input

• input object
  • PlatformApplicationArn required String

Output

Output schema unknown

DeleteTopic

amazonaws_sns.DeleteTopic({
  "TopicArn": ""
}, context)

Input

• input object
  • TopicArn required topicARN

Output

Output schema unknown

GetEndpointAttributes

amazonaws_sns.GetEndpointAttributes({
  "EndpointArn": ""
}, context)

Input

• input object
  • EndpointArn required String

Output

• output GetEndpointAttributesResponse

GetPlatformApplicationAttributes

amazonaws_sns.GetPlatformApplicationAttributes({
  "PlatformApplicationArn": ""
}, context)

Input

• input object
  • PlatformApplicationArn required String

Output

• output GetPlatformApplicationAttributesResponse

GetSMSAttributes

amazonaws_sns.GetSMSAttributes({}, context)

Input

• input object
  • attributes ListString

Output

• output GetSMSAttributesResponse

GetSubscriptionAttributes

amazonaws_sns.GetSubscriptionAttributes({
  "SubscriptionArn": ""
}, context)

Input

• input object
  • SubscriptionArn required subscriptionARN

Output

• output GetSubscriptionAttributesResponse

GetTopicAttributes

amazonaws_sns.GetTopicAttributes({
  "TopicArn": ""
}, context)

Input

• input object
  • TopicArn required topicARN

Output

• output GetTopicAttributesResponse

ListEndpointsByPlatformApplication

amazonaws_sns.ListEndpointsByPlatformApplication({
  "PlatformApplicationArn": ""
}, context)

Input

• input object
  • NextToken string
  • NextToken String
  • PlatformApplicationArn required String

Output

• output ListEndpointsByPlatformApplicationResponse

ListPhoneNumbersOptedOut

amazonaws_sns.ListPhoneNumbersOptedOut({}, context)

Input

• input object
  • nextToken string

Output

• output ListPhoneNumbersOptedOutResponse

ListPlatformApplications

amazonaws_sns.ListPlatformApplications({}, context)

Input

• input object
  • NextToken string
  • NextToken String

Output

• output ListPlatformApplicationsResponse

ListSubscriptions

amazonaws_sns.ListSubscriptions({}, context)

Input

• input object
  • NextToken string
  • NextToken nextToken

Output

• output ListSubscriptionsResponse

ListSubscriptionsByTopic

amazonaws_sns.ListSubscriptionsByTopic({
  "TopicArn": ""
}, context)

Input

• input object
  • NextToken string
  • NextToken nextToken
  • TopicArn required topicARN

Output

• output ListSubscriptionsByTopicResponse

ListTopics

amazonaws_sns.ListTopics({}, context)

Input

• input object
  • NextToken string
  • NextToken nextToken

Output

• output ListTopicsResponse

OptInPhoneNumber

amazonaws_sns.OptInPhoneNumber({
  "phoneNumber": ""
}, context)

Input

• input object
  • phoneNumber required PhoneNumber

Output

• output OptInPhoneNumberResponse

Publish

amazonaws_sns.Publish({
  "Message": ""
}, context)

Input

• input object
  • Message required message
  • MessageAttributes MessageAttributeMap
  • MessageStructure messageStructure
  • PhoneNumber String
  • Subject subject
  • TargetArn String
  • TopicArn topicARN

Output

• output PublishResponse

RemovePermission

amazonaws_sns.RemovePermission({
  "TopicArn": "",
  "Label": ""
}, context)

Input

• input object
  • Label required label
  • TopicArn required topicARN

Output

Output schema unknown

SetEndpointAttributes

amazonaws_sns.SetEndpointAttributes({
  "EndpointArn": "",
  "Attributes": []
}, context)

Input

• input object
  • Attributes required MapStringToString
  • EndpointArn required String

Output

Output schema unknown

SetPlatformApplicationAttributes

amazonaws_sns.SetPlatformApplicationAttributes({
  "PlatformApplicationArn": "",
  "Attributes": []
}, context)

Input

• input object
  • Attributes required MapStringToString
  • PlatformApplicationArn required String

Output

Output schema unknown

SetSMSAttributes

amazonaws_sns.SetSMSAttributes({
  "attributes": []
}, context)

Input

• input object
  • attributes required MapStringToString

Output

• output SetSMSAttributesResponse

SetSubscriptionAttributes

amazonaws_sns.SetSubscriptionAttributes({
  "SubscriptionArn": "",
  "AttributeName": ""
}, context)

Input

• input object
  • AttributeName required attributeName
  • AttributeValue attributeValue
  • SubscriptionArn required subscriptionARN

Output

Output schema unknown

SetTopicAttributes

amazonaws_sns.SetTopicAttributes({
  "TopicArn": "",
  "AttributeName": ""
}, context)

Input

• input object
  • AttributeName required attributeName
  • AttributeValue attributeValue
  • TopicArn required topicARN

Output

Output schema unknown

Subscribe

amazonaws_sns.Subscribe({
  "TopicArn": "",
  "Protocol": ""
}, context)

Input

• input object
  • Endpoint endpoint
  • Protocol required protocol
  • TopicArn required topicARN

Output

• output SubscribeResponse

Unsubscribe

amazonaws_sns.Unsubscribe({
  "SubscriptionArn": ""
}, context)

Input

• input object
  • SubscriptionArn required subscriptionARN

Output

Output schema unknown

Definitions

ActionsList

• ActionsList array
  • items action

AddPermissionInput

• AddPermissionInput object
  • AWSAccountId required DelegatesList
  • ActionName required ActionsList
  • Label required label
  • TopicArn required topicARN

AuthorizationErrorException

• AuthorizationErrorException object: Indicates that the user has been denied access to the requested resource.
  • message string

Binary

• Binary string

CheckIfPhoneNumberIsOptedOutInput

• CheckIfPhoneNumberIsOptedOutInput object: The input for the CheckIfPhoneNumberIsOptedOut action.
  • phoneNumber required PhoneNumber

CheckIfPhoneNumberIsOptedOutResponse

• CheckIfPhoneNumberIsOptedOutResponse object: The response from the CheckIfPhoneNumberIsOptedOut action.
  • isOptedOut boolean

ConfirmSubscriptionInput

• ConfirmSubscriptionInput object: Input for ConfirmSubscription action.
  • AuthenticateOnUnsubscribe authenticateOnUnsubscribe
  • Token required token
  • TopicArn required topicARN

ConfirmSubscriptionResponse

• ConfirmSubscriptionResponse object: Response for ConfirmSubscriptions action.
  • SubscriptionArn subscriptionARN

CreateEndpointResponse

• CreateEndpointResponse object: Response from CreateEndpoint action.
  • EndpointArn String

CreatePlatformApplicationInput

• CreatePlatformApplicationInput object: Input for CreatePlatformApplication action.
  • Attributes required MapStringToString
  • Name required String
  • Platform required String

CreatePlatformApplicationResponse

• CreatePlatformApplicationResponse object: Response from CreatePlatformApplication action.
  • PlatformApplicationArn String

CreatePlatformEndpointInput

• CreatePlatformEndpointInput object: Input for CreatePlatformEndpoint action.
  • Attributes MapStringToString
  • CustomUserData String
  • PlatformApplicationArn required String
  • Token required String

CreateTopicInput

• CreateTopicInput object: Input for CreateTopic action.
  • Name required topicName

CreateTopicResponse

• CreateTopicResponse object: Response from CreateTopic action.
  • TopicArn topicARN

DelegatesList

• DelegatesList array
  • items delegate

DeleteEndpointInput

• DeleteEndpointInput object: Input for DeleteEndpoint action.
  • EndpointArn required String

DeletePlatformApplicationInput

• DeletePlatformApplicationInput object: Input for DeletePlatformApplication action.
  • PlatformApplicationArn required String

DeleteTopicInput

• DeleteTopicInput object
  • TopicArn required topicARN

Endpoint

• Endpoint object: Endpoint for mobile app and device.
  • Attributes MapStringToString
  • EndpointArn String

EndpointDisabledException

• EndpointDisabledException object: Exception error indicating endpoint disabled.
  • message string

GetEndpointAttributesInput

• GetEndpointAttributesInput object: Input for GetEndpointAttributes action.
  • EndpointArn required String

GetEndpointAttributesResponse

• GetEndpointAttributesResponse object: Response from GetEndpointAttributes of the EndpointArn.
  • Attributes MapStringToString

GetPlatformApplicationAttributesInput

• GetPlatformApplicationAttributesInput object: Input for GetPlatformApplicationAttributes action.
  • PlatformApplicationArn required String

GetPlatformApplicationAttributesResponse

• GetPlatformApplicationAttributesResponse object: Response for GetPlatformApplicationAttributes action.
  • Attributes MapStringToString

GetSMSAttributesInput

• GetSMSAttributesInput object: The input for the GetSMSAttributes request.
  • attributes ListString

GetSMSAttributesResponse

• GetSMSAttributesResponse object: The response from the GetSMSAttributes request.
  • attributes MapStringToString

GetSubscriptionAttributesInput

• GetSubscriptionAttributesInput object: Input for GetSubscriptionAttributes.
  • SubscriptionArn required subscriptionARN

GetSubscriptionAttributesResponse

• GetSubscriptionAttributesResponse object: Response for GetSubscriptionAttributes action.
  • Attributes SubscriptionAttributesMap

GetTopicAttributesInput

• GetTopicAttributesInput object: Input for GetTopicAttributes action.
  • TopicArn required topicARN

GetTopicAttributesResponse

• GetTopicAttributesResponse object: Response for GetTopicAttributes action.
  • Attributes TopicAttributesMap

InternalErrorException

• InternalErrorException object: Indicates an internal service error.
  • message string

InvalidParameterException

• InvalidParameterException object: Indicates that a request parameter does not comply with the associated constraints.
  • message string

InvalidParameterValueException

• InvalidParameterValueException object: Indicates that a request parameter does not comply with the associated constraints.
  • message string

ListEndpointsByPlatformApplicationInput

• ListEndpointsByPlatformApplicationInput object: Input for ListEndpointsByPlatformApplication action.
  • NextToken String
  • PlatformApplicationArn required String

ListEndpointsByPlatformApplicationResponse

• ListEndpointsByPlatformApplicationResponse object: Response for ListEndpointsByPlatformApplication action.
  • Endpoints ListOfEndpoints
  • NextToken String

ListOfEndpoints

• ListOfEndpoints array
  • items Endpoint

ListOfPlatformApplications

• ListOfPlatformApplications array
  • items PlatformApplication

ListPhoneNumbersOptedOutInput

• ListPhoneNumbersOptedOutInput object: The input for the ListPhoneNumbersOptedOut action.
  • nextToken string

ListPhoneNumbersOptedOutResponse

• ListPhoneNumbersOptedOutResponse object: The response from the ListPhoneNumbersOptedOut action.
  • nextToken string
  • phoneNumbers PhoneNumberList

ListPlatformApplicationsInput

• ListPlatformApplicationsInput object: Input for ListPlatformApplications action.
  • NextToken String

ListPlatformApplicationsResponse

• ListPlatformApplicationsResponse object: Response for ListPlatformApplications action.
  • NextToken String
  • PlatformApplications ListOfPlatformApplications

ListString

• ListString array
  • items String

ListSubscriptionsByTopicInput

• ListSubscriptionsByTopicInput object: Input for ListSubscriptionsByTopic action.
  • NextToken nextToken
  • TopicArn required topicARN

ListSubscriptionsByTopicResponse

• ListSubscriptionsByTopicResponse object: Response for ListSubscriptionsByTopic action.
  • NextToken nextToken
  • Subscriptions SubscriptionsList

ListSubscriptionsInput

• ListSubscriptionsInput object: Input for ListSubscriptions action.
  • NextToken nextToken

ListSubscriptionsResponse

• ListSubscriptionsResponse object: Response for ListSubscriptions action
  • NextToken nextToken
  • Subscriptions SubscriptionsList

ListTopicsInput

• ListTopicsInput object
  • NextToken nextToken

ListTopicsResponse

• ListTopicsResponse object: Response for ListTopics action.
  • NextToken nextToken
  • Topics TopicsList

MapStringToString

• MapStringToString array
  • items object
    • key String
    • value String

MessageAttributeMap

• MessageAttributeMap array
  • items object
    • key String
    • value MessageAttributeValue

MessageAttributeValue

• MessageAttributeValue object:

  The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

  Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.

  • BinaryValue Binary
  • DataType required String
  • StringValue String

NotFoundException

• NotFoundException object: Indicates that the requested resource does not exist.
  • message string

OptInPhoneNumberInput

• OptInPhoneNumberInput object: Input for the OptInPhoneNumber action.
  • phoneNumber required PhoneNumber

OptInPhoneNumberResponse

• OptInPhoneNumberResponse object: The response for the OptInPhoneNumber action.

PhoneNumber

• PhoneNumber string

PhoneNumberList

• PhoneNumberList array
  • items PhoneNumber

PlatformApplication

• PlatformApplication object: Platform application object.
  • Attributes MapStringToString
  • PlatformApplicationArn String

PlatformApplicationDisabledException

• PlatformApplicationDisabledException object: Exception error indicating platform application disabled.
  • message string

PublishInput

• PublishInput object: Input for Publish action.
  • Message required message
  • MessageAttributes MessageAttributeMap
  • MessageStructure messageStructure
  • PhoneNumber String
  • Subject subject
  • TargetArn String
  • TopicArn topicARN

PublishResponse

• PublishResponse object: Response for Publish action.
  • MessageId messageId

RemovePermissionInput

• RemovePermissionInput object: Input for RemovePermission action.
  • Label required label
  • TopicArn required topicARN

SetEndpointAttributesInput

• SetEndpointAttributesInput object: Input for SetEndpointAttributes action.
  • Attributes required MapStringToString
  • EndpointArn required String

SetPlatformApplicationAttributesInput

• SetPlatformApplicationAttributesInput object: Input for SetPlatformApplicationAttributes action.
  • Attributes required MapStringToString
  • PlatformApplicationArn required String

SetSMSAttributesInput

• SetSMSAttributesInput object: The input for the SetSMSAttributes action.
  • attributes required MapStringToString

SetSMSAttributesResponse

• SetSMSAttributesResponse object: The response for the SetSMSAttributes action.

SetSubscriptionAttributesInput

• SetSubscriptionAttributesInput object: Input for SetSubscriptionAttributes action.
  • AttributeName required attributeName
  • AttributeValue attributeValue
  • SubscriptionArn required subscriptionARN

SetTopicAttributesInput

• SetTopicAttributesInput object: Input for SetTopicAttributes action.
  • AttributeName required attributeName
  • AttributeValue attributeValue
  • TopicArn required topicARN

String

• String string

SubscribeInput

• SubscribeInput object: Input for Subscribe action.
  • Endpoint endpoint
  • Protocol required protocol
  • TopicArn required topicARN

SubscribeResponse

• SubscribeResponse object: Response for Subscribe action.
  • SubscriptionArn subscriptionARN

Subscription

• Subscription object: A wrapper type for the attributes of an Amazon SNS subscription.
  • Endpoint endpoint
  • Owner account
  • Protocol protocol
  • SubscriptionArn subscriptionARN
  • TopicArn topicARN

SubscriptionAttributesMap

• SubscriptionAttributesMap array
  • items object
    • key attributeName
    • value attributeValue

SubscriptionLimitExceededException

• SubscriptionLimitExceededException object: Indicates that the customer already owns the maximum allowed number of subscriptions.
  • message string

SubscriptionsList

• SubscriptionsList array
  • items Subscription

ThrottledException

• ThrottledException object: Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
  • message string

Topic

• Topic object: A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
  • TopicArn topicARN

TopicAttributesMap

• TopicAttributesMap array
  • items object
    • key attributeName
    • value attributeValue

TopicLimitExceededException

• TopicLimitExceededException object: Indicates that the customer already owns the maximum allowed number of topics.
  • message string

TopicsList

• TopicsList array
  • items Topic

UnsubscribeInput

• UnsubscribeInput object: Input for Unsubscribe action.
  • SubscriptionArn required subscriptionARN

account

• account string

action

• action string

attributeName

• attributeName string

attributeValue

• attributeValue string

authenticateOnUnsubscribe

• authenticateOnUnsubscribe string

boolean

• boolean boolean

delegate

• delegate string

endpoint

• endpoint string

label

• label string

message

• message string

messageId

• messageId string

messageStructure

• messageStructure string

nextToken

• nextToken string

protocol

• protocol string

string

• string string

subject

• subject string

subscriptionARN

• subscriptionARN string

token

• token string

topicARN

• topicARN string

topicName

• topicName string