AmazonSNSClient (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.sns.AmazonSNSClient

All Implemented Interfaces:

AmazonSNS

Direct Known Subclasses:

AmazonSNSAsyncClient
```
public class AmazonSNSClient
extends AmazonWebServiceClient
implements AmazonSNS
```
Client for accessing Amazon Simple Notification Service. All service calls made using this client are blocking, and will not return until the service call completes.
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.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC

Constructor Summary

Constructors
Constructor and Description
`AmazonSNSClient()` Deprecated.
`AmazonSNSClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials.
`AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials and client configuration options.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider and client configuration options.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, HttpClient httpClient)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider, client configuration options and request metric collector.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)` Deprecated.
`AmazonSNSClient(ClientConfiguration clientConfiguration)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPermission(AddPermissionRequest addPermissionRequest)` Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
`void`	`addPermission(java.lang.String topicArn, java.lang.String label, java.util.List<java.lang.String> aWSAccountIds, java.util.List<java.lang.String> actionNames)` Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
`CheckIfPhoneNumberIsOptedOutResult`	`checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)` Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
`ConfirmSubscriptionResult`	`confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`ConfirmSubscriptionResult`	`confirmSubscription(java.lang.String topicArn, java.lang.String token)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`ConfirmSubscriptionResult`	`confirmSubscription(java.lang.String topicArn, java.lang.String token, java.lang.String authenticateOnUnsubscribe)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`CreatePlatformApplicationResult`	`createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)` 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.
`CreatePlatformEndpointResult`	`createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)` 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.
`CreateTopicResult`	`createTopic(CreateTopicRequest createTopicRequest)` Creates a topic to which notifications can be published.
`CreateTopicResult`	`createTopic(java.lang.String name)` Creates a topic to which notifications can be published.
`void`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` Deletes the endpoint for a device and mobile app from Amazon SNS.
`void`	`deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)` Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
`void`	`deleteTopic(DeleteTopicRequest deleteTopicRequest)` Deletes a topic and all its subscriptions.
`void`	`deleteTopic(java.lang.String topicArn)` Deletes a topic and all its subscriptions.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
`GetEndpointAttributesResult`	`getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)` Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS.
`GetPlatformApplicationAttributesResult`	`getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)` Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
`GetSMSAttributesResult`	`getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)` Returns the settings for sending SMS messages from your account.
`GetSubscriptionAttributesResult`	`getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)` Returns all of the properties of a subscription.
`GetSubscriptionAttributesResult`	`getSubscriptionAttributes(java.lang.String subscriptionArn)` Returns all of the properties of a subscription.
`GetTopicAttributesResult`	`getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)` Returns all of the properties of a topic.
`GetTopicAttributesResult`	`getTopicAttributes(java.lang.String topicArn)` Returns all of the properties of a topic.
`ListEndpointsByPlatformApplicationResult`	`listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)` Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS.
`ListPhoneNumbersOptedOutResult`	`listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)` Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
`ListPlatformApplicationsResult`	`listPlatformApplications()` Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
`ListPlatformApplicationsResult`	`listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)` Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
`ListSubscriptionsResult`	`listSubscriptions()` Returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)` Returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(java.lang.String nextToken)` Returns a list of the requester's subscriptions.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)` Returns a list of the subscriptions to a specific topic.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(java.lang.String topicArn)` Returns a list of the subscriptions to a specific topic.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(java.lang.String topicArn, java.lang.String nextToken)` Returns a list of the subscriptions to a specific topic.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` List all tags added to the specified Amazon SNS topic.
`ListTopicsResult`	`listTopics()` Returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(ListTopicsRequest listTopicsRequest)` Returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(java.lang.String nextToken)` Returns a list of the requester's topics.
`OptInPhoneNumberResult`	`optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest)` Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
`PublishResult`	`publish(PublishRequest publishRequest)` 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`).
`PublishResult`	`publish(java.lang.String topicArn, java.lang.String message)` 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`).
`PublishResult`	`publish(java.lang.String topicArn, java.lang.String message, java.lang.String subject)` 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`).
`void`	`removePermission(RemovePermissionRequest removePermissionRequest)` Removes a statement from a topic's access control policy.
`void`	`removePermission(java.lang.String topicArn, java.lang.String label)` Removes a statement from a topic's access control policy.
`void`	`setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)` 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.
`void`	`setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)` Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging).
`SetSMSAttributesResult`	`setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest)` Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
`void`	`setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)` Allows a subscription owner to set an attribute of the subscription to a new value.
`void`	`setSubscriptionAttributes(java.lang.String subscriptionArn, java.lang.String attributeName, java.lang.String attributeValue)` Allows a subscription owner to set an attribute of the subscription to a new value.
`void`	`setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)` Allows a topic owner to set an attribute of the topic to a new value.
`void`	`setTopicAttributes(java.lang.String topicArn, java.lang.String attributeName, java.lang.String attributeValue)` Allows a topic owner to set an attribute of the topic to a new value.
`SubscribeResult`	`subscribe(java.lang.String topicArn, java.lang.String protocol, java.lang.String endpoint)` Subscribes an endpoint to an Amazon SNS topic.
`SubscribeResult`	`subscribe(SubscribeRequest subscribeRequest)` Subscribes an endpoint to an Amazon SNS topic.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Add tags to the specified Amazon SNS topic.
`void`	`unsubscribe(java.lang.String subscriptionArn)` Deletes a subscription.
`void`	`unsubscribe(UnsubscribeRequest unsubscribeRequest)` Deletes a subscription.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Remove tags from the specified Amazon SNS topic.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.sns.AmazonSNS
setEndpoint, setRegion, shutdown

