public class AmazonSNSAsyncClient extends AmazonSNSClient implements AmazonSNSAsync
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 .
Constructor and Description |
---|
AmazonSNSAsyncClient()
Constructs a new asynchronous client to invoke service methods on
AmazonSNS.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials,
executor service, and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials
and executor service.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials provider.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials
provider and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials
provider, executor service, and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS using the specified AWS account credentials provider
and executor service.
|
AmazonSNSAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on
AmazonSNS.
|
Modifier and Type | Method and Description |
---|---|
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
The
AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions. |
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,Void> asyncHandler)
The
AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest)
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. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
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. |
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
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. |
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest,
AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
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. |
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest)
The
CreatePlatformEndpoint creates an endpoint for a
device and mobile app on one of the supported push notification
services, such as GCM and APNS. |
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
The
CreatePlatformEndpoint creates an endpoint for a
device and mobile app on one of the supported push notification
services, such as GCM and APNS. |
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest)
The
CreateTopic action creates a topic to which
notifications can be published. |
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
The
CreateTopic action creates a topic to which
notifications can be published. |
Future<Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
The
DeleteEndpoint action, which is idempotent, deletes
the endpoint from SNS. |
Future<Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
AsyncHandler<DeleteEndpointRequest,Void> asyncHandler)
The
DeleteEndpoint action, which is idempotent, deletes
the endpoint from SNS. |
Future<Void> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
The
DeletePlatformApplication action deletes a platform
application object for one of the supported push notification
services, such as APNS and GCM. |
Future<Void> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest,
AsyncHandler<DeletePlatformApplicationRequest,Void> asyncHandler)
The
DeletePlatformApplication action deletes a platform
application object for one of the supported push notification
services, such as APNS and GCM. |
Future<Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
The
DeleteTopic action deletes a topic and all its
subscriptions. |
Future<Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
AsyncHandler<DeleteTopicRequest,Void> asyncHandler)
The
DeleteTopic action deletes a topic and all its
subscriptions. |
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
The
GetEndpointAttributes retrieves the endpoint
attributes for a device on one of the supported push notification
services, such as GCM and APNS. |
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
The
GetEndpointAttributes retrieves the endpoint
attributes for a device on one of the supported push notification
services, such as GCM and APNS. |
ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
The
GetPlatformApplicationAttributes action retrieves the
attributes of the platform application object for the supported push
notification services, such as APNS and GCM. |
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
The
GetPlatformApplicationAttributes action retrieves the
attributes of the platform application object for the supported push
notification services, such as APNS and GCM. |
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
The
GetSubscriptionAttribtues action returns all of the
properties of a subscription. |
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
The
GetSubscriptionAttribtues action returns all of the
properties of a subscription. |
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest)
The
GetTopicAttributes action returns all of the
properties of a topic. |
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
The
GetTopicAttributes action returns all of the
properties of a topic. |
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
The
ListEndpointsByPlatformApplication action lists the
endpoints and endpoint attributes for devices in a supported push
notification service, such as GCM and APNS. |
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
The
ListEndpointsByPlatformApplication action lists the
endpoints and endpoint attributes for devices in a supported push
notification service, such as GCM and APNS. |
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
The
ListPlatformApplications action lists the platform
application objects for the supported push notification services, such
as APNS and GCM. |
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
The
ListPlatformApplications action lists the platform
application objects for the supported push notification services, such
as APNS and GCM. |
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest)
The
ListSubscriptions action returns a list of the
requester's subscriptions. |
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
The
ListSubscriptions action returns a list of the
requester's subscriptions. |
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
The
ListSubscriptionsByTopic action returns a list of the
subscriptions to a specific topic. |
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
The
ListSubscriptionsByTopic action returns a list of the
subscriptions to a specific topic. |
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest)
The
ListTopics action returns a list of the requester's
topics. |
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
The
ListTopics action returns a list of the requester's
topics. |
Future<PublishResult> |
publishAsync(PublishRequest publishRequest)
The
Publish action sends a message to all of a topic's
subscribed endpoints. |
Future<PublishResult> |
publishAsync(PublishRequest publishRequest,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
The
Publish action sends a message to all of a topic's
subscribed endpoints. |
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
The
RemovePermission action removes a statement from a
topic's access control policy. |
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
The
RemovePermission action removes a statement from a
topic's access control policy. |
Future<Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
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. |
Future<Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
AsyncHandler<SetEndpointAttributesRequest,Void> asyncHandler)
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. |
Future<Void> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
The
SetPlatformApplicationAttributes action sets the
attributes of the platform application object for the supported push
notification services, such as APNS and GCM. |
Future<Void> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
AsyncHandler<SetPlatformApplicationAttributesRequest,Void> asyncHandler)
The
SetPlatformApplicationAttributes action sets the
attributes of the platform application object for the supported push
notification services, such as APNS and GCM. |
Future<Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
The
SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value. |
Future<Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
AsyncHandler<SetSubscriptionAttributesRequest,Void> asyncHandler)
The
SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value. |
Future<Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
The
SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value. |
Future<Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler<SetTopicAttributesRequest,Void> asyncHandler)
The
SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value. |
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest)
The
Subscribe action prepares to subscribe an endpoint by
sending the endpoint a confirmation message. |
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
The
Subscribe action prepares to subscribe an endpoint by
sending the endpoint a confirmation message. |
Future<Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
The
Unsubscribe action deletes a subscription. |
Future<Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
AsyncHandler<UnsubscribeRequest,Void> asyncHandler)
The
Unsubscribe action deletes a subscription. |
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, setEndpointAttributes, setPlatformApplicationAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, subscribe, subscribe, unsubscribe, unsubscribe
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setTimeOffset, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, subscribe, subscribe, unsubscribe, unsubscribe
public AmazonSNSAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonSNSAsyncClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonSNS
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonSNSAsyncClient(AWSCredentials awsCredentials)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonSNSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonSNSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will
be executed.public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
- The executor service by which all asynchronous requests will
be executed.public ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface AmazonSNS
shutdown
in class AmazonWebServiceClient
public Future<ConfirmSubscriptionResult> 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".
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionRequest
- Container for the necessary
parameters to execute the ConfirmSubscription operation on AmazonSNS.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.public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler) 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".
confirmSubscriptionAsync
in interface AmazonSNSAsync
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.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.public Future<CreatePlatformApplicationResult> 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 .
createPlatformApplicationAsync
in interface AmazonSNSAsync
createPlatformApplicationRequest
- Container for the necessary
parameters to execute the CreatePlatformApplication operation on
AmazonSNS.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.public Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> 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 .
createPlatformApplicationAsync
in interface AmazonSNSAsync
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.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.public Future<GetTopicAttributesResult> 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.
getTopicAttributesAsync
in interface AmazonSNSAsync
getTopicAttributesRequest
- Container for the necessary
parameters to execute the GetTopicAttributes operation on AmazonSNS.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.public Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> 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.
getTopicAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<SubscribeResult> 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.
subscribeAsync
in interface AmazonSNSAsync
subscribeRequest
- Container for the necessary parameters to
execute the Subscribe operation on AmazonSNS.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.public Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> 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.
subscribeAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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 .
deleteEndpointAsync
in interface AmazonSNSAsync
deleteEndpointRequest
- Container for the necessary parameters to
execute the DeleteEndpoint operation on AmazonSNS.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.public Future<Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,Void> 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 .
deleteEndpointAsync
in interface AmazonSNSAsync
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.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.public Future<Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetTopicAttributes
action allows a topic owner to set
an attribute of the topic to a new value.
setTopicAttributesAsync
in interface AmazonSNSAsync
setTopicAttributesRequest
- Container for the necessary
parameters to execute the SetTopicAttributes operation on AmazonSNS.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.public Future<Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest, AsyncHandler<SetTopicAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
The SetTopicAttributes
action allows a topic owner to set
an attribute of the topic to a new value.
setTopicAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
The RemovePermission
action removes a statement from a
topic's access control policy.
removePermissionAsync
in interface AmazonSNSAsync
removePermissionRequest
- Container for the necessary parameters
to execute the RemovePermission operation on AmazonSNS.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.public Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
The RemovePermission
action removes a statement from a
topic's access control policy.
removePermissionAsync
in interface AmazonSNSAsync
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.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.public Future<GetEndpointAttributesResult> 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 .
getEndpointAttributesAsync
in interface AmazonSNSAsync
getEndpointAttributesRequest
- Container for the necessary
parameters to execute the GetEndpointAttributes operation on
AmazonSNS.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.public Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> 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 .
getEndpointAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<ListSubscriptionsResult> 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.
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsRequest
- Container for the necessary parameters
to execute the ListSubscriptions operation on AmazonSNS.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.public Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> 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.
listSubscriptionsAsync
in interface AmazonSNSAsync
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.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.public Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws AmazonServiceException, AmazonClientException
The CreatePlatformEndpoint
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. For more information, see
Using Amazon SNS Mobile Push Notifications .
createPlatformEndpointAsync
in interface AmazonSNSAsync
createPlatformEndpointRequest
- Container for the necessary
parameters to execute the CreatePlatformEndpoint operation on
AmazonSNS.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.public Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler) throws AmazonServiceException, AmazonClientException
The CreatePlatformEndpoint
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. For more information, see
Using Amazon SNS Mobile Push Notifications .
createPlatformEndpointAsync
in interface AmazonSNSAsync
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.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.public Future<Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetSubscriptionAttributes
action allows a
subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
setSubscriptionAttributesRequest
- Container for the necessary
parameters to execute the SetSubscriptionAttributes operation on
AmazonSNS.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.public Future<Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest, AsyncHandler<SetSubscriptionAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
The SetSubscriptionAttributes
action allows a
subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest) throws AmazonServiceException, AmazonClientException
The CreateTopic
action creates a topic to which
notifications can be published. Users can create at most 100 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.
createTopicAsync
in interface AmazonSNSAsync
createTopicRequest
- Container for the necessary parameters to
execute the CreateTopic operation on AmazonSNS.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.public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler) throws AmazonServiceException, AmazonClientException
The CreateTopic
action creates a topic to which
notifications can be published. Users can create at most 100 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.
createTopicAsync
in interface AmazonSNSAsync
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.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.public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetSubscriptionAttribtues
action returns all of the
properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
getSubscriptionAttributesRequest
- Container for the necessary
parameters to execute the GetSubscriptionAttributes operation on
AmazonSNS.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.public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
The GetSubscriptionAttribtues
action returns all of the
properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<ListTopicsResult> 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.
listTopicsAsync
in interface AmazonSNSAsync
listTopicsRequest
- Container for the necessary parameters to
execute the ListTopics operation on AmazonSNS.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.public Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> 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.
listTopicsAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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 .
deletePlatformApplicationAsync
in interface AmazonSNSAsync
deletePlatformApplicationRequest
- Container for the necessary
parameters to execute the DeletePlatformApplication operation on
AmazonSNS.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.public Future<Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest, AsyncHandler<DeletePlatformApplicationRequest,Void> 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 .
deletePlatformApplicationAsync
in interface AmazonSNSAsync
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.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.public Future<ListPlatformApplicationsResult> 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 .
listPlatformApplicationsAsync
in interface AmazonSNSAsync
listPlatformApplicationsRequest
- Container for the necessary
parameters to execute the ListPlatformApplications operation on
AmazonSNS.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.public Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> 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 .
listPlatformApplicationsAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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 .
setEndpointAttributesAsync
in interface AmazonSNSAsync
setEndpointAttributesRequest
- Container for the necessary
parameters to execute the SetEndpointAttributes operation on
AmazonSNS.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.public Future<Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest, AsyncHandler<SetEndpointAttributesRequest,Void> 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 .
setEndpointAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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.
unsubscribeAsync
in interface AmazonSNSAsync
unsubscribeRequest
- Container for the necessary parameters to
execute the Unsubscribe operation on AmazonSNS.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.public Future<Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,Void> 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.
unsubscribeAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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.
deleteTopicAsync
in interface AmazonSNSAsync
deleteTopicRequest
- Container for the necessary parameters to
execute the DeleteTopic operation on AmazonSNS.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.public Future<Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,Void> 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.
deleteTopicAsync
in interface AmazonSNSAsync
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.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.public Future<GetPlatformApplicationAttributesResult> 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 .
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
getPlatformApplicationAttributesRequest
- Container for the
necessary parameters to execute the GetPlatformApplicationAttributes
operation on AmazonSNS.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.public Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> 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 .
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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 .
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
setPlatformApplicationAttributesRequest
- Container for the
necessary parameters to execute the SetPlatformApplicationAttributes
operation on AmazonSNS.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.public Future<Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest, AsyncHandler<SetPlatformApplicationAttributesRequest,Void> 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 .
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
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.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.public Future<Void> 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.
addPermissionAsync
in interface AmazonSNSAsync
addPermissionRequest
- Container for the necessary parameters to
execute the AddPermission operation on AmazonSNS.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.public Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,Void> 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.
addPermissionAsync
in interface AmazonSNSAsync
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.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.public Future<ListEndpointsByPlatformApplicationResult> 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 .
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
listEndpointsByPlatformApplicationRequest
- Container for the
necessary parameters to execute the ListEndpointsByPlatformApplication
operation on AmazonSNS.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.public Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> 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 .
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
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.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.public Future<ListSubscriptionsByTopicResult> 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.
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicRequest
- Container for the necessary
parameters to execute the ListSubscriptionsByTopic operation on
AmazonSNS.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.public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> 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.
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
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.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.public Future<PublishResult> 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.
publishAsync
in interface AmazonSNSAsync
publishRequest
- Container for the necessary parameters to
execute the Publish operation on AmazonSNS.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.public Future<PublishResult> publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> 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.
publishAsync
in interface AmazonSNSAsync
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.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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.