aws_sns
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 the Amazon SNS product page. 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.Summary
Functions
-
add_permission(Client, Input)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
- add_permission(Client, Input, Options)
-
check_if_phone_number_is_opted_out(Client, Input)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
- check_if_phone_number_is_opted_out(Client, Input, Options)
-
confirm_subscription(Client, Input)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier
Subscribe
action. - confirm_subscription(Client, Input, Options)
-
create_platform_application(Client, Input)
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register.
- create_platform_application(Client, Input, Options)
-
create_platform_endpoint(Client, Input)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
- create_platform_endpoint(Client, Input, Options)
-
create_topic(Client, Input)
Creates a topic to which notifications can be published.
- create_topic(Client, Input, Options)
-
delete_endpoint(Client, Input)
Deletes the endpoint for a device and mobile app from Amazon SNS.
- delete_endpoint(Client, Input, Options)
-
delete_platform_application(Client, Input)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
- delete_platform_application(Client, Input, Options)
-
delete_topic(Client, Input)
Deletes a topic and all its subscriptions.
- delete_topic(Client, Input, Options)
-
get_endpoint_attributes(Client, Input)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
- get_endpoint_attributes(Client, Input, Options)
-
get_platform_application_attributes(Client, Input)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
- get_platform_application_attributes(Client, Input, Options)
-
get_sms_attributes(Client, Input)
Returns the settings for sending SMS messages from your account.
- get_sms_attributes(Client, Input, Options)
-
get_subscription_attributes(Client, Input)
Returns all of the properties of a subscription.
- get_subscription_attributes(Client, Input, Options)
-
get_topic_attributes(Client, Input)
Returns all of the properties of a topic.
- get_topic_attributes(Client, Input, Options)
-
list_endpoints_by_platform_application(Client, Input)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.
- list_endpoints_by_platform_application(Client, Input, Options)
-
list_phone_numbers_opted_out(Client, Input)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
- list_phone_numbers_opted_out(Client, Input, Options)
-
list_platform_applications(Client, Input)
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
- list_platform_applications(Client, Input, Options)
-
list_subscriptions(Client, Input)
Returns a list of the requester's subscriptions.
- list_subscriptions(Client, Input, Options)
-
list_subscriptions_by_topic(Client, Input)
Returns a list of the subscriptions to a specific topic.
- list_subscriptions_by_topic(Client, Input, Options)
-
list_tags_for_resource(Client, Input)
List all tags added to the specified Amazon SNS topic.
- list_tags_for_resource(Client, Input, Options)
-
list_topics(Client, Input)
Returns a list of the requester's topics.
- list_topics(Client, Input, Options)
-
opt_in_phone_number(Client, Input)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
- opt_in_phone_number(Client, Input, Options)
-
publish(Client, Input)
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the
TargetArn
). - publish(Client, Input, Options)
-
remove_permission(Client, Input)
Removes a statement from a topic's access control policy.
- remove_permission(Client, Input, Options)
-
set_endpoint_attributes(Client, Input)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
- set_endpoint_attributes(Client, Input, Options)
-
set_platform_application_attributes(Client, Input)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
- set_platform_application_attributes(Client, Input, Options)
-
set_sms_attributes(Client, Input)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
- set_sms_attributes(Client, Input, Options)
-
set_subscription_attributes(Client, Input)
Allows a subscription owner to set an attribute of the subscription to a new value.
- set_subscription_attributes(Client, Input, Options)
-
set_topic_attributes(Client, Input)
Allows a topic owner to set an attribute of the topic to a new value.
- set_topic_attributes(Client, Input, Options)
-
subscribe(Client, Input)
Subscribes an endpoint to an Amazon SNS topic.
- subscribe(Client, Input, Options)
-
tag_resource(Client, Input)
Add tags to the specified Amazon SNS topic.
- tag_resource(Client, Input, Options)
-
unsubscribe(Client, Input)
Deletes a subscription.
- unsubscribe(Client, Input, Options)
-
untag_resource(Client, Input)
Remove tags from the specified Amazon SNS topic.
- untag_resource(Client, Input, Options)
Functions
add_permission(Client, Input)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
add_permission(Client, Input, Options)
check_if_phone_number_is_opted_out(Client, Input)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using theOptInPhoneNumber
action.
check_if_phone_number_is_opted_out(Client, Input, Options)
confirm_subscription(Client, Input)
Verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe
action.
AuthenticateOnUnsubscribe
flag is set to "true".
confirm_subscription(Client, Input, Options)
create_platform_application(Client, Input)
Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register.
You must specify PlatformPrincipal
and PlatformCredential
attributes
when using the CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the
notification service.
For
ADM
,PlatformPrincipal
isclient id
andPlatformCredential
isclient secret
.For
Baidu
,PlatformPrincipal
isAPI key
andPlatformCredential
issecret key
.For
APNS
andAPNS_SANDBOX
,PlatformPrincipal
isSSL certificate
andPlatformCredential
isprivate key
.For
GCM
(Firebase Cloud Messaging), there is noPlatformPrincipal
and thePlatformCredential
isAPI key
.For
MPNS
,PlatformPrincipal
isTLS certificate
andPlatformCredential
isprivate key
.For
WNS
,PlatformPrincipal
isPackage Security Identifier
andPlatformCredential
issecret key
.
PlatformApplicationArn
as an
attribute for the CreatePlatformEndpoint
action.
create_platform_application(Client, Input, Options)
create_platform_endpoint(Client, Input)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
CreatePlatformEndpoint
requires the PlatformApplicationArn
that is
returned from CreatePlatformApplication
. You can use the returned
EndpointArn
to send a message to a mobile app or by the Subscribe
action for subscription to a topic. The CreatePlatformEndpoint
action is
idempotent, so if the requester already owns an endpoint with the same
device token and attributes, that endpoint's ARN is returned without
creating a new endpoint. For more information, see Using Amazon SNS Mobile
Push Notifications.
CreatePlatformEndpoint
with Baidu, two attributes must be
provided: ChannelId and UserId. The token field must also contain the
ChannelId. For more information, see Creating an Amazon SNS Endpoint for
Baidu.
create_platform_endpoint(Client, Input, Options)
create_topic(Client, Input)
Creates a topic to which notifications can be published.
Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.create_topic(Client, Input, Options)
delete_endpoint(Client, Input)
Deletes the endpoint for a device and mobile app from Amazon SNS.
This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.delete_endpoint(Client, Input, Options)
delete_platform_application(Client, Input)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
For more information, see Using Amazon SNS Mobile Push Notifications.delete_platform_application(Client, Input, Options)
delete_topic(Client, Input)
Deletes a topic and all its subscriptions.
Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.delete_topic(Client, Input, Options)
get_endpoint_attributes(Client, Input)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
For more information, see Using Amazon SNS Mobile Push Notifications.get_endpoint_attributes(Client, Input, Options)
get_platform_application_attributes(Client, Input)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
For more information, see Using Amazon SNS Mobile Push Notifications.get_platform_application_attributes(Client, Input, Options)
get_sms_attributes(Client, Input)
Returns the settings for sending SMS messages from your account.
These settings are set with theSetSMSAttributes
action.
get_sms_attributes(Client, Input, Options)
get_subscription_attributes(Client, Input)
Returns all of the properties of a subscription.
get_subscription_attributes(Client, Input, Options)
get_topic_attributes(Client, Input)
Returns all of the properties of a topic.
Topic properties returned might differ based on the authorization of the user.get_topic_attributes(Client, Input, Options)
list_endpoints_by_platform_application(Client, Input)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.
The results for ListEndpointsByPlatformApplication
are paginated and
return a limited list of endpoints, up to 100. If additional records are
available after the first page results, then a NextToken string will be
returned. To receive the next page, you call
ListEndpointsByPlatformApplication
again using the NextToken string
received from the previous call. When there are no more records to return,
NextToken will be null. For more information, see Using Amazon SNS Mobile
Push Notifications.
list_endpoints_by_platform_application(Client, Input, Options)
list_phone_numbers_opted_out(Client, Input)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results forListPhoneNumbersOptedOut
are paginated, and each page
returns up to 100 phone numbers. If additional phone numbers are available
after the first page of results, then a NextToken
string will be
returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the NextToken
string received from the previous call. When
there are no more records to return, NextToken
will be null.
list_phone_numbers_opted_out(Client, Input, Options)
list_platform_applications(Client, Input)
Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
The results for ListPlatformApplications
are paginated and return a
limited list of applications, up to 100. If additional records are
available after the first page results, then a NextToken string will be
returned. To receive the next page, you call ListPlatformApplications
using the NextToken string received from the previous call. When there are
no more records to return, NextToken
will be null. For more information,
see Using Amazon SNS Mobile Push Notifications.
list_platform_applications(Client, Input, Options)
list_subscriptions(Client, Input)
Returns a list of the requester's subscriptions.
Each call returns a limited list of subscriptions, up to 100. If there are
more subscriptions, a NextToken
is also returned. Use the NextToken
parameter in a new ListSubscriptions
call to get further results.
list_subscriptions(Client, Input, Options)
list_subscriptions_by_topic(Client, Input)
Returns a list of the subscriptions to a specific topic.
Each call returns a limited list of subscriptions, up to 100. If there are
more subscriptions, a NextToken
is also returned. Use the NextToken
parameter in a new ListSubscriptionsByTopic
call to get further results.
list_subscriptions_by_topic(Client, Input, Options)
list_tags_for_resource(Client, Input)
List all tags added to the specified Amazon SNS topic.
For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.list_tags_for_resource(Client, Input, Options)
list_topics(Client, Input)
Returns a list of the requester's topics.
Each call returns a limited list of topics, up to 100. If there are more
topics, a NextToken
is also returned. Use the NextToken
parameter in a
new ListTopics
call to get further results.
list_topics(Client, Input, Options)
opt_in_phone_number(Client, Input)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.opt_in_phone_number(Client, Input, Options)
publish(Client, Input)
Sends a message to an Amazon SNS topic, a text message (SMS message)
directly to a phone number, or a message to a mobile platform endpoint
(when you specify the TargetArn
).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the message has been saved and Amazon SNS
will attempt to deliver it shortly.
To use the Publish
action for sending a message to a mobile endpoint,
such as an app on a Kindle device or mobile phone, you must specify the
EndpointArn for the TargetArn parameter. The EndpointArn is returned when
making a call with the CreatePlatformEndpoint
action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same AWS Region.publish(Client, Input, Options)
remove_permission(Client, Input)
Removes a statement from a topic's access control policy.
remove_permission(Client, Input, Options)
set_endpoint_attributes(Client, Input)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
For more information, see Using Amazon SNS Mobile Push Notifications.set_endpoint_attributes(Client, Input, Options)
set_platform_application_attributes(Client, Input)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.set_platform_application_attributes(Client, Input, Options)
set_sms_attributes(Client, Input)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use
the Publish
action with the MessageAttributes.entry.N
parameter. For
more information, see Publishing to a mobile phone in the Amazon SNS
Developer Guide.
sns.amazonaws.com
) permission to perform the s3:ListBucket
action.
set_sms_attributes(Client, Input, Options)
set_subscription_attributes(Client, Input)
Allows a subscription owner to set an attribute of the subscription to a new value.
set_subscription_attributes(Client, Input, Options)
set_topic_attributes(Client, Input)
Allows a topic owner to set an attribute of the topic to a new value.
set_topic_attributes(Client, Input, Options)
subscribe(Client, Input)
Subscribes an endpoint to an Amazon SNS topic.
If the endpoint type is HTTP/S or email, or if the endpoint and the topic
are not in the same AWS account, the endpoint owner must run the
ConfirmSubscription
action to confirm the subscription.
You call the ConfirmSubscription
action with the token from the
subscription response. Confirmation tokens are valid for three days.
subscribe(Client, Input, Options)
tag_resource(Client, Input)
Add tags to the specified Amazon SNS topic.
For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
tag_resource(Client, Input, Options)
unsubscribe(Client, Input)
Deletes a subscription.
If the subscription requires authentication for deletion, only the owner
of the subscription or the topic's owner can unsubscribe, and an AWS
signature is required. If the Unsubscribe
call does not require
authentication and the requester is not the subscription owner, a final
cancellation message is delivered to the endpoint, so that the endpoint
owner can easily resubscribe to the topic if the Unsubscribe
request was
unintended.
unsubscribe(Client, Input, Options)
untag_resource(Client, Input)
Remove tags from the specified Amazon SNS topic.
For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.