AbstractAmazonSNS (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sns.AbstractAmazonSNS

All Implemented Interfaces:

AmazonSNS

Direct Known Subclasses:

AbstractAmazonSNSAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonSNS
extends Object
implements AmazonSNS
```
Abstract implementation of AmazonSNS. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.sns.AmazonSNS
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddPermissionResult`	`addPermission(AddPermissionRequest request)` Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
`AddPermissionResult`	`addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)` Simplified method form for invoking the AddPermission operation.
`CheckIfPhoneNumberIsOptedOutResult`	`checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)` Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
`ConfirmSubscriptionResult`	`confirmSubscription(ConfirmSubscriptionRequest request)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`ConfirmSubscriptionResult`	`confirmSubscription(String topicArn, String token)` Simplified method form for invoking the ConfirmSubscription operation.
`ConfirmSubscriptionResult`	`confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe)` Simplified method form for invoking the ConfirmSubscription operation.
`CreatePlatformApplicationResult`	`createPlatformApplication(CreatePlatformApplicationRequest request)` Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.
`CreatePlatformEndpointResult`	`createPlatformEndpoint(CreatePlatformEndpointRequest request)` Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
`CreateTopicResult`	`createTopic(CreateTopicRequest request)` Creates a topic to which notifications can be published.
`CreateTopicResult`	`createTopic(String name)` Simplified method form for invoking the CreateTopic operation.
`DeleteEndpointResult`	`deleteEndpoint(DeleteEndpointRequest request)` Deletes the endpoint for a device and mobile app from Amazon SNS.
`DeletePlatformApplicationResult`	`deletePlatformApplication(DeletePlatformApplicationRequest request)` Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
`DeleteTopicResult`	`deleteTopic(DeleteTopicRequest request)` Deletes a topic and all its subscriptions.
`DeleteTopicResult`	`deleteTopic(String topicArn)` Simplified method form for invoking the DeleteTopic operation.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetEndpointAttributesResult`	`getEndpointAttributes(GetEndpointAttributesRequest request)` Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
`GetPlatformApplicationAttributesResult`	`getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)` Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
`GetSMSAttributesResult`	`getSMSAttributes(GetSMSAttributesRequest request)` Returns the settings for sending SMS messages from your account.
`GetSubscriptionAttributesResult`	`getSubscriptionAttributes(GetSubscriptionAttributesRequest request)` Returns all of the properties of a subscription.
`GetSubscriptionAttributesResult`	`getSubscriptionAttributes(String subscriptionArn)` Simplified method form for invoking the GetSubscriptionAttributes operation.
`GetTopicAttributesResult`	`getTopicAttributes(GetTopicAttributesRequest request)` Returns all of the properties of a topic.
`GetTopicAttributesResult`	`getTopicAttributes(String topicArn)` Simplified method form for invoking the GetTopicAttributes operation.
`ListEndpointsByPlatformApplicationResult`	`listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)` Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
`ListPhoneNumbersOptedOutResult`	`listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request)` Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
`ListPlatformApplicationsResult`	`listPlatformApplications()` Simplified method form for invoking the ListPlatformApplications operation.
`ListPlatformApplicationsResult`	`listPlatformApplications(ListPlatformApplicationsRequest request)` Lists the platform application objects for the supported push notification services, such as APNS and GCM.
`ListSubscriptionsResult`	`listSubscriptions()` Simplified method form for invoking the ListSubscriptions operation.
`ListSubscriptionsResult`	`listSubscriptions(ListSubscriptionsRequest request)` Returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(String nextToken)` Simplified method form for invoking the ListSubscriptions operation.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)` Returns a list of the subscriptions to a specific topic.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(String topicArn)` Simplified method form for invoking the ListSubscriptionsByTopic operation.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(String topicArn, String nextToken)` Simplified method form for invoking the ListSubscriptionsByTopic operation.
`ListTopicsResult`	`listTopics()` Simplified method form for invoking the ListTopics operation.
`ListTopicsResult`	`listTopics(ListTopicsRequest request)` Returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(String nextToken)` Simplified method form for invoking the ListTopics operation.
`OptInPhoneNumberResult`	`optInPhoneNumber(OptInPhoneNumberRequest request)` 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 request)` Sends a message to all of a topic's subscribed endpoints.
`PublishResult`	`publish(String topicArn, String message)` Simplified method form for invoking the Publish operation.
`PublishResult`	`publish(String topicArn, String message, String subject)` Simplified method form for invoking the Publish operation.
`RemovePermissionResult`	`removePermission(RemovePermissionRequest request)` Removes a statement from a topic's access control policy.
`RemovePermissionResult`	`removePermission(String topicArn, String label)` Simplified method form for invoking the RemovePermission operation.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com").
`SetEndpointAttributesResult`	`setEndpointAttributes(SetEndpointAttributesRequest request)` Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
`SetPlatformApplicationAttributesResult`	`setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)` Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
`void`	`setRegion(Region region)` An alternative to `AmazonSNS.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`SetSMSAttributesResult`	`setSMSAttributes(SetSMSAttributesRequest request)` Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
`SetSubscriptionAttributesResult`	`setSubscriptionAttributes(SetSubscriptionAttributesRequest request)` Allows a subscription owner to set an attribute of the topic to a new value.
`SetSubscriptionAttributesResult`	`setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue)` Simplified method form for invoking the SetSubscriptionAttributes operation.
`SetTopicAttributesResult`	`setTopicAttributes(SetTopicAttributesRequest request)` Allows a topic owner to set an attribute of the topic to a new value.
`SetTopicAttributesResult`	`setTopicAttributes(String topicArn, String attributeName, String attributeValue)` Simplified method form for invoking the SetTopicAttributes operation.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`SubscribeResult`	`subscribe(String topicArn, String protocol, String endpoint)` Simplified method form for invoking the Subscribe operation.
`SubscribeResult`	`subscribe(SubscribeRequest request)` Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
`UnsubscribeResult`	`unsubscribe(String subscriptionArn)` Simplified method form for invoking the Unsubscribe operation.
`UnsubscribeResult`	`unsubscribe(UnsubscribeRequest request)` Deletes a subscription.

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

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonSNS
    
    Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonSNS
    
    Parameters:
    
    endpoint - The endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonSNS
    
    An alternative to AmazonSNS.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonSNS
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - addPermission
```
public AddPermissionResult addPermission(AddPermissionRequest request)
```
    Description copied from interface: AmazonSNS
    
    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
    
    Returns:
    
    Result of the AddPermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - addPermission
```
public AddPermissionResult addPermission(String topicArn,
                                         String label,
                                         List<String> aWSAccountIds,
                                         List<String> actionNames)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the AddPermission operation.
    
    Specified by:
    
    addPermission in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.addPermission(AddPermissionRequest)
  - checkIfPhoneNumberIsOptedOut
