public interface AmazonSNSAsync extends AmazonSNS
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 .
Modifier and Type | Method and Description |
---|---|
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access
for the specified AWS accounts to the specified actions.
|
Future<Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,Void> asyncHandler)
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)
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)
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)
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)
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)
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)
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)
Creates a topic to which notifications can be published.
|
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a topic to which notifications can be published.
|
Future<Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint from Amazon SNS.
|
Future<Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
AsyncHandler<DeleteEndpointRequest,Void> asyncHandler)
Deletes the endpoint from Amazon SNS.
|
Future<Void> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
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)
Deletes a platform application object for one of the supported push
notification services, such as APNS and GCM.
|
Future<Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
Deletes a topic and all its subscriptions.
|
Future<Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
AsyncHandler<DeleteTopicRequest,Void> asyncHandler)
Deletes a topic and all its subscriptions.
|
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the
supported push notification services, such as GCM and APNS.
|
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
Retrieves the endpoint attributes for a device on one of the
supported push notification services, such as GCM and APNS.
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
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)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Returns all of the properties of a subscription.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest)
Returns all of the properties of a topic.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Returns all of the properties of a topic.
|
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
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)
Lists the endpoints and endpoint attributes for devices in a
supported push notification service, such as GCM and APNS.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
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)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Returns a list of the subscriptions to a specific topic.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Returns a list of the requester's topics.
|
Future<PublishResult> |
publishAsync(PublishRequest publishRequest)
Sends a message to all of a topic's subscribed endpoints.
|
Future<PublishResult> |
publishAsync(PublishRequest publishRequest,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Sends a message to all of a topic's subscribed endpoints.
|
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
|
Future<Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,Void> asyncHandler)
Removes a statement from a topic's access control policy.
|
Future<Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the
supported push notification services, such as GCM and APNS.
|
Future<Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
AsyncHandler<SetEndpointAttributesRequest,Void> asyncHandler)
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)
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)
Sets the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
Future<Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
Future<Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
AsyncHandler<SetSubscriptionAttributesRequest,Void> asyncHandler)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
Future<Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler<SetTopicAttributesRequest,Void> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a
confirmation message.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Prepares to subscribe an endpoint by sending the endpoint a
confirmation message.
|
Future<Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
Future<Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
AsyncHandler<UnsubscribeRequest,Void> asyncHandler)
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, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, shutdown, subscribe, subscribe, unsubscribe, unsubscribe
Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe
action. If the token is valid, the action creates a new subscription
and returns its Amazon Resource Name (ARN). This call requires an AWS
signature only when the AuthenticateOnUnsubscribe
flag is
set to "true".
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.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Verifies an endpoint owner's intent to receive messages by validating
the token sent to the endpoint by an earlier Subscribe
action. If the token is valid, the action creates a new subscription
and returns its Amazon Resource Name (ARN). This call requires an AWS
signature only when the AuthenticateOnUnsubscribe
flag is
set to "true".
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.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and
mobile apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
CreatePlatformApplication
action. The PlatformPrincipal
is received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is
not applicable. For ADM, PlatformPrincipal is "client id". The
PlatformCredential is also received from the notification service. For
APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret". The PlatformApplicationArn that is returned when
using CreatePlatformApplication
is then used as an
attribute for the CreatePlatformEndpoint
action. For more
information, see
Using Amazon SNS Mobile Push Notifications
.
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.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and
mobile apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
CreatePlatformApplication
action. The PlatformPrincipal
is received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is
not applicable. For ADM, PlatformPrincipal is "client id". The
PlatformCredential is also received from the notification service. For
APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret". The PlatformApplicationArn that is returned when
using CreatePlatformApplication
is then used as an
attribute for the CreatePlatformEndpoint
action. For more
information, see
Using Amazon SNS Mobile Push Notifications
.
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.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
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.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
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.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest) throws AmazonServiceException, AmazonClientException
Prepares to subscribe an endpoint by sending the endpoint a
confirmation message. To actually create a subscription, the endpoint
owner must call the ConfirmSubscription
action with the
token from the confirmation message. Confirmation tokens are valid for
three days.
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.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Prepares to subscribe an endpoint by sending the endpoint a
confirmation message. To actually create a subscription, the endpoint
owner must call the ConfirmSubscription
action with the
token from the confirmation message. Confirmation tokens are valid for
three days.
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.Future<Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest) throws AmazonServiceException, AmazonClientException
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a topic owner to set an attribute of the topic to a new value.
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.Future<Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest, AsyncHandler<SetTopicAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Allows a topic owner to set an attribute of the topic to a new value.
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.Future<Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest) throws AmazonServiceException, AmazonClientException
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
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.Future<Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
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.Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
Removes a statement from a topic's access control policy.
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.Future<Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Removes a statement from a topic's access control policy.
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.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's subscriptions. Each call returns a
limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptions
call to get further results.
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.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's subscriptions. Each call returns a
limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptions
call to get further results.
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.Future<Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a subscription owner to set an attribute of the topic to a new value.
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.Future<Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest, AsyncHandler<SetSubscriptionAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Allows a subscription owner to set an attribute of the topic to a new value.
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.Future<Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest, AsyncHandler<SetPlatformApplicationAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws AmazonServiceException, AmazonClientException
Creates an endpoint for a device and mobile app on one of the
supported push notification services, such as GCM and APNS.
CreatePlatformEndpoint
requires the
PlatformApplicationArn that is returned from
CreatePlatformApplication
. The EndpointArn that is
returned when using CreatePlatformEndpoint
can then be
used by the Publish
action to send a message to a mobile
app or by the Subscribe
action for subscription to a
topic. The CreatePlatformEndpoint
action is idempotent,
so if the requester already owns an endpoint with the same device
token and attributes, that endpoint's ARN is returned without creating
a new endpoint. For more information, see
Using Amazon SNS Mobile Push Notifications
.
When using CreatePlatformEndpoint
with Baidu, two
attributes must be provided: ChannelId and UserId. The token field
must also contain the ChannelId. For more information, see
Creating an Amazon SNS Endpoint for Baidu
.
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.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates an endpoint for a device and mobile app on one of the
supported push notification services, such as GCM and APNS.
CreatePlatformEndpoint
requires the
PlatformApplicationArn that is returned from
CreatePlatformApplication
. The EndpointArn that is
returned when using CreatePlatformEndpoint
can then be
used by the Publish
action to send a message to a mobile
app or by the Subscribe
action for subscription to a
topic. The CreatePlatformEndpoint
action is idempotent,
so if the requester already owns an endpoint with the same device
token and attributes, that endpoint's ARN is returned without creating
a new endpoint. For more information, see
Using Amazon SNS Mobile Push Notifications
.
When using CreatePlatformEndpoint
with Baidu, two
attributes must be provided: ChannelId and UserId. The token field
must also contain the ChannelId. For more information, see
Creating an Amazon SNS Endpoint for Baidu
.
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.Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
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.Future<Void> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
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.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
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.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
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.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest) throws AmazonServiceException, AmazonClientException
Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns . This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
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.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns . This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
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.Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's topics. Each call returns a limited
list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use the
NextToken
parameter in a new ListTopics
call
to get further results.
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.Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's topics. Each call returns a limited
list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use the
NextToken
parameter in a new ListTopics
call
to get further results.
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.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Lists the endpoints and endpoint attributes for devices in a
supported push notification service, such as GCM and APNS. The results
for ListEndpointsByPlatformApplication
are paginated and
return a limited list of endpoints, up to 100. If additional records
are available after the first page results, then a NextToken string
will be returned. To receive the next page, you call
ListEndpointsByPlatformApplication
again using the
NextToken string received from the previous call. When there are no
more records to return, NextToken will be null. For more information,
see
Using Amazon SNS Mobile Push Notifications
.
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.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the endpoints and endpoint attributes for devices in a
supported push notification service, such as GCM and APNS. The results
for ListEndpointsByPlatformApplication
are paginated and
return a limited list of endpoints, up to 100. If additional records
are available after the first page results, then a NextToken string
will be returned. To receive the next page, you call
ListEndpointsByPlatformApplication
again using the
NextToken string received from the previous call. When there are no
more records to return, NextToken will be null. For more information,
see
Using Amazon SNS Mobile Push Notifications
.
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.Future<Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest, AsyncHandler<DeletePlatformApplicationRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws AmazonServiceException, AmazonClientException
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. The results for
ListPlatformApplications
are paginated and return a
limited list of applications, up to 100. If additional records are
available after the first page results, then a NextToken string will
be returned. To receive the next page, you call
ListPlatformApplications
using the NextToken string
received from the previous call. When there are no more records to
return, NextToken will be null. For more information, see
Using Amazon SNS Mobile Push Notifications
.
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.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. The results for
ListPlatformApplications
are paginated and return a
limited list of applications, up to 100. If additional records are
available after the first page results, then a NextToken string will
be returned. To receive the next page, you call
ListPlatformApplications
using the NextToken string
received from the previous call. When there are no more records to
return, NextToken will be null. For more information, see
Using Amazon SNS Mobile Push Notifications
.
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.Future<Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest, AsyncHandler<SetEndpointAttributesRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications .
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.Future<Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest) throws AmazonServiceException, AmazonClientException
Deletes a subscription. If the subscription requires authentication
for deletion, only the owner of the subscription or the topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe
call does not require authentication and the
requester is not the subscription owner, a final cancellation message
is delivered to the endpoint, so that the endpoint owner can easily
resubscribe to the topic if the Unsubscribe
request was
unintended.
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.Future<Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a subscription. If the subscription requires authentication
for deletion, only the owner of the subscription or the topic's owner
can unsubscribe, and an AWS signature is required. If the
Unsubscribe
call does not require authentication and the
requester is not the subscription owner, a final cancellation message
is delivered to the endpoint, so that the endpoint owner can easily
resubscribe to the topic if the Unsubscribe
request was
unintended.
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.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the subscriptions to a specific topic. Each call
returns a limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptionsByTopic
call to get further results.
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.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the subscriptions to a specific topic. Each call
returns a limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptionsByTopic
call to get further results.
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.Future<PublishResult> publishAsync(PublishRequest publishRequest) throws AmazonServiceException, AmazonClientException
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and
Amazon SNS will attempt to deliver it to the topic's subscribers
shortly. The format of the outgoing message to each subscribed
endpoint depends on the notification protocol selected.
To use the Publish
action for sending a message to a
mobile endpoint, such as an app on a Kindle device or mobile phone,
you must specify the EndpointArn. The EndpointArn is returned when
making a call with the CreatePlatformEndpoint
action. The
second example below shows a request and response for publishing to a
mobile endpoint.
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.Future<PublishResult> publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and
Amazon SNS will attempt to deliver it to the topic's subscribers
shortly. The format of the outgoing message to each subscribed
endpoint depends on the notification protocol selected.
To use the Publish
action for sending a message to a
mobile endpoint, such as an app on a Kindle device or mobile phone,
you must specify the EndpointArn. The EndpointArn is returned when
making a call with the CreatePlatformEndpoint
action. The
second example below shows a request and response for publishing to a
mobile endpoint.
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 © 2015. All rights reserved.