AWSSDK.SimpleNotificationService Implementation for accessing SimpleNotificationService 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. Add statement to the policy that gives the sns topic access to send a message to the queue. Check to see if the policy for the queue has already given permission to the topic. Verifies that the ARN for the topic matches the topic name Helper method for AuthorizeS3ToPublishAsync() Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic asynchronously. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topic to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic. Subscribes an existing Amazon SQS queue to existing Amazon SNS topics asynchronously. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topics to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The mapping of topic ARNs to subscription ARNs as returned by Amazon SNS when the queue is successfully subscribed to each topic. Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found asynchronously. The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches is found. The name of the topic find A Task containing the matched SNS topic. This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. The topic that will have its policy updated. The bucket that will be given access to publish from. /// A Task Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topic to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic. Subscribes an existing Amazon SQS queue to existing Amazon SNS topics. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topics to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The mapping of topic ARNs to subscription ARNs as returned by Amazon SNS when the queue is successfully subscribed to each topic. Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found. The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches is found. The name of the topic find The matched SNS topic. This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. The topic that will have its policy updated. The bucket that will be given access to publish from. Paginators for the service Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> The region to connect. Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> The AmazonSimpleNotificationServiceClient Configuration Object Constructs AmazonSimpleNotificationServiceClient with AWS Credentials AWS Credentials Constructs AmazonSimpleNotificationServiceClient with AWS Credentials AWS Credentials The region to connect. Constructs AmazonSimpleNotificationServiceClient with AWS Credentials and an AmazonSimpleNotificationServiceClient Configuration object. AWS Credentials The AmazonSimpleNotificationServiceClient Configuration Object Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key AWS Access Key ID AWS Secret Access Key Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key AWS Access Key ID AWS Secret Access Key The region to connect. Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. AWS Access Key ID AWS Secret Access Key The AmazonSimpleNotificationServiceClient Configuration Object Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key AWS Access Key ID AWS Secret Access Key AWS Session Token Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key AWS Access Key ID AWS Secret Access Key AWS Session Token The region to connect. Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object. AWS Access Key ID AWS Secret Access Key AWS Session Token The AmazonSimpleNotificationServiceClient Configuration Object Creates the signer for the service. Customize the pipeline Capture metadata for the service. Disposes the service client. 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. The ARN of the topic whose access control policy you wish to modify. A unique identifier for the new policy statement. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the AddPermission service method. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. The ARN of the topic whose access control policy you wish to modify. A unique identifier for the new policy statement. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the AddPermission service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method. The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for CheckIfPhoneNumberIsOptedOut Operation 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. Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for CheckIfPhoneNumberIsOptedOut Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". Container for the necessary parameters to execute the ConfirmSubscription service method. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". Container for the necessary parameters to execute the ConfirmSubscription service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
  • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • 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. Container for the necessary parameters to execute the CreatePlatformApplication service method. The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreatePlatformApplication Operation 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
  • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • 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. Container for the necessary parameters to execute the CreatePlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreatePlatformApplication Operation 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. 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 Creating an Amazon SNS Endpoint for Baidu. Container for the necessary parameters to execute the CreatePlatformEndpoint service method. The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for CreatePlatformEndpoint Operation 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. 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 Creating an Amazon SNS Endpoint for Baidu. Container for the necessary parameters to execute the CreatePlatformEndpoint service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for CreatePlatformEndpoint Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the CreateSMSSandboxPhoneNumber service method. The response from the CreateSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreateSMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the CreateSMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreateSMSSandboxPhoneNumber Operation 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 Creating an Amazon SNS topic 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. The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. Container for the necessary parameters to execute the CreateTopic service method. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. Container for the necessary parameters to execute the CreateTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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. Container for the necessary parameters to execute the DeleteEndpoint service method. The response from the DeleteEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteEndpoint Operation 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. Container for the necessary parameters to execute the DeleteEndpoint service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteEndpoint Operation 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. Container for the necessary parameters to execute the DeletePlatformApplication service method. The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeletePlatformApplication Operation 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. Container for the necessary parameters to execute the DeletePlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeletePlatformApplication Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the DeleteSMSSandboxPhoneNumber service method. The response from the DeleteSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteSMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the DeleteSMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteSMSSandboxPhoneNumber Operation 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. The ARN of the topic you want to delete. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. Container for the necessary parameters to execute the DeleteTopic service method. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. The ARN of the topic you want to delete. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. Container for the necessary parameters to execute the DeleteTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the GetDataProtectionPolicy service method. The response from the GetDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetDataProtectionPolicy Operation Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the GetDataProtectionPolicy service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetDataProtectionPolicy Operation 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. Container for the necessary parameters to execute the GetEndpointAttributes service method. The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetEndpointAttributes Operation 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. Container for the necessary parameters to execute the GetEndpointAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetEndpointAttributes Operation 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. Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method. The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetPlatformApplicationAttributes Operation 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. Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetPlatformApplicationAttributes Operation Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. Container for the necessary parameters to execute the GetSMSAttributes service method. The response from the GetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSAttributes Operation Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. Container for the necessary parameters to execute the GetSMSAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSAttributes Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the GetSMSSandboxAccountStatus service method. The response from the GetSMSSandboxAccountStatus service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSSandboxAccountStatus Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the GetSMSSandboxAccountStatus service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSMSSandboxAccountStatus service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSSandboxAccountStatus Operation Returns all of the properties of a subscription. The ARN of the subscription whose properties you want to get. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. Container for the necessary parameters to execute the GetSubscriptionAttributes service method. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. The ARN of the subscription whose properties you want to get. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. Container for the necessary parameters to execute the GetSubscriptionAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. The ARN of the topic whose properties you want to get. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. Container for the necessary parameters to execute the GetTopicAttributes service method. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. The ARN of the topic whose properties you want to get. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. Container for the necessary parameters to execute the GetTopicAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation 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. This action is throttled at 30 transactions per second (TPS). Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method. The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListEndpointsByPlatformApplication Operation 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. This action is throttled at 30 transactions per second (TPS). Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListEndpointsByPlatformApplication Operation Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListOriginationNumbers service method. The response from the ListOriginationNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a parameter in the request is invalid. REST API Reference for ListOriginationNumbers Operation Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListOriginationNumbers service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListOriginationNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a parameter in the request is invalid. REST API Reference for ListOriginationNumbers Operation 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. Container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method. The response from the ListPhoneNumbersOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListPhoneNumbersOptedOut Operation 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. Container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPhoneNumbersOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListPhoneNumbersOptedOut Operation 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. This action is throttled at 15 transactions per second (TPS). The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). Container for the necessary parameters to execute the ListPlatformApplications service method. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). Container for the necessary parameters to execute the ListPlatformApplications service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListSMSSandboxPhoneNumbers service method. The response from the ListSMSSandboxPhoneNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListSMSSandboxPhoneNumbers Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListSMSSandboxPhoneNumbers service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSMSSandboxPhoneNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListSMSSandboxPhoneNumbers Operation 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). The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Token returned by the previous ListSubscriptions request. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Container for the necessary parameters to execute the ListSubscriptions service method. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Token returned by the previous ListSubscriptions request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Container for the necessary parameters to execute the ListSubscriptions service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). The ARN of the topic for which you wish to find subscriptions. Token returned by the previous ListSubscriptionsByTopic request. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). Container for the necessary parameters to execute the ListSubscriptionsByTopic service method. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. Token returned by the previous ListSubscriptionsByTopic request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). Container for the necessary parameters to execute the ListSubscriptionsByTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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. Container for the necessary parameters to execute the ListTagsForResource service method. The response from the ListTagsForResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for ListTagsForResource Operation 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. Container for the necessary parameters to execute the ListTagsForResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTagsForResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for ListTagsForResource Operation 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). The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Token returned by the previous ListTopics request. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Container for the necessary parameters to execute the ListTopics service method. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Token returned by the previous ListTopics request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Container for the necessary parameters to execute the ListTopics service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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. Container for the necessary parameters to execute the OptInPhoneNumber service method. The response from the OptInPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for OptInPhoneNumber Operation 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. Container for the necessary parameters to execute the OptInPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the OptInPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for OptInPhoneNumber Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. Container for the necessary parameters to execute the Publish service method. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. Container for the necessary parameters to execute the Publish service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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. Container for the necessary parameters to execute the PublishBatch service method. The response from the PublishBatch service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Two or more batch entries in the request have the same Id. The length of all the batch messages put together is more than the limit. The batch request doesn't contain any entries. Exception error indicating endpoint disabled. Indicates an internal service error. The Id of a batch entry in a batch request doesn't abide by the specification. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. The batch request contains more entries than permissible. Indicates that a parameter in the request is invalid. REST API Reference for PublishBatch Operation 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. Container for the necessary parameters to execute the PublishBatch service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the PublishBatch service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Two or more batch entries in the request have the same Id. The length of all the batch messages put together is more than the limit. The batch request doesn't contain any entries. Exception error indicating endpoint disabled. Indicates an internal service error. The Id of a batch entry in a batch request doesn't abide by the specification. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. The batch request contains more entries than permissible. Indicates that a parameter in the request is invalid. REST API Reference for PublishBatch Operation Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the PutDataProtectionPolicy service method. The response from the PutDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for PutDataProtectionPolicy Operation Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the PutDataProtectionPolicy service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the PutDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for PutDataProtectionPolicy Operation 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. The ARN of the topic whose access control policy you wish to modify. The unique label of the statement you want to remove. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the RemovePermission service method. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. The ARN of the topic whose access control policy you wish to modify. The unique label of the statement you want to remove. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the RemovePermission service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the SetEndpointAttributes service method. The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetEndpointAttributes Operation 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. Container for the necessary parameters to execute the SetEndpointAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetEndpointAttributes Operation 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. Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method. The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetPlatformApplicationAttributes Operation 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. Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetPlatformApplicationAttributes Operation 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. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. Container for the necessary parameters to execute the SetSMSAttributes service method. The response from the SetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for SetSMSAttributes Operation 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. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. Container for the necessary parameters to execute the SetSMSAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for SetSMSAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. The ARN of the subscription to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The new value for the attribute in JSON format. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. Container for the necessary parameters to execute the SetSubscriptionAttributes service method. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. The ARN of the subscription to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The new value for the attribute in JSON format. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. Container for the necessary parameters to execute the SetSubscriptionAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation 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. The ARN of the topic to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The new value for the attribute. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. Container for the necessary parameters to execute the SetTopicAttributes service method. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. The ARN of the topic to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The new value for the attribute. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. Container for the necessary parameters to execute the SetTopicAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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 two days. This action is throttled at 100 transactions per second (TPS). The ARN of the topic you want to subscribe to. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). Container for the necessary parameters to execute the Subscribe service method. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). The ARN of the topic you want to subscribe to. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). Container for the necessary parameters to execute the Subscribe service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
