com.amazonaws.services.sns

Interface AmazonSNSAsync

All Superinterfaces:

AmazonSNS

All Known Implementing Classes:

AmazonSNSAsyncClient

public interface AmazonSNSAsync
extends AmazonSNS

Interface for accessing AmazonSNS asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. 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 http://aws.amazon.com/sns . For detailed information about Amazon SNS features and their associated API calls, see 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 .

Method Summary

Methods

Modifier and Type	Method and Description
java.util.concurrent.Future<java.lang.Void>	addPermissionAsync(AddPermissionRequest addPermissionRequest) Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
java.util.concurrent.Future<java.lang.Void>	addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler) Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
java.util.concurrent.Future<ConfirmSubscriptionResult>	confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
java.util.concurrent.Future<ConfirmSubscriptionResult>	confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
java.util.concurrent.Future<CreatePlatformApplicationResult>	createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest) 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.
java.util.concurrent.Future<CreatePlatformApplicationResult>	createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler) 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.
java.util.concurrent.Future<CreatePlatformEndpointResult>	createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<CreatePlatformEndpointResult>	createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<CreateTopicResult>	createTopicAsync(CreateTopicRequest createTopicRequest) Creates a topic to which notifications can be published.
java.util.concurrent.Future<CreateTopicResult>	createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler) Creates a topic to which notifications can be published.
java.util.concurrent.Future<java.lang.Void>	deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest) Deletes the endpoint from Amazon SNS.
java.util.concurrent.Future<java.lang.Void>	deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,java.lang.Void> asyncHandler) Deletes the endpoint from Amazon SNS.
java.util.concurrent.Future<java.lang.Void>	deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<java.lang.Void>	deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest, AsyncHandler<DeletePlatformApplicationRequest,java.lang.Void> asyncHandler) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<java.lang.Void>	deleteTopicAsync(DeleteTopicRequest deleteTopicRequest) Deletes a topic and all its subscriptions.
java.util.concurrent.Future<java.lang.Void>	deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,java.lang.Void> asyncHandler) Deletes a topic and all its subscriptions.
java.util.concurrent.Future<GetEndpointAttributesResult>	getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<GetEndpointAttributesResult>	getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<GetPlatformApplicationAttributesResult>	getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<GetPlatformApplicationAttributesResult>	getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<GetSubscriptionAttributesResult>	getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) Returns all of the properties of a subscription.
java.util.concurrent.Future<GetSubscriptionAttributesResult>	getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler) Returns all of the properties of a subscription.
java.util.concurrent.Future<GetTopicAttributesResult>	getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest) Returns all of the properties of a topic.
java.util.concurrent.Future<GetTopicAttributesResult>	getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler) Returns all of the properties of a topic.
java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult>	listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult>	listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
java.util.concurrent.Future<ListPlatformApplicationsResult>	listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest) Lists the platform application objects for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<ListPlatformApplicationsResult>	listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler) Lists the platform application objects for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<ListSubscriptionsResult>	listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest) Returns a list of the requester's subscriptions.
java.util.concurrent.Future<ListSubscriptionsResult>	listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler) Returns a list of the requester's subscriptions.
java.util.concurrent.Future<ListSubscriptionsByTopicResult>	listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) Returns a list of the subscriptions to a specific topic.
java.util.concurrent.Future<ListSubscriptionsByTopicResult>	listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler) Returns a list of the subscriptions to a specific topic.
java.util.concurrent.Future<ListTopicsResult>	listTopicsAsync(ListTopicsRequest listTopicsRequest) Returns a list of the requester's topics.
java.util.concurrent.Future<ListTopicsResult>	listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler) Returns a list of the requester's topics.
java.util.concurrent.Future<PublishResult>	publishAsync(PublishRequest publishRequest) Sends a message to all of a topic's subscribed endpoints.
java.util.concurrent.Future<PublishResult>	publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler) Sends a message to all of a topic's subscribed endpoints.
java.util.concurrent.Future<java.lang.Void>	removePermissionAsync(RemovePermissionRequest removePermissionRequest) Removes a statement from a topic's access control policy.
java.util.concurrent.Future<java.lang.Void>	removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler) Removes a statement from a topic's access control policy.
java.util.concurrent.Future<java.lang.Void>	setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<java.lang.Void>	setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest, AsyncHandler<SetEndpointAttributesRequest,java.lang.Void> asyncHandler) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
java.util.concurrent.Future<java.lang.Void>	setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<java.lang.Void>	setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest, AsyncHandler<SetPlatformApplicationAttributesRequest,java.lang.Void> asyncHandler) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
java.util.concurrent.Future<java.lang.Void>	setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) Allows a subscription owner to set an attribute of the topic to a new value.
java.util.concurrent.Future<java.lang.Void>	setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest, AsyncHandler<SetSubscriptionAttributesRequest,java.lang.Void> asyncHandler) Allows a subscription owner to set an attribute of the topic to a new value.
java.util.concurrent.Future<java.lang.Void>	setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest) Allows a topic owner to set an attribute of the topic to a new value.
java.util.concurrent.Future<java.lang.Void>	setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest, AsyncHandler<SetTopicAttributesRequest,java.lang.Void> asyncHandler) Allows a topic owner to set an attribute of the topic to a new value.
java.util.concurrent.Future<SubscribeResult>	subscribeAsync(SubscribeRequest subscribeRequest) Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
java.util.concurrent.Future<SubscribeResult>	subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler) Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
java.util.concurrent.Future<java.lang.Void>	unsubscribeAsync(UnsubscribeRequest unsubscribeRequest) Deletes a subscription.
java.util.concurrent.Future<java.lang.Void>	unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,java.lang.Void> asyncHandler) Deletes a subscription.

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

