public interface AmazonSNSAsync extends AmazonSNS
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
| Modifier and Type | Method and Description |
|---|---|
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 (Firebase Cloud Messaging),
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 (Firebase Cloud Messaging),
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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging).
|
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 (Firebase Cloud Messaging).
|
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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging) and
APNS.
|
java.util.concurrent.Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
Retrieves the attributes of the platform application object for the
supported push notification services, such as APNS and GCM (Firebase
Cloud Messaging).
|
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 (Firebase
Cloud Messaging).
|
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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging).
|
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 (Firebase Cloud Messaging).
|
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<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List all tags added to the specified Amazon SNS topic.
|
java.util.concurrent.Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all tags added to the specified Amazon SNS 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 an Amazon SNS topic, a text message (SMS message)
directly to a phone number, or a message to a mobile platform endpoint
(when you specify the
TargetArn). |
java.util.concurrent.Future<PublishResult> |
publishAsync(PublishRequest publishRequest,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Sends a message to an Amazon SNS topic, a text message (SMS message)
directly to a phone number, or a message to a mobile platform endpoint
(when you specify the
TargetArn). |
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 (Firebase Cloud Messaging) 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 (Firebase Cloud Messaging) 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 (Firebase Cloud
Messaging).
|
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 (Firebase Cloud
Messaging).
|
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 subscription 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 subscription to a
new value.
|
java.util.concurrent.Future<java.lang.Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
java.util.concurrent.Future<java.lang.Void> |
setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
AsyncHandler<SetTopicAttributesRequest,java.lang.Void> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
|
java.util.concurrent.Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest)
Subscribes an endpoint to an Amazon SNS topic.
|
java.util.concurrent.Future<SubscribeResult> |
subscribeAsync(SubscribeRequest subscribeRequest,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Subscribes an endpoint to an Amazon SNS topic.
|
java.util.concurrent.Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Add tags to the specified Amazon SNS topic.
|
java.util.concurrent.Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Add tags to the specified Amazon SNS topic.
|
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.
|
java.util.concurrent.Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Remove tags from the specified Amazon SNS topic.
|
java.util.concurrent.Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Remove tags from the specified Amazon SNS topic.
|
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, listTagsForResource, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, removePermission, removePermission, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, shutdown, subscribe, subscribe, tagResource, unsubscribe, unsubscribe, untagResourcejava.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.
addPermissionRequest - InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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.
checkIfPhoneNumberIsOptedOutRequest -
The input for the CheckIfPhoneNumberIsOptedOut
action.
ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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.
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.ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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".
confirmSubscriptionRequest - Input for ConfirmSubscription action.
SubscriptionLimitExceededExceptionInvalidParameterExceptionNotFoundExceptionInternalErrorExceptionAuthorizationErrorExceptionFilterPolicyLimitExceededExceptionAmazonClientException - If any internal errors 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.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".
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.SubscriptionLimitExceededExceptionInvalidParameterExceptionNotFoundExceptionInternalErrorExceptionAuthorizationErrorExceptionFilterPolicyLimitExceededExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging),
to which devices and mobile apps may register. You must specify
PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are
received from the notification service.
For ADM, PlatformPrincipal is
client id and PlatformCredential is
client secret.
For Baidu, PlatformPrincipal is
API key and PlatformCredential is
secret key.
For APNS and APNS_SANDBOX,
PlatformPrincipal is SSL certificate and
PlatformCredential is private key.
For GCM (Firebase Cloud Messaging), there is no
PlatformPrincipal and the PlatformCredential is
API key.
For MPNS, PlatformPrincipal is
TLS certificate and PlatformCredential is
private key.
For WNS, PlatformPrincipal is
Package Security Identifier and
PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an
attribute for the CreatePlatformEndpoint action.
createPlatformApplicationRequest - Input for CreatePlatformApplication action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging),
to which devices and mobile apps may register. You must specify
PlatformPrincipal and PlatformCredential
attributes when using the CreatePlatformApplication action.
PlatformPrincipal and PlatformCredential are
received from the notification service.
For ADM, PlatformPrincipal is
client id and PlatformCredential is
client secret.
For Baidu, PlatformPrincipal is
API key and PlatformCredential is
secret key.
For APNS and APNS_SANDBOX,
PlatformPrincipal is SSL certificate and
PlatformCredential is private key.
For GCM (Firebase Cloud Messaging), there is no
PlatformPrincipal and the PlatformCredential is
API key.
For MPNS, PlatformPrincipal is
TLS certificate and PlatformCredential is
private key.
For WNS, PlatformPrincipal is
Package Security Identifier and
PlatformCredential is secret key.
You can use the returned PlatformApplicationArn as an
attribute for the CreatePlatformEndpoint action.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and
APNS. CreatePlatformEndpoint requires the
PlatformApplicationArn that is returned from
CreatePlatformApplication. You can use the returned
EndpointArn to send a message to a mobile app or by the
Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the
requester already owns an endpoint with the same device token and
attributes, that endpoint's ARN is returned without creating a new
endpoint. For more information, see Using
Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes
must be provided: ChannelId and UserId. The token field must also contain
the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and
APNS. CreatePlatformEndpoint requires the
PlatformApplicationArn that is returned from
CreatePlatformApplication. You can use the returned
EndpointArn to send a message to a mobile app or by the
Subscribe action for subscription to a topic. The
CreatePlatformEndpoint action is idempotent, so if the
requester already owns an endpoint with the same device token and
attributes, that endpoint's ARN is returned without creating a new
endpoint. For more information, see Using
Amazon SNS Mobile Push Notifications.
When using CreatePlatformEndpoint with Baidu, two attributes
must be provided: ChannelId and UserId. The token field must also contain
the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.
createPlatformEndpointRequest - 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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicRequest - Input for CreateTopic action.
InvalidParameterExceptionTopicLimitExceededExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidSecurityExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicRequest - 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.InvalidParameterExceptionTopicLimitExceededExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidSecurityExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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.
deleteEndpointRequest - Input for DeleteEndpoint action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplicationRequest - Input for DeletePlatformApplication action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
deleteTopicRequest - InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionStaleTagExceptionTagPolicyExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionStaleTagExceptionTagPolicyExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributesRequest - Input for GetEndpointAttributes action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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.
getSMSAttributesRequest -
The input for the GetSMSAttributes request.
ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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.
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.ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.
InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns all of the properties of a subscription.
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.InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
getTopicAttributesRequest - Input for GetTopicAttributes action.
InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) 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.
This action is throttled at 30 transactions per second (TPS).
listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) 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.
This action is throttled at 30 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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.
listPhoneNumbersOptedOutRequest -
The input for the ListPhoneNumbersOptedOut
action.
ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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.
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.ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging).
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.
This action is throttled at 15 transactions per second (TPS).
listPlatformApplicationsRequest - Input for ListPlatformApplications action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging).
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.
This action is throttled at 15 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsRequest - Input for ListSubscriptions action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.
InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, AmazonClientException
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
listTagsForResourceRequest - ResourceNotFoundExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) throws AmazonServiceException, AmazonClientException
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
listTagsForResourceRequest - 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.ResourceNotFoundExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
listTopicsRequest - InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 30 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
optInPhoneNumberRequest - Input for the OptInPhoneNumber action.
ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.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.
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.ThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest) throws AmazonServiceException, AmazonClientException
Sends a message to an Amazon SNS topic, a text message (SMS message)
directly to a phone number, or a message to a mobile platform endpoint
(when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and
Amazon SNS will attempt to deliver it shortly.
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.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same AWS Region.
publishRequest - Input for Publish action.
InvalidParameterExceptionInvalidParameterValueExceptionInternalErrorExceptionNotFoundExceptionEndpointDisabledExceptionPlatformApplicationDisabledExceptionAuthorizationErrorExceptionKMSDisabledExceptionKMSInvalidStateExceptionKMSNotFoundExceptionKMSOptInRequiredExceptionKMSThrottlingExceptionKMSAccessDeniedExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<PublishResult> publishAsync(PublishRequest publishRequest, AsyncHandler<PublishRequest,PublishResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Sends a message to an Amazon SNS topic, a text message (SMS message)
directly to a phone number, or a message to a mobile platform endpoint
(when you specify the TargetArn).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId is returned, the message has been saved and
Amazon SNS will attempt to deliver it shortly.
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.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
You can publish messages only to topics and endpoints in the same AWS Region.
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.InvalidParameterExceptionInvalidParameterValueExceptionInternalErrorExceptionNotFoundExceptionEndpointDisabledExceptionPlatformApplicationDisabledExceptionAuthorizationErrorExceptionKMSDisabledExceptionKMSInvalidStateExceptionKMSNotFoundExceptionKMSOptInRequiredExceptionKMSThrottlingExceptionKMSAccessDeniedExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<java.lang.Void> removePermissionAsync(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
Removes a statement from a topic's access control policy.
removePermissionRequest - Input for RemovePermission action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributesRequest - Input for SetEndpointAttributes action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). 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.
setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 (Firebase Cloud Messaging). 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.
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionAmazonClientException - If any internal errors 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.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 Publishing to a mobile phone in the Amazon SNS Developer
Guide.
To use this operation, you must grant the Amazon SNS service principal (
sns.amazonaws.com) permission to perform the
s3:ListBucket action.
setSMSAttributesRequest - The input for the SetSMSAttributes action.
InvalidParameterExceptionThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 Publishing to a mobile phone in the Amazon SNS Developer
Guide.
To use this operation, you must grant the Amazon SNS service principal (
sns.amazonaws.com) permission to perform the
s3:ListBucket action.
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.InvalidParameterExceptionThrottledExceptionInternalErrorExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<java.lang.Void> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.
InvalidParameterExceptionFilterPolicyLimitExceededExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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 subscription to a new value.
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.InvalidParameterExceptionFilterPolicyLimitExceededExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionAmazonClientException - If any internal errors 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.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.
setTopicAttributesRequest - Input for SetTopicAttributes action.
InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.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.
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.InvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest) throws AmazonServiceException, AmazonClientException
Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
HTTP/S or email, or if the endpoint and the topic are not in the same AWS
account, the endpoint owner must run the ConfirmSubscription
action to confirm the subscription.
You call the ConfirmSubscription action with the token from
the subscription response. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
subscribeRequest - Input for Subscribe action.
SubscriptionLimitExceededExceptionFilterPolicyLimitExceededExceptionInvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<SubscribeResult> subscribeAsync(SubscribeRequest subscribeRequest, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
HTTP/S or email, or if the endpoint and the topic are not in the same AWS
account, the endpoint owner must run the ConfirmSubscription
action to confirm the subscription.
You call the ConfirmSubscription action with the token from
the subscription response. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
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.SubscriptionLimitExceededExceptionFilterPolicyLimitExceededExceptionInvalidParameterExceptionInternalErrorExceptionNotFoundExceptionAuthorizationErrorExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest) throws AmazonServiceException, AmazonClientException
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
tagResourceRequest - ResourceNotFoundExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
tagResourceRequest - 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.ResourceNotFoundExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 100 transactions per second (TPS).
unsubscribeRequest - Input for Unsubscribe action.
InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.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.
This action is throttled at 100 transactions per second (TPS).
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.InvalidParameterExceptionInternalErrorExceptionAuthorizationErrorExceptionNotFoundExceptionInvalidSecurityExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest) throws AmazonServiceException, AmazonClientException
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResourceRequest - ResourceNotFoundExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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.java.util.concurrent.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResourceRequest - 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.ResourceNotFoundExceptionTagLimitExceededExceptionStaleTagExceptionTagPolicyExceptionInvalidParameterExceptionAuthorizationErrorExceptionConcurrentAccessExceptionAmazonClientException - If any internal errors 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 © 2018 Amazon Web Services, Inc. All Rights Reserved.