Container for the necessary parameters to execute the TagResource service method. The response from the TagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for TagResource Operation 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
Container for the necessary parameters to execute the TagResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the TagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for TagResource Operation 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). The ARN of the subscription to be deleted. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). Container for the necessary parameters to execute the Unsubscribe service method. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). The ARN of the subscription to be deleted. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). Container for the necessary parameters to execute the Unsubscribe service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the UntagResource service method. The response from the UntagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for UntagResource Operation Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the UntagResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the UntagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for UntagResource Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the VerifySMSSandboxPhoneNumber service method. The response from the VerifySMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that the one-time password (OTP) used for verification is invalid. REST API Reference for VerifySMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the VerifySMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the VerifySMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that the one-time password (OTP) used for verification is invalid. REST API Reference for VerifySMSSandboxPhoneNumber Operation Returns the endpoint that will be used for a particular request. Request for the desired service operation. The resolved endpoint for the given request. Interface for accessing SimpleNotificationService 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. Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : { "AWS":["*"] }, "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topic to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic. Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic asynchronously. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : { "AWS":["*"] }, "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topic to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. A Task containing the subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic. Subscribes an existing Amazon SQS queue to existing Amazon SNS topics. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topics to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. The mapping of topic ARNs to subscription ARNs as returned by Amazon SNS when the queue is successfully subscribed to each topic. Subscribes an existing Amazon SQS queue to existing Amazon SNS topics asynchronously. The policy applied to the SQS queue is similar to this: { "Version" : "2008-10-17", "Statement" : [{ "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic", "Effect" : "Allow", "Principal" : "*", "Action" : ["sqs:SendMessage"], "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"], "Condition" : { "ArnLike":{ "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"] } } }] } There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue. The topics to subscribe to The SQS client used to get attributes and set the policy on the SQS queue. The queue to add a subscription to. A Task containing the mapping of topic ARNs to subscription ARNs as returned by Amazon SNS wrapped when the queue is successfully subscribed to each topic. Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found. The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches is found. The name of the topic find The matched SNS topic. Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found asynchronously. The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches is found. The name of the topic find A Task containing the matched SNS topic. This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. The topic that will have its policy updated. The bucket that will be given access to publish from. This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it. The topic that will have its policy updated. The bucket that will be given access to publish from. /// A Task Paginators for the service 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. The ARN of the topic whose access control policy you wish to modify. A unique identifier for the new policy statement. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the AddPermission service method. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. The ARN of the topic whose access control policy you wish to modify. A unique identifier for the new policy statement. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the AddPermission service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the AddPermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for AddPermission Operation 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. Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method. The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for CheckIfPhoneNumberIsOptedOut Operation 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. Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for CheckIfPhoneNumberIsOptedOut Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". Container for the necessary parameters to execute the ConfirmSubscription service method. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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". Container for the necessary parameters to execute the ConfirmSubscription service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ConfirmSubscription service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for ConfirmSubscription Operation 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
  • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • 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. Container for the necessary parameters to execute the CreatePlatformApplication service method. The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreatePlatformApplication Operation 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
  • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • 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. Container for the necessary parameters to execute the CreatePlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreatePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreatePlatformApplication Operation 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. 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 Creating an Amazon SNS Endpoint for Baidu. Container for the necessary parameters to execute the CreatePlatformEndpoint service method. The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for CreatePlatformEndpoint Operation 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. 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 Creating an Amazon SNS Endpoint for Baidu. Container for the necessary parameters to execute the CreatePlatformEndpoint service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreatePlatformEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for CreatePlatformEndpoint Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the CreateSMSSandboxPhoneNumber service method. The response from the CreateSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreateSMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the CreateSMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for CreateSMSSandboxPhoneNumber Operation 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 Creating an Amazon SNS topic 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. The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. Container for the necessary parameters to execute the CreateTopic service method. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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 Creating an Amazon SNS topic 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. Container for the necessary parameters to execute the CreateTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the CreateTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Indicates that the customer already owns the maximum allowed number of topics. REST API Reference for CreateTopic Operation 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. Container for the necessary parameters to execute the DeleteEndpoint service method. The response from the DeleteEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteEndpoint Operation 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. Container for the necessary parameters to execute the DeleteEndpoint service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteEndpoint service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteEndpoint Operation 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. Container for the necessary parameters to execute the DeletePlatformApplication service method. The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeletePlatformApplication Operation 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. Container for the necessary parameters to execute the DeletePlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeletePlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeletePlatformApplication Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the DeleteSMSSandboxPhoneNumber service method. The response from the DeleteSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteSMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the DeleteSMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteSMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for DeleteSMSSandboxPhoneNumber Operation 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. The ARN of the topic you want to delete. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. Container for the necessary parameters to execute the DeleteTopic service method. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. The ARN of the topic you want to delete. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation 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. Container for the necessary parameters to execute the DeleteTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the DeleteTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the specified state is not a valid state for an event source. Indicates that the requested resource does not exist. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for DeleteTopic Operation Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the GetDataProtectionPolicy service method. The response from the GetDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetDataProtectionPolicy Operation Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the GetDataProtectionPolicy service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetDataProtectionPolicy Operation 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. Container for the necessary parameters to execute the GetEndpointAttributes service method. The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetEndpointAttributes Operation 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. Container for the necessary parameters to execute the GetEndpointAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetEndpointAttributes Operation 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. Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method. The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetPlatformApplicationAttributes Operation 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. Container for the necessary parameters to execute the GetPlatformApplicationAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetPlatformApplicationAttributes Operation Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. Container for the necessary parameters to execute the GetSMSAttributes service method. The response from the GetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSAttributes Operation Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. Container for the necessary parameters to execute the GetSMSAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSAttributes Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the GetSMSSandboxAccountStatus service method. The response from the GetSMSSandboxAccountStatus service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSSandboxAccountStatus Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the GetSMSSandboxAccountStatus service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSMSSandboxAccountStatus service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for GetSMSSandboxAccountStatus Operation Returns all of the properties of a subscription. The ARN of the subscription whose properties you want to get. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. Container for the necessary parameters to execute the GetSubscriptionAttributes service method. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. The ARN of the subscription whose properties you want to get. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a subscription. Container for the necessary parameters to execute the GetSubscriptionAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for GetSubscriptionAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. The ARN of the topic whose properties you want to get. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. Container for the necessary parameters to execute the GetTopicAttributes service method. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. The ARN of the topic whose properties you want to get. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. Container for the necessary parameters to execute the GetTopicAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the GetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for GetTopicAttributes Operation 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. This action is throttled at 30 transactions per second (TPS). Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method. The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListEndpointsByPlatformApplication Operation 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. This action is throttled at 30 transactions per second (TPS). Container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListEndpointsByPlatformApplication service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListEndpointsByPlatformApplication Operation Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListOriginationNumbers service method. The response from the ListOriginationNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a parameter in the request is invalid. REST API Reference for ListOriginationNumbers Operation Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListOriginationNumbers service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListOriginationNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that a parameter in the request is invalid. REST API Reference for ListOriginationNumbers Operation 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. Container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method. The response from the ListPhoneNumbersOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListPhoneNumbersOptedOut Operation 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. Container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPhoneNumbersOptedOut service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListPhoneNumbersOptedOut Operation 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. This action is throttled at 15 transactions per second (TPS). The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). Container for the necessary parameters to execute the ListPlatformApplications service method. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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. This action is throttled at 15 transactions per second (TPS). Container for the necessary parameters to execute the ListPlatformApplications service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListPlatformApplications service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListPlatformApplications Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListSMSSandboxPhoneNumbers service method. The response from the ListSMSSandboxPhoneNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListSMSSandboxPhoneNumbers Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the ListSMSSandboxPhoneNumbers service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSMSSandboxPhoneNumbers service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for ListSMSSandboxPhoneNumbers Operation 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). The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Token returned by the previous ListSubscriptions request. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Container for the necessary parameters to execute the ListSubscriptions service method. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Token returned by the previous ListSubscriptions request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). Container for the necessary parameters to execute the ListSubscriptions service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptions service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListSubscriptions Operation 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). The ARN of the topic for which you wish to find subscriptions. Token returned by the previous ListSubscriptionsByTopic request. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). Container for the necessary parameters to execute the ListSubscriptionsByTopic service method. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. Token returned by the previous ListSubscriptionsByTopic request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). The ARN of the topic for which you wish to find subscriptions. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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). Container for the necessary parameters to execute the ListSubscriptionsByTopic service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListSubscriptionsByTopic service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for ListSubscriptionsByTopic Operation 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. Container for the necessary parameters to execute the ListTagsForResource service method. The response from the ListTagsForResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for ListTagsForResource Operation 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. Container for the necessary parameters to execute the ListTagsForResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTagsForResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for ListTagsForResource Operation 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). The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Token returned by the previous ListTopics request. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Container for the necessary parameters to execute the ListTopics service method. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Token returned by the previous ListTopics request. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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). Container for the necessary parameters to execute the ListTopics service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the ListTopics service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. REST API Reference for ListTopics Operation 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. Container for the necessary parameters to execute the OptInPhoneNumber service method. The response from the OptInPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for OptInPhoneNumber Operation 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. Container for the necessary parameters to execute the OptInPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the OptInPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for OptInPhoneNumber Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. Container for the necessary parameters to execute the Publish service method. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. Container for the necessary parameters to execute the Publish service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Publish service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Exception error indicating endpoint disabled. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. Indicates that a parameter in the request is invalid. REST API Reference for Publish Operation 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. Container for the necessary parameters to execute the PublishBatch service method. The response from the PublishBatch service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Two or more batch entries in the request have the same Id. The length of all the batch messages put together is more than the limit. The batch request doesn't contain any entries. Exception error indicating endpoint disabled. Indicates an internal service error. The Id of a batch entry in a batch request doesn't abide by the specification. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. The batch request contains more entries than permissible. Indicates that a parameter in the request is invalid. REST API Reference for PublishBatch Operation 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. Container for the necessary parameters to execute the PublishBatch service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the PublishBatch service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Two or more batch entries in the request have the same Id. The length of all the batch messages put together is more than the limit. The batch request doesn't contain any entries. Exception error indicating endpoint disabled. Indicates an internal service error. The Id of a batch entry in a batch request doesn't abide by the specification. Indicates that a request parameter does not comply with the associated constraints. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. The ciphertext references a key that doesn't exist or that you don't have access to. The request was rejected because the specified Amazon Web Services KMS key isn't enabled. The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. The request was rejected because the specified entity or resource can't be found. The Amazon Web Services access key ID needs a subscription for the service. The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Indicates that the requested resource does not exist. Exception error indicating platform application disabled. The batch request contains more entries than permissible. Indicates that a parameter in the request is invalid. REST API Reference for PublishBatch Operation Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the PutDataProtectionPolicy service method. The response from the PutDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for PutDataProtectionPolicy Operation Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. Container for the necessary parameters to execute the PutDataProtectionPolicy service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the PutDataProtectionPolicy service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for PutDataProtectionPolicy Operation 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. The ARN of the topic whose access control policy you wish to modify. The unique label of the statement you want to remove. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the RemovePermission service method. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. The ARN of the topic whose access control policy you wish to modify. The unique label of the statement you want to remove. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the RemovePermission service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the RemovePermission service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for RemovePermission Operation 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. Container for the necessary parameters to execute the SetEndpointAttributes service method. The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetEndpointAttributes Operation 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. Container for the necessary parameters to execute the SetEndpointAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetEndpointAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetEndpointAttributes Operation 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. Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method. The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetPlatformApplicationAttributes Operation 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. Container for the necessary parameters to execute the SetPlatformApplicationAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetPlatformApplicationAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. REST API Reference for SetPlatformApplicationAttributes Operation 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. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. Container for the necessary parameters to execute the SetSMSAttributes service method. The response from the SetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for SetSMSAttributes Operation 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. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. Container for the necessary parameters to execute the SetSMSAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSMSAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. REST API Reference for SetSMSAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. The ARN of the subscription to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The new value for the attribute in JSON format. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. Container for the necessary parameters to execute the SetSubscriptionAttributes service method. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. The ARN of the subscription to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The new value for the attribute in JSON format. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation Allows a subscription owner to set an attribute of the subscription to a new value. Container for the necessary parameters to execute the SetSubscriptionAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetSubscriptionAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. REST API Reference for SetSubscriptionAttributes Operation 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. The ARN of the topic to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The new value for the attribute. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. Container for the necessary parameters to execute the SetTopicAttributes service method. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. The ARN of the topic to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The new value for the attribute. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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. Container for the necessary parameters to execute the SetTopicAttributes service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the SetTopicAttributes service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for SetTopicAttributes Operation 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 two days. This action is throttled at 100 transactions per second (TPS). The ARN of the topic you want to subscribe to. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). Container for the necessary parameters to execute the Subscribe service method. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). The ARN of the topic you want to subscribe to. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 two days. This action is throttled at 100 transactions per second (TPS). Container for the necessary parameters to execute the Subscribe service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Subscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Indicates that the customer already owns the maximum allowed number of subscriptions. REST API Reference for Subscribe Operation 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