addPermission, addPermission, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteTopic, deleteTopic, getCachedResponseMetadata, getEndpointAttributes, getPlatformApplicationAttributes, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listPlatformApplications, listPlatformApplications, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTopics, listTopics, listTopics, publish, publish, publish, removePermission, removePermission, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, shutdown, subscribe, subscribe, unsubscribe, unsubscribe

Method Detail

confirmSubscriptionAsync

java.util.concurrent.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(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".

Parameters:

confirmSubscriptionRequest - Container for the necessary parameters to execute the ConfirmSubscription operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ConfirmSubscription service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

confirmSubscriptionAsync

java.util.concurrent.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
                                                                              AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
                                                                                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".

Parameters:

confirmSubscriptionRequest - Container for the necessary parameters to execute the ConfirmSubscription operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ConfirmSubscription service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createPlatformApplicationAsync

java.util.concurrent.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
                                                                                            throws AmazonServiceException,
                                                                                                   AmazonClientException

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 APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". 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 .

Parameters:

createPlatformApplicationRequest - Container for the necessary parameters to execute the CreatePlatformApplication operation on AmazonSNS.

Returns:

A Java Future object containing the response from the CreatePlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createPlatformApplicationAsync

java.util.concurrent.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest,
                                                                                          AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
                                                                                            throws AmazonServiceException,
                                                                                                   AmazonClientException

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 APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". 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 .

Parameters:

createPlatformApplicationRequest - Container for the necessary parameters to execute the CreatePlatformApplication operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreatePlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getTopicAttributesAsync

java.util.concurrent.Future<GetTopicAttributesResult> getTopicAttributesAsync(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.

Parameters:

getTopicAttributesRequest - Container for the necessary parameters to execute the GetTopicAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the GetTopicAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getTopicAttributesAsync

java.util.concurrent.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
                                                                            AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

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

Parameters:

getTopicAttributesRequest - Container for the necessary parameters to execute the GetTopicAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetTopicAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

subscribeAsync

java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Parameters:

subscribeRequest - Container for the necessary parameters to execute the Subscribe operation on AmazonSNS.

Returns:

A Java Future object containing the response from the Subscribe service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

subscribeAsync

java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest,
                                                          AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Parameters:

subscribeRequest - Container for the necessary parameters to execute the Subscribe operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the Subscribe service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deleteEndpointAsync

java.util.concurrent.Future<java.lang.Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .

Parameters:

deleteEndpointRequest - Container for the necessary parameters to execute the DeleteEndpoint operation on AmazonSNS.

Returns:

A Java Future object containing the response from the DeleteEndpoint service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deleteEndpointAsync

java.util.concurrent.Future<java.lang.Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
                                                              AsyncHandler<DeleteEndpointRequest,java.lang.Void> asyncHandler)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .

Parameters:

deleteEndpointRequest - Container for the necessary parameters to execute the DeleteEndpoint operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteEndpoint service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setTopicAttributesAsync

java.util.concurrent.Future<java.lang.Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

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

Parameters:

setTopicAttributesRequest - Container for the necessary parameters to execute the SetTopicAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the SetTopicAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setTopicAttributesAsync

java.util.concurrent.Future<java.lang.Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
                                                                  AsyncHandler<SetTopicAttributesRequest,java.lang.Void> asyncHandler)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

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