```
public CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - The input for the CheckIfPhoneNumberIsOptedOut action.
    
    Returns:
    
    Result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - Input for ConfirmSubscription action.
    
    Returns:
    
    Result of the ConfirmSubscription operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(String topicArn,
                                                     String token,
                                                     String authenticateOnUnsubscribe)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ConfirmSubscription operation.
    
    Specified by:
    
    confirmSubscription in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)
  - confirmSubscription
```
public ConfirmSubscriptionResult confirmSubscription(String topicArn,
                                                     String token)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ConfirmSubscription operation.
    
    Specified by:
    
    confirmSubscription in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)
  - createPlatformApplication
```
public CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest request)
```
    Description copied from interface: AmazonSNS
    
    Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
    
    For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
    
    Specified by:
    
    createPlatformApplication in interface AmazonSNS
    
    Parameters:
    
    request - Input for CreatePlatformApplication action.
    
    Returns:
    
    Result of the CreatePlatformApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPlatformEndpoint
```
public CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest request)
```
    Description copied from interface: AmazonSNS
    
    Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action 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:
    
    request - Input for CreatePlatformEndpoint action.
    
    Returns:
    
    Result of the CreatePlatformEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTopic
```
public CreateTopicResult createTopic(CreateTopicRequest request)
```
    Description copied from interface: AmazonSNS
    
    Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://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:
    
    request - Input for CreateTopic action.
    
    Returns:
    
    Result of the CreateTopic operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTopic
```
public CreateTopicResult createTopic(String name)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the CreateTopic operation.
    
    Specified by:
    
    createTopic in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.createTopic(CreateTopicRequest)
  - deleteEndpoint
```
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - Input for DeleteEndpoint action.
    
    Returns:
    
    Result of the DeleteEndpoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePlatformApplication
```
public DeletePlatformApplicationResult deletePlatformApplication(DeletePlatformApplicationRequest request)
```
    Description copied from interface: AmazonSNS
    
    Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
    
    Specified by:
    
    deletePlatformApplication in interface AmazonSNS
    
    Parameters:
    
    request - Input for DeletePlatformApplication action.
    
    Returns:
    
    Result of the DeletePlatformApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTopic
```
public DeleteTopicResult deleteTopic(DeleteTopicRequest request)
```
    Description copied from interface: AmazonSNS
    
    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
    
    Returns:
    
    Result of the DeleteTopic operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTopic
```
public DeleteTopicResult deleteTopic(String topicArn)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the DeleteTopic operation.
    
    Specified by:
    
    deleteTopic in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.deleteTopic(DeleteTopicRequest)
  - getEndpointAttributes
```
public GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
    
    Specified by:
    
    getEndpointAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for GetEndpointAttributes action.
    
    Returns:
    
    Result of the GetEndpointAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPlatformApplicationAttributes
```
public GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
    
    Specified by:
    
    getPlatformApplicationAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for GetPlatformApplicationAttributes action.
    
    Returns:
    
    Result of the GetPlatformApplicationAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSMSAttributes
```
public GetSMSAttributesResult getSMSAttributes(GetSMSAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - The input for the GetSMSAttributes request.
    
    Returns:
    
    Result of the GetSMSAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSubscriptionAttributes
```
public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Returns all of the properties of a subscription.
    
    Specified by:
    
    getSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for GetSubscriptionAttributes.
    
    Returns:
    
    Result of the GetSubscriptionAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSubscriptionAttributes
```
public GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the GetSubscriptionAttributes operation.
    
    Specified by:
    
    getSubscriptionAttributes in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)
  - getTopicAttributes
```
public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - Input for GetTopicAttributes action.
    
    Returns:
    
    Result of the GetTopicAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTopicAttributes
```
public GetTopicAttributesResult getTopicAttributes(String topicArn)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the GetTopicAttributes operation.
    
    Specified by:
    
    getTopicAttributes in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.getTopicAttributes(GetTopicAttributesRequest)
  - listEndpointsByPlatformApplication
```
public ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)
```
    Description copied from interface: AmazonSNS
    
    Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM 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.
    
    Specified by:
    
    listEndpointsByPlatformApplication in interface AmazonSNS
    
    Parameters:
    
    request - Input for ListEndpointsByPlatformApplication action.
    
    Returns:
    
    Result of the ListEndpointsByPlatformApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPhoneNumbersOptedOut
```
public ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - The input for the ListPhoneNumbersOptedOut action.
    
    Returns:
    
    Result of the ListPhoneNumbersOptedOut operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPlatformApplications
```
public ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest request)
```
    Description copied from interface: AmazonSNS
    
    Lists the platform application objects for the supported push notification services, such as APNS and GCM. 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.
    
    Specified by:
    
    listPlatformApplications in interface AmazonSNS
    
    Parameters:
    
    request - Input for ListPlatformApplications action.
    
    Returns:
    
    Result of the ListPlatformApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPlatformApplications
```
public ListPlatformApplicationsResult listPlatformApplications()
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListPlatformApplications operation.
    
    Specified by:
    
    listPlatformApplications in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest request)