Container for the necessary parameters to execute the TagResource service method. The response from the TagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for TagResource Operation 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
Container for the necessary parameters to execute the TagResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the TagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for TagResource Operation 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). The ARN of the subscription to be deleted. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). Container for the necessary parameters to execute the Unsubscribe service method. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). The ARN of the subscription to be deleted. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation 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). Container for the necessary parameters to execute the Unsubscribe service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the Unsubscribe service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Indicates that the requested resource does not exist. REST API Reference for Unsubscribe Operation Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the UntagResource service method. The response from the UntagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for UntagResource Operation Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the UntagResource service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the UntagResource service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Can't add more than 50 tags to a topic. The request doesn't comply with the IAM tag policy. Correct your request and then retry it. REST API Reference for UntagResource Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the VerifySMSSandboxPhoneNumber service method. The response from the VerifySMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that the one-time password (OTP) used for verification is invalid. REST API Reference for VerifySMSSandboxPhoneNumber Operation 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 SMS sandbox in the Amazon SNS Developer Guide. Container for the necessary parameters to execute the VerifySMSSandboxPhoneNumber service method. A cancellation token that can be used by other objects or threads to receive notice of cancellation. The response from the VerifySMSSandboxPhoneNumber service method, as returned by SimpleNotificationService. Indicates that the user has been denied access to the requested resource. Indicates an internal service error. Indicates that a request parameter does not comply with the associated constraints. Can’t perform the action on the specified resource. Make sure that the resource exists. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Indicates that the one-time password (OTP) used for verification is invalid. REST API Reference for VerifySMSSandboxPhoneNumber Operation Returns the endpoint that will be used for a particular request. Request for the desired service operation. The resolved endpoint for the given request. This class reads in JSON formatted Amazon SNS messages into Message objects. The messages can also be verified using the IsMessageSignatureValid operation. The value of the Type property for a subscription confirmation message The value of the Type property for a unsubscribe confirmation message The value of the Type property for a notification message Parses the JSON message from Amazon SNS into the Message object. The JSON text from an Amazon SNS message The Message object with properties set from the JSON document Gets a Universally Unique Identifier, unique for each message published. For a notification that Amazon SNS resends during a retry, the message ID of the original message is used. Gets the MessageText value specified when the notification was published to the topic. Gets the Base64-encoded "SHA1withRSA" or "SHA256withRSA" signature of the Message, MessageId, Subject (if present), Type, Timestamp, and TopicArn values. Gets the Version of the Amazon SNS signature used. Gets the URL to the certificate that was used to sign the message. Gets the Subject parameter specified when the notification was published to the topic. Note that this is an optional parameter. If no Subject was specified, then this name/value pair does not appear in this JSON document. Gets the URL that you must visit in order to re-confirm the subscription. Alternatively, you can instead use the Token with the ConfirmSubscription action to re-confirm the subscription. Gets the time (GMT) when the notification was published. Gets a value you can use with the ConfirmSubscription action to re-confirm the subscription. Alternatively, you can simply visit the SubscribeURL. Gets the Amazon Resource Name (ARN) for the topic. Gets the type of message. Possible values are Notification, SubscriptionConfirmation, and UnsubscribeConfirmation. Returns true if the message type is a subscription confirmation. True if the message type is a subscription confirmation. Returns true if the message type is a unsubscribe confirmation. True if the message type is a unsubscribe confirmation. Returns true if the message type is a notification message. True if the message type is a notification message. Gets a URL that you can use to unsubscribe the endpoint from this topic. If you visit this URL, Amazon SNS unsubscribes the endpoint and stops sending notifications to this endpoint. Verifies that the signing certificate url is from a recognizable source. Returns the cert url if it cen be verified, otherwise throws an exception. Verifies the SignatureVersion is either 1 for SHA1 or 2 for SHA256 Returns true if is a valid value, otherwise throws an exception SignatureVersion in a SNS message Returns the SignatureVersion if it's a valid value, otherwise throws an exception Verifies the authenticity of a message sent by Amazon SNS. This is done by computing a signature from the fields in the message and then comparing the signature to the signature provided as part of the message. Returns true if the message is authentic. Build the string to sign for Notification messages. The string to sign Build the string to sign for SubscriptionConfirmation and UnsubscribeConfirmation messages. The string to sign Uses the SubscribeURL property to subscribe to the topic Uses the UnsubscribeURL property to unsubscribe from the topic Configuration for accessing Amazon SimpleNotificationService service The ServiceId, which is the unique identifier for a service. Default constructor The constant used to lookup in the region hash the endpoint. Gets the ServiceVersion property. Gets the value of UserAgent property. Configuration for accessing Amazon SimpleNotificationService service Collection of all s supported by SimpleNotificationService

The STANDARD mode provides the latest recommended default values that should be safe to run in most scenarios

Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK

The IN_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services from within the same AWS region

Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK

The CROSS_REGION mode builds on the standard mode and includes optimization tailored for applications which call AWS services in a different region

Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK

The MOBILE mode builds on the standard mode and includes optimization tailored for mobile applications

Note that the default values vended from this mode might change as best practices may evolve. As a result, it is encouraged to perform tests when upgrading the SDK

The AUTO mode is an experimental mode that builds on the standard mode. The SDK will attempt to discover the execution environment to determine the appropriate settings automatically.

Note that the auto detection is heuristics-based and does not guarantee 100% accuracy. STANDARD mode will be used if the execution environment cannot be determined. The auto detection might query EC2 Instance Metadata service, which might introduce latency. Therefore we recommend choosing an explicit defaults_mode instead if startup latency is critical to your application