Parameters:

setTopicAttributesRequest - Container for the necessary parameters to execute the SetTopicAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetTopicAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

removePermissionAsync

java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

Parameters:

removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSNS.

Returns:

A Java Future object containing the response from the RemovePermission service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

removePermissionAsync

java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest,
                                                                AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

Parameters:

removePermissionRequest - Container for the necessary parameters to execute the RemovePermission operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the RemovePermission service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getEndpointAttributesAsync

java.util.concurrent.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

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 .

Parameters:

getEndpointAttributesRequest - Container for the necessary parameters to execute the GetEndpointAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the GetEndpointAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getEndpointAttributesAsync

java.util.concurrent.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
                                                                                  AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
                                                                                    throws AmazonServiceException,
                                                                                           AmazonClientException

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 .

Parameters:

getEndpointAttributesRequest - Container for the necessary parameters to execute the GetEndpointAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetEndpointAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listSubscriptionsAsync

java.util.concurrent.Future<ListSubscriptionsResult> listSubscriptionsAsync(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.

Parameters:

listSubscriptionsRequest - Container for the necessary parameters to execute the ListSubscriptions operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ListSubscriptions service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listSubscriptionsAsync

java.util.concurrent.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
                                                                          AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
                                                                            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.

Parameters:

listSubscriptionsRequest - Container for the necessary parameters to execute the ListSubscriptions operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListSubscriptions service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createPlatformEndpointAsync

java.util.concurrent.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(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 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 .

Parameters:

createPlatformEndpointRequest - Container for the necessary parameters to execute the CreatePlatformEndpoint operation on AmazonSNS.

Returns:

A Java Future object containing the response from the CreatePlatformEndpoint service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createPlatformEndpointAsync

java.util.concurrent.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
                                                                                    AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
                                                                                      throws AmazonServiceException,
                                                                                             AmazonClientException

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 .

Parameters:

createPlatformEndpointRequest - Container for the necessary parameters to execute the CreatePlatformEndpoint operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreatePlatformEndpoint service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setSubscriptionAttributesAsync

java.util.concurrent.Future<java.lang.Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
                                                                           throws AmazonServiceException,
                                                                                  AmazonClientException

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

Parameters:

setSubscriptionAttributesRequest - Container for the necessary parameters to execute the SetSubscriptionAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the SetSubscriptionAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setSubscriptionAttributesAsync

java.util.concurrent.Future<java.lang.Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
                                                                         AsyncHandler<SetSubscriptionAttributesRequest,java.lang.Void> asyncHandler)
                                                                           throws AmazonServiceException,
                                                                                  AmazonClientException

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

Parameters:

setSubscriptionAttributesRequest - Container for the necessary parameters to execute the SetSubscriptionAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetSubscriptionAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createTopicAsync

java.util.concurrent.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Creates a topic to which notifications can be published. Users can create at most 3000 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.

Parameters:

createTopicRequest - Container for the necessary parameters to execute the CreateTopic operation on AmazonSNS.

Returns:

A Java Future object containing the response from the CreateTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

createTopicAsync

java.util.concurrent.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest,
                                                              AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Creates a topic to which notifications can be published. Users can create at most 3000 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.

Parameters:

createTopicRequest - Container for the necessary parameters to execute the CreateTopic operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the CreateTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getSubscriptionAttributesAsync

java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
                                                                                            throws AmazonServiceException,
                                                                                                   AmazonClientException

Returns all of the properties of a subscription.

Parameters:

getSubscriptionAttributesRequest - Container for the necessary parameters to execute the GetSubscriptionAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the GetSubscriptionAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getSubscriptionAttributesAsync

java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
                                                                                          AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
                                                                                            throws AmazonServiceException,
                                                                                                   AmazonClientException

Returns all of the properties of a subscription.

Parameters:

getSubscriptionAttributesRequest - Container for the necessary parameters to execute the GetSubscriptionAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetSubscriptionAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listTopicsAsync

java.util.concurrent.Future<ListTopicsResult> listTopicsAsync(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.

Parameters:

listTopicsRequest - Container for the necessary parameters to execute the ListTopics operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ListTopics service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listTopicsAsync

java.util.concurrent.Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest,
                                                            AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
                                                              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.

Parameters:

listTopicsRequest - Container for the necessary parameters to execute the ListTopics operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListTopics service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deletePlatformApplicationAsync

java.util.concurrent.Future<java.lang.Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
                                                                           throws AmazonServiceException,
                                                                                  AmazonClientException

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 .

Parameters:

deletePlatformApplicationRequest - Container for the necessary parameters to execute the DeletePlatformApplication operation on AmazonSNS.

Returns:

A Java Future object containing the response from the DeletePlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deletePlatformApplicationAsync

java.util.concurrent.Future<java.lang.Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest,
                                                                         AsyncHandler<DeletePlatformApplicationRequest,java.lang.Void> asyncHandler)
                                                                           throws AmazonServiceException,
                                                                                  AmazonClientException

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 .

Parameters:

deletePlatformApplicationRequest - Container for the necessary parameters to execute the DeletePlatformApplication operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeletePlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listPlatformApplicationsAsync

java.util.concurrent.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
                                                                                          throws AmazonServiceException,
                                                                                                 AmazonClientException

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 .

Parameters:

listPlatformApplicationsRequest - Container for the necessary parameters to execute the ListPlatformApplications operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ListPlatformApplications service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listPlatformApplicationsAsync

java.util.concurrent.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
                                                                                        AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
                                                                                          throws AmazonServiceException,
                                                                                                 AmazonClientException

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 .

Parameters:

listPlatformApplicationsRequest - Container for the necessary parameters to execute the ListPlatformApplications operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListPlatformApplications service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setEndpointAttributesAsync

java.util.concurrent.Future<java.lang.Void> setEndpointAttributesAsync(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 and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .

Parameters:

setEndpointAttributesRequest - Container for the necessary parameters to execute the SetEndpointAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the SetEndpointAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setEndpointAttributesAsync

java.util.concurrent.Future<java.lang.Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
                                                                     AsyncHandler<SetEndpointAttributesRequest,java.lang.Void> asyncHandler)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

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 .

Parameters:

setEndpointAttributesRequest - Container for the necessary parameters to execute the SetEndpointAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetEndpointAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

unsubscribeAsync

java.util.concurrent.Future<java.lang.Void> unsubscribeAsync(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.

Parameters:

unsubscribeRequest - Container for the necessary parameters to execute the Unsubscribe operation on AmazonSNS.

Returns:

A Java Future object containing the response from the Unsubscribe service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

unsubscribeAsync

java.util.concurrent.Future<java.lang.Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
                                                           AsyncHandler<UnsubscribeRequest,java.lang.Void> asyncHandler)
                                                             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.

Parameters:

unsubscribeRequest - Container for the necessary parameters to execute the Unsubscribe operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the Unsubscribe service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deleteTopicAsync

java.util.concurrent.Future<java.lang.Void> deleteTopicAsync(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.

Parameters:

deleteTopicRequest - Container for the necessary parameters to execute the DeleteTopic operation on AmazonSNS.

Returns:

A Java Future object containing the response from the DeleteTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

deleteTopicAsync

java.util.concurrent.Future<java.lang.Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
                                                           AsyncHandler<DeleteTopicRequest,java.lang.Void> asyncHandler)
                                                             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.

Parameters:

deleteTopicRequest - Container for the necessary parameters to execute the DeleteTopic operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the DeleteTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getPlatformApplicationAttributesAsync

java.util.concurrent.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
                                                                                                          throws AmazonServiceException,
                                                                                                                 AmazonClientException

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 .

Parameters:

getPlatformApplicationAttributesRequest - Container for the necessary parameters to execute the GetPlatformApplicationAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the GetPlatformApplicationAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

getPlatformApplicationAttributesAsync

java.util.concurrent.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
                                                                                                        AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
                                                                                                          throws AmazonServiceException,
                                                                                                                 AmazonClientException

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 .

Parameters:

getPlatformApplicationAttributesRequest - Container for the necessary parameters to execute the GetPlatformApplicationAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the GetPlatformApplicationAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setPlatformApplicationAttributesAsync

java.util.concurrent.Future<java.lang.Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
                                                                                  throws AmazonServiceException,
                                                                                         AmazonClientException

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 .

Parameters:

setPlatformApplicationAttributesRequest - Container for the necessary parameters to execute the SetPlatformApplicationAttributes operation on AmazonSNS.

Returns:

A Java Future object containing the response from the SetPlatformApplicationAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

setPlatformApplicationAttributesAsync

java.util.concurrent.Future<java.lang.Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
                                                                                AsyncHandler<SetPlatformApplicationAttributesRequest,java.lang.Void> asyncHandler)
                                                                                  throws AmazonServiceException,
                                                                                         AmazonClientException

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 .

