com.amazonaws.services.sns.AmazonSNSAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.sns;
import java.util.concurrent.Future;
import com.amazonaws.AmazonClientException;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.handlers.AsyncHandler;
import com.amazonaws.services.sns.model.*;
/**
* 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
* .
*
*/
public interface AmazonSNSAsync extends AmazonSNS {
/**
*
* The ConfirmSubscription action 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".
*
*
* @param confirmSubscriptionRequest Container for the necessary
* parameters to execute the ConfirmSubscription operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ConfirmSubscription action 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".
*
*
* @param confirmSubscriptionRequest Container for the necessary
* parameters to execute the ConfirmSubscription operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreatePlatformApplication action 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
* .
*
*
* @param createPlatformApplicationRequest Container for the necessary
* parameters to execute the CreatePlatformApplication operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreatePlatformApplication action 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
* .
*
*
* @param createPlatformApplicationRequest Container for the necessary
* parameters to execute the CreatePlatformApplication operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetTopicAttributes action returns all of the
* properties of a topic. Topic properties returned might differ based on
* the authorization of the user.
*
*
* @param getTopicAttributesRequest Container for the necessary
* parameters to execute the GetTopicAttributes operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetTopicAttributes action returns all of the
* properties of a topic. Topic properties returned might differ based on
* the authorization of the user.
*
*
* @param getTopicAttributesRequest Container for the necessary
* parameters to execute the GetTopicAttributes operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Subscribe action 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.
*
*
* @param subscribeRequest Container for the necessary parameters to
* execute the Subscribe operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future subscribeAsync(SubscribeRequest subscribeRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Subscribe action 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.
*
*
* @param subscribeRequest Container for the necessary parameters to
* execute the Subscribe operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeleteEndpoint action, which is idempotent, deletes
* the endpoint from SNS. For more information, see
* Using Amazon SNS Mobile Push Notifications
* .
*
*
* @param deleteEndpointRequest Container for the necessary parameters to
* execute the DeleteEndpoint operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeleteEndpoint action, which is idempotent, deletes
* the endpoint from SNS. For more information, see
* Using Amazon SNS Mobile Push Notifications
* .
*
*
* @param deleteEndpointRequest Container for the necessary parameters to
* execute the DeleteEndpoint operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetTopicAttributes action allows a topic owner to set
* an attribute of the topic to a new value.
*
*
* @param setTopicAttributesRequest Container for the necessary
* parameters to execute the SetTopicAttributes operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetTopicAttributes action allows a topic owner to set
* an attribute of the topic to a new value.
*
*
* @param setTopicAttributesRequest Container for the necessary
* parameters to execute the SetTopicAttributes operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The RemovePermission action removes a statement from a
* topic's access control policy.
*
*
* @param removePermissionRequest Container for the necessary parameters
* to execute the RemovePermission operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future removePermissionAsync(RemovePermissionRequest removePermissionRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The RemovePermission action removes a statement from a
* topic's access control policy.
*
*
* @param removePermissionRequest Container for the necessary parameters
* to execute the RemovePermission operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetEndpointAttributes 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
* .
*
*
* @param getEndpointAttributesRequest Container for the necessary
* parameters to execute the GetEndpointAttributes operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetEndpointAttributes 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
* .
*
*
* @param getEndpointAttributesRequest Container for the necessary
* parameters to execute the GetEndpointAttributes operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListSubscriptions action 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.
*
*
* @param listSubscriptionsRequest Container for the necessary parameters
* to execute the ListSubscriptions operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListSubscriptions action 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.
*
*
* @param listSubscriptionsRequest Container for the necessary parameters
* to execute the ListSubscriptions operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreatePlatformEndpoint action 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
* .
*
*
* @param createPlatformEndpointRequest Container for the necessary
* parameters to execute the CreatePlatformEndpoint operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreatePlatformEndpoint action 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
* .
*
*
* @param createPlatformEndpointRequest Container for the necessary
* parameters to execute the CreatePlatformEndpoint operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetSubscriptionAttributes action allows a
* subscription owner to set an attribute of the topic to a new value.
*
*
* @param setSubscriptionAttributesRequest Container for the necessary
* parameters to execute the SetSubscriptionAttributes operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetSubscriptionAttributes action allows a
* subscription owner to set an attribute of the topic to a new value.
*
*
* @param setSubscriptionAttributesRequest Container for the necessary
* parameters to execute the SetSubscriptionAttributes operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreateTopic action 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.
*
*
* @param createTopicRequest Container for the necessary parameters to
* execute the CreateTopic operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createTopicAsync(CreateTopicRequest createTopicRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The CreateTopic action 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.
*
*
* @param createTopicRequest Container for the necessary parameters to
* execute the CreateTopic operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future createTopicAsync(CreateTopicRequest createTopicRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetSubscriptionAttribtues action returns all of the
* properties of a subscription.
*
*
* @param getSubscriptionAttributesRequest Container for the necessary
* parameters to execute the GetSubscriptionAttributes operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetSubscriptionAttribtues action returns all of the
* properties of a subscription.
*
*
* @param getSubscriptionAttributesRequest Container for the necessary
* parameters to execute the GetSubscriptionAttributes operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListTopics action 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.
*
*
* @param listTopicsRequest Container for the necessary parameters to
* execute the ListTopics operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listTopicsAsync(ListTopicsRequest listTopicsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListTopics action 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.
*
*
* @param listTopicsRequest Container for the necessary parameters to
* execute the ListTopics operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listTopicsAsync(ListTopicsRequest listTopicsRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeletePlatformApplication action 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
* .
*
*
* @param deletePlatformApplicationRequest Container for the necessary
* parameters to execute the DeletePlatformApplication operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeletePlatformApplication action 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
* .
*
*
* @param deletePlatformApplicationRequest Container for the necessary
* parameters to execute the DeletePlatformApplication operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListPlatformApplications action 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
* .
*
*
* @param listPlatformApplicationsRequest Container for the necessary
* parameters to execute the ListPlatformApplications operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListPlatformApplications action 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
* .
*
*
* @param listPlatformApplicationsRequest Container for the necessary
* parameters to execute the ListPlatformApplications operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetEndpointAttributes action 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
* .
*
*
* @param setEndpointAttributesRequest Container for the necessary
* parameters to execute the SetEndpointAttributes operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetEndpointAttributes action 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
* .
*
*
* @param setEndpointAttributesRequest Container for the necessary
* parameters to execute the SetEndpointAttributes operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Unsubscribe action 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.
*
*
* @param unsubscribeRequest Container for the necessary parameters to
* execute the Unsubscribe operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Unsubscribe action 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.
*
*
* @param unsubscribeRequest Container for the necessary parameters to
* execute the Unsubscribe operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeleteTopic action 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.
*
*
* @param deleteTopicRequest Container for the necessary parameters to
* execute the DeleteTopic operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The DeleteTopic action 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.
*
*
* @param deleteTopicRequest Container for the necessary parameters to
* execute the DeleteTopic operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetPlatformApplicationAttributes action 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
* .
*
*
* @param getPlatformApplicationAttributesRequest Container for the
* necessary parameters to execute the GetPlatformApplicationAttributes
* operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The GetPlatformApplicationAttributes action 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
* .
*
*
* @param getPlatformApplicationAttributesRequest Container for the
* necessary parameters to execute the GetPlatformApplicationAttributes
* operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetPlatformApplicationAttributes action 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
* .
*
*
* @param setPlatformApplicationAttributesRequest Container for the
* necessary parameters to execute the SetPlatformApplicationAttributes
* operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The SetPlatformApplicationAttributes action 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
* .
*
*
* @param setPlatformApplicationAttributesRequest Container for the
* necessary parameters to execute the SetPlatformApplicationAttributes
* operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The AddPermission action adds a statement to a topic's
* access control policy, granting access for the specified AWS accounts
* to the specified actions.
*
*
* @param addPermissionRequest Container for the necessary parameters to
* execute the AddPermission operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future addPermissionAsync(AddPermissionRequest addPermissionRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The AddPermission action adds a statement to a topic's
* access control policy, granting access for the specified AWS accounts
* to the specified actions.
*
*
* @param addPermissionRequest Container for the necessary parameters to
* execute the AddPermission operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListEndpointsByPlatformApplication action 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
* .
*
*
* @param listEndpointsByPlatformApplicationRequest Container for the
* necessary parameters to execute the ListEndpointsByPlatformApplication
* operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListEndpointsByPlatformApplication action 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
* .
*
*
* @param listEndpointsByPlatformApplicationRequest Container for the
* necessary parameters to execute the ListEndpointsByPlatformApplication
* operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListSubscriptionsByTopic action 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.
*
*
* @param listSubscriptionsByTopicRequest Container for the necessary
* parameters to execute the ListSubscriptionsByTopic operation on
* AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The ListSubscriptionsByTopic action 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.
*
*
* @param listSubscriptionsByTopicRequest Container for the necessary
* parameters to execute the ListSubscriptionsByTopic operation on
* AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Publish action 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.
*
*
* @param publishRequest Container for the necessary parameters to
* execute the Publish operation on AmazonSNS.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future publishAsync(PublishRequest publishRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* The Publish action 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.
*
*
* @param publishRequest Container for the necessary parameters to
* execute the Publish operation on AmazonSNS.
* @param 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.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonSNS indicating
* either a problem with the data in the request, or a server side issue.
*/
public Future publishAsync(PublishRequest publishRequest,
AsyncHandler asyncHandler)
throws AmazonServiceException, AmazonClientException;
}