The LEGACY mode provides default settings that vary per SDK and were used prior to establishment of defaults_mode

 Contains parameters used for resolving SimpleNotificationService endpoints Parameters can be sourced from client config and service operations Used by internal SimpleNotificationServiceEndpointProvider and SimpleNotificationServiceEndpointResolver Can be used by custom EndpointProvider, see ClientConfig.EndpointProvider SimpleNotificationServiceEndpointParameters constructor Region parameter UseDualStack parameter UseFIPS parameter Endpoint parameter Common exception for the SimpleNotificationService service. Construct instance of AmazonSimpleNotificationServiceException Construct instance of AmazonSimpleNotificationServiceException Construct instance of AmazonSimpleNotificationServiceException Construct instance of AmazonSimpleNotificationServiceException Construct instance of AmazonSimpleNotificationServiceException Constructs a new instance of the AmazonSimpleNotificationServiceException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Amazon SimpleNotificationService endpoint provider. Resolves endpoint for given set of SimpleNotificationServiceEndpointParameters. Can throw AmazonClientException if endpoint resolution is unsuccessful. Resolve endpoint for SimpleNotificationServiceEndpointParameters Amazon SimpleNotificationService endpoint resolver. Custom PipelineHandler responsible for resolving endpoint and setting authentication parameters for SimpleNotificationService service requests. Collects values for SimpleNotificationServiceEndpointParameters and then tries to resolve endpoint by calling ResolveEndpoint method on GlobalEndpoints.Provider if present, otherwise uses SimpleNotificationServiceEndpointProvider. Responsible for setting authentication and http headers provided by resolved endpoint. Service metadata for Amazon SimpleNotificationService service Gets the value of the Service Id. Gets the dictionary that gives mapping of renamed operations Container for the parameters to the AddPermission operation. 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. Empty constructor used to set properties independently even when a simple constructor is available Instantiates AddPermissionRequest with the parameterized properties The ARN of the topic whose access control policy you wish to modify. A unique identifier for the new policy statement. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. Gets and sets the property ActionName. The action you want to allow for the specified principal(s). Valid values: Any Amazon SNS action name, for example Publish. Gets and sets the property AWSAccountId. The Amazon Web Services account IDs of the users (principals) who will be given access to the specified actions. The users must have Amazon Web Services account, but do not need to be signed up for this service. Gets and sets the property Label. A unique identifier for the new policy statement. Gets and sets the property TopicArn. The ARN of the topic whose access control policy you wish to modify. This is the response object from the AddPermission operation. Indicates that the user has been denied access to the requested resource. Constructs a new AuthorizationErrorException with the specified error message. Describes the error encountered. Construct instance of AuthorizationErrorException Construct instance of AuthorizationErrorException Construct instance of AuthorizationErrorException Construct instance of AuthorizationErrorException Constructs a new instance of the AuthorizationErrorException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Two or more batch entries in the request have the same Id. Constructs a new BatchEntryIdsNotDistinctException with the specified error message. Describes the error encountered. Construct instance of BatchEntryIdsNotDistinctException Construct instance of BatchEntryIdsNotDistinctException Construct instance of BatchEntryIdsNotDistinctException Construct instance of BatchEntryIdsNotDistinctException Constructs a new instance of the BatchEntryIdsNotDistinctException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The length of all the batch messages put together is more than the limit. Constructs a new BatchRequestTooLongException with the specified error message. Describes the error encountered. Construct instance of BatchRequestTooLongException Construct instance of BatchRequestTooLongException Construct instance of BatchRequestTooLongException Construct instance of BatchRequestTooLongException Constructs a new instance of the BatchRequestTooLongException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Gives a detailed description of failed messages in the batch. Gets and sets the property Code. An error code representing why the action failed on this entry. Gets and sets the property Id. The Id of an entry in a batch request Gets and sets the property Message. A message explaining why the action failed on this entry. Gets and sets the property SenderFault. Specifies whether the error happened due to the caller of the batch API action. Container for the parameters to the CheckIfPhoneNumberIsOptedOut operation. 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. Gets and sets the property PhoneNumber. The phone number for which you want to check the opt out status. The response from the CheckIfPhoneNumberIsOptedOut action. Gets and sets the property IsOptedOut. Indicates whether the phone number is opted out:
  • true – The phone number is opted out, meaning you cannot publish SMS messages to it.
  • false – The phone number is opted in, meaning you can publish SMS messages to it.
Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially. Constructs a new ConcurrentAccessException with the specified error message. Describes the error encountered. Construct instance of ConcurrentAccessException Construct instance of ConcurrentAccessException Construct instance of ConcurrentAccessException Construct instance of ConcurrentAccessException Constructs a new instance of the ConcurrentAccessException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the ConfirmSubscription operation. 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". Empty constructor used to set properties independently even when a simple constructor is available Instantiates ConfirmSubscriptionRequest with the parameterized properties The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Instantiates ConfirmSubscriptionRequest with the parameterized properties The ARN of the topic for which you wish to confirm a subscription. Short-lived token sent to an endpoint during the Subscribe action. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. Gets and sets the property AuthenticateOnUnsubscribe. Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication. Gets and sets the property Token. Short-lived token sent to an endpoint during the Subscribe action. Gets and sets the property TopicArn. The ARN of the topic for which you wish to confirm a subscription. Response for ConfirmSubscriptions action. Gets and sets the property SubscriptionArn. The ARN of the created subscription. Container for the parameters to the CreatePlatformApplication operation. 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
  • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
  • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • 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. Gets and sets the property Attributes. For a list of attributes, see SetPlatformApplicationAttributes . Gets and sets the property Name. Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long. Gets and sets the property Platform. The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging). Response from CreatePlatformApplication action. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn is returned. Container for the parameters to the CreatePlatformEndpoint operation. 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. 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 Creating an Amazon SNS Endpoint for Baidu. Gets and sets the property Attributes. For a list of attributes, see SetEndpointAttributes . Gets and sets the property CustomUserData. Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. Gets and sets the property Token. Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID. Response from CreateEndpoint action. Gets and sets the property EndpointArn. EndpointArn returned from CreateEndpoint action. Container for the parameters to the CreateSMSSandboxPhoneNumber operation. 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 SMS sandbox in the Amazon SNS Developer Guide. Gets and sets the property LanguageCode. The language to use for sending the OTP. The default value is en-US. Gets and sets the property PhoneNumber. The destination phone number to verify. On verification, Amazon SNS adds this phone number to the list of verified phone numbers that you can send SMS messages to. This is the response object from the CreateSMSSandboxPhoneNumber operation. Container for the parameters to the CreateTopic operation. 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 Creating an Amazon SNS topic 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. Empty constructor used to set properties independently even when a simple constructor is available Instantiates CreateTopicRequest with the parameterized properties The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. Gets and sets the property Attributes. A map of attributes with their corresponding values. The following lists names, descriptions, and values of the special request parameters that the CreateTopic action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • FifoTopic – Set to true to create a FIFO topic.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
  • ArchivePolicy – Adds or updates an inline policy document to archive messages stored in the specified Amazon SNS topic.
  • BeginningArchiveTime – The earliest starting point at which a message in the topic’s archive can be replayed from. This point in time is based on the configured message retention period set by the topic’s message archiving policy.
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Gets and sets the property DataProtectionPolicy. The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720. Gets and sets the property Name. The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix. Gets and sets the property Tags. The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the sns:CreateTopic and sns:TagResource permissions. Response from CreateTopic action. Gets and sets the property TopicArn. The Amazon Resource Name (ARN) assigned to the created topic. Container for the parameters to the DeleteEndpoint operation. 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. Gets and sets the property EndpointArn. EndpointArn of endpoint to delete. This is the response object from the DeleteEndpoint operation. Container for the parameters to the DeletePlatformApplication operation. 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. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn of platform application object to delete. This is the response object from the DeletePlatformApplication operation. Container for the parameters to the DeleteSMSSandboxPhoneNumber operation. 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 SMS sandbox in the Amazon SNS Developer Guide. Gets and sets the property PhoneNumber. The destination phone number to delete. This is the response object from the DeleteSMSSandboxPhoneNumber operation. Container for the parameters to the DeleteTopic operation. 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. Empty constructor used to set properties independently even when a simple constructor is available Instantiates DeleteTopicRequest with the parameterized properties The ARN of the topic you want to delete. Gets and sets the property TopicArn. The ARN of the topic you want to delete. This is the response object from the DeleteTopic operation. The batch request doesn't contain any entries. Constructs a new EmptyBatchRequestException with the specified error message. Describes the error encountered. Construct instance of EmptyBatchRequestException Construct instance of EmptyBatchRequestException Construct instance of EmptyBatchRequestException Construct instance of EmptyBatchRequestException Constructs a new instance of the EmptyBatchRequestException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The endpoint for mobile app and device. Gets and sets the property Attributes. Attributes for endpoint. Gets and sets the property EndpointArn. The EndpointArn for mobile app and device. Exception error indicating endpoint disabled. Constructs a new EndpointDisabledException with the specified error message. Describes the error encountered. Construct instance of EndpointDisabledException Construct instance of EndpointDisabledException Construct instance of EndpointDisabledException Construct instance of EndpointDisabledException Constructs a new instance of the EndpointDisabledException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center. Constructs a new FilterPolicyLimitExceededException with the specified error message. Describes the error encountered. Construct instance of FilterPolicyLimitExceededException Construct instance of FilterPolicyLimitExceededException Construct instance of FilterPolicyLimitExceededException Construct instance of FilterPolicyLimitExceededException Constructs a new instance of the FilterPolicyLimitExceededException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the GetDataProtectionPolicy operation. Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic. Gets and sets the property ResourceArn. The ARN of the topic whose DataProtectionPolicy you want to get. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. This is the response object from the GetDataProtectionPolicy operation. Gets and sets the property DataProtectionPolicy. Retrieves the DataProtectionPolicy in JSON string format. Container for the parameters to the GetEndpointAttributes operation. 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. Gets and sets the property EndpointArn. EndpointArn for GetEndpointAttributes input. Response from GetEndpointAttributes of the EndpointArn. Gets and sets the property Attributes. Attributes include the following:
  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service. The device token for the iOS platform is returned in lowercase.