Parameters:

setPlatformApplicationAttributesRequest - Container for the necessary parameters to execute the SetPlatformApplicationAttributes operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the SetPlatformApplicationAttributes service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

addPermissionAsync

java.util.concurrent.Future<java.lang.Void> addPermissionAsync(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.

Parameters:

addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSNS.

Returns:

A Java Future object containing the response from the AddPermission service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

addPermissionAsync

java.util.concurrent.Future<java.lang.Void> addPermissionAsync(AddPermissionRequest addPermissionRequest,
                                                             AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

Parameters:

addPermissionRequest - Container for the necessary parameters to execute the AddPermission operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the AddPermission service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listEndpointsByPlatformApplicationAsync

java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
                                                                                                              throws AmazonServiceException,
                                                                                                                     AmazonClientException

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 .

Parameters:

listEndpointsByPlatformApplicationRequest - Container for the necessary parameters to execute the ListEndpointsByPlatformApplication operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ListEndpointsByPlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listEndpointsByPlatformApplicationAsync

java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
                                                                                                            AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
                                                                                                              throws AmazonServiceException,
                                                                                                                     AmazonClientException

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 .

Parameters:

listEndpointsByPlatformApplicationRequest - Container for the necessary parameters to execute the ListEndpointsByPlatformApplication operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListEndpointsByPlatformApplication service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listSubscriptionsByTopicAsync

java.util.concurrent.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(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.

Parameters:

listSubscriptionsByTopicRequest - Container for the necessary parameters to execute the ListSubscriptionsByTopic operation on AmazonSNS.

Returns:

A Java Future object containing the response from the ListSubscriptionsByTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

listSubscriptionsByTopicAsync

java.util.concurrent.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
                                                                                        AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
                                                                                          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.

Parameters:

listSubscriptionsByTopicRequest - Container for the necessary parameters to execute the ListSubscriptionsByTopic operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the ListSubscriptionsByTopic service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

publishAsync

java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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 selected.

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. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

Parameters:

publishRequest - Container for the necessary parameters to execute the Publish operation on AmazonSNS.

Returns:

A Java Future object containing the response from the Publish service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.

publishAsync

java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest,
                                                      AsyncHandler<PublishRequest,PublishResult> asyncHandler)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

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 selected.

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. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

Parameters:

publishRequest - Container for the necessary parameters to execute the Publish operation on AmazonSNS.

asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.

Returns:

A Java Future object containing the response from the Publish service method, as returned by AmazonSNS.

Throws:

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 AmazonSNS indicating either a problem with the data in the request, or a server side issue.