- Constructor Detail
  - AmazonSNSClient
```
@Deprecated
public AmazonSNSClient()
```
    Deprecated.
    Constructs a new client to invoke service methods on AmazonSNS. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonSNSClient
```
@Deprecated
public AmazonSNSClient(ClientConfiguration clientConfiguration)
```
    Deprecated.
    Constructs a new client to invoke service methods on AmazonSNS. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonSNS (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonSNSClient
```
public AmazonSNSClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials.
    The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonSNSClient client = new AmazonSNSClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonSNSClient
```
public AmazonSNSClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials and client configuration options.
    The client requests are authenticated using the AWSCredentials provided in this constructor. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonSNSClient client = new AmazonSNSClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonSNS (ex: proxy settings, retry counts, etc.).
  - AmazonSNSClient
```
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonSNSClient client = new AmazonSNSClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonSNSClient
```
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider and client configuration options.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonSNSClient client = new AmazonSNSClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonSNS (ex: proxy settings, retry counts, etc.).
  - AmazonSNSClient
```
@Deprecated
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   com.amazonaws.metrics.RequestMetricCollector requestMetricCollector)
```
    Deprecated.
    
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider, client configuration options and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonSNS (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
  - AmazonSNSClient
```
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       HttpClient httpClient)
```
    Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider, client configuration options and request metric collector.
    The client requests are authenticated using the AWSCredentials provided by the AWSCredentialsProvider. Static AWSCredentials can be passed for quick testing. However, it is strongly recommended to use Amazon Cognito vended temporary credentials for use in production. This can be achieved by using AWSMobileClient. Please see https://aws-amplify.github.io/docs/android/authentication for instructions on how to enable AWSMobileClient.
```
 AWSMobileClient.getInstance().initialize(getApplicationContext(), new Callback<UserStateDetails>() {
     @Override
     public void onResult(final UserStateDetails details) {
         AmazonSNSClient client = new AmazonSNSClient(AWSMobileClient.getInstance());
     }
 
     @Override
     public void onError(final Exception e) {
         e.printStackTrace();
     }
 });
 
```
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to AmazonSNS (ex: proxy settings, retry counts, etc.).
    
    httpClient - A http client
- Method Detail
  - addPermission
```
public void addPermission(AddPermissionRequest addPermissionRequest)
                   throws AmazonServiceException,
                          AmazonClientException
```
    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
    
    Specified by:
    
    addPermission in interface AmazonSNS
    
    Parameters:
    
    addPermissionRequest -
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - checkIfPhoneNumberIsOptedOut
```
public CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException
```
    Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
    
    To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.
    
    Specified by:
    
    checkIfPhoneNumberIsOptedOut in interface AmazonSNS
    
    Parameters:
    
    checkIfPhoneNumberIsOptedOutRequest -
    The input for the CheckIfPhoneNumberIsOptedOut action.
    
    Returns:
    
    checkIfPhoneNumberIsOptedOutResult The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ThrottledException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidParameterException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    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".
    
    Specified by:
    
    confirmSubscription in interface AmazonSNS
    
    Parameters:
    
    confirmSubscriptionRequest -
    Input for ConfirmSubscription action.
    
    Returns:
    
    confirmSubscriptionResult The response from the ConfirmSubscription service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    SubscriptionLimitExceededException
    
    InvalidParameterException
    
    NotFoundException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    FilterPolicyLimitExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - createPlatformApplication
```
public CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.
    
    PlatformPrincipal and PlatformCredential are received from the notification service.
    - For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.
    - For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.
    - For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.
    - For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.
    - For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.
    - For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.
    You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.
    Specified by:
    
    createPlatformApplication in interface AmazonSNS
    
    Parameters:
    
    createPlatformApplicationRequest -
    Input for CreatePlatformApplication action.
    
    Returns:
    
    createPlatformApplicationResult The response from the CreatePlatformApplication service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - createPlatformEndpoint
```
public CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException
```
    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.
    
    Specified by:
    
    createPlatformEndpoint in interface AmazonSNS
    
    Parameters:
    
    createPlatformEndpointRequest -
    Input for CreatePlatformEndpoint action.
    
    Returns:
    
    createPlatformEndpointResult The response from the CreatePlatformEndpoint service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - createTopic
```
public CreateTopicResult createTopic(CreateTopicRequest createTopicRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
```
    Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
    
    Specified by:
    
    createTopic in interface AmazonSNS
    
    Parameters:
    
    createTopicRequest -
    Input for CreateTopic action.
    
    Returns:
    
    createTopicResult The response from the CreateTopic service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    TopicLimitExceededException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    TagLimitExceededException
    
    StaleTagException
    
    TagPolicyException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - deleteEndpoint
```
public void deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
                    throws AmazonServiceException,
                           AmazonClientException
```
    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.
    
    Specified by:
    
    deleteEndpoint in interface AmazonSNS
    
    Parameters:
    
    deleteEndpointRequest -
    Input for DeleteEndpoint action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - deletePlatformApplication
```
public void deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
                               throws AmazonServiceException,
                                      AmazonClientException
```
    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.
    
    Specified by:
    
    deletePlatformApplication in interface AmazonSNS
    
    Parameters:
    
    deletePlatformApplicationRequest -
    Input for DeletePlatformApplication action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - deleteTopic
```
public void deleteTopic(DeleteTopicRequest deleteTopicRequest)
                 throws AmazonServiceException,
                        AmazonClientException
```
    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.
    
    Specified by:
    
    deleteTopic in interface AmazonSNS
    
    Parameters:
    
    deleteTopicRequest -
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    StaleTagException
    
    TagPolicyException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getEndpointAttributes
```
public GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException
```
    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.
    
    Specified by:
    
    getEndpointAttributes in interface AmazonSNS
    
    Parameters:
    
    getEndpointAttributesRequest -
    Input for GetEndpointAttributes action.
    
    Returns:
    
    getEndpointAttributesResult The response from the GetEndpointAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getPlatformApplicationAttributes
```
public GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
                                                                        throws AmazonServiceException,
                                                                               AmazonClientException
```
    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.
    
    Specified by:
    
    getPlatformApplicationAttributes in interface AmazonSNS
    
    Parameters:
    
    getPlatformApplicationAttributesRequest -
    Input for GetPlatformApplicationAttributes action.
    
    Returns:
    
    getPlatformApplicationAttributesResult The response from the GetPlatformApplicationAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getSMSAttributes
```
public GetSMSAttributesResult getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    Returns the settings for sending SMS messages from your account.
    
    These settings are set with the SetSMSAttributes action.
    
    Specified by:
    
    getSMSAttributes in interface AmazonSNS
    
    Parameters:
    
    getSMSAttributesRequest -
    The input for the GetSMSAttributes request.
    
    Returns:
    
    getSMSAttributesResult The response from the GetSMSAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ThrottledException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidParameterException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getSubscriptionAttributes
```
public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    Returns all of the properties of a subscription.
    
    Specified by:
    
    getSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    getSubscriptionAttributesRequest -
    Input for GetSubscriptionAttributes.
    
    Returns:
    
    getSubscriptionAttributesResult The response from the GetSubscriptionAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getTopicAttributes
```
public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException
```
    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
    
    Specified by:
    
    getTopicAttributes in interface AmazonSNS
    
    Parameters:
    
    getTopicAttributesRequest -
    Input for GetTopicAttributes action.
    
    Returns:
    
    getTopicAttributesResult The response from the GetTopicAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listEndpointsByPlatformApplication
```
public ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException
```
    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).
    
    Specified by:
    
    listEndpointsByPlatformApplication in interface AmazonSNS
    
    Parameters:
    
    listEndpointsByPlatformApplicationRequest -
    Input for ListEndpointsByPlatformApplication action.
    
    Returns:
    
    listEndpointsByPlatformApplicationResult The response from the ListEndpointsByPlatformApplication service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listPhoneNumbersOptedOut
```
public ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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.
    
    Specified by:
    
    listPhoneNumbersOptedOut in interface AmazonSNS
    
    Parameters:
    
    listPhoneNumbersOptedOutRequest -
    The input for the ListPhoneNumbersOptedOut action.
    
    Returns:
    
    listPhoneNumbersOptedOutResult The response from the ListPhoneNumbersOptedOut service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ThrottledException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidParameterException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listPlatformApplications
```
public ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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).
    
    Specified by:
    
    listPlatformApplications in interface AmazonSNS
    
    Parameters:
    
    listPlatformApplicationsRequest -
    Input for ListPlatformApplications action.
    
    Returns:
    
    listPlatformApplicationsResult The response from the ListPlatformApplications service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    Parameters:
    
    listSubscriptionsRequest -
    Input for ListSubscriptions action.
    
    Returns:
    
    listSubscriptionsResult The response from the ListSubscriptions service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    Parameters:
    
    listSubscriptionsByTopicRequest -
    Input for ListSubscriptionsByTopic action.
    
    Returns:
    
    listSubscriptionsByTopicResult The response from the ListSubscriptionsByTopic service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    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.
    
    Specified by:
    
    listTagsForResource in interface AmazonSNS
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    listTagsForResourceResult The response from the ListTagsForResource service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ResourceNotFoundException
    
    TagPolicyException
    
    InvalidParameterException
    
    AuthorizationErrorException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listTopics
```
public ListTopicsResult listTopics(ListTopicsRequest listTopicsRequest)
                            throws AmazonServiceException,
                                   AmazonClientException
```
    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).
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    Parameters:
    
    listTopicsRequest -
    
    Returns:
    
    listTopicsResult The response from the ListTopics service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - optInPhoneNumber
```
public OptInPhoneNumberResult optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    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.
    
    Specified by:
    
    optInPhoneNumber in interface AmazonSNS
    
    Parameters:
    
    optInPhoneNumberRequest -
    Input for the OptInPhoneNumber action.
    
    Returns:
    
    optInPhoneNumberResult The response from the OptInPhoneNumber service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ThrottledException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidParameterException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - publish
```
public PublishResult publish(PublishRequest publishRequest)
                      throws AmazonServiceException,
                             AmazonClientException
```
    Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
    
    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
    
    When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.
    
    To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
    
    For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
    
    You can publish messages only to topics and endpoints in the same AWS Region.
    
    Specified by:
    
    publish in interface AmazonSNS
    
    Parameters:
    
    publishRequest -
    Input for Publish action.
    
    Returns:
    
    publishResult The response from the Publish service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InvalidParameterValueException
    
    InternalErrorException
    
    NotFoundException
    
    EndpointDisabledException
    
    PlatformApplicationDisabledException
    
    AuthorizationErrorException
    
    KMSDisabledException
    
    KMSInvalidStateException
    
    KMSNotFoundException
    
    KMSOptInRequiredException
    
    KMSThrottlingException
    
    KMSAccessDeniedException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - removePermission
```
public void removePermission(RemovePermissionRequest removePermissionRequest)
                      throws AmazonServiceException,
                             AmazonClientException
```
    Removes a statement from a topic's access control policy.
    
    Specified by:
    
    removePermission in interface AmazonSNS
    
    Parameters:
    
    removePermissionRequest -
    Input for RemovePermission action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setEndpointAttributes
```
public void setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)
                           throws AmazonServiceException,
                                  AmazonClientException
```
    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.
    
    Specified by:
    
    setEndpointAttributes in interface AmazonSNS
    
    Parameters:
    
    setEndpointAttributesRequest -
    Input for SetEndpointAttributes action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setPlatformApplicationAttributes
```
public void setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException
```
    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.
    
    Specified by:
    
    setPlatformApplicationAttributes in interface AmazonSNS
    
    Parameters:
    
    setPlatformApplicationAttributesRequest -
    Input for SetPlatformApplicationAttributes action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setSMSAttributes
```
public SetSMSAttributesResult setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException
```
    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.
    
    Specified by:
    
    setSMSAttributes in interface AmazonSNS
    
    Parameters:
    
    setSMSAttributesRequest -
    The input for the SetSMSAttributes action.
    
    Returns:
    
    setSMSAttributesResult The response from the SetSMSAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    ThrottledException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setSubscriptionAttributes
```
public void setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
                               throws AmazonServiceException,
                                      AmazonClientException
```
    Allows a subscription owner to set an attribute of the subscription to a new value.
    
    Specified by:
    
    setSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    setSubscriptionAttributesRequest -
    Input for SetSubscriptionAttributes action.
    
    Throws:
    
    InvalidParameterException
    
    FilterPolicyLimitExceededException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setTopicAttributes
```
public void setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
                        throws AmazonServiceException,
                               AmazonClientException
```
    Allows a topic owner to set an attribute of the topic to a new value.
    
    Specified by:
    
    setTopicAttributes in interface AmazonSNS
    
    Parameters:
    
    setTopicAttributesRequest -
    Input for SetTopicAttributes action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - subscribe
```
public SubscribeResult subscribe(SubscribeRequest subscribeRequest)
                          throws AmazonServiceException,
                                 AmazonClientException
```
    Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.
    
    You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.
    
    This action is throttled at 100 transactions per second (TPS).
    
    Specified by:
    
    subscribe in interface AmazonSNS
    
    Parameters:
    
    subscribeRequest -
    Input for Subscribe action.
    
    Returns:
    
    subscribeResult The response from the Subscribe service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    SubscriptionLimitExceededException
    
    FilterPolicyLimitExceededException
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
                              throws AmazonServiceException,
                                     AmazonClientException
```
    Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
    
    When you use topic tags, keep the following guidelines in mind:
    - Adding more than 50 tags to a topic isn't recommended.
    - Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
    - Tags are case-sensitive.
    - A new tag with a key identical to that of an existing tag overwrites the existing tag.
    - Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
    Specified by:
    
    tagResource in interface AmazonSNS
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    tagResourceResult The response from the TagResource service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ResourceNotFoundException
    
    TagLimitExceededException
    
    StaleTagException
    
    TagPolicyException
    
    InvalidParameterException
    
    AuthorizationErrorException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - unsubscribe
```
public void unsubscribe(UnsubscribeRequest unsubscribeRequest)
                 throws AmazonServiceException,
                        AmazonClientException
```
    Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
    
    This action is throttled at 100 transactions per second (TPS).
    
    Specified by:
    
    unsubscribe in interface AmazonSNS
    
    Parameters:
    
    unsubscribeRequest -
    Input for Unsubscribe action.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException
```
    Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
    
    Specified by:
    
    untagResource in interface AmazonSNS
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    untagResourceResult The response from the UntagResource service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    ResourceNotFoundException
    
    TagLimitExceededException
    
    StaleTagException
    
    TagPolicyException
    
    InvalidParameterException
    
    AuthorizationErrorException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setSubscriptionAttributes
```
public void setSubscriptionAttributes(java.lang.String subscriptionArn,
                                      java.lang.String attributeName,
                                      java.lang.String attributeValue)
                               throws AmazonServiceException,
                                      AmazonClientException
```
    Allows a subscription owner to set an attribute of the subscription to a new value.
    Specified by:
    
    setSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    subscriptionArn -
    The ARN of the subscription to modify.
    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.
    
    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 Kinesis Data Firehose delivery stream subscriptions:
    
    SubscriptionRoleArn – The ARN of the IAM role that has the following:
    
    Permission to write to the Kinesis Data Firehose delivery stream
    
    Amazon SNS listed as a trusted entity
    
    Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
    attributeValue -
    The new value for the attribute in JSON format.
    
    Throws:
    
    InvalidParameterException
    
    FilterPolicyLimitExceededException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getSubscriptionAttributes
```
public GetSubscriptionAttributesResult getSubscriptionAttributes(java.lang.String subscriptionArn)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException
```
    Returns all of the properties of a subscription.
    
    Specified by:
    
    getSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    subscriptionArn -
    The ARN of the subscription whose properties you want to get.
    
    Returns:
    
    getSubscriptionAttributesResult The response from the GetSubscriptionAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - subscribe
```
public SubscribeResult subscribe(java.lang.String topicArn,
                                 java.lang.String protocol,
                                 java.lang.String endpoint)
                          throws AmazonServiceException,
                                 AmazonClientException
```
    Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.
    
    You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.
    
    This action is throttled at 100 transactions per second (TPS).
    Specified by:
    
    subscribe in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic you want to subscribe to.
    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 AWS Lambda function
    
    firehose – delivery of JSON-encoded message to an Amazon Kinesis Data Firehose delivery stream.
    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 AWS Lambda function.
    
    For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis Data Firehose delivery stream.
    Returns:
    
    subscribeResult The response from the Subscribe service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    SubscriptionLimitExceededException
    
    FilterPolicyLimitExceededException
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - addPermission
```
public void addPermission(java.lang.String topicArn,
                          java.lang.String label,
                          java.util.List<java.lang.String> aWSAccountIds,
                          java.util.List<java.lang.String> actionNames)
                   throws AmazonServiceException,
                          AmazonClientException
```
    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
    
    Specified by:
    
    addPermission in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic whose access control policy you wish to modify.
    
    label -
    A unique identifier for the new policy statement.
    
    aWSAccountIds -
    The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.
    
    actionNames -
    The action you want to allow for the specified principal(s).
    
    Valid values: Any Amazon SNS action name, for example Publish.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getTopicAttributes
```
public GetTopicAttributesResult getTopicAttributes(java.lang.String topicArn)
                                            throws AmazonServiceException,
                                                   AmazonClientException
```
    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
    
    Specified by:
    
    getTopicAttributes in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic whose properties you want to get.
    
    Returns:
    
    getTopicAttributesResult The response from the GetTopicAttributes service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - removePermission
```
public void removePermission(java.lang.String topicArn,
                             java.lang.String label)
                      throws AmazonServiceException,
                             AmazonClientException
```
    Removes a statement from a topic's access control policy.
    
    Specified by:
    
    removePermission in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic whose access control policy you wish to modify.
    
    label -
    The unique label of the statement you want to remove.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listTopics
```
public ListTopicsResult listTopics()
                            throws AmazonServiceException,
                                   AmazonClientException
```
    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).
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    Returns:
    
    listTopicsResult The response from the ListTopics service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listTopics
```
public ListTopicsResult listTopics(java.lang.String nextToken)
                            throws AmazonServiceException,
                                   AmazonClientException
```
    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).
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    Parameters:
    
    nextToken -
    Token returned by the previous ListTopics request.
    
    Returns:
    
    listTopicsResult The response from the ListTopics service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(java.lang.String topicArn,
                                                     java.lang.String token,
                                                     java.lang.String authenticateOnUnsubscribe)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    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".
    
    Specified by:
    
    confirmSubscription in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic for which you wish to confirm a subscription.
    
    token -
    Short-lived token sent to an endpoint during the Subscribe action.
    
    authenticateOnUnsubscribe -
    Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.
    
    Returns:
    
    confirmSubscriptionResult The response from the ConfirmSubscription service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    SubscriptionLimitExceededException
    
    InvalidParameterException
    
    NotFoundException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    FilterPolicyLimitExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(java.lang.String topicArn,
                                                     java.lang.String token)
                                              throws AmazonServiceException,
                                                     AmazonClientException
```
    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".
    
    Specified by:
    
    confirmSubscription in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic for which you wish to confirm a subscription.
    
    token -
    Short-lived token sent to an endpoint during the Subscribe action.
    
    Returns:
    
    confirmSubscriptionResult The response from the ConfirmSubscription service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    SubscriptionLimitExceededException
    
    InvalidParameterException
    
    NotFoundException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    FilterPolicyLimitExceededException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - setTopicAttributes
```
public void setTopicAttributes(java.lang.String topicArn,
                               java.lang.String attributeName,
                               java.lang.String attributeValue)
                        throws AmazonServiceException,
                               AmazonClientException
```
    Allows a topic owner to set an attribute of the topic to a new value.
    Specified by:
    
    setTopicAttributes in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic to modify.
    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:
    
    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.
    
    The following attribute applies only to server-side-encryption:
    
    KmsMasterKeyId – The ID of an AWS-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 AWS Key Management Service API Reference.
    
    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 the MessageDeduplicationId parameter for the Publish action.
    attributeValue -
    The new value for the attribute.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - createTopic
```
public CreateTopicResult createTopic(java.lang.String name)
                              throws AmazonServiceException,
                                     AmazonClientException
```
    Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
    
    Specified by:
    
    createTopic in interface AmazonSNS
    
    Parameters:
    
    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.
    
    Returns:
    
    createTopicResult The response from the CreateTopic service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    TopicLimitExceededException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    InvalidSecurityException
    
    TagLimitExceededException
    
    StaleTagException
    
    TagPolicyException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - deleteTopic
```
public void deleteTopic(java.lang.String topicArn)
                 throws AmazonServiceException,
                        AmazonClientException
```
    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.
    
    Specified by:
    
    deleteTopic in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic you want to delete.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    StaleTagException
    
    TagPolicyException
    
    ConcurrentAccessException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - unsubscribe
```
public void unsubscribe(java.lang.String subscriptionArn)
                 throws AmazonServiceException,
                        AmazonClientException
```
    Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
    
    This action is throttled at 100 transactions per second (TPS).
    
    Specified by:
    
    unsubscribe in interface AmazonSNS
    
    Parameters:
    
    subscriptionArn -
    The ARN of the subscription to be deleted.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    NotFoundException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - publish
```
public PublishResult publish(java.lang.String topicArn,
                             java.lang.String message)
                      throws AmazonServiceException,
                             AmazonClientException
```
    Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
    
    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
    
    When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.
    
    To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
    
    For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
    
    You can publish messages only to topics and endpoints in the same AWS Region.
    Specified by:
    
    publish in interface AmazonSNS
    
    Parameters:
    
    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.
    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).
    Returns:
    
    publishResult The response from the Publish service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InvalidParameterValueException
    
    InternalErrorException
    
    NotFoundException
    
    EndpointDisabledException
    
    PlatformApplicationDisabledException
    
    AuthorizationErrorException
    
    KMSDisabledException
    
    KMSInvalidStateException
    
    KMSNotFoundException
    
    KMSOptInRequiredException
    
    KMSThrottlingException
    
    KMSAccessDeniedException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - publish
```
public PublishResult publish(java.lang.String topicArn,
                             java.lang.String message,
                             java.lang.String subject)
                      throws AmazonServiceException,
                             AmazonClientException
```
    Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).
    
    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
    
    When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.
    
    To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.
    
    For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
    
    You can publish messages only to topics and endpoints in the same AWS Region.
    Specified by:
    
    publish in interface AmazonSNS
    
    Parameters:
    
    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.
    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).
    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 ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
    
    Returns:
    
    publishResult The response from the Publish service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InvalidParameterValueException
    
    InternalErrorException
    
    NotFoundException
    
    EndpointDisabledException
    
    PlatformApplicationDisabledException
    
    AuthorizationErrorException
    
    KMSDisabledException
    
    KMSInvalidStateException
    
    KMSNotFoundException
    
    KMSOptInRequiredException
    
    KMSThrottlingException
    
    KMSAccessDeniedException
    
    InvalidSecurityException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions()
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    Returns:
    
    listSubscriptionsResult The response from the ListSubscriptions service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions(java.lang.String nextToken)
                                          throws AmazonServiceException,
                                                 AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    Parameters:
    
    nextToken -
    Token returned by the previous ListSubscriptions request.
    
    Returns:
    
    listSubscriptionsResult The response from the ListSubscriptions service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(java.lang.String topicArn)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic for which you wish to find subscriptions.
    
    Returns:
    
    listSubscriptionsByTopicResult The response from the ListSubscriptionsByTopic service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(java.lang.String topicArn,
                                                               java.lang.String nextToken)
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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).
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    Parameters:
    
    topicArn -
    The ARN of the topic for which you wish to find subscriptions.
    
    nextToken -
    Token returned by the previous ListSubscriptionsByTopic request.
    
    Returns:
    
    listSubscriptionsByTopicResult The response from the ListSubscriptionsByTopic service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    NotFoundException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - listPlatformApplications
```
public ListPlatformApplicationsResult listPlatformApplications()
                                                        throws AmazonServiceException,
                                                               AmazonClientException
```
    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).
    
    Specified by:
    
    listPlatformApplications in interface AmazonSNS
    
    Returns:
    
    listPlatformApplicationsResult The response from the ListPlatformApplications service method, as returned by Amazon Simple Notification Service.
    
    Throws:
    
    InvalidParameterException
    
    InternalErrorException
    
    AuthorizationErrorException
    
    AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
    
    AmazonServiceException - If an error response is returned by Amazon Simple Notification Service indicating either a problem with the data in the request, or a server side issue.
  - getCachedResponseMetadata
```
@Deprecated
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Deprecated. ResponseMetadata cache can hold up to 50 requests and responses in memory and will cause memory issue. This method now always returns null.
    
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonSNS
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AmazonSNSClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.sns.AmazonSNS

Constructor Detail

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

AmazonSNSClient

Method Detail

addPermission

checkIfPhoneNumberIsOptedOut

confirmSubscription

createPlatformApplication

createPlatformEndpoint

createTopic

deleteEndpoint

deletePlatformApplication

deleteTopic

getEndpointAttributes

getPlatformApplicationAttributes

getSMSAttributes

getSubscriptionAttributes

getTopicAttributes

listEndpointsByPlatformApplication

listPhoneNumbersOptedOut

listPlatformApplications

listSubscriptions

listSubscriptionsByTopic

listTagsForResource

listTopics

optInPhoneNumber

publish

removePermission

setEndpointAttributes

setPlatformApplicationAttributes

setSMSAttributes

setSubscriptionAttributes

setTopicAttributes

subscribe

tagResource

unsubscribe

untagResource

setSubscriptionAttributes

getSubscriptionAttributes

subscribe

addPermission

getTopicAttributes

removePermission

listTopics

listTopics

confirmSubscription

confirmSubscription

setTopicAttributes

createTopic

deleteTopic

unsubscribe

publish

publish

listSubscriptions

listSubscriptions

listSubscriptionsByTopic

listSubscriptionsByTopic

listPlatformApplications

getCachedResponseMetadata