Container for the parameters to the GetPlatformApplicationAttributes operation. 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. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn for GetPlatformApplicationAttributesInput. Response for GetPlatformApplicationAttributes action. Gets and sets the property Attributes. Attributes include the following:
  • AppleCertificateExpiryDate – The expiry date of the SSL certificate used to configure certificate-based authentication.
  • ApplePlatformTeamID – The Apple developer account ID used to configure token-based authentication.
  • ApplePlatformBundleID – The app identifier used to configure token-based authentication.
  • AuthenticationMethod – Returns the credential type used when sending push notifications from application to APNS/APNS_Sandbox, or application to GCM.
    • APNS – Returns the token or certificate.
    • GCM – Returns the token or key.
  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.
  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.
  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.
  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
Container for the parameters to the GetSMSAttributes operation. Returns the settings for sending SMS messages from your Amazon Web Services account. These settings are set with the SetSMSAttributes action. Gets and sets the property Attributes. A list of the individual attribute names, such as MonthlySpendLimit, for which you want values. For all attribute names, see SetSMSAttributes. If you don't use this parameter, Amazon SNS returns all SMS attributes. The response from the GetSMSAttributes request. Gets and sets the property Attributes. The SMS attribute names and their values. Container for the parameters to the GetSMSSandboxAccountStatus operation. 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 SMS sandbox in the Amazon SNS Developer Guide. This is the response object from the GetSMSSandboxAccountStatus operation. Gets and sets the property IsInSandbox. Indicates whether the calling Amazon Web Services account is in the SMS sandbox. Container for the parameters to the GetSubscriptionAttributes operation. Returns all of the properties of a subscription. Empty constructor used to set properties independently even when a simple constructor is available Instantiates GetSubscriptionAttributesRequest with the parameterized properties The ARN of the subscription whose properties you want to get. Gets and sets the property SubscriptionArn. The ARN of the subscription whose properties you want to get. Response for GetSubscriptionAttributes action. Gets and sets the property Attributes. A map of the subscription's attributes. Attributes in this map include the following:
  • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • Owner – The Amazon Web Services account ID of the subscription's owner.
  • PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
  • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
  • SubscriptionArn – The subscription's ARN.
  • TopicArn – The topic ARN that the subscription is associated with.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