```
    Description copied from interface: AmazonSNS
    
    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.
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    Parameters:
    
    request - Input for ListSubscriptions action.
    
    Returns:
    
    Result of the ListSubscriptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions()
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListSubscriptions operation.
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listSubscriptions(ListSubscriptionsRequest)
  - listSubscriptions
```
public ListSubscriptionsResult listSubscriptions(String nextToken)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListSubscriptions operation.
    
    Specified by:
    
    listSubscriptions in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listSubscriptions(ListSubscriptionsRequest)
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)
```
    Description copied from interface: AmazonSNS
    
    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.
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    Parameters:
    
    request - Input for ListSubscriptionsByTopic action.
    
    Returns:
    
    Result of the ListSubscriptionsByTopic operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListSubscriptionsByTopic operation.
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)
  - listSubscriptionsByTopic
```
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn,
                                                               String nextToken)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListSubscriptionsByTopic operation.
    
    Specified by:
    
    listSubscriptionsByTopic in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)
  - listTopics
```
public ListTopicsResult listTopics(ListTopicsRequest request)
```
    Description copied from interface: AmazonSNS
    
    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.
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    Returns:
    
    Result of the ListTopics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTopics
```
public ListTopicsResult listTopics()
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListTopics operation.
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listTopics(ListTopicsRequest)
  - listTopics
```
public ListTopicsResult listTopics(String nextToken)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the ListTopics operation.
    
    Specified by:
    
    listTopics in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.listTopics(ListTopicsRequest)
  - optInPhoneNumber
```
public OptInPhoneNumberResult optInPhoneNumber(OptInPhoneNumberRequest request)
```
    Description copied from interface: AmazonSNS
    
    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:
    
    request - Input for the OptInPhoneNumber action.
    
    Returns:
    
    Result of the OptInPhoneNumber operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - publish
```
public PublishResult publish(PublishRequest request)
```
    Description copied from interface: AmazonSNS
    
    Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.
    
    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.
    
    Specified by:
    
    publish in interface AmazonSNS
    
    Parameters:
    
    request - Input for Publish action.
    
    Returns:
    
    Result of the Publish operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - publish
```
public PublishResult publish(String topicArn,
                             String message)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the Publish operation.
    
    Specified by:
    
    publish in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.publish(PublishRequest)
  - publish
```
public PublishResult publish(String topicArn,
                             String message,
                             String subject)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the Publish operation.
    
    Specified by:
    
    publish in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.publish(PublishRequest)
  - removePermission
```
public RemovePermissionResult removePermission(RemovePermissionRequest request)
```
    Description copied from interface: AmazonSNS
    
    Removes a statement from a topic's access control policy.
    
    Specified by:
    
    removePermission in interface AmazonSNS
    
    Parameters:
    
    request - Input for RemovePermission action.
    
    Returns:
    
    Result of the RemovePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removePermission
