integrations.sh
← all integrations

amazonaws.com – sns

OpenAPI apis-guru cloud

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 . For detailed information about Amazon SNS features and their associated API calls, see the .

For information on the permissions you need to use this API, see 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 .

Homepage
https://api.apis.guru/v2/specs/amazonaws.com:sns/2010-03-31.json
Provider
amazonaws.com:sns / sns
OpenAPI version
3.0.0
Spec (JSON)
https://api.apis.guru/v2/specs/amazonaws.com/sns/2010-03-31/openapi.json
Spec (YAML)
https://api.apis.guru/v2/specs/amazonaws.com/sns/2010-03-31/openapi.yaml

Tools (86)

Extracted live via the executor SDK.

  • actionAddPermission.getAddPermission

    Adds 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 ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionAddPermission.postAddPermission

    Adds 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 ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionCheckIfPhoneNumberIsOptedOut.getCheckIfPhoneNumberIsOptedOut

    Accepts 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 SMS messages to a number that is opted out.

    To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

  • actionCheckIfPhoneNumberIsOptedOut.postCheckIfPhoneNumberIsOptedOut

    Accepts 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 SMS messages to a number that is opted out.

    To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

  • actionConfirmSubscription.getConfirmSubscription

    Verifies 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, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

  • actionConfirmSubscription.postConfirmSubscription

    Verifies 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, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

  • actionCreatePlatformApplication.getCreatePlatformApplication

    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 is client id and PlatformCredential is client secret.

    • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

    • For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

    • For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.

    • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

    • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

    • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

    You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

  • actionCreatePlatformApplication.postCreatePlatformApplication

    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 is client id and PlatformCredential is client secret.

    • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

    • For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

    • For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.

    • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

    • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

    • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

    You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

  • actionCreatePlatformEndpoint.getCreatePlatformEndpoint

    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 .

    When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see .

  • actionCreatePlatformEndpoint.postCreatePlatformEndpoint

    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 .

    When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see .

  • actionCreateSmsSandboxPhoneNumber.getCreateSmsSandboxPhoneNumber

    Adds 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 using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionCreateSmsSandboxPhoneNumber.postCreateSmsSandboxPhoneNumber

    Adds 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 using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionCreateTopic.getCreateTopic

    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 in the Amazon SNS Developer Guide. 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.

  • actionCreateTopic.postCreateTopic

    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 in the Amazon SNS Developer Guide. 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.

  • actionDeleteEndpoint.getDeleteEndpoint

    Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see .

    When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

  • actionDeleteEndpoint.postDeleteEndpoint

    Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see .

    When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

  • actionDeletePlatformApplication.getDeletePlatformApplication

    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 .

  • actionDeletePlatformApplication.postDeletePlatformApplication

    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 .

  • actionDeleteSmsSandboxPhoneNumber.getDeleteSmsSandboxPhoneNumber

    Deletes 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 Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionDeleteSmsSandboxPhoneNumber.postDeleteSmsSandboxPhoneNumber

    Deletes 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 Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionDeleteTopic.getDeleteTopic

    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.

  • actionDeleteTopic.postDeleteTopic

    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.

  • actionGetDataProtectionPolicy.getGetDataProtectionPolicy

    Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

  • actionGetDataProtectionPolicy.postGetDataProtectionPolicy

    Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

  • actionGetEndpointAttributes.getGetEndpointAttributes

    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 .

  • actionGetEndpointAttributes.postGetEndpointAttributes

    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 .

  • actionGetPlatformApplicationAttributes.getGetPlatformApplicationAttributes

    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 .

  • actionGetPlatformApplicationAttributes.postGetPlatformApplicationAttributes

    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 .

  • actionGetSmsAttributes.getGetSmsAttributes

    Returns the settings for sending SMS messages from your Amazon Web Services account.

    These settings are set with the SetSMSAttributes action.

  • actionGetSmsAttributes.postGetSmsAttributes

    Returns the settings for sending SMS messages from your Amazon Web Services account.

    These settings are set with the SetSMSAttributes action.

  • actionGetSmsSandboxAccountStatus.getGetSmsSandboxAccountStatus

    Retrieves 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 SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionGetSmsSandboxAccountStatus.postGetSmsSandboxAccountStatus

    Retrieves 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 SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionGetSubscriptionAttributes.getGetSubscriptionAttributes

    Returns all of the properties of a subscription.

  • actionGetSubscriptionAttributes.postGetSubscriptionAttributes

    Returns all of the properties of a subscription.

  • actionGetTopicAttributes.getGetTopicAttributes

    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

  • actionGetTopicAttributes.postGetTopicAttributes

    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

  • actionListEndpointsByPlatformApplication.getListEndpointsByPlatformApplication

    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 .

    This action is throttled at 30 transactions per second (TPS).

  • actionListEndpointsByPlatformApplication.postListEndpointsByPlatformApplication

    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 .

    This action is throttled at 30 transactions per second (TPS).

  • actionListOriginationNumbers.getListOriginationNumbers

    Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see in the Amazon SNS Developer Guide.

  • actionListOriginationNumbers.postListOriginationNumbers

    Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see in the Amazon SNS Developer Guide.

  • actionListPhoneNumbersOptedOut.getListPhoneNumbersOptedOut

    Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

    The results for ListPhoneNumbersOptedOut 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.

  • actionListPhoneNumbersOptedOut.postListPhoneNumbersOptedOut

    Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

    The results for ListPhoneNumbersOptedOut 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.

  • actionListPlatformApplications.getListPlatformApplications

    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 .

    This action is throttled at 15 transactions per second (TPS).

  • actionListPlatformApplications.postListPlatformApplications

    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 .

    This action is throttled at 15 transactions per second (TPS).

  • actionListSmsSandboxPhoneNumbers.getListSmsSandboxPhoneNumbers

    Lists 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 send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionListSmsSandboxPhoneNumbers.postListSmsSandboxPhoneNumbers

    Lists 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 send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionListSubscriptions.getListSubscriptions

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionListSubscriptions.postListSubscriptions

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionListSubscriptionsByTopic.getListSubscriptionsByTopic

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionListSubscriptionsByTopic.postListSubscriptionsByTopic

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionListTagsForResource.getListTagsForResource

    List all tags added to the specified Amazon SNS topic. For an overview, see in the Amazon Simple Notification Service Developer Guide.

  • actionListTagsForResource.postListTagsForResource

    List all tags added to the specified Amazon SNS topic. For an overview, see in the Amazon Simple Notification Service Developer Guide.

  • actionListTopics.getListTopics

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionListTopics.postListTopics

    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.

    This action is throttled at 30 transactions per second (TPS).

  • actionOptInPhoneNumber.getOptInPhoneNumber

    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.

  • actionOptInPhoneNumber.postOptInPhoneNumber

    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.

  • actionPublish.getPublish

    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 is saved and Amazon SNS immediately delivers it to subscribers.

    To use the Publish action for publishing 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 .

    You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

  • actionPublish.postPublish

    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 is saved and Amazon SNS immediately delivers it to subscribers.

    To use the Publish action for publishing 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 .

    You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

  • actionPublishBatch.getPublishBatch

    Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

    The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

  • actionPublishBatch.postPublishBatch

    Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

    The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

  • actionPutDataProtectionPolicy.getPutDataProtectionPolicy

    Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

  • actionPutDataProtectionPolicy.postPutDataProtectionPolicy

    Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

  • actionRemovePermission.getRemovePermission

    Removes a statement from a topic's access control policy.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionRemovePermission.postRemovePermission

    Removes a statement from a topic's access control policy.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionSetEndpointAttributes.getSetEndpointAttributes

    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 .

  • actionSetEndpointAttributes.postSetEndpointAttributes

    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 .

  • actionSetPlatformApplicationAttributes.getSetPlatformApplicationAttributes

    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 . For information on configuring attributes for message delivery status, see .

  • actionSetPlatformApplicationAttributes.postSetPlatformApplicationAttributes

    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 . For information on configuring attributes for message delivery status, see .

  • actionSetSmsAttributes.getSetSmsAttributes

    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 in the Amazon SNS Developer Guide.

    To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

  • actionSetSmsAttributes.postSetSmsAttributes

    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 in the Amazon SNS Developer Guide.

    To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

  • actionSetSubscriptionAttributes.getSetSubscriptionAttributes

    Allows a subscription owner to set an attribute of the subscription to a new value.

  • actionSetSubscriptionAttributes.postSetSubscriptionAttributes

    Allows a subscription owner to set an attribute of the subscription to a new value.

  • actionSetTopicAttributes.getSetTopicAttributes

    Allows 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 AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionSetTopicAttributes.postSetTopicAttributes

    Allows 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 AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

  • actionSubscribe.getSubscribe

    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 Amazon Web Services 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.

    This action is throttled at 100 transactions per second (TPS).

  • actionSubscribe.postSubscribe

    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 Amazon Web Services 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.

    This action is throttled at 100 transactions per second (TPS).

  • actionTagResource.getTagResource

    Add tags to the specified Amazon SNS topic. For an overview, see 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a .

  • actionTagResource.postTagResource

    Add tags to the specified Amazon SNS topic. For an overview, see 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a .

  • actionUnsubscribe.getUnsubscribe

    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 Amazon Web Services 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.

    Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

    This action is throttled at 100 transactions per second (TPS).

  • actionUnsubscribe.postUnsubscribe

    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 Amazon Web Services 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.

    Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

    This action is throttled at 100 transactions per second (TPS).

  • actionUntagResource.getUntagResource

    Remove tags from the specified Amazon SNS topic. For an overview, see in the Amazon SNS Developer Guide.

  • actionUntagResource.postUntagResource

    Remove tags from the specified Amazon SNS topic. For an overview, see in the Amazon SNS Developer Guide.

  • actionVerifySmsSandboxPhoneNumber.getVerifySmsSandboxPhoneNumber

    Verifies 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 messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • actionVerifySmsSandboxPhoneNumber.postVerifySmsSandboxPhoneNumber

    Verifies 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 messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see in the Amazon SNS Developer Guide.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools