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.
LOGGING_AWS_REQUEST_METRIC
Constructor and Description |
---|
AmazonSNSAsyncClient()
Deprecated.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials,
executor service, and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials
and executor service.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials
provider.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials
provider and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials
provider, executor service, and client configuration options.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
java.util.concurrent.ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on Amazon
Simple Notification Service using the specified AWS account credentials
provider and executor service.
|
AmazonSNSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.Future<java.lang.Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest)
Adds a statement to a topic's access control policy, granting access for
the specified AWS accounts to the specified actions.
|
java.util.concurrent.Future<java.lang.Void> |
addPermissionAsync(AddPermissionRequest addPermissionRequest,
AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler)
Adds a statement to a topic's access control policy, granting access for
the specified AWS accounts to the specified actions.
|
java.util.concurrent.Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
Accepts a phone number and indicates whether the phone holder has opted
out of receiving SMS messages from your account.
|
java.util.concurrent.Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest,
AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler)
Accepts a phone number and indicates whether the phone holder has opted
out of receiving SMS messages from your account.
|
java.util.concurrent.Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest)
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier
Subscribe action. |
java.util.concurrent.Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier
Subscribe action. |
java.util.concurrent.Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register.
|
java.util.concurrent.Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest,
AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register.
|
java.util.concurrent.Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest)
Creates a topic to which notifications can be published.
|
java.util.concurrent.Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest createTopicRequest,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a topic to which notifications can be published.
|
java.util.concurrent.Future<java.lang.Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
java.util.concurrent.Future<java.lang.Void> |
deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
AsyncHandler<DeleteEndpointRequest,java.lang.Void> asyncHandler)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
java.util.concurrent.Future<java.lang.Void> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest)
Deletes a platform application object for one of the supported push
notification services, such as APNS and GCM.
|
java.util.concurrent.Future<java.lang.Void> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest,
AsyncHandler<DeletePlatformApplicationRequest,java.lang.Void> asyncHandler)
Deletes a platform application object for one of the supported push
notification services, such as APNS and GCM.
|
java.util.concurrent.Future<java.lang.Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest)
Deletes a topic and all its subscriptions.
|
java.util.concurrent.Future<java.lang.Void> |
deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
AsyncHandler<DeleteTopicRequest,java.lang.Void> asyncHandler)
Deletes a topic and all its subscriptions.
|
java.util.concurrent.Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
Retrieves the endpoint attributes for a device on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.ExecutorService |
getExecutorService()
Returns the executor service used by this async client to execute
requests.
|
java.util.concurrent.Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
java.util.concurrent.Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM.
|
java.util.concurrent.Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest)
Returns the settings for sending SMS messages from your account.
|
java.util.concurrent.Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest,
AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler)
Returns the settings for sending SMS messages from your account.
|
java.util.concurrent.Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
|
java.util.concurrent.Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Returns all of the properties of a subscription.
|
java.util.concurrent.Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest)
Returns all of the properties of a topic.
|
java.util.concurrent.Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Returns all of the properties of a topic.
|
java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS.
|
java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS.
|
java.util.concurrent.Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
Returns a list of phone numbers that are opted out, meaning you cannot
send SMS messages to them.
|
java.util.concurrent.Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest,
AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler)
Returns a list of phone numbers that are opted out, meaning you cannot
send SMS messages to them.
|
java.util.concurrent.Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM.
|
java.util.concurrent.Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Lists the platform application objects for the supported push
notification services, such as APNS and GCM.
|
java.util.concurrent.Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest)
Returns a list of the requester's subscriptions.
|
java.util.concurrent.Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Returns a list of the requester's subscriptions.
|
java.util.concurrent.Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
Returns a list of the subscriptions to a specific topic.
|
java.util.concurrent.Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Returns a list of the subscriptions to a specific topic.
|
java.util.concurrent.Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest)
Returns a list of the requester's topics.
|
java.util.concurrent.Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest listTopicsRequest,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Returns a list of the requester's topics.
|
java.util.concurrent.Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest)
Use this request to opt in a phone number that is opted out, which
enables you to resume sending SMS messages to the number.
|
java.util.concurrent.Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest,
AsyncHandler<OptInPhoneNumberRequest,OptInPhoneNumberResult> asyncHandler)
Use this request to opt in a phone number that is opted out, which
enables you to resume sending SMS messages to the number.
|
java.util.concurrent.Future<PublishResult> |
publishAsync(PublishRequest publishRequest)
Sends a message to all of a topic's subscribed endpoints.
|
java.util.concurrent.Future<PublishResult> |
publishAsync(PublishRequest publishRequest,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Sends a message to all of a topic's subscribed endpoints.
|
java.util.concurrent.Future<java.lang.Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
|
java.util.concurrent.Future<java.lang.Void> |
removePermissionAsync(RemovePermissionRequest removePermissionRequest,
AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler)
Removes a statement from a topic's access control policy.
|
java.util.concurrent.Future<java.lang.Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.Future<java.lang.Void> |
setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
AsyncHandler<SetEndpointAttributesRequest,java.lang.Void> asyncHandler)
Sets the attributes for an endpoint for a device on one of the supported
push notification services, such as GCM and APNS.
|
java.util.concurrent.Future<java.lang.Void> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
Sets the attributes of the platform application object for the supported
push notification services, such as APNS and GCM.
|
java.util.concurrent.Future<java.lang.Void> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
AsyncHandler<SetPlatformApplicationAttributesRequest,java.lang.Void> asyncHandler)
Sets the attributes of the platform application object for the supported
push notification services, such as APNS and GCM.
|
java.util.concurrent.Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest)
Use this request to set the default settings for sending SMS messages and
receiving daily SMS usage reports.
|
java.util.concurrent.Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest,
AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler)
Use this request to set the default settings for sending SMS messages and
receiving daily SMS usage reports.
|
java.util.concurrent.Future<java.lang.Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
java.util.concurrent.Future<java.lang.Void> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
AsyncHandler<SetSubscriptionAttributesRequest,java.lang.Void> asyncHandler)
Allows a subscription owner to set an attribute of the topic to a new
value.
|
java.util.concurrent.Future<java.lang.Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
java.util.concurrent.Future<java.lang.Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler<SetTopicAttributesRequest,java.lang.Void> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
java.util.concurrent.Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message.
|
java.util.concurrent.Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message.
|
java.util.concurrent.Future<java.lang.Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
java.util.concurrent.Future<java.lang.Void> |
unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
AsyncHandler<UnsubscribeRequest,java.lang.Void> asyncHandler)
Deletes a subscription.
|
addPermission, addPermission, checkIfPhoneNumberIsOptedOut, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteTopic, deleteTopic, getCachedResponseMetadata, getEndpointAttributes, getPlatformApplicationAttributes, getSMSAttributes, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listPhoneNumbersOptedOut, listPlatformApplications, listPlatformApplications, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, removePermission, removePermission, setEndpointAttributes, setPlatformApplicationAttributes, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, subscribe, subscribe, unsubscribe, unsubscribe
addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addPermission, addPermission, checkIfPhoneNumberIsOptedOut, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteTopic, deleteTopic, getCachedResponseMetadata, getEndpointAttributes, getPlatformApplicationAttributes, getSMSAttributes, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listPhoneNumbersOptedOut, listPlatformApplications, listPlatformApplications, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, removePermission, removePermission, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, subscribe, subscribe, unsubscribe, unsubscribe
@Deprecated public AmazonSNSAsyncClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated 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 Amazon Simple Notification Service
(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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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, java.util.concurrent.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 java.util.concurrent.ExecutorService getExecutorService()
public void shutdown()
shutdown
in interface AmazonSNS
shutdown
in class AmazonWebServiceClient
public java.util.concurrent.Future<java.lang.Void> addPermissionAsync(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionAsync
in interface AmazonSNSAsync
addPermissionRequest
- InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> addPermissionAsync(AddPermissionRequest addPermissionRequest, AsyncHandler<AddPermissionRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionAsync
in interface AmazonSNSAsync
addPermissionRequest
- 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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) throws AmazonServiceException, AmazonClientException
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber
action.
checkIfPhoneNumberIsOptedOutAsync
in interface AmazonSNSAsync
checkIfPhoneNumberIsOptedOutRequest
-
The input for the CheckIfPhoneNumberIsOptedOut
action.
ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest, AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber
action.
checkIfPhoneNumberIsOptedOutAsync
in interface AmazonSNSAsync
checkIfPhoneNumberIsOptedOutRequest
-
The input for the CheckIfPhoneNumberIsOptedOut
action.
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.ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier Subscribe
action.
If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only
when the AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionRequest
- Input for ConfirmSubscription action.
SubscriptionLimitExceededException
InvalidParameterException
NotFoundException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Verifies an endpoint owner's intent to receive messages by validating the
token sent to the endpoint by an earlier Subscribe
action.
If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only
when the AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionRequest
- Input for ConfirmSubscription action.
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.SubscriptionLimitExceededException
InvalidParameterException
NotFoundException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
CreatePlatformApplication
action. The PlatformPrincipal is
received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not
applicable. For ADM, PlatformPrincipal is "client id". The
PlatformCredential is also received from the notification service. For
WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is
"API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret". For WNS, PlatformCredential is "secret key". For MPNS,
PlatformCredential is "private key". For Baidu, PlatformCredential is
"secret key". The PlatformApplicationArn that is returned when using
CreatePlatformApplication
is then used as an attribute for
the CreatePlatformEndpoint
action. For more information, see
Using Amazon SNS Mobile Push Notifications. For more information
about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
createPlatformApplicationAsync
in interface AmazonSNSAsync
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest createPlatformApplicationRequest, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a platform application object for one of the supported push
notification services, such as APNS and GCM, to which devices and mobile
apps may register. You must specify PlatformPrincipal and
PlatformCredential attributes when using the
CreatePlatformApplication
action. The PlatformPrincipal is
received from the notification service. For APNS/APNS_SANDBOX,
PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not
applicable. For ADM, PlatformPrincipal is "client id". The
PlatformCredential is also received from the notification service. For
WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is
"API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM,
PlatformCredential is "API key". For ADM, PlatformCredential is
"client secret". For WNS, PlatformCredential is "secret key". For MPNS,
PlatformCredential is "private key". For Baidu, PlatformCredential is
"secret key". The PlatformApplicationArn that is returned when using
CreatePlatformApplication
is then used as an attribute for
the CreatePlatformEndpoint
action. For more information, see
Using Amazon SNS Mobile Push Notifications. For more information
about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.
createPlatformApplicationAsync
in interface AmazonSNSAsync
createPlatformApplicationRequest
- Input for CreatePlatformApplication action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws AmazonServiceException, AmazonClientException
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
CreatePlatformEndpoint
requires the PlatformApplicationArn
that is returned from CreatePlatformApplication
. The
EndpointArn that is returned when using
CreatePlatformEndpoint
can then be used by the
Publish
action to send a message to a mobile app or by the
Subscribe
action for subscription to a topic. The
CreatePlatformEndpoint
action is idempotent, so if the
requester already owns an endpoint with the same device token and
attributes, that endpoint's ARN is returned without creating a new
endpoint. For more information, see Using
Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint
with Baidu, two attributes
must be provided: ChannelId and UserId. The token field must also contain
the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
createPlatformEndpointAsync
in interface AmazonSNSAsync
createPlatformEndpointRequest
- Input for CreatePlatformEndpoint action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates an endpoint for a device and mobile app on one of the supported
push notification services, such as GCM and APNS.
CreatePlatformEndpoint
requires the PlatformApplicationArn
that is returned from CreatePlatformApplication
. The
EndpointArn that is returned when using
CreatePlatformEndpoint
can then be used by the
Publish
action to send a message to a mobile app or by the
Subscribe
action for subscription to a topic. The
CreatePlatformEndpoint
action is idempotent, so if the
requester already owns an endpoint with the same device token and
attributes, that endpoint's ARN is returned without creating a new
endpoint. For more information, see Using
Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint
with Baidu, two attributes
must be provided: ChannelId and UserId. The token field must also contain
the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
createPlatformEndpointAsync
in interface AmazonSNSAsync
createPlatformEndpointRequest
- Input for CreatePlatformEndpoint action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest) throws AmazonServiceException, AmazonClientException
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicAsync
in interface AmazonSNSAsync
createTopicRequest
- Input for CreateTopic action.
InvalidParameterException
TopicLimitExceededException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<CreateTopicResult> createTopicAsync(CreateTopicRequest createTopicRequest, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicAsync
in interface AmazonSNSAsync
createTopicRequest
- Input for CreateTopic action.
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.InvalidParameterException
TopicLimitExceededException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest) throws AmazonServiceException, AmazonClientException
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointAsync
in interface AmazonSNSAsync
deleteEndpointRequest
- Input for DeleteEndpoint action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest, AsyncHandler<DeleteEndpointRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointAsync
in interface AmazonSNSAsync
deleteEndpointRequest
- Input for DeleteEndpoint action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationAsync
in interface AmazonSNSAsync
deletePlatformApplicationRequest
- Input for DeletePlatformApplication action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deletePlatformApplicationAsync(DeletePlatformApplicationRequest deletePlatformApplicationRequest, AsyncHandler<DeletePlatformApplicationRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationAsync
in interface AmazonSNSAsync
deletePlatformApplicationRequest
- Input for DeletePlatformApplication action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest) throws AmazonServiceException, AmazonClientException
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopicAsync
in interface AmazonSNSAsync
deleteTopicRequest
- InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> deleteTopicAsync(DeleteTopicRequest deleteTopicRequest, AsyncHandler<DeleteTopicRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopicAsync
in interface AmazonSNSAsync
deleteTopicRequest
- 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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesAsync
in interface AmazonSNSAsync
getEndpointAttributesRequest
- Input for GetEndpointAttributes action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesAsync
in interface AmazonSNSAsync
getEndpointAttributesRequest
- Input for GetEndpointAttributes action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
getPlatformApplicationAttributesRequest
- Input for GetPlatformApplicationAttributes action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
getPlatformApplicationAttributesRequest
- Input for GetPlatformApplicationAttributes action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetSMSAttributesResult> getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributesAsync
in interface AmazonSNSAsync
getSMSAttributesRequest
-
The input for the GetSMSAttributes
request.
ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetSMSAttributesResult> getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest, AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributesAsync
in interface AmazonSNSAsync
getSMSAttributesRequest
-
The input for the GetSMSAttributes
request.
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.ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
getSubscriptionAttributesRequest
- Input for GetSubscriptionAttributes.
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.InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesAsync
in interface AmazonSNSAsync
getTopicAttributesRequest
- Input for GetTopicAttributes action.
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesAsync
in interface AmazonSNSAsync
getTopicAttributesRequest
- Input for GetTopicAttributes action.
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.InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS. The results for
ListEndpointsByPlatformApplication
are paginated and return
a limited list of endpoints, up to 100. If additional records are
available after the first page results, then a NextToken string will be
returned. To receive the next page, you call
ListEndpointsByPlatformApplication
again using the NextToken
string received from the previous call. When there are no more records to
return, NextToken will be null. For more information, see Using
Amazon SNS Mobile Push Notifications.
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the endpoints and endpoint attributes for devices in a supported
push notification service, such as GCM and APNS. The results for
ListEndpointsByPlatformApplication
are paginated and return
a limited list of endpoints, up to 100. If additional records are
available after the first page results, then a NextToken string will be
returned. To receive the next page, you call
ListEndpointsByPlatformApplication
again using the NextToken
string received from the previous call. When there are no more records to
return, NextToken will be null. For more information, see Using
Amazon SNS Mobile Push Notifications.
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
listEndpointsByPlatformApplicationRequest
- Input for ListEndpointsByPlatformApplication action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) throws AmazonServiceException, AmazonClientException
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut
are paginated, and
each page returns up to 100 phone numbers. If additional phone numbers
are available after the first page of results, then a
NextToken
string will be returned. To receive the next page,
you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there
are no more records to return, NextToken
will be null.
listPhoneNumbersOptedOutAsync
in interface AmazonSNSAsync
listPhoneNumbersOptedOutRequest
-
The input for the ListPhoneNumbersOptedOut
action.
ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest, AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut
are paginated, and
each page returns up to 100 phone numbers. If additional phone numbers
are available after the first page of results, then a
NextToken
string will be returned. To receive the next page,
you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there
are no more records to return, NextToken
will be null.
listPhoneNumbersOptedOutAsync
in interface AmazonSNSAsync
listPhoneNumbersOptedOutRequest
-
The input for the ListPhoneNumbersOptedOut
action.
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.ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws AmazonServiceException, AmazonClientException
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. The results for
ListPlatformApplications
are paginated and return a limited
list of applications, up to 100. If additional records are available
after the first page results, then a NextToken string will be returned.
To receive the next page, you call ListPlatformApplications
using the NextToken string received from the previous call. When there
are no more records to return, NextToken will be null. For more
information, see Using
Amazon SNS Mobile Push Notifications.
listPlatformApplicationsAsync
in interface AmazonSNSAsync
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the platform application objects for the supported push
notification services, such as APNS and GCM. The results for
ListPlatformApplications
are paginated and return a limited
list of applications, up to 100. If additional records are available
after the first page results, then a NextToken string will be returned.
To receive the next page, you call ListPlatformApplications
using the NextToken string received from the previous call. When there
are no more records to return, NextToken will be null. For more
information, see Using
Amazon SNS Mobile Push Notifications.
listPlatformApplicationsAsync
in interface AmazonSNSAsync
listPlatformApplicationsRequest
- Input for ListPlatformApplications action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's subscriptions. Each call returns a
limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new ListSubscriptions
call to get further results.
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsRequest
- Input for ListSubscriptions action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's subscriptions. Each call returns a
limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new ListSubscriptions
call to get further results.
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsRequest
- Input for ListSubscriptions action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the subscriptions to a specific topic. Each call
returns a limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptionsByTopic
call to get further results.
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the subscriptions to a specific topic. Each call
returns a limited list of subscriptions, up to 100. If there are more
subscriptions, a NextToken
is also returned. Use the
NextToken
parameter in a new
ListSubscriptionsByTopic
call to get further results.
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicRequest
- Input for ListSubscriptionsByTopic action.
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.InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's topics. Each call returns a limited
list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use the NextToken
parameter in a new ListTopics
call to get further results.
listTopicsAsync
in interface AmazonSNSAsync
listTopicsRequest
- InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest listTopicsRequest, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the requester's topics. Each call returns a limited
list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use the NextToken
parameter in a new ListTopics
call to get further results.
listTopicsAsync
in interface AmazonSNSAsync
listTopicsRequest
- 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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<OptInPhoneNumberResult> optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest) throws AmazonServiceException, AmazonClientException
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberAsync
in interface AmazonSNSAsync
optInPhoneNumberRequest
- Input for the OptInPhoneNumber action.
ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<OptInPhoneNumberResult> optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest, AsyncHandler<OptInPhoneNumberRequest,OptInPhoneNumberResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberAsync
in interface AmazonSNSAsync
optInPhoneNumberRequest
- Input for the OptInPhoneNumber action.
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.ThrottledException
InternalErrorException
InvalidParameterException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest) throws AmazonServiceException, AmazonClientException
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and Amazon
SNS will attempt to deliver it to the topic's subscribers shortly. The
format of the outgoing message to each subscribed endpoint depends on the
notification protocol.
To use the Publish
action for sending a message to a mobile
endpoint, such as an app on a Kindle device or mobile phone, you must
specify the EndpointArn for the TargetArn parameter. The EndpointArn is
returned when making a call with the CreatePlatformEndpoint
action. The second example below shows a request and response for
publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishAsync
in interface AmazonSNSAsync
publishRequest
- Input for Publish action.
InvalidParameterException
InvalidParameterValueException
InternalErrorException
NotFoundException
EndpointDisabledException
PlatformApplicationDisabledException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Sends a message to all of a topic's subscribed endpoints. When a
messageId
is returned, the message has been saved and Amazon
SNS will attempt to deliver it to the topic's subscribers shortly. The
format of the outgoing message to each subscribed endpoint depends on the
notification protocol.
To use the Publish
action for sending a message to a mobile
endpoint, such as an app on a Kindle device or mobile phone, you must
specify the EndpointArn for the TargetArn parameter. The EndpointArn is
returned when making a call with the CreatePlatformEndpoint
action. The second example below shows a request and response for
publishing to a mobile endpoint.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishAsync
in interface AmazonSNSAsync
publishRequest
- Input for Publish action.
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.InvalidParameterException
InvalidParameterValueException
InternalErrorException
NotFoundException
EndpointDisabledException
PlatformApplicationDisabledException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
Removes a statement from a topic's access control policy.
removePermissionAsync
in interface AmazonSNSAsync
removePermissionRequest
- Input for RemovePermission action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest, AsyncHandler<RemovePermissionRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Removes a statement from a topic's access control policy.
removePermissionAsync
in interface AmazonSNSAsync
removePermissionRequest
- Input for RemovePermission action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesAsync
in interface AmazonSNSAsync
setEndpointAttributesRequest
- Input for SetEndpointAttributes action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest, AsyncHandler<SetEndpointAttributesRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesAsync
in interface AmazonSNSAsync
setEndpointAttributesRequest
- Input for SetEndpointAttributes action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
setPlatformApplicationAttributesRequest
- Input for SetPlatformApplicationAttributes action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest, AsyncHandler<SetPlatformApplicationAttributesRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
setPlatformApplicationAttributesRequest
- Input for SetPlatformApplicationAttributes action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<SetSMSAttributesResult> setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest) throws AmazonServiceException, AmazonClientException
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use
the Publish
action with the
MessageAttributes.entry.N
parameter. For more information,
see Sending an SMS Message in the Amazon SNS Developer Guide.
setSMSAttributesAsync
in interface AmazonSNSAsync
setSMSAttributesRequest
- The input for the SetSMSAttributes action.
InvalidParameterException
ThrottledException
InternalErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<SetSMSAttributesResult> setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest, AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use
the Publish
action with the
MessageAttributes.entry.N
parameter. For more information,
see Sending an SMS Message in the Amazon SNS Developer Guide.
setSMSAttributesAsync
in interface AmazonSNSAsync
setSMSAttributesRequest
- The input for the SetSMSAttributes action.
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.InvalidParameterException
ThrottledException
InternalErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest, AsyncHandler<SetSubscriptionAttributesRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.
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.InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesAsync
in interface AmazonSNSAsync
setTopicAttributesRequest
- Input for SetTopicAttributes action.
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest, AsyncHandler<SetTopicAttributesRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesAsync
in interface AmazonSNSAsync
setTopicAttributesRequest
- Input for SetTopicAttributes action.
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.InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest) throws AmazonServiceException, AmazonClientException
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message. To actually create a subscription, the endpoint owner must call
the ConfirmSubscription
action with the token from the
confirmation message. Confirmation tokens are valid for three days.
subscribeAsync
in interface AmazonSNSAsync
subscribeRequest
- Input for Subscribe action.
SubscriptionLimitExceededException
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message. To actually create a subscription, the endpoint owner must call
the ConfirmSubscription
action with the token from the
confirmation message. Confirmation tokens are valid for three days.
subscribeAsync
in interface AmazonSNSAsync
subscribeRequest
- Input for Subscribe action.
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.SubscriptionLimitExceededException
InvalidParameterException
InternalErrorException
NotFoundException
AuthorizationErrorException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest) throws AmazonServiceException, AmazonClientException
Deletes a subscription. If the subscription requires authentication for
deletion, only the owner of the subscription or the topic's owner can
unsubscribe, and an AWS signature is required. If the
Unsubscribe
call does not require authentication and the
requester is not the subscription owner, a final cancellation message is
delivered to the endpoint, so that the endpoint owner can easily
resubscribe to the topic if the Unsubscribe
request was
unintended.
unsubscribeAsync
in interface AmazonSNSAsync
unsubscribeRequest
- Input for Unsubscribe action.
InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.public java.util.concurrent.Future<java.lang.Void> unsubscribeAsync(UnsubscribeRequest unsubscribeRequest, AsyncHandler<UnsubscribeRequest,java.lang.Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a subscription. If the subscription requires authentication for
deletion, only the owner of the subscription or the topic's owner can
unsubscribe, and an AWS signature is required. If the
Unsubscribe
call does not require authentication and the
requester is not the subscription owner, a final cancellation message is
delivered to the endpoint, so that the endpoint owner can easily
resubscribe to the topic if the Unsubscribe
request was
unintended.
unsubscribeAsync
in interface AmazonSNSAsync
unsubscribeRequest
- Input for Unsubscribe action.
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.InvalidParameterException
InternalErrorException
AuthorizationErrorException
NotFoundException
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 Amazon
Simple Notification Service indicating either a problem with
the data in the request, or a server side issue.Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.