```
public RemovePermissionResult removePermission(String topicArn,
                                               String label)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the RemovePermission operation.
    
    Specified by:
    
    removePermission in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.removePermission(RemovePermissionRequest)
  - setEndpointAttributes
```
public SetEndpointAttributesResult setEndpointAttributes(SetEndpointAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
    
    Specified by:
    
    setEndpointAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for SetEndpointAttributes action.
    
    Returns:
    
    Result of the SetEndpointAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setPlatformApplicationAttributes
```
public SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. 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:
    
    request - Input for SetPlatformApplicationAttributes action.
    
    Returns:
    
    Result of the SetPlatformApplicationAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setSMSAttributes
```
public SetSMSAttributesResult setSMSAttributes(SetSMSAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    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 Sending an SMS Message in the Amazon SNS Developer Guide.
    
    Specified by:
    
    setSMSAttributes in interface AmazonSNS
    
    Parameters:
    
    request - The input for the SetSMSAttributes action.
    
    Returns:
    
    Result of the SetSMSAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setSubscriptionAttributes
```
public SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Allows a subscription owner to set an attribute of the topic to a new value.
    
    Specified by:
    
    setSubscriptionAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for SetSubscriptionAttributes action.
    
    Returns:
    
    Result of the SetSubscriptionAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setSubscriptionAttributes
```
public SetSubscriptionAttributesResult setSubscriptionAttributes(String subscriptionArn,
                                                                 String attributeName,
                                                                 String attributeValue)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the SetSubscriptionAttributes operation.
    
    Specified by:
    
    setSubscriptionAttributes in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)
  - setTopicAttributes
```
public SetTopicAttributesResult setTopicAttributes(SetTopicAttributesRequest request)
```
    Description copied from interface: AmazonSNS
    
    Allows a topic owner to set an attribute of the topic to a new value.
    
    Specified by:
    
    setTopicAttributes in interface AmazonSNS
    
    Parameters:
    
    request - Input for SetTopicAttributes action.
    
    Returns:
    
    Result of the SetTopicAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setTopicAttributes
```
public SetTopicAttributesResult setTopicAttributes(String topicArn,
                                                   String attributeName,
                                                   String attributeValue)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the SetTopicAttributes operation.
    
    Specified by:
    
    setTopicAttributes in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.setTopicAttributes(SetTopicAttributesRequest)
  - subscribe
```
public SubscribeResult subscribe(SubscribeRequest request)
```
    Description copied from interface: AmazonSNS
    
    Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
    
    Specified by:
    
    subscribe in interface AmazonSNS
    
    Parameters:
    
    request - Input for Subscribe action.
    
    Returns:
    
    Result of the Subscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - subscribe
```
public SubscribeResult subscribe(String topicArn,
                                 String protocol,
                                 String endpoint)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the Subscribe operation.
    
    Specified by:
    
    subscribe in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.subscribe(SubscribeRequest)
  - unsubscribe
```
public UnsubscribeResult unsubscribe(UnsubscribeRequest request)
```
    Description copied from interface: AmazonSNS
    
    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.
    
    Specified by:
    
    unsubscribe in interface AmazonSNS
    
    Parameters:
    
    request - Input for Unsubscribe action.
    
    Returns:
    
    Result of the Unsubscribe operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - unsubscribe
```
public UnsubscribeResult unsubscribe(String subscriptionArn)
```
    Description copied from interface: AmazonSNS
    
    Simplified method form for invoking the Unsubscribe operation.
    
    Specified by:
    
    unsubscribe in interface AmazonSNS
    
    See Also:
    
    AmazonSNS.unsubscribe(UnsubscribeRequest)
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonSNS
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonSNS
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonSNS
    
    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 a 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.

Did this page help you?

Class AbstractAmazonSNS

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

addPermission

addPermission

checkIfPhoneNumberIsOptedOut

confirmSubscription

confirmSubscription

confirmSubscription

createPlatformApplication

createPlatformEndpoint

createTopic

createTopic

deleteEndpoint

deletePlatformApplication

deleteTopic

deleteTopic

getEndpointAttributes

getPlatformApplicationAttributes

getSMSAttributes

getSubscriptionAttributes

getSubscriptionAttributes

getTopicAttributes

getTopicAttributes

listEndpointsByPlatformApplication

listPhoneNumbersOptedOut

listPlatformApplications

listPlatformApplications

listSubscriptions

listSubscriptions

listSubscriptions

listSubscriptionsByTopic

listSubscriptionsByTopic

listSubscriptionsByTopic

listTopics

listTopics

listTopics

optInPhoneNumber

publish

publish

publish

removePermission

removePermission

setEndpointAttributes

setPlatformApplicationAttributes

setSMSAttributes

setSubscriptionAttributes

setSubscriptionAttributes

setTopicAttributes

setTopicAttributes

subscribe

subscribe

unsubscribe

unsubscribe

shutdown

getCachedResponseMetadata