Container for the parameters to the GetTopicAttributes operation. Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user. Empty constructor used to set properties independently even when a simple constructor is available Instantiates GetTopicAttributesRequest with the parameterized properties The ARN of the topic whose properties you want to get. Gets and sets the property TopicArn. The ARN of the topic whose properties you want to get. Response for GetTopicAttributes action. Gets and sets the property Attributes. A map of the topic's attributes. Attributes in this map include the following:
  • DeliveryPolicy – The JSON serialization of the topic's delivery policy.
  • DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
  • Owner – The Amazon Web Services account ID of the topic's owner.
  • Policy – The JSON serialization of the topic's access control policy.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
    • By default, SignatureVersion is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
    • When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature. If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
  • SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
  • SubscriptionsDeleted – The number of deleted subscriptions for the topic.
  • SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
  • TopicArn – The topic's ARN.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
  • FifoTopic – When this is set to true, a FIFO topic is created.
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Indicates an internal service error. Constructs a new InternalErrorException with the specified error message. Describes the error encountered. Construct instance of InternalErrorException Construct instance of InternalErrorException Construct instance of InternalErrorException Construct instance of InternalErrorException Constructs a new instance of the InternalErrorException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). AddPermission Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for AddPermission operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for AuthorizationErrorException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for BatchEntryIdsNotDistinctException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for BatchRequestTooLongException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for BatchResultErrorEntry Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. CheckIfPhoneNumberIsOptedOut Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for CheckIfPhoneNumberIsOptedOut operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for ConcurrentAccessException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ConfirmSubscription Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ConfirmSubscription operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. CreatePlatformApplication Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for CreatePlatformApplication operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. CreatePlatformEndpoint Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for CreatePlatformEndpoint operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. CreateSMSSandboxPhoneNumber Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for CreateSMSSandboxPhoneNumber operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. CreateTopic Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for CreateTopic operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. DeleteEndpoint Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for DeleteEndpoint operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. DeletePlatformApplication Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for DeletePlatformApplication operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. DeleteSMSSandboxPhoneNumber Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for DeleteSMSSandboxPhoneNumber operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. DeleteTopic Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for DeleteTopic operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for EmptyBatchRequestException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for EndpointDisabledException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for Endpoint Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for FilterPolicyLimitExceededException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetDataProtectionPolicy Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetDataProtectionPolicy operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetEndpointAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetEndpointAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetPlatformApplicationAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetPlatformApplicationAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetSMSAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetSMSAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetSMSSandboxAccountStatus Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetSMSSandboxAccountStatus operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetSubscriptionAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetSubscriptionAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. GetTopicAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for GetTopicAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InternalErrorException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InvalidBatchEntryIdException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InvalidParameterException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InvalidParameterValueException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InvalidSecurityException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for InvalidStateException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSAccessDeniedException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSDisabledException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSInvalidStateException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSNotFoundException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSOptInRequiredException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for KMSThrottlingException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListEndpointsByPlatformApplication Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListEndpointsByPlatformApplication operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListOriginationNumbers Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListOriginationNumbers operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListPhoneNumbersOptedOut Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListPhoneNumbersOptedOut operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListPlatformApplications Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListPlatformApplications operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListSMSSandboxPhoneNumbers Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListSMSSandboxPhoneNumbers operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListSubscriptionsByTopic Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListSubscriptionsByTopic operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListSubscriptions Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListSubscriptions operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListTagsForResource Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListTagsForResource operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. ListTopics Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for ListTopics operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for NotFoundException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for OptedOutException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. OptInPhoneNumber Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for OptInPhoneNumber operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for PhoneNumberInformation Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for PlatformApplicationDisabledException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for PlatformApplication Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. PublishBatch Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for PublishBatch operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for PublishBatchResultEntry Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Publish Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for Publish operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. PutDataProtectionPolicy Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for PutDataProtectionPolicy operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. RemovePermission Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for RemovePermission operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for ReplayLimitExceededException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for ResourceNotFoundException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. SetEndpointAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for SetEndpointAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. SetPlatformApplicationAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for SetPlatformApplicationAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. SetSMSAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for SetSMSAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. SetSubscriptionAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for SetSubscriptionAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. SetTopicAttributes Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for SetTopicAttributes operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for SMSSandboxPhoneNumber Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for StaleTagException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Subscribe Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for Subscribe operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for SubscriptionLimitExceededException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for Subscription Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for TagLimitExceededException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for TagPolicyException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. TagResource Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for TagResource operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for Tag Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for ThrottledException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for TooManyEntriesInBatchRequestException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for TopicLimitExceededException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for Topic Object Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Unsubscribe Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for Unsubscribe operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. UntagResource Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for UntagResource operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for UserErrorException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for ValidationException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. Response Unmarshaller for VerificationException operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. VerifySMSSandboxPhoneNumber Request Marshaller Marshaller the request object to the HTTP request. Marshaller the request object to the HTTP request. Gets the singleton. Response Unmarshaller for VerifySMSSandboxPhoneNumber operation Unmarshaller the response from the service to the response class. Unmarshaller error response to exception. Gets the singleton. The Id of a batch entry in a batch request doesn't abide by the specification. Constructs a new InvalidBatchEntryIdException with the specified error message. Describes the error encountered. Construct instance of InvalidBatchEntryIdException Construct instance of InvalidBatchEntryIdException Construct instance of InvalidBatchEntryIdException Construct instance of InvalidBatchEntryIdException Constructs a new instance of the InvalidBatchEntryIdException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that a request parameter does not comply with the associated constraints. Constructs a new InvalidParameterException with the specified error message. Describes the error encountered. Construct instance of InvalidParameterException Construct instance of InvalidParameterException Construct instance of InvalidParameterException Construct instance of InvalidParameterException Constructs a new instance of the InvalidParameterException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that a request parameter does not comply with the associated constraints. Constructs a new InvalidParameterValueException with the specified error message. Describes the error encountered. Construct instance of InvalidParameterValueException Construct instance of InvalidParameterValueException Construct instance of InvalidParameterValueException Construct instance of InvalidParameterValueException Constructs a new instance of the InvalidParameterValueException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4. Constructs a new InvalidSecurityException with the specified error message. Describes the error encountered. Construct instance of InvalidSecurityException Construct instance of InvalidSecurityException Construct instance of InvalidSecurityException Construct instance of InvalidSecurityException Constructs a new instance of the InvalidSecurityException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that the specified state is not a valid state for an event source. Constructs a new InvalidStateException with the specified error message. Describes the error encountered. Construct instance of InvalidStateException Construct instance of InvalidStateException Construct instance of InvalidStateException Construct instance of InvalidStateException Constructs a new instance of the InvalidStateException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The ciphertext references a key that doesn't exist or that you don't have access to. Constructs a new KMSAccessDeniedException with the specified error message. Describes the error encountered. Construct instance of KMSAccessDeniedException Construct instance of KMSAccessDeniedException Construct instance of KMSAccessDeniedException Construct instance of KMSAccessDeniedException Constructs a new instance of the KMSAccessDeniedException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The request was rejected because the specified Amazon Web Services KMS key isn't enabled. Constructs a new KMSDisabledException with the specified error message. Describes the error encountered. Construct instance of KMSDisabledException Construct instance of KMSDisabledException Construct instance of KMSDisabledException Construct instance of KMSDisabledException Constructs a new instance of the KMSDisabledException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide. Constructs a new KMSInvalidStateException with the specified error message. Describes the error encountered. Construct instance of KMSInvalidStateException Construct instance of KMSInvalidStateException Construct instance of KMSInvalidStateException Construct instance of KMSInvalidStateException Constructs a new instance of the KMSInvalidStateException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The request was rejected because the specified entity or resource can't be found. Constructs a new KMSNotFoundException with the specified error message. Describes the error encountered. Construct instance of KMSNotFoundException Construct instance of KMSNotFoundException Construct instance of KMSNotFoundException Construct instance of KMSNotFoundException Constructs a new instance of the KMSNotFoundException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The Amazon Web Services access key ID needs a subscription for the service. Constructs a new KMSOptInRequiredException with the specified error message. Describes the error encountered. Construct instance of KMSOptInRequiredException Construct instance of KMSOptInRequiredException Construct instance of KMSOptInRequiredException Construct instance of KMSOptInRequiredException Constructs a new instance of the KMSOptInRequiredException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide. Constructs a new KMSThrottlingException with the specified error message. Describes the error encountered. Construct instance of KMSThrottlingException Construct instance of KMSThrottlingException Construct instance of KMSThrottlingException Construct instance of KMSThrottlingException Constructs a new instance of the KMSThrottlingException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the ListEndpointsByPlatformApplication operation. 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. This action is throttled at 30 transactions per second (TPS). Gets and sets the property NextToken. NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. Response for ListEndpointsByPlatformApplication action. Gets and sets the property Endpoints. Endpoints returned for ListEndpointsByPlatformApplication action. Gets and sets the property NextToken. NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. Container for the parameters to the ListOriginationNumbers operation. Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide. Gets and sets the property MaxResults. The maximum number of origination numbers to return. Gets and sets the property NextToken. Token that the previous ListOriginationNumbers request returns. This is the response object from the ListOriginationNumbers operation. Gets and sets the property NextToken. A NextToken string is returned when you call the ListOriginationNumbers operation if additional pages of records are available. Gets and sets the property PhoneNumbers. A list of the calling account's verified and pending origination numbers. Container for the parameters to the ListPhoneNumbersOptedOut operation. 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. Gets and sets the property NextToken. A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results. The response from the ListPhoneNumbersOptedOut action. Gets and sets the property NextToken. A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results. Gets and sets the property PhoneNumbers. A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers. Container for the parameters to the ListPlatformApplications operation. 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. This action is throttled at 15 transactions per second (TPS). Gets and sets the property NextToken. NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. Response for ListPlatformApplications action. Gets and sets the property NextToken. NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results. Gets and sets the property PlatformApplications. Platform applications returned when calling ListPlatformApplications action. Container for the parameters to the ListSMSSandboxPhoneNumbers operation. 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 SMS sandbox in the Amazon SNS Developer Guide. Gets and sets the property MaxResults. The maximum number of phone numbers to return. Gets and sets the property NextToken. Token that the previous ListSMSSandboxPhoneNumbersInput request returns. This is the response object from the ListSMSSandboxPhoneNumbers operation. Gets and sets the property NextToken. A NextToken string is returned when you call the ListSMSSandboxPhoneNumbersInput operation if additional pages of records are available. Gets and sets the property PhoneNumbers. A list of the calling account's pending and verified phone numbers. Container for the parameters to the ListSubscriptionsByTopic operation. 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). Empty constructor used to set properties independently even when a simple constructor is available Instantiates ListSubscriptionsByTopicRequest with the parameterized properties The ARN of the topic for which you wish to find subscriptions. Instantiates ListSubscriptionsByTopicRequest with the parameterized properties The ARN of the topic for which you wish to find subscriptions. Token returned by the previous ListSubscriptionsByTopic request. Gets and sets the property NextToken. Token returned by the previous ListSubscriptionsByTopic request. Gets and sets the property TopicArn. The ARN of the topic for which you wish to find subscriptions. Response for ListSubscriptionsByTopic action. Gets and sets the property NextToken. Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve. Gets and sets the property Subscriptions. A list of subscriptions. Container for the parameters to the ListSubscriptions operation. 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). Empty constructor used to set properties independently even when a simple constructor is available Instantiates ListSubscriptionsRequest with the parameterized properties Token returned by the previous ListSubscriptions request. Gets and sets the property NextToken. Token returned by the previous ListSubscriptions request. Response for ListSubscriptions action Gets and sets the property NextToken. Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve. Gets and sets the property Subscriptions. A list of subscriptions. Container for the parameters to the ListTagsForResource operation. 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. Gets and sets the property ResourceArn. The ARN of the topic for which to list tags. This is the response object from the ListTagsForResource operation. Gets and sets the property Tags. The tags associated with the specified topic. Container for the parameters to the ListTopics operation. 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). Empty constructor used to set properties independently even when a simple constructor is available Instantiates ListTopicsRequest with the parameterized properties Token returned by the previous ListTopics request. Gets and sets the property NextToken. Token returned by the previous ListTopics request. Response for ListTopics action. Gets and sets the property NextToken. Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve. Gets and sets the property Topics. A list of topic ARNs. 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. Gets and sets the property BinaryValue. Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. Gets and sets the property DataType. Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. Gets and sets the property StringValue. Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters. Indicates that the requested resource does not exist. Constructs a new NotFoundException with the specified error message. Describes the error encountered. Construct instance of NotFoundException Construct instance of NotFoundException Construct instance of NotFoundException Construct instance of NotFoundException Constructs a new instance of the NotFoundException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out. Constructs a new OptedOutException with the specified error message. Describes the error encountered. Construct instance of OptedOutException Construct instance of OptedOutException Construct instance of OptedOutException Construct instance of OptedOutException Constructs a new instance of the OptedOutException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the OptInPhoneNumber operation. 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. Gets and sets the property PhoneNumber. The phone number to opt in. Use E.164 format. The response for the OptInPhoneNumber action. A list of phone numbers and their metadata. Gets and sets the property CreatedAt. The date and time when the phone number was created. Gets and sets the property Iso2CountryCode. The two-character code for the country or region, in ISO 3166-1 alpha-2 format. Gets and sets the property NumberCapabilities. The capabilities of each phone number. Gets and sets the property PhoneNumber. The phone number. Gets and sets the property RouteType. The list of supported routes. Gets and sets the property Status. The status of the phone number. Platform application object. Gets and sets the property Attributes. Attributes for platform application object. Gets and sets the property PlatformApplicationArn. PlatformApplicationArn for platform application object. Exception error indicating platform application disabled. Constructs a new PlatformApplicationDisabledException with the specified error message. Describes the error encountered. Construct instance of PlatformApplicationDisabledException Construct instance of PlatformApplicationDisabledException Construct instance of PlatformApplicationDisabledException Construct instance of PlatformApplicationDisabledException Constructs a new instance of the PlatformApplicationDisabledException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the PublishBatch operation. 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. Gets and sets the property PublishBatchRequestEntries. A list of PublishBatch request entries to be sent to the SNS topic. Gets and sets the property TopicArn. The Amazon resource name (ARN) of the topic you want to batch publish to. Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch. Gets and sets the property Id. An identifier for the message in this batch. The Ids of a batch request must be unique within a request. This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_). Gets and sets the property Message. The body of the message. Gets and sets the property MessageAttributes. Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SNS message attributes in the Amazon SNS Developer Guide. Gets and sets the property MessageDeduplicationId. This parameter applies only to FIFO (first-in-first-out) topics. The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered.
  • Every message must have a unique MessageDeduplicationId.
    • You may provide a MessageDeduplicationId explicitly.
    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your topic, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    • If you don't provide a MessageDeduplicationId and the topic doesn't have ContentBasedDeduplication set, the action fails with an error.
    • If the topic has a ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.
  • If you send one message with ContentBasedDeduplication enabled, and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.
The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues). If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SNS can't detect duplicate messages. Amazon SNS continues to keep track of the message deduplication ID even after the message is received and deleted. The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). Gets and sets the property MessageGroupId. This parameter applies only to FIFO (first-in-first-out) topics. The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single topic, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the topic, but the session data of each user is processed in a FIFO fashion. You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails. The length of MessageGroupId is 128 characters. MessageGroupId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). MessageGroupId is required for FIFO topics. You can't use it for standard topics. Gets and sets the property MessageStructure. Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
  • be a syntactically valid JSON object; and
  • contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g. http). Gets and sets the property Subject. The subject of the batch message. This is the response object from the PublishBatch operation. Gets and sets the property Failed. A list of failed PublishBatch responses. Gets and sets the property Successful. A list of successful PublishBatch responses. Encloses data related to a successful message in a batch request for topic. Gets and sets the property Id. The Id of an entry in a batch request. Gets and sets the property MessageId. An identifier for the message. Gets and sets the property SequenceNumber. This parameter applies only to FIFO (first-in-first-out) topics. The large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId. Container for the parameters to the Publish operation. 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 Send Custom Platform-Specific Payloads in Messages to Mobile Devices. You can publish messages only to topics and endpoints in the same Amazon Web Services Region. Empty constructor used to set properties independently even when a simple constructor is available Instantiates PublishRequest with the parameterized properties The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Instantiates PublishRequest with the parameterized properties The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. Gets and sets the property Message. The message you want to send. If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter. Constraints:
  • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
  • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters. If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries. The total size limit for a single SMS Publish action is 1,600 characters.
JSON-specific constraints:
  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
  • The values will be parsed (unescaped) before they are used in outgoing messages.
  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
  • Values have a minimum length of 0 (the empty string, "", is allowed).
  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
  • Non-string values will cause the key to be ignored.
  • Keys that do not correspond to supported transport protocols are ignored.
  • Duplicate keys are not allowed.
  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).
