Client library for Amazon Simple Notification Service
npm install --save @datafire/amazonaws_sns
let amazonaws_sns = require('@datafire/amazonaws_sns').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
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 https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in 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.
amazonaws_sns.AddPermission({
"TopicArn": "",
"Label": "",
"AWSAccountId": [],
"ActionName": []
}, context)
- input
object
- TopicArn required
string
- Label required
string
- AWSAccountId required
array
- ActionName required
array
- TopicArn required
Output schema unknown
amazonaws_sns.AddPermission({
"TopicArn": null,
"Label": null,
"AWSAccountId": null,
"ActionName": null
}, context)
- input
object
Output schema unknown
amazonaws_sns.CheckIfPhoneNumberIsOptedOut({
"phoneNumber": ""
}, context)
- input
object
- phoneNumber required
string
- phoneNumber required
amazonaws_sns.CheckIfPhoneNumberIsOptedOut({
"phoneNumber": null
}, context)
- input
object
- phoneNumber required
amazonaws_sns.ConfirmSubscription({
"TopicArn": "",
"Token": ""
}, context)
- input
object
- TopicArn required
string
- Token required
string
- AuthenticateOnUnsubscribe
string
- TopicArn required
- output ConfirmSubscriptionResponse
amazonaws_sns.ConfirmSubscription({
"TopicArn": null,
"Token": null
}, context)
- input
object
- AuthenticateOnUnsubscribe
- Token required
- TopicArn required
- output ConfirmSubscriptionResponse
amazonaws_sns.CreatePlatformApplication({
"Name": "",
"Platform": "",
"Attributes": {}
}, context)
- input
object
- Name required
string
- Platform required
string
- Attributes required
object
- Name required
amazonaws_sns.CreatePlatformApplication({
"Name": null,
"Platform": null,
"Attributes": null
}, context)
- input
object
- Attributes required
- Name required
- Platform required
amazonaws_sns.CreatePlatformEndpoint({
"PlatformApplicationArn": "",
"Token": ""
}, context)
- input
object
- PlatformApplicationArn required
string
- Token required
string
- CustomUserData
string
- Attributes
object
- PlatformApplicationArn required
- output CreateEndpointResponse
amazonaws_sns.CreatePlatformEndpoint({
"PlatformApplicationArn": null,
"Token": null
}, context)
- input
object
- Attributes
- CustomUserData
- PlatformApplicationArn required
- Token required
- output CreateEndpointResponse
amazonaws_sns.CreateTopic({
"Name": ""
}, context)
- input
object
- Name required
string
- Attributes
object
- Tags
array
- Name required
- output CreateTopicResponse
amazonaws_sns.CreateTopic({
"Name": null
}, context)
- input
object
- Attributes
- Name required
- Tags
- items Tag
- output CreateTopicResponse
amazonaws_sns.DeleteEndpoint({
"EndpointArn": ""
}, context)
- input
object
- EndpointArn required
string
- EndpointArn required
Output schema unknown
amazonaws_sns.DeleteEndpoint({
"EndpointArn": null
}, context)
- input
object
- EndpointArn required
Output schema unknown
amazonaws_sns.DeletePlatformApplication({
"PlatformApplicationArn": ""
}, context)
- input
object
- PlatformApplicationArn required
string
- PlatformApplicationArn required
Output schema unknown
amazonaws_sns.DeletePlatformApplication({
"PlatformApplicationArn": null
}, context)
- input
object
- PlatformApplicationArn required
Output schema unknown
amazonaws_sns.DeleteTopic({
"TopicArn": ""
}, context)
- input
object
- TopicArn required
string
- TopicArn required
Output schema unknown
amazonaws_sns.DeleteTopic({
"TopicArn": null
}, context)
- input
object
- TopicArn required
Output schema unknown
amazonaws_sns.GetEndpointAttributes({
"EndpointArn": ""
}, context)
- input
object
- EndpointArn required
string
- EndpointArn required
amazonaws_sns.GetEndpointAttributes({
"EndpointArn": null
}, context)
- input
object
- EndpointArn required
amazonaws_sns.GetPlatformApplicationAttributes({
"PlatformApplicationArn": ""
}, context)
- input
object
- PlatformApplicationArn required
string
- PlatformApplicationArn required
amazonaws_sns.GetPlatformApplicationAttributes({
"PlatformApplicationArn": null
}, context)
- input
object
- PlatformApplicationArn required
amazonaws_sns.GetSMSAttributes({}, context)
- input
object
- attributes
array
- attributes
- output GetSMSAttributesResponse
amazonaws_sns.GetSMSAttributes({}, context)
- input
object
- attributes
- items String
- attributes
- output GetSMSAttributesResponse
amazonaws_sns.GetSubscriptionAttributes({
"SubscriptionArn": ""
}, context)
- input
object
- SubscriptionArn required
string
- SubscriptionArn required
amazonaws_sns.GetSubscriptionAttributes({
"SubscriptionArn": null
}, context)
- input
object
- SubscriptionArn required
amazonaws_sns.GetTopicAttributes({
"TopicArn": ""
}, context)
- input
object
- TopicArn required
string
- TopicArn required
- output GetTopicAttributesResponse
amazonaws_sns.GetTopicAttributes({
"TopicArn": null
}, context)
- input
object
- TopicArn required
- output GetTopicAttributesResponse
amazonaws_sns.ListEndpointsByPlatformApplication({
"PlatformApplicationArn": ""
}, context)
- input
object
- PlatformApplicationArn required
string
- NextToken
string
- PlatformApplicationArn required
amazonaws_sns.ListEndpointsByPlatformApplication({
"PlatformApplicationArn": null
}, context)
- input
object
- NextToken
string
- NextToken
- PlatformApplicationArn required
- NextToken
amazonaws_sns.ListPhoneNumbersOptedOut({}, context)
- input
object
- nextToken
string
- nextToken
amazonaws_sns.ListPhoneNumbersOptedOut({}, context)
- input
object
- nextToken
amazonaws_sns.ListPlatformApplications({}, context)
- input
object
- NextToken
string
- NextToken
amazonaws_sns.ListPlatformApplications({}, context)
- input
object
- NextToken
string
- NextToken
- NextToken
amazonaws_sns.ListSubscriptions({}, context)
- input
object
- NextToken
string
- NextToken
- output ListSubscriptionsResponse
amazonaws_sns.ListSubscriptions({}, context)
- input
object
- NextToken
string
- NextToken
- NextToken
- output ListSubscriptionsResponse
amazonaws_sns.ListSubscriptionsByTopic({
"TopicArn": ""
}, context)
- input
object
- TopicArn required
string
- NextToken
string
- TopicArn required
amazonaws_sns.ListSubscriptionsByTopic({
"TopicArn": null
}, context)
- input
object
- NextToken
string
- NextToken
- TopicArn required
- NextToken
amazonaws_sns.ListTagsForResource({
"ResourceArn": ""
}, context)
- input
object
- ResourceArn required
string
- ResourceArn required
- output ListTagsForResourceResponse
amazonaws_sns.ListTagsForResource({
"ResourceArn": null
}, context)
- input
object
- ResourceArn required
- output ListTagsForResourceResponse
amazonaws_sns.ListTopics({}, context)
- input
object
- NextToken
string
- NextToken
- output ListTopicsResponse
amazonaws_sns.ListTopics({}, context)
- input
object
- NextToken
string
- NextToken
- NextToken
- output ListTopicsResponse
amazonaws_sns.OptInPhoneNumber({
"phoneNumber": ""
}, context)
- input
object
- phoneNumber required
string
- phoneNumber required
- output OptInPhoneNumberResponse
amazonaws_sns.OptInPhoneNumber({
"phoneNumber": null
}, context)
- input
object
- phoneNumber required
- output OptInPhoneNumberResponse
amazonaws_sns.Publish({
"Message": ""
}, context)
- input
object
- TopicArn
string
- TargetArn
string
- PhoneNumber
string
- Message required
string
- Subject
string
- MessageStructure
string
- MessageAttributes
object
- MessageDeduplicationId
string
- MessageGroupId
string
- TopicArn
- output PublishResponse
amazonaws_sns.Publish({
"Message": null
}, context)
- input
object
- Message required
- MessageAttributes
- MessageDeduplicationId
- MessageGroupId
- MessageStructure
- PhoneNumber
- Subject
- TargetArn
- TopicArn
- output PublishResponse
amazonaws_sns.RemovePermission({
"TopicArn": "",
"Label": ""
}, context)
- input
object
- TopicArn required
string
- Label required
string
- TopicArn required
Output schema unknown
amazonaws_sns.RemovePermission({
"TopicArn": null,
"Label": null
}, context)
- input
object
- Label required
- TopicArn required
Output schema unknown
amazonaws_sns.SetEndpointAttributes({
"EndpointArn": "",
"Attributes": {}
}, context)
- input
object
- EndpointArn required
string
- Attributes required
object
- EndpointArn required
Output schema unknown
amazonaws_sns.SetEndpointAttributes({
"EndpointArn": null,
"Attributes": null
}, context)
- input
object
- Attributes required
- EndpointArn required
Output schema unknown
amazonaws_sns.SetPlatformApplicationAttributes({
"PlatformApplicationArn": "",
"Attributes": {}
}, context)
- input
object
- PlatformApplicationArn required
string
- Attributes required
object
- PlatformApplicationArn required
Output schema unknown
amazonaws_sns.SetPlatformApplicationAttributes({
"PlatformApplicationArn": null,
"Attributes": null
}, context)
- input
object
- Attributes required
- PlatformApplicationArn required
Output schema unknown
amazonaws_sns.SetSMSAttributes({
"attributes": {}
}, context)
- input
object
- attributes required
object
- attributes required
- output SetSMSAttributesResponse
amazonaws_sns.SetSMSAttributes({
"attributes": null
}, context)
- input
object
- attributes required
- output SetSMSAttributesResponse
amazonaws_sns.SetSubscriptionAttributes({
"SubscriptionArn": "",
"AttributeName": ""
}, context)
- input
object
- SubscriptionArn required
string
- AttributeName required
string
- AttributeValue
string
- SubscriptionArn required
Output schema unknown
amazonaws_sns.SetSubscriptionAttributes({
"SubscriptionArn": null,
"AttributeName": null
}, context)
- input
object
- AttributeName required
- AttributeValue
- SubscriptionArn required
Output schema unknown
amazonaws_sns.SetTopicAttributes({
"TopicArn": "",
"AttributeName": ""
}, context)
- input
object
- TopicArn required
string
- AttributeName required
string
- AttributeValue
string
- TopicArn required
Output schema unknown
amazonaws_sns.SetTopicAttributes({
"TopicArn": null,
"AttributeName": null
}, context)
- input
object
- AttributeName required
- AttributeValue
- TopicArn required
Output schema unknown
amazonaws_sns.Subscribe({
"TopicArn": "",
"Protocol": ""
}, context)
- input
object
- TopicArn required
string
- Protocol required
string
- Endpoint
string
- Attributes
object
- ReturnSubscriptionArn
boolean
- TopicArn required
- output SubscribeResponse
amazonaws_sns.Subscribe({
"TopicArn": null,
"Protocol": null
}, context)
- input
object
- Attributes
- Endpoint
- Protocol required
- ReturnSubscriptionArn
- TopicArn required
- output SubscribeResponse
amazonaws_sns.TagResource({
"ResourceArn": "",
"Tags": []
}, context)
- input
object
- ResourceArn required
string
- Tags required
array
- ResourceArn required
- output TagResourceResponse
amazonaws_sns.TagResource({
"ResourceArn": null,
"Tags": null
}, context)
- input
object
- ResourceArn required
- Tags required
- items Tag
- output TagResourceResponse
amazonaws_sns.Unsubscribe({
"SubscriptionArn": ""
}, context)
- input
object
- SubscriptionArn required
string
- SubscriptionArn required
Output schema unknown
amazonaws_sns.Unsubscribe({
"SubscriptionArn": null
}, context)
- input
object
- SubscriptionArn required
Output schema unknown
amazonaws_sns.UntagResource({
"ResourceArn": "",
"TagKeys": []
}, context)
- input
object
- ResourceArn required
string
- TagKeys required
array
- ResourceArn required
- output UntagResourceResponse
amazonaws_sns.UntagResource({
"ResourceArn": null,
"TagKeys": null
}, context)
- input
object
- ResourceArn required
- TagKeys required
- items TagKey
- output UntagResourceResponse
- ActionsList
array
- items action
- AddPermissionInput
object
- AmazonResourceName
string
- Binary
string
- CheckIfPhoneNumberIsOptedOutInput
object
: The input for theCheckIfPhoneNumberIsOptedOut
action.- phoneNumber required
- CheckIfPhoneNumberIsOptedOutResponse
object
: The response from theCheckIfPhoneNumberIsOptedOut
action.- isOptedOut
- ConfirmSubscriptionInput
object
: Input for ConfirmSubscription action.- AuthenticateOnUnsubscribe
- Token required
- TopicArn required
- ConfirmSubscriptionResponse
object
: Response for ConfirmSubscriptions action.- SubscriptionArn
- CreateEndpointResponse
object
: Response from CreateEndpoint action.- EndpointArn
- CreatePlatformApplicationInput
object
: Input for CreatePlatformApplication action.- Attributes required
- Name required
- Platform required
- CreatePlatformApplicationResponse
object
: Response from CreatePlatformApplication action.- PlatformApplicationArn
- CreatePlatformEndpointInput
object
: Input for CreatePlatformEndpoint action.- Attributes
- CustomUserData
- PlatformApplicationArn required
- Token required
- CreateTopicInput
object
: Input for CreateTopic action.- Attributes
- Name required
- Tags
- items Tag
- CreateTopicResponse
object
: Response from CreateTopic action.- TopicArn
- DelegatesList
array
- items delegate
- DeleteEndpointInput
object
: Input for DeleteEndpoint action.- EndpointArn required
- DeletePlatformApplicationInput
object
: Input for DeletePlatformApplication action.- PlatformApplicationArn required
- DeleteTopicInput
object
- TopicArn required
- Endpoint
object
: Endpoint for mobile app and device.- Attributes
- EndpointArn
- GetEndpointAttributesInput
object
: Input for GetEndpointAttributes action.- EndpointArn required
- GetEndpointAttributesResponse
object
: Response from GetEndpointAttributes of the EndpointArn.- Attributes
- GetPlatformApplicationAttributesInput
object
: Input for GetPlatformApplicationAttributes action.- PlatformApplicationArn required
- GetPlatformApplicationAttributesResponse
object
: Response for GetPlatformApplicationAttributes action.- Attributes
- GetSMSAttributesInput
object
: The input for theGetSMSAttributes
request.- attributes
- items String
- attributes
- GetSMSAttributesResponse
object
: The response from theGetSMSAttributes
request.- attributes
- GetSubscriptionAttributesInput
object
: Input for GetSubscriptionAttributes.- SubscriptionArn required
- GetSubscriptionAttributesResponse
object
: Response for GetSubscriptionAttributes action.- Attributes
- GetTopicAttributesInput
object
: Input for GetTopicAttributes action.- TopicArn required
- GetTopicAttributesResponse
object
: Response for GetTopicAttributes action.- Attributes
- ListEndpointsByPlatformApplicationInput
object
: Input for ListEndpointsByPlatformApplication action.- NextToken
- PlatformApplicationArn required
- ListEndpointsByPlatformApplicationResponse
object
: Response for ListEndpointsByPlatformApplication action.- Endpoints
- items Endpoint
- NextToken
- Endpoints
- ListOfEndpoints
array
- items Endpoint
- ListOfPlatformApplications
array
- items PlatformApplication
- ListPhoneNumbersOptedOutInput
object
: The input for theListPhoneNumbersOptedOut
action.- nextToken
- ListPhoneNumbersOptedOutResponse
object
: The response from theListPhoneNumbersOptedOut
action.- nextToken
- phoneNumbers
- items PhoneNumber
- ListPlatformApplicationsInput
object
: Input for ListPlatformApplications action.- NextToken
- ListPlatformApplicationsResponse
object
: Response for ListPlatformApplications action.- NextToken
- PlatformApplications
- items PlatformApplication
- ListString
array
- items String
- ListSubscriptionsByTopicInput
object
: Input for ListSubscriptionsByTopic action.- NextToken
- TopicArn required
- ListSubscriptionsByTopicResponse
object
: Response for ListSubscriptionsByTopic action.- NextToken
- Subscriptions
- items Subscription
- ListSubscriptionsInput
object
: Input for ListSubscriptions action.- NextToken
- ListSubscriptionsResponse
object
: Response for ListSubscriptions action- NextToken
- Subscriptions
- items Subscription
- ListTagsForResourceRequest
object
- ResourceArn required
- ListTagsForResourceResponse
object
- Tags
- items Tag
- Tags
- ListTopicsInput
object
- NextToken
- ListTopicsResponse
object
: Response for ListTopics action.- NextToken
- Topics
- items Topic
- MapStringToString
object
- MessageAttributeMap
object
- 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 Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.
- BinaryValue
- DataType required
- StringValue
- OptInPhoneNumberInput
object
: Input for the OptInPhoneNumber action.- phoneNumber required
- OptInPhoneNumberResponse
object
: The response for the OptInPhoneNumber action.
- PhoneNumber
string
- PhoneNumberList
array
- items PhoneNumber
- PlatformApplication
object
: Platform application object.- Attributes
- PlatformApplicationArn
- PublishInput
object
: Input for Publish action.- Message required
- MessageAttributes
- MessageDeduplicationId
- MessageGroupId
- MessageStructure
- PhoneNumber
- Subject
- TargetArn
- TopicArn
- PublishResponse
object
: Response for Publish action.- MessageId
- SequenceNumber
- RemovePermissionInput
object
: Input for RemovePermission action.- Label required
- TopicArn required
- SetEndpointAttributesInput
object
: Input for SetEndpointAttributes action.- Attributes required
- EndpointArn required
- SetPlatformApplicationAttributesInput
object
: Input for SetPlatformApplicationAttributes action.- Attributes required
- PlatformApplicationArn required
- SetSMSAttributesInput
object
: The input for the SetSMSAttributes action.- attributes required
- SetSMSAttributesResponse
object
: The response for the SetSMSAttributes action.
- SetSubscriptionAttributesInput
object
: Input for SetSubscriptionAttributes action.- AttributeName required
- AttributeValue
- SubscriptionArn required
- SetTopicAttributesInput
object
: Input for SetTopicAttributes action.- AttributeName required
- AttributeValue
- TopicArn required
- String
string
- SubscribeInput
object
: Input for Subscribe action.- Attributes
- Endpoint
- Protocol required
- ReturnSubscriptionArn
- TopicArn required
- SubscribeResponse
object
: Response for Subscribe action.- SubscriptionArn
- Subscription
object
: A wrapper type for the attributes of an Amazon SNS subscription.- Endpoint
- Owner
- Protocol
- SubscriptionArn
- TopicArn
- SubscriptionAttributesMap
object
- SubscriptionsList
array
- items Subscription
- Tag
object
: The list of tags to be added to the specified topic.- Key required
- Value required
- TagKey
string
- TagKeyList
array
- items TagKey
- TagList
array
- items Tag
- TagResourceRequest
object
- ResourceArn required
- Tags required
- items Tag
- TagResourceResponse
object
- TagValue
string
- Topic
object
: A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, useGetTopicAttributes
.- TopicArn
- TopicAttributesMap
object
- TopicsList
array
- items Topic
- UnsubscribeInput
object
: Input for Unsubscribe action.- SubscriptionArn required
- UntagResourceRequest
object
- ResourceArn required
- TagKeys required
- items TagKey
- UntagResourceResponse
object
- account
string
- action
string
- attributeName
string
- attributeValue
string
- authenticateOnUnsubscribe
string
- boolean
boolean
- delegate
string
- endpoint
string
- label
string
- message
string
- messageId
string
- messageStructure
string
- nextToken
string
- protocol
string
- string
string
- subject
string
- subscriptionARN
string
- token
string
- topicARN
string
- topicName
string