Amazon Web Services, Inc.

Amazon Simple Notification Service

Amazon Simple Notification Service Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled…

Communication#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 .

Endpoints 42

  • POSTAdd permission/#Action=AddPermission?Action=AddPermission&Version=2010-03-31Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions. To remove the…
  • POSTCheck if phone number is opted out/#Action=CheckIfPhoneNumberIsOptedOut?Action=CheckIfPhoneNumberIsOptedOut&Version=2010-03-31Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send…
  • POSTConfirm subscription/#Action=ConfirmSubscription?Action=ConfirmSubscription&Version=2010-03-31Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid,…
  • POSTCreate platform application/#Action=CreatePlatformApplication?Action=CreatePlatformApplication&Version=2010-03-31Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices…
  • POSTCreate platform endpoint/#Action=CreatePlatformEndpoint?Action=CreatePlatformEndpoint&Version=2010-03-31Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.…
  • POSTCreate sMS sandbox phone number/#Action=CreateSMSSandboxPhoneNumber?Action=CreateSMSSandboxPhoneNumber&Version=2010-03-31Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number. When you start…
  • POSTCreate topic/#Action=CreateTopic?Action=CreateTopic&Version=2010-03-31Creates 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,…
  • POSTDelete endpoint/#Action=DeleteEndpoint?Action=DeleteEndpoint&Version=2010-03-31Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push…
  • POSTDelete platform application/#Action=DeletePlatformApplication?Action=DeletePlatformApplication&Version=2010-03-31Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more…
  • POSTDelete sMS sandbox phone number/#Action=DeleteSMSSandboxPhoneNumber?Action=DeleteSMSSandboxPhoneNumber&Version=2010-03-31Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox. When you start using Amazon SNS to send SMS messages, your…
  • POSTDelete topic/#Action=DeleteTopic?Action=DeleteTopic&Version=2010-03-31Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This…
  • POSTGet data protection policy/#Action=GetDataProtectionPolicy?Action=GetDataProtectionPolicy&Version=2010-03-31Amazon SNS message data protection is no longer available to new customers. For more information and guidance on alternatives, see Amazon SNS message data…
  • POSTGet endpoint attributes/#Action=GetEndpointAttributes?Action=GetEndpointAttributes&Version=2010-03-31Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more…
  • POSTGet platform application attributes/#Action=GetPlatformApplicationAttributes?Action=GetPlatformApplicationAttributes&Version=2010-03-31Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For…
  • POSTGet sMS attributes/#Action=GetSMSAttributes?Action=GetSMSAttributes&Version=2010-03-31Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action.
  • POSTGet sMS sandbox account status/#Action=GetSMSSandboxAccountStatus?Action=GetSMSSandboxAccountStatus&Version=2010-03-31Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region. When you start using Amazon SNS to send…
  • POSTGet subscription attributes/#Action=GetSubscriptionAttributes?Action=GetSubscriptionAttributes&Version=2010-03-31Returns all of the properties of a subscription.
  • POSTGet topic attributes/#Action=GetTopicAttributes?Action=GetTopicAttributes&Version=2010-03-31Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
  • POSTList endpoints by platform application/#Action=ListEndpointsByPlatformApplication?Action=ListEndpointsByPlatformApplication&Version=2010-03-31Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results…
  • POSTList origination numbers/#Action=ListOriginationNumbers?Action=ListOriginationNumbers&Version=2010-03-31Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see…
  • POSTList phone numbers opted out/#Action=ListPhoneNumbersOptedOut?Action=ListPhoneNumbersOptedOut&Version=2010-03-31Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them. The results for ListPhoneNumbersOptedOut are paginated, and…
  • POSTList platform applications/#Action=ListPlatformApplications?Action=ListPlatformApplications&Version=2010-03-31Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for…
  • POSTList sMS sandbox phone numbers/#Action=ListSMSSandboxPhoneNumbers?Action=ListSMSSandboxPhoneNumbers&Version=2010-03-31Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox. When you start using Amazon SNS to…
  • POSTList subscriptions/#Action=ListSubscriptions?Action=ListSubscriptions&Version=2010-03-31Returns 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…
  • POSTList subscriptions by topic/#Action=ListSubscriptionsByTopic?Action=ListSubscriptionsByTopic&Version=2010-03-31Returns 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…
  • POSTList tags for resource/#Action=ListTagsForResource?Action=ListTagsForResource&Version=2010-03-31List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide .
  • POSTList topics/#Action=ListTopics?Action=ListTopics&Version=2010-03-31Returns 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…
  • POSTOpt in phone number/#Action=OptInPhoneNumber?Action=OptInPhoneNumber&Version=2010-03-31Use 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…
  • POSTPublish/#Action=Publish?Action=Publish&Version=2010-03-31Sends 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…
  • POSTPublish batch/#Action=PublishBatch?Action=PublishBatch&Version=2010-03-31Publishes up to 10 messages to the specified topic in a single batch. This is a batch version of the Publish API. If you try to send more than 10 messages in…
  • POSTPut data protection policy/#Action=PutDataProtectionPolicy?Action=PutDataProtectionPolicy&Version=2010-03-31Amazon SNS message data protection is no longer available to new customers. For more information and guidance on alternatives, see Amazon SNS message data…
  • POSTRemove permission/#Action=RemovePermission?Action=RemovePermission&Version=2010-03-31Removes a statement from a topic's access control policy. To remove the ability to change topic permissions, you must deny permissions to the AddPermission ,…
  • POSTSet endpoint attributes/#Action=SetEndpointAttributes?Action=SetEndpointAttributes&Version=2010-03-31Sets 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…
  • POSTSet platform application attributes/#Action=SetPlatformApplicationAttributes?Action=SetPlatformApplicationAttributes&Version=2010-03-31Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more…
  • POSTSet sMS attributes/#Action=SetSMSAttributes?Action=SetSMSAttributes&Version=2010-03-31Use 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…
  • POSTSet subscription attributes/#Action=SetSubscriptionAttributes?Action=SetSubscriptionAttributes&Version=2010-03-31Allows a subscription owner to set an attribute of the subscription to a new value.
  • POSTSet topic attributes/#Action=SetTopicAttributes?Action=SetTopicAttributes&Version=2010-03-31Allows a topic owner to set an attribute of the topic to a new value. To remove the ability to change topic permissions, you must deny permissions to the…
  • POSTSubscribe/#Action=Subscribe?Action=Subscribe&Version=2010-03-31Subscribes 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 Amazon Web…
  • POSTTag resource/#Action=TagResource?Action=TagResource&Version=2010-03-31Add 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…
  • POSTUnsubscribe/#Action=Unsubscribe?Action=Unsubscribe&Version=2010-03-31Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and…
  • POSTUntag resource/#Action=UntagResource?Action=UntagResource&Version=2010-03-31Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide .
  • POSTVerify sMS sandbox phone number/#Action=VerifySMSSandboxPhoneNumber?Action=VerifySMSSandboxPhoneNumber&Version=2010-03-31Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account. When you start using Amazon SNS to send SMS…

API details

Base URL
https://sns.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
42 operations on 42 pathsPOST 42
Description format
AWS Smithy model, API version 2010-03-31

How to test the Amazon Simple Notification Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Simple Notification Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Add permission” (POST /#Action=AddPermission?Action=AddPermission&Version=2010-03-31), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Simple Notification Service?

Amazon Simple Notification Service Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled… It is listed under Communication and has 42 endpoints.

Who publishes the Amazon Simple Notification Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Simple Notification Service?

Requests go to https://sns.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Simple Notification Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Simple Notification Service have?

42 operations on 42 paths (42 POST).

Is forking the Amazon Simple Notification Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.