Gets and sets the property MessageAttributes. Message attributes for Publish action. Gets and sets the property MessageDeduplicationId. This parameter applies only to FIFO (first-in-first-out) topics. The MessageDeduplicationId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). Every message must have a unique MessageDeduplicationId, which is a token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any message sent with the same MessageDeduplicationId during the 5-minute deduplication interval is treated as a duplicate. If the topic has ContentBasedDeduplication set, the system generates a MessageDeduplicationId based on the contents of the message. Your MessageDeduplicationId overrides the generated one. Gets and sets the property MessageGroupId. This parameter applies only to FIFO (first-in-first-out) topics. The MessageGroupId can contain up to 128 alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~). The MessageGroupId is a tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). Every message must include a MessageGroupId. Gets and sets the property MessageStructure. Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:
  • be a syntactically valid JSON object; and
  • contain at least a top-level JSON key of "default" with a value that is a string.
You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http"). Valid value: json Gets and sets the property PhoneNumber. The phone number to which you want to deliver an SMS message. Use E.164 format. If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters. Gets and sets the property Subject. Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints. Constraints: Subjects must be UTF-8 text with no line breaks or control characters, and less than 100 characters long. Gets and sets the property TargetArn. If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters. Gets and sets the property TopicArn. The topic you want to publish to. If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters. Response for Publish action. Gets and sets the property MessageId. Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters Gets and sets the property SequenceNumber. This response element applies only to FIFO (first-in-first-out) topics. The sequence number is a large, non-consecutive number that Amazon SNS assigns to each message. The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for each MessageGroupId. Container for the parameters to the PutDataProtectionPolicy operation. Adds or updates an inline policy document that is stored in the specified Amazon SNS topic. Gets and sets the property DataProtectionPolicy. The JSON serialization of the topic's DataProtectionPolicy. The DataProtectionPolicy must be in JSON string format. Length Constraints: Maximum length of 30,720. Gets and sets the property ResourceArn. The ARN of the topic whose DataProtectionPolicy you want to add or update. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. This is the response object from the PutDataProtectionPolicy operation. Container for the parameters to the RemovePermission operation. 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. Empty constructor used to set properties independently even when a simple constructor is available Instantiates RemovePermissionRequest with the parameterized properties The ARN of the topic whose access control policy you wish to modify. The unique label of the statement you want to remove. Gets and sets the property Label. The unique label of the statement you want to remove. Gets and sets the property TopicArn. The ARN of the topic whose access control policy you wish to modify. This is the response object from the RemovePermission operation. Indicates that the request parameter has exceeded the maximum number of concurrent message replays. Constructs a new ReplayLimitExceededException with the specified error message. Describes the error encountered. Construct instance of ReplayLimitExceededException Construct instance of ReplayLimitExceededException Construct instance of ReplayLimitExceededException Construct instance of ReplayLimitExceededException Constructs a new instance of the ReplayLimitExceededException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Can’t perform the action on the specified resource. Make sure that the resource exists. Constructs a new ResourceNotFoundException with the specified error message. Describes the error encountered. Construct instance of ResourceNotFoundException Construct instance of ResourceNotFoundException Construct instance of ResourceNotFoundException Construct instance of ResourceNotFoundException Constructs a new instance of the ResourceNotFoundException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the SetEndpointAttributes operation. 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. Gets and sets the property Attributes. A map of the endpoint attributes. Attributes in this map include the following:
  • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
  • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
  • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.
Gets and sets the property EndpointArn. EndpointArn used for SetEndpointAttributes action. This is the response object from the SetEndpointAttributes operation. Container for the parameters to the SetPlatformApplicationAttributes operation. 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. Gets and sets the property Attributes. A map of the platform application attributes. Attributes in this map include the following:
  • PlatformCredential – The credential received from the notification service.
    • For ADM, PlatformCredentialis client secret.
    • For Apple Services using certificate credentials, PlatformCredential is private key.
    • For Apple Services using token credentials, PlatformCredential is signing key.
    • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.
    • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
  • PlatformPrincipal – The principal received from the notification service.
    • For ADM, PlatformPrincipalis client id.
    • For Apple Services using certificate credentials, PlatformPrincipal is SSL certificate.
    • For Apple Services using token credentials, PlatformPrincipal is signing key ID.
    • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal.
  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.
  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.
  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.
  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
  • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
  • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.
The following attributes only apply to APNs token-based authentication:
  • ApplePlatformTeamID – The identifier that's assigned to your Apple developer account team.
  • ApplePlatformBundleID – The bundle identifier that's assigned to your iOS app.
Gets and sets the property PlatformApplicationArn. PlatformApplicationArn for SetPlatformApplicationAttributes action. This is the response object from the SetPlatformApplicationAttributes operation. Container for the parameters to the SetSMSAttributes operation. 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. To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action. Gets and sets the property Attributes. The default settings for sending SMS messages from your Amazon Web Services account. You can set values for the following attribute names: MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes. Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit. By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase. DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information. DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10. DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter. DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:
  • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
  • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.
UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your Amazon Web Services account:
  • Time that the message was published (in UTC)
  • Message ID
  • Destination phone number
  • Message type
  • Delivery status
  • Message price (in USD)
  • Part number (a message is split into multiple parts if it is too long for a single message)
  • Total number of parts
To receive the report, the bucket must have a policy that allows the Amazon SNS service principal to perform the s3:PutObject and s3:GetBucketLocation actions. For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide. The response for the SetSMSAttributes action. Container for the parameters to the SetSubscriptionAttributes operation. Allows a subscription owner to set an attribute of the subscription to a new value. Empty constructor used to set properties independently even when a simple constructor is available Instantiates SetSubscriptionAttributesRequest with the parameterized properties The ARN of the subscription to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The new value for the attribute in JSON format. Gets and sets the property AttributeName. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that this action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
Gets and sets the property AttributeValue. The new value for the attribute in JSON format. Gets and sets the property SubscriptionArn. The ARN of the subscription to modify. This is the response object from the SetSubscriptionAttributes operation. Container for the parameters to the SetTopicAttributes operation. 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. Empty constructor used to set properties independently even when a simple constructor is available Instantiates SetTopicAttributesRequest with the parameterized properties The ARN of the topic to modify. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
The new value for the attribute. Gets and sets the property AttributeName. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:
  • ApplicationSuccessFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • DisplayName – The display name to use for a topic with SMS subscriptions.
  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
  • TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
  • HTTP
    • HTTPSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
    • HTTPFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
  • Amazon Kinesis Data Firehose
    • FirehoseSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
    • FirehoseFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
  • Lambda
    • LambdaSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
    • LambdaFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
  • Platform application endpoint
    • ApplicationSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    • ApplicationFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
    In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services. For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
  • Amazon SQS
    • SQSSuccessFeedbackRoleArn – Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSSuccessFeedbackSampleRate – Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
    • SQSFailureFeedbackRoleArn – Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs. The following attribute applies only to server-side-encryption:
  • KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
  • SignatureVersion – The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion is set to 1.
The following attribute applies only to FIFO topics:
  • ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
    • By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
    • When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
Gets and sets the property AttributeValue. The new value for the attribute. Gets and sets the property TopicArn. The ARN of the topic to modify. This is the response object from the SetTopicAttributes operation. A verified or pending destination phone number 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 SMS sandbox in the Amazon SNS Developer Guide. Gets and sets the property PhoneNumber. The destination phone number. Gets and sets the property Status. The destination phone number's verification status. A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation. Constructs a new StaleTagException with the specified error message. Describes the error encountered. Construct instance of StaleTagException Construct instance of StaleTagException Construct instance of StaleTagException Construct instance of StaleTagException Constructs a new instance of the StaleTagException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the Subscribe operation. 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 two days. This action is throttled at 100 transactions per second (TPS). Empty constructor used to set properties independently even when a simple constructor is available Instantiates SubscribeRequest with the parameterized properties The ARN of the topic you want to subscribe to. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
Gets and sets the property Attributes. A map of attributes with their corresponding values. The following lists the names, descriptions, and values of the special request parameters that the Subscribe action uses:
  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
  • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
  • FilterPolicyScope – This attribute lets you choose the filtering scope by using one of the following string value types:
    • MessageAttributes (default) – The filter is applied on the message attributes.
    • MessageBody – The filter is applied on the message body.
  • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:
  • SubscriptionRoleArn – The ARN of the IAM role that has the following:
    • Permission to write to the Firehose delivery stream
    • Amazon SNS listed as a trusted entity
    Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.
The following attributes apply only to FIFO topics:
  • ReplayPolicy – Adds or updates an inline policy document for a subscription to replay messages stored in the specified Amazon SNS topic.
  • ReplayStatus – Retrieves the status of the subscription message replay, which can be one of the following:
    • Completed – The replay has successfully redelivered all messages, and is now delivering newly published messages. If an ending point was specified in the ReplayPolicy then the subscription will no longer receive newly published messages.
    • In progress – The replay is currently replaying the selected messages.
    • Failed – The replay was unable to complete.
    • Pending – The default state while the replay initiates.
Gets and sets the property Endpoint. The endpoint that you want to receive notifications. Endpoints vary by protocol:
  • For the http protocol, the (public) endpoint is a URL beginning with http://.
  • For the https protocol, the (public) endpoint is a URL beginning with https://.
  • For the email protocol, the endpoint is an email address.
  • For the email-json protocol, the endpoint is an email address.
  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device.
  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.
  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
  • For the lambda protocol, the endpoint is the ARN of an Lambda function.
  • For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
Gets and sets the property Protocol. The protocol that you want to use. Supported protocols include:
  • http – delivery of JSON-encoded message via HTTP POST
  • https – delivery of JSON-encoded message via HTTPS POST
  • email – delivery of message via SMTP
  • email-json – delivery of JSON-encoded message via SMTP
  • sms – delivery of message via SMS
  • sqs – delivery of JSON-encoded message to an Amazon SQS queue
  • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device
  • lambda – delivery of JSON-encoded message to an Lambda function
  • firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
Gets and sets the property ReturnSubscriptionArn. Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed. If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token. The default value is false. Gets and sets the property TopicArn. The ARN of the topic you want to subscribe to. Response for Subscribe action. Gets and sets the property SubscriptionArn. The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation. A wrapper type for the attributes of an Amazon SNS subscription. Empty constructor used to set properties independently even when a simple constructor is available Gets and sets the property Endpoint. The subscription's endpoint (format depends on the protocol). Gets and sets the property Owner. The subscription's owner. Gets and sets the property Protocol. The subscription's protocol. Gets and sets the property SubscriptionArn. The subscription's ARN. Gets and sets the property TopicArn. The ARN of the subscription's topic. Indicates that the customer already owns the maximum allowed number of subscriptions. Constructs a new SubscriptionLimitExceededException with the specified error message. Describes the error encountered. Construct instance of SubscriptionLimitExceededException Construct instance of SubscriptionLimitExceededException Construct instance of SubscriptionLimitExceededException Construct instance of SubscriptionLimitExceededException Constructs a new instance of the SubscriptionLimitExceededException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The list of tags to be added to the specified topic. Gets and sets the property Key. The required key portion of the tag. Gets and sets the property Value. The optional value portion of the tag. Can't add more than 50 tags to a topic. Constructs a new TagLimitExceededException with the specified error message. Describes the error encountered. Construct instance of TagLimitExceededException Construct instance of TagLimitExceededException Construct instance of TagLimitExceededException Construct instance of TagLimitExceededException Constructs a new instance of the TagLimitExceededException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The request doesn't comply with the IAM tag policy. Correct your request and then retry it. Constructs a new TagPolicyException with the specified error message. Describes the error encountered. Construct instance of TagPolicyException Construct instance of TagPolicyException Construct instance of TagPolicyException Construct instance of TagPolicyException Constructs a new instance of the TagPolicyException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the TagResource operation. 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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
Gets and sets the property ResourceArn. The ARN of the topic to which to add tags. Gets and sets the property Tags. The tags to be added to the specified topic. A tag consists of a required key and an optional value. This is the response object from the TagResource operation. Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account. Constructs a new ThrottledException with the specified error message. Describes the error encountered. Construct instance of ThrottledException Construct instance of ThrottledException Construct instance of ThrottledException Construct instance of ThrottledException Constructs a new instance of the ThrottledException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). The batch request contains more entries than permissible. Constructs a new TooManyEntriesInBatchRequestException with the specified error message. Describes the error encountered. Construct instance of TooManyEntriesInBatchRequestException Construct instance of TooManyEntriesInBatchRequestException Construct instance of TooManyEntriesInBatchRequestException Construct instance of TooManyEntriesInBatchRequestException Constructs a new instance of the TooManyEntriesInBatchRequestException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes. Empty constructor used to set properties independently even when a simple constructor is available Gets and sets the property TopicArn. The topic's ARN. Indicates that the customer already owns the maximum allowed number of topics. Constructs a new TopicLimitExceededException with the specified error message. Describes the error encountered. Construct instance of TopicLimitExceededException Construct instance of TopicLimitExceededException Construct instance of TopicLimitExceededException Construct instance of TopicLimitExceededException Constructs a new instance of the TopicLimitExceededException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Container for the parameters to the Unsubscribe operation. 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). Empty constructor used to set properties independently even when a simple constructor is available Instantiates UnsubscribeRequest with the parameterized properties The ARN of the subscription to be deleted. Gets and sets the property SubscriptionArn. The ARN of the subscription to be deleted. This is the response object from the Unsubscribe operation. Container for the parameters to the UntagResource operation. Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide. Gets and sets the property ResourceArn. The ARN of the topic from which to remove tags. Gets and sets the property TagKeys. The list of tag keys to remove from the specified topic. This is the response object from the UntagResource operation. Indicates that a request parameter does not comply with the associated constraints. Constructs a new UserErrorException with the specified error message. Describes the error encountered. Construct instance of UserErrorException Construct instance of UserErrorException Construct instance of UserErrorException Construct instance of UserErrorException Constructs a new instance of the UserErrorException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that a parameter in the request is invalid. Constructs a new ValidationException with the specified error message. Describes the error encountered. Construct instance of ValidationException Construct instance of ValidationException Construct instance of ValidationException Construct instance of ValidationException Constructs a new instance of the ValidationException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Indicates that the one-time password (OTP) used for verification is invalid. Constructs a new VerificationException with the specified error message. Describes the error encountered. Construct instance of VerificationException Construct instance of VerificationException Construct instance of VerificationException Construct instance of VerificationException Constructs a new instance of the VerificationException class with serialized data. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is null. The class name is null or is zero (0). Sets the with information about the exception. The that holds the serialized object data about the exception being thrown. The that contains contextual information about the source or destination. The parameter is a null reference (Nothing in Visual Basic). Gets and sets the property Status. The status of the verification error. Container for the parameters to the VerifySMSSandboxPhoneNumber operation. 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 SMS sandbox in the Amazon SNS Developer Guide. Gets and sets the property OneTimePassword. The OTP sent to the destination number from the CreateSMSSandBoxPhoneNumber call. Gets and sets the property PhoneNumber. The destination phone number to verify. The destination phone number's verification status. Paginator for the ListEndpointsByPlatformApplication operation Enumerable containing all full responses for the operation Enumerable containing all of the Endpoints Paginator for the ListOriginationNumbers operation Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Paginator for the ListPhoneNumbersOptedOut operation Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Paginator for the ListPlatformApplications operation Enumerable containing all full responses for the operation Enumerable containing all of the PlatformApplications Paginator for the ListSMSSandboxPhoneNumbers operation Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Paginator for the ListSubscriptionsByTopic operation Enumerable containing all full responses for the operation Enumerable containing all of the Subscriptions Paginator for the ListSubscriptions operation Enumerable containing all full responses for the operation Enumerable containing all of the Subscriptions Paginator for the ListTopics operation Enumerable containing all full responses for the operation Enumerable containing all of the Topics Paginators for the SimpleNotificationService service Paginator for ListEndpointsByPlatformApplication operation Paginator for ListOriginationNumbers operation Paginator for ListPhoneNumbersOptedOut operation Paginator for ListPlatformApplications operation Paginator for ListSMSSandboxPhoneNumbers operation Paginator for ListSubscriptions operation Paginator for ListSubscriptionsByTopic operation Paginator for ListTopics operation Base class for ListEndpointsByPlatformApplication paginators. Enumerable containing all full responses for the operation Enumerable containing all of the Endpoints Base class for ListOriginationNumbers paginators. Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Base class for ListPhoneNumbersOptedOut paginators. Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Base class for ListPlatformApplications paginators. Enumerable containing all full responses for the operation Enumerable containing all of the PlatformApplications Base class for ListSMSSandboxPhoneNumbers paginators. Enumerable containing all full responses for the operation Enumerable containing all of the PhoneNumbers Base class for ListSubscriptionsByTopic paginators. Enumerable containing all full responses for the operation Enumerable containing all of the Subscriptions Base class for ListSubscriptions paginators. Enumerable containing all full responses for the operation Enumerable containing all of the Subscriptions Base class for ListTopics paginators. Enumerable containing all full responses for the operation Enumerable containing all of the Topics Paginators for the SimpleNotificationService service Paginator for ListEndpointsByPlatformApplication operation Paginator for ListOriginationNumbers operation Paginator for ListPhoneNumbersOptedOut operation Paginator for ListPlatformApplications operation Paginator for ListSMSSandboxPhoneNumbers operation Paginator for ListSubscriptions operation Paginator for ListSubscriptionsByTopic operation Paginator for ListTopics operation Base class for SimpleNotificationService operation requests. Constants used for properties of type LanguageCodeString. Constant DeDE for LanguageCodeString Constant EnGB for LanguageCodeString Constant EnUS for LanguageCodeString Constant Es419 for LanguageCodeString Constant EsES for LanguageCodeString Constant FrCA for LanguageCodeString Constant FrFR for LanguageCodeString Constant ItIT for LanguageCodeString Constant JaJP for LanguageCodeString Constant KrKR for LanguageCodeString Constant PtBR for LanguageCodeString Constant ZhCN for LanguageCodeString Constant ZhTW for LanguageCodeString This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK. Finds the constant for the unique value. The unique value for the constant The constant for the unique value Utility method to convert strings to the constant class. The string value to convert to the constant class. Constants used for properties of type NumberCapability. Constant MMS for NumberCapability Constant SMS for NumberCapability Constant VOICE for NumberCapability This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK. Finds the constant for the unique value. The unique value for the constant The constant for the unique value Utility method to convert strings to the constant class. The string value to convert to the constant class. Constants used for properties of type RouteType. Constant Premium for RouteType Constant Promotional for RouteType Constant Transactional for RouteType This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK. Finds the constant for the unique value. The unique value for the constant The constant for the unique value Utility method to convert strings to the constant class. The string value to convert to the constant class. Constants used for properties of type SMSSandboxPhoneNumberVerificationStatus. Constant Pending for SMSSandboxPhoneNumberVerificationStatus Constant Verified for SMSSandboxPhoneNumberVerificationStatus This constant constructor does not need to be called if the constant you are attempting to use is already defined as a static instance of this class. This constructor should be used to construct constants that are not defined as statics, for instance if attempting to use a feature that is newer than the current version of the SDK. Finds the constant for the unique value. The unique value for the constant The constant for the unique value Utility method to convert strings to the constant class. The string value to convert to the constant class.