@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSNSAsyncClient extends AmazonSNSClient implements AmazonSNSAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
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.
configFactory, defaultUnmarshaller, exceptionUnmarshallers
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonSNSAsyncClient()
Deprecated.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSNSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonSNSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest request)
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services
accounts to the specified actions.
|
Future<AddPermissionResult> |
addPermissionAsync(AddPermissionRequest request,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services
accounts to the specified actions.
|
Future<AddPermissionResult> |
addPermissionAsync(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames)
Simplified method form for invoking the AddPermission operation.
|
Future<AddPermissionResult> |
addPermissionAsync(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames,
AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
Simplified method form for invoking the AddPermission operation with an AsyncHandler.
|
static AmazonSNSAsyncClientBuilder |
asyncBuilder() |
Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
Amazon Web Services account.
|
Future<CheckIfPhoneNumberIsOptedOutResult> |
checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request,
AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
Amazon Web Services account.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest request)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(ConfirmSubscriptionRequest request,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token)
Simplified method form for invoking the ConfirmSubscription operation.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Simplified method form for invoking the ConfirmSubscription operation with an AsyncHandler.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
String authenticateOnUnsubscribe)
Simplified method form for invoking the ConfirmSubscription operation.
|
Future<ConfirmSubscriptionResult> |
confirmSubscriptionAsync(String topicArn,
String token,
String authenticateOnUnsubscribe,
AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
Simplified method form for invoking the ConfirmSubscription operation with an AsyncHandler.
|
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest request)
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.
|
Future<CreatePlatformApplicationResult> |
createPlatformApplicationAsync(CreatePlatformApplicationRequest request,
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.
|
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest request)
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.
|
Future<CreatePlatformEndpointResult> |
createPlatformEndpointAsync(CreatePlatformEndpointRequest request,
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.
|
Future<CreateSMSSandboxPhoneNumberResult> |
createSMSSandboxPhoneNumberAsync(CreateSMSSandboxPhoneNumberRequest request)
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time
password (OTP) to that phone number.
|
Future<CreateSMSSandboxPhoneNumberResult> |
createSMSSandboxPhoneNumberAsync(CreateSMSSandboxPhoneNumberRequest request,
AsyncHandler<CreateSMSSandboxPhoneNumberRequest,CreateSMSSandboxPhoneNumberResult> asyncHandler)
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time
password (OTP) to that phone number.
|
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest request)
Creates a topic to which notifications can be published.
|
Future<CreateTopicResult> |
createTopicAsync(CreateTopicRequest request,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Creates a topic to which notifications can be published.
|
Future<CreateTopicResult> |
createTopicAsync(String name)
Simplified method form for invoking the CreateTopic operation.
|
Future<CreateTopicResult> |
createTopicAsync(String name,
AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
Simplified method form for invoking the CreateTopic operation with an AsyncHandler.
|
Future<DeleteEndpointResult> |
deleteEndpointAsync(DeleteEndpointRequest request)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
Future<DeleteEndpointResult> |
deleteEndpointAsync(DeleteEndpointRequest request,
AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
Future<DeletePlatformApplicationResult> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest request)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
Future<DeletePlatformApplicationResult> |
deletePlatformApplicationAsync(DeletePlatformApplicationRequest request,
AsyncHandler<DeletePlatformApplicationRequest,DeletePlatformApplicationResult> asyncHandler)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
Future<DeleteSMSSandboxPhoneNumberResult> |
deleteSMSSandboxPhoneNumberAsync(DeleteSMSSandboxPhoneNumberRequest request)
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
|
Future<DeleteSMSSandboxPhoneNumberResult> |
deleteSMSSandboxPhoneNumberAsync(DeleteSMSSandboxPhoneNumberRequest request,
AsyncHandler<DeleteSMSSandboxPhoneNumberRequest,DeleteSMSSandboxPhoneNumberResult> asyncHandler)
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
|
Future<DeleteTopicResult> |
deleteTopicAsync(DeleteTopicRequest request)
Deletes a topic and all its subscriptions.
|
Future<DeleteTopicResult> |
deleteTopicAsync(DeleteTopicRequest request,
AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Deletes a topic and all its subscriptions.
|
Future<DeleteTopicResult> |
deleteTopicAsync(String topicArn)
Simplified method form for invoking the DeleteTopic operation.
|
Future<DeleteTopicResult> |
deleteTopicAsync(String topicArn,
AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
Simplified method form for invoking the DeleteTopic operation with an AsyncHandler.
|
Future<GetDataProtectionPolicyResult> |
getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request)
Retrieves the specified inline
DataProtectionPolicy document that is stored in the specified Amazon
SNS topic. |
Future<GetDataProtectionPolicyResult> |
getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request,
AsyncHandler<GetDataProtectionPolicyRequest,GetDataProtectionPolicyResult> asyncHandler)
Retrieves the specified inline
DataProtectionPolicy document that is stored in the specified Amazon
SNS topic. |
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest request)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM
(Firebase Cloud Messaging) and APNS.
|
Future<GetEndpointAttributesResult> |
getEndpointAttributesAsync(GetEndpointAttributesRequest request,
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.
|
ExecutorService |
getExecutorService()
Returns the executor service used by this client to execute async requests.
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest request)
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and GCM (Firebase Cloud Messaging).
|
Future<GetPlatformApplicationAttributesResult> |
getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest request,
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).
|
Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest request)
Returns the settings for sending SMS messages from your Amazon Web Services account.
|
Future<GetSMSAttributesResult> |
getSMSAttributesAsync(GetSMSAttributesRequest request,
AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler)
Returns the settings for sending SMS messages from your Amazon Web Services account.
|
Future<GetSMSSandboxAccountStatusResult> |
getSMSSandboxAccountStatusAsync(GetSMSSandboxAccountStatusRequest request)
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services
Region.
|
Future<GetSMSSandboxAccountStatusResult> |
getSMSSandboxAccountStatusAsync(GetSMSSandboxAccountStatusRequest request,
AsyncHandler<GetSMSSandboxAccountStatusRequest,GetSMSSandboxAccountStatusResult> asyncHandler)
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services
Region.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest request)
Returns all of the properties of a subscription.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest request,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Returns all of the properties of a subscription.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(String subscriptionArn)
Simplified method form for invoking the GetSubscriptionAttributes operation.
|
Future<GetSubscriptionAttributesResult> |
getSubscriptionAttributesAsync(String subscriptionArn,
AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
Simplified method form for invoking the GetSubscriptionAttributes operation with an AsyncHandler.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest request)
Returns all of the properties of a topic.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(GetTopicAttributesRequest request,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Returns all of the properties of a topic.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(String topicArn)
Simplified method form for invoking the GetTopicAttributes operation.
|
Future<GetTopicAttributesResult> |
getTopicAttributesAsync(String topicArn,
AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
Simplified method form for invoking the GetTopicAttributes operation with an AsyncHandler.
|
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest request)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM
(Firebase Cloud Messaging) and APNS.
|
Future<ListEndpointsByPlatformApplicationResult> |
listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest request,
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.
|
Future<ListOriginationNumbersResult> |
listOriginationNumbersAsync(ListOriginationNumbersRequest request)
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
|
Future<ListOriginationNumbersResult> |
listOriginationNumbersAsync(ListOriginationNumbersRequest request,
AsyncHandler<ListOriginationNumbersRequest,ListOriginationNumbersResult> asyncHandler)
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata.
|
Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest request)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
Future<ListPhoneNumbersOptedOutResult> |
listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest request,
AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync()
Simplified method form for invoking the ListPlatformApplications operation.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Simplified method form for invoking the ListPlatformApplications operation with an AsyncHandler.
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest request)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
Future<ListPlatformApplicationsResult> |
listPlatformApplicationsAsync(ListPlatformApplicationsRequest request,
AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
Future<ListSMSSandboxPhoneNumbersResult> |
listSMSSandboxPhoneNumbersAsync(ListSMSSandboxPhoneNumbersRequest request)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
Future<ListSMSSandboxPhoneNumbersResult> |
listSMSSandboxPhoneNumbersAsync(ListSMSSandboxPhoneNumbersRequest request,
AsyncHandler<ListSMSSandboxPhoneNumbersRequest,ListSMSSandboxPhoneNumbersResult> asyncHandler)
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS
sandbox.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync()
Simplified method form for invoking the ListSubscriptions operation.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Simplified method form for invoking the ListSubscriptions operation with an AsyncHandler.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest request)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(ListSubscriptionsRequest request,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Returns a list of the requester's subscriptions.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(String nextToken)
Simplified method form for invoking the ListSubscriptions operation.
|
Future<ListSubscriptionsResult> |
listSubscriptionsAsync(String nextToken,
AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
Simplified method form for invoking the ListSubscriptions operation with an AsyncHandler.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest request)
Returns a list of the subscriptions to a specific topic.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest request,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Returns a list of the subscriptions to a specific topic.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn)
Simplified method form for invoking the ListSubscriptionsByTopic operation.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Simplified method form for invoking the ListSubscriptionsByTopic operation with an AsyncHandler.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
String nextToken)
Simplified method form for invoking the ListSubscriptionsByTopic operation.
|
Future<ListSubscriptionsByTopicResult> |
listSubscriptionsByTopicAsync(String topicArn,
String nextToken,
AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
Simplified method form for invoking the ListSubscriptionsByTopic operation with an AsyncHandler.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request)
List all tags added to the specified Amazon SNS topic.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest request,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all tags added to the specified Amazon SNS topic.
|
Future<ListTopicsResult> |
listTopicsAsync()
Simplified method form for invoking the ListTopics operation.
|
Future<ListTopicsResult> |
listTopicsAsync(AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Simplified method form for invoking the ListTopics operation with an AsyncHandler.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest request)
Returns a list of the requester's topics.
|
Future<ListTopicsResult> |
listTopicsAsync(ListTopicsRequest request,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Returns a list of the requester's topics.
|
Future<ListTopicsResult> |
listTopicsAsync(String nextToken)
Simplified method form for invoking the ListTopics operation.
|
Future<ListTopicsResult> |
listTopicsAsync(String nextToken,
AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
Simplified method form for invoking the ListTopics operation with an AsyncHandler.
|
Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(OptInPhoneNumberRequest request)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
the number.
|
Future<OptInPhoneNumberResult> |
optInPhoneNumberAsync(OptInPhoneNumberRequest request,
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.
|
Future<PublishResult> |
publishAsync(PublishRequest request)
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 ). |
Future<PublishResult> |
publishAsync(PublishRequest request,
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 ). |
Future<PublishResult> |
publishAsync(String topicArn,
String message)
Simplified method form for invoking the Publish operation.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Simplified method form for invoking the Publish operation with an AsyncHandler.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
String subject)
Simplified method form for invoking the Publish operation.
|
Future<PublishResult> |
publishAsync(String topicArn,
String message,
String subject,
AsyncHandler<PublishRequest,PublishResult> asyncHandler)
Simplified method form for invoking the Publish operation with an AsyncHandler.
|
Future<PublishBatchResult> |
publishBatchAsync(PublishBatchRequest request)
Publishes up to ten messages to the specified topic.
|
Future<PublishBatchResult> |
publishBatchAsync(PublishBatchRequest request,
AsyncHandler<PublishBatchRequest,PublishBatchResult> asyncHandler)
Publishes up to ten messages to the specified topic.
|
Future<PutDataProtectionPolicyResult> |
putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request)
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
|
Future<PutDataProtectionPolicyResult> |
putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request,
AsyncHandler<PutDataProtectionPolicyRequest,PutDataProtectionPolicyResult> asyncHandler)
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request)
Removes a statement from a topic's access control policy.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Removes a statement from a topic's access control policy.
|
Future<RemovePermissionResult> |
removePermissionAsync(String topicArn,
String label)
Simplified method form for invoking the RemovePermission operation.
|
Future<RemovePermissionResult> |
removePermissionAsync(String topicArn,
String label,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Simplified method form for invoking the RemovePermission operation with an AsyncHandler.
|
Future<SetEndpointAttributesResult> |
setEndpointAttributesAsync(SetEndpointAttributesRequest request)
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.
|
Future<SetEndpointAttributesResult> |
setEndpointAttributesAsync(SetEndpointAttributesRequest request,
AsyncHandler<SetEndpointAttributesRequest,SetEndpointAttributesResult> 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.
|
Future<SetPlatformApplicationAttributesResult> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest request)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and GCM (Firebase Cloud Messaging).
|
Future<SetPlatformApplicationAttributesResult> |
setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest request,
AsyncHandler<SetPlatformApplicationAttributesRequest,SetPlatformApplicationAttributesResult> asyncHandler)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and GCM (Firebase Cloud Messaging).
|
Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest request)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
Future<SetSMSAttributesResult> |
setSMSAttributesAsync(SetSMSAttributesRequest request,
AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest request)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest request,
AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(String subscriptionArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetSubscriptionAttributes operation.
|
Future<SetSubscriptionAttributesResult> |
setSubscriptionAttributesAsync(String subscriptionArn,
String attributeName,
String attributeValue,
AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
Simplified method form for invoking the SetSubscriptionAttributes operation with an AsyncHandler.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(SetTopicAttributesRequest request)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(SetTopicAttributesRequest request,
AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Allows a topic owner to set an attribute of the topic to a new value.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(String topicArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetTopicAttributes operation.
|
Future<SetTopicAttributesResult> |
setTopicAttributesAsync(String topicArn,
String attributeName,
String attributeValue,
AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
Simplified method form for invoking the SetTopicAttributes operation with an AsyncHandler.
|
void |
shutdown()
Shuts down the client, releasing all managed resources.
|
Future<SubscribeResult> |
subscribeAsync(String topicArn,
String protocol,
String endpoint)
Simplified method form for invoking the Subscribe operation.
|
Future<SubscribeResult> |
subscribeAsync(String topicArn,
String protocol,
String endpoint,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Simplified method form for invoking the Subscribe operation with an AsyncHandler.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest request)
Subscribes an endpoint to an Amazon SNS topic.
|
Future<SubscribeResult> |
subscribeAsync(SubscribeRequest request,
AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
Subscribes an endpoint to an Amazon SNS topic.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request)
Add tags to the specified Amazon SNS topic.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest request,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Add tags to the specified Amazon SNS topic.
|
Future<UnsubscribeResult> |
unsubscribeAsync(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.
|
Future<UnsubscribeResult> |
unsubscribeAsync(String subscriptionArn,
AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
Simplified method form for invoking the Unsubscribe operation with an AsyncHandler.
|
Future<UnsubscribeResult> |
unsubscribeAsync(UnsubscribeRequest request)
Deletes a subscription.
|
Future<UnsubscribeResult> |
unsubscribeAsync(UnsubscribeRequest request,
AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
Deletes a subscription.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request)
Remove tags from the specified Amazon SNS topic.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest request,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Remove tags from the specified Amazon SNS topic.
|
Future<VerifySMSSandboxPhoneNumberResult> |
verifySMSSandboxPhoneNumberAsync(VerifySMSSandboxPhoneNumberRequest request)
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
|
Future<VerifySMSSandboxPhoneNumberResult> |
verifySMSSandboxPhoneNumberAsync(VerifySMSSandboxPhoneNumberRequest request,
AsyncHandler<VerifySMSSandboxPhoneNumberRequest,VerifySMSSandboxPhoneNumberResult> asyncHandler)
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
|
addPermission, addPermission, builder, checkIfPhoneNumberIsOptedOut, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createSMSSandboxPhoneNumber, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteSMSSandboxPhoneNumber, deleteTopic, deleteTopic, getCachedResponseMetadata, getDataProtectionPolicy, getEndpointAttributes, getPlatformApplicationAttributes, getSMSAttributes, getSMSSandboxAccountStatus, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listOriginationNumbers, listPhoneNumbersOptedOut, listPlatformApplications, listPlatformApplications, listSMSSandboxPhoneNumbers, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTagsForResource, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, publishBatch, putDataProtectionPolicy, removePermission, removePermission, setEndpointAttributes, setPlatformApplicationAttributes, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, subscribe, subscribe, tagResource, unsubscribe, unsubscribe, untagResource, verifySMSSandboxPhoneNumber
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addPermission, addPermission, checkIfPhoneNumberIsOptedOut, confirmSubscription, confirmSubscription, confirmSubscription, createPlatformApplication, createPlatformEndpoint, createSMSSandboxPhoneNumber, createTopic, createTopic, deleteEndpoint, deletePlatformApplication, deleteSMSSandboxPhoneNumber, deleteTopic, deleteTopic, getCachedResponseMetadata, getDataProtectionPolicy, getEndpointAttributes, getPlatformApplicationAttributes, getSMSAttributes, getSMSSandboxAccountStatus, getSubscriptionAttributes, getSubscriptionAttributes, getTopicAttributes, getTopicAttributes, listEndpointsByPlatformApplication, listOriginationNumbers, listPhoneNumbersOptedOut, listPlatformApplications, listPlatformApplications, listSMSSandboxPhoneNumbers, listSubscriptions, listSubscriptions, listSubscriptions, listSubscriptionsByTopic, listSubscriptionsByTopic, listSubscriptionsByTopic, listTagsForResource, listTopics, listTopics, listTopics, optInPhoneNumber, publish, publish, publish, publishBatch, putDataProtectionPolicy, removePermission, removePermission, setEndpoint, setEndpointAttributes, setPlatformApplicationAttributes, setRegion, setSMSAttributes, setSubscriptionAttributes, setSubscriptionAttributes, setTopicAttributes, setTopicAttributes, subscribe, subscribe, tagResource, unsubscribe, unsubscribe, untagResource, verifySMSSandboxPhoneNumber
@Deprecated public AmazonSNSAsyncClient()
AmazonSNSAsyncClientBuilder.defaultClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonSNSAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonSNSAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonSNSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSNSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)
@Deprecated public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections()
.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain
,
Executors.newFixedThreadPool(int)
@Deprecated public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonSNSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.public static AmazonSNSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest request)
AmazonSNSAsync
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
addPermissionAsync
in interface AmazonSNSAsync
public Future<AddPermissionResult> addPermissionAsync(AddPermissionRequest request, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
AmazonSNSAsync
Adds a statement to a topic's access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
addPermissionAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AddPermissionResult> addPermissionAsync(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
addPermissionAsync
in interface AmazonSNSAsync
addPermissionAsync(AddPermissionRequest)
public Future<AddPermissionResult> addPermissionAsync(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames, AsyncHandler<AddPermissionRequest,AddPermissionResult> asyncHandler)
addPermissionAsync
in interface AmazonSNSAsync
addPermissionAsync(AddPermissionRequest, com.amazonaws.handlers.AsyncHandler)
public Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request)
AmazonSNSAsync
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber
action.
checkIfPhoneNumberIsOptedOutAsync
in interface AmazonSNSAsync
request
- The input for the CheckIfPhoneNumberIsOptedOut
action.public Future<CheckIfPhoneNumberIsOptedOutResult> checkIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest request, AsyncHandler<CheckIfPhoneNumberIsOptedOutRequest,CheckIfPhoneNumberIsOptedOutResult> asyncHandler)
AmazonSNSAsync
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber
action.
checkIfPhoneNumberIsOptedOutAsync
in interface AmazonSNSAsync
request
- The input for the CheckIfPhoneNumberIsOptedOut
action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest request)
AmazonSNSAsync
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier Subscribe
action. If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only when the
AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscriptionAsync
in interface AmazonSNSAsync
request
- Input for ConfirmSubscription action.public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(ConfirmSubscriptionRequest request, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
AmazonSNSAsync
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier Subscribe
action. If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only when the
AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscriptionAsync
in interface AmazonSNSAsync
request
- Input for ConfirmSubscription action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe)
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionAsync(ConfirmSubscriptionRequest)
public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionAsync(ConfirmSubscriptionRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token)
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionAsync(ConfirmSubscriptionRequest)
public Future<ConfirmSubscriptionResult> confirmSubscriptionAsync(String topicArn, String token, AsyncHandler<ConfirmSubscriptionRequest,ConfirmSubscriptionResult> asyncHandler)
confirmSubscriptionAsync
in interface AmazonSNSAsync
confirmSubscriptionAsync(ConfirmSubscriptionRequest, com.amazonaws.handlers.AsyncHandler)
public Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest request)
AmazonSNSAsync
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
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is
signing key ID
and PlatformCredential
is signing 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.
createPlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for CreatePlatformApplication action.public Future<CreatePlatformApplicationResult> createPlatformApplicationAsync(CreatePlatformApplicationRequest request, AsyncHandler<CreatePlatformApplicationRequest,CreatePlatformApplicationResult> asyncHandler)
AmazonSNSAsync
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
using certificate credentials, PlatformPrincipal
is SSL certificate
and PlatformCredential
is private key
.
For APNS
and APNS_SANDBOX
using token credentials, PlatformPrincipal
is
signing key ID
and PlatformCredential
is signing 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.
createPlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for CreatePlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest request)
AmazonSNSAsync
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.
createPlatformEndpointAsync
in interface AmazonSNSAsync
request
- Input for CreatePlatformEndpoint action.public Future<CreatePlatformEndpointResult> createPlatformEndpointAsync(CreatePlatformEndpointRequest request, AsyncHandler<CreatePlatformEndpointRequest,CreatePlatformEndpointResult> asyncHandler)
AmazonSNSAsync
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.
createPlatformEndpointAsync
in interface AmazonSNSAsync
request
- Input for CreatePlatformEndpoint action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateSMSSandboxPhoneNumberResult> createSMSSandboxPhoneNumberAsync(CreateSMSSandboxPhoneNumberRequest request)
AmazonSNSAsync
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
createSMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
public Future<CreateSMSSandboxPhoneNumberResult> createSMSSandboxPhoneNumberAsync(CreateSMSSandboxPhoneNumberRequest request, AsyncHandler<CreateSMSSandboxPhoneNumberRequest,CreateSMSSandboxPhoneNumberResult> asyncHandler)
AmazonSNSAsync
Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
createSMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest request)
AmazonSNSAsync
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 Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicAsync
in interface AmazonSNSAsync
request
- Input for CreateTopic action.public Future<CreateTopicResult> createTopicAsync(CreateTopicRequest request, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
AmazonSNSAsync
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 Creating an Amazon SNS topic in the Amazon SNS Developer Guide. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopicAsync
in interface AmazonSNSAsync
request
- Input for CreateTopic action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTopicResult> createTopicAsync(String name)
createTopicAsync
in interface AmazonSNSAsync
createTopicAsync(CreateTopicRequest)
public Future<CreateTopicResult> createTopicAsync(String name, AsyncHandler<CreateTopicRequest,CreateTopicResult> asyncHandler)
createTopicAsync
in interface AmazonSNSAsync
createTopicAsync(CreateTopicRequest, com.amazonaws.handlers.AsyncHandler)
public Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest request)
AmazonSNSAsync
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointAsync
in interface AmazonSNSAsync
request
- Input for DeleteEndpoint action.public Future<DeleteEndpointResult> deleteEndpointAsync(DeleteEndpointRequest request, AsyncHandler<DeleteEndpointRequest,DeleteEndpointResult> asyncHandler)
AmazonSNSAsync
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointAsync
in interface AmazonSNSAsync
request
- Input for DeleteEndpoint action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePlatformApplicationResult> deletePlatformApplicationAsync(DeletePlatformApplicationRequest request)
AmazonSNSAsync
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.
deletePlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for DeletePlatformApplication action.public Future<DeletePlatformApplicationResult> deletePlatformApplicationAsync(DeletePlatformApplicationRequest request, AsyncHandler<DeletePlatformApplicationRequest,DeletePlatformApplicationResult> asyncHandler)
AmazonSNSAsync
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.
deletePlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for DeletePlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteSMSSandboxPhoneNumberResult> deleteSMSSandboxPhoneNumberAsync(DeleteSMSSandboxPhoneNumberRequest request)
AmazonSNSAsync
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
deleteSMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
public Future<DeleteSMSSandboxPhoneNumberResult> deleteSMSSandboxPhoneNumberAsync(DeleteSMSSandboxPhoneNumberRequest request, AsyncHandler<DeleteSMSSandboxPhoneNumberRequest,DeleteSMSSandboxPhoneNumberResult> asyncHandler)
AmazonSNSAsync
Deletes an Amazon Web Services account's verified or pending phone number from the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
deleteSMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest request)
AmazonSNSAsync
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopicAsync
in interface AmazonSNSAsync
public Future<DeleteTopicResult> deleteTopicAsync(DeleteTopicRequest request, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
AmazonSNSAsync
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopicAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTopicResult> deleteTopicAsync(String topicArn)
deleteTopicAsync
in interface AmazonSNSAsync
deleteTopicAsync(DeleteTopicRequest)
public Future<DeleteTopicResult> deleteTopicAsync(String topicArn, AsyncHandler<DeleteTopicRequest,DeleteTopicResult> asyncHandler)
deleteTopicAsync
in interface AmazonSNSAsync
deleteTopicAsync(DeleteTopicRequest, com.amazonaws.handlers.AsyncHandler)
public Future<GetDataProtectionPolicyResult> getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request)
AmazonSNSAsync
Retrieves the specified inline DataProtectionPolicy
document that is stored in the specified Amazon
SNS topic.
getDataProtectionPolicyAsync
in interface AmazonSNSAsync
public Future<GetDataProtectionPolicyResult> getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest request, AsyncHandler<GetDataProtectionPolicyRequest,GetDataProtectionPolicyResult> asyncHandler)
AmazonSNSAsync
Retrieves the specified inline DataProtectionPolicy
document that is stored in the specified Amazon
SNS topic.
getDataProtectionPolicyAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest request)
AmazonSNSAsync
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.
getEndpointAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetEndpointAttributes action.public Future<GetEndpointAttributesResult> getEndpointAttributesAsync(GetEndpointAttributesRequest request, AsyncHandler<GetEndpointAttributesRequest,GetEndpointAttributesResult> asyncHandler)
AmazonSNSAsync
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.
getEndpointAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetEndpointAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest request)
AmazonSNSAsync
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.
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetPlatformApplicationAttributes action.public Future<GetPlatformApplicationAttributesResult> getPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest request, AsyncHandler<GetPlatformApplicationAttributesRequest,GetPlatformApplicationAttributesResult> asyncHandler)
AmazonSNSAsync
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.
getPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetPlatformApplicationAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSMSAttributesResult> getSMSAttributesAsync(GetSMSAttributesRequest request)
AmazonSNSAsync
Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributesAsync
in interface AmazonSNSAsync
request
- The input for the GetSMSAttributes
request.public Future<GetSMSAttributesResult> getSMSAttributesAsync(GetSMSAttributesRequest request, AsyncHandler<GetSMSAttributesRequest,GetSMSAttributesResult> asyncHandler)
AmazonSNSAsync
Returns the settings for sending SMS messages from your Amazon Web Services account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributesAsync
in interface AmazonSNSAsync
request
- The input for the GetSMSAttributes
request.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSMSSandboxAccountStatusResult> getSMSSandboxAccountStatusAsync(GetSMSSandboxAccountStatusRequest request)
AmazonSNSAsync
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
getSMSSandboxAccountStatusAsync
in interface AmazonSNSAsync
public Future<GetSMSSandboxAccountStatusResult> getSMSSandboxAccountStatusAsync(GetSMSSandboxAccountStatusRequest request, AsyncHandler<GetSMSSandboxAccountStatusRequest,GetSMSSandboxAccountStatusResult> asyncHandler)
AmazonSNSAsync
Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
getSMSSandboxAccountStatusAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest request)
AmazonSNSAsync
Returns all of the properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetSubscriptionAttributes.public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest request, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
AmazonSNSAsync
Returns all of the properties of a subscription.
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetSubscriptionAttributes.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(String subscriptionArn)
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest)
public Future<GetSubscriptionAttributesResult> getSubscriptionAttributesAsync(String subscriptionArn, AsyncHandler<GetSubscriptionAttributesRequest,GetSubscriptionAttributesResult> asyncHandler)
getSubscriptionAttributesAsync
in interface AmazonSNSAsync
getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest request)
AmazonSNSAsync
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetTopicAttributes action.public Future<GetTopicAttributesResult> getTopicAttributesAsync(GetTopicAttributesRequest request, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
AmazonSNSAsync
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesAsync
in interface AmazonSNSAsync
request
- Input for GetTopicAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetTopicAttributesResult> getTopicAttributesAsync(String topicArn)
getTopicAttributesAsync
in interface AmazonSNSAsync
getTopicAttributesAsync(GetTopicAttributesRequest)
public Future<GetTopicAttributesResult> getTopicAttributesAsync(String topicArn, AsyncHandler<GetTopicAttributesRequest,GetTopicAttributesResult> asyncHandler)
getTopicAttributesAsync
in interface AmazonSNSAsync
getTopicAttributesAsync(GetTopicAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest request)
AmazonSNSAsync
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).
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for ListEndpointsByPlatformApplication action.public Future<ListEndpointsByPlatformApplicationResult> listEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest request, AsyncHandler<ListEndpointsByPlatformApplicationRequest,ListEndpointsByPlatformApplicationResult> asyncHandler)
AmazonSNSAsync
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).
listEndpointsByPlatformApplicationAsync
in interface AmazonSNSAsync
request
- Input for ListEndpointsByPlatformApplication action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListOriginationNumbersResult> listOriginationNumbersAsync(ListOriginationNumbersRequest request)
AmazonSNSAsync
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
listOriginationNumbersAsync
in interface AmazonSNSAsync
public Future<ListOriginationNumbersResult> listOriginationNumbersAsync(ListOriginationNumbersRequest request, AsyncHandler<ListOriginationNumbersRequest,ListOriginationNumbersResult> asyncHandler)
AmazonSNSAsync
Lists the calling Amazon Web Services account's dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.
listOriginationNumbersAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest request)
AmazonSNSAsync
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
listPhoneNumbersOptedOutAsync
in interface AmazonSNSAsync
request
- The input for the ListPhoneNumbersOptedOut
action.public Future<ListPhoneNumbersOptedOutResult> listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest request, AsyncHandler<ListPhoneNumbersOptedOutRequest,ListPhoneNumbersOptedOutResult> asyncHandler)
AmazonSNSAsync
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
listPhoneNumbersOptedOutAsync
in interface AmazonSNSAsync
request
- The input for the ListPhoneNumbersOptedOut
action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest request)
AmazonSNSAsync
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).
listPlatformApplicationsAsync
in interface AmazonSNSAsync
request
- Input for ListPlatformApplications action.public Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(ListPlatformApplicationsRequest request, AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
AmazonSNSAsync
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).
listPlatformApplicationsAsync
in interface AmazonSNSAsync
request
- Input for ListPlatformApplications action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync()
listPlatformApplicationsAsync
in interface AmazonSNSAsync
listPlatformApplicationsAsync(ListPlatformApplicationsRequest)
public Future<ListPlatformApplicationsResult> listPlatformApplicationsAsync(AsyncHandler<ListPlatformApplicationsRequest,ListPlatformApplicationsResult> asyncHandler)
listPlatformApplicationsAsync
in interface AmazonSNSAsync
listPlatformApplicationsAsync(ListPlatformApplicationsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListSMSSandboxPhoneNumbersResult> listSMSSandboxPhoneNumbersAsync(ListSMSSandboxPhoneNumbersRequest request)
AmazonSNSAsync
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
listSMSSandboxPhoneNumbersAsync
in interface AmazonSNSAsync
public Future<ListSMSSandboxPhoneNumbersResult> listSMSSandboxPhoneNumbersAsync(ListSMSSandboxPhoneNumbersRequest request, AsyncHandler<ListSMSSandboxPhoneNumbersRequest,ListSMSSandboxPhoneNumbersResult> asyncHandler)
AmazonSNSAsync
Lists the calling Amazon Web Services account's current verified and pending destination phone numbers in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
listSMSSandboxPhoneNumbersAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest request)
AmazonSNSAsync
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).
listSubscriptionsAsync
in interface AmazonSNSAsync
request
- Input for ListSubscriptions action.public Future<ListSubscriptionsResult> listSubscriptionsAsync(ListSubscriptionsRequest request, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
AmazonSNSAsync
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).
listSubscriptionsAsync
in interface AmazonSNSAsync
request
- Input for ListSubscriptions action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSubscriptionsResult> listSubscriptionsAsync()
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsAsync(ListSubscriptionsRequest)
public Future<ListSubscriptionsResult> listSubscriptionsAsync(AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsAsync(ListSubscriptionsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListSubscriptionsResult> listSubscriptionsAsync(String nextToken)
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsAsync(ListSubscriptionsRequest)
public Future<ListSubscriptionsResult> listSubscriptionsAsync(String nextToken, AsyncHandler<ListSubscriptionsRequest,ListSubscriptionsResult> asyncHandler)
listSubscriptionsAsync
in interface AmazonSNSAsync
listSubscriptionsAsync(ListSubscriptionsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest request)
AmazonSNSAsync
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).
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
request
- Input for ListSubscriptionsByTopic action.public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest request, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
AmazonSNSAsync
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).
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
request
- Input for ListSubscriptionsByTopic action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn)
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest)
public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, String nextToken)
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest)
public Future<ListSubscriptionsByTopicResult> listSubscriptionsByTopicAsync(String topicArn, String nextToken, AsyncHandler<ListSubscriptionsByTopicRequest,ListSubscriptionsByTopicResult> asyncHandler)
listSubscriptionsByTopicAsync
in interface AmazonSNSAsync
listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonSNSAsync
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.
listTagsForResourceAsync
in interface AmazonSNSAsync
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonSNSAsync
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.
listTagsForResourceAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest request)
AmazonSNSAsync
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).
listTopicsAsync
in interface AmazonSNSAsync
public Future<ListTopicsResult> listTopicsAsync(ListTopicsRequest request, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
AmazonSNSAsync
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).
listTopicsAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTopicsResult> listTopicsAsync()
listTopicsAsync
in interface AmazonSNSAsync
listTopicsAsync(ListTopicsRequest)
public Future<ListTopicsResult> listTopicsAsync(AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
listTopicsAsync
in interface AmazonSNSAsync
listTopicsAsync(ListTopicsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<ListTopicsResult> listTopicsAsync(String nextToken)
listTopicsAsync
in interface AmazonSNSAsync
listTopicsAsync(ListTopicsRequest)
public Future<ListTopicsResult> listTopicsAsync(String nextToken, AsyncHandler<ListTopicsRequest,ListTopicsResult> asyncHandler)
listTopicsAsync
in interface AmazonSNSAsync
listTopicsAsync(ListTopicsRequest, com.amazonaws.handlers.AsyncHandler)
public Future<OptInPhoneNumberResult> optInPhoneNumberAsync(OptInPhoneNumberRequest request)
AmazonSNSAsync
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberAsync
in interface AmazonSNSAsync
request
- Input for the OptInPhoneNumber action.public Future<OptInPhoneNumberResult> optInPhoneNumberAsync(OptInPhoneNumberRequest request, AsyncHandler<OptInPhoneNumberRequest,OptInPhoneNumberResult> asyncHandler)
AmazonSNSAsync
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberAsync
in interface AmazonSNSAsync
request
- Input for the OptInPhoneNumber action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PublishResult> publishAsync(PublishRequest request)
AmazonSNSAsync
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 is saved and Amazon SNS immediately delivers it to
subscribers.
To use the Publish
action for publishing 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 Amazon Web Services Region.
publishAsync
in interface AmazonSNSAsync
request
- Input for Publish action.public Future<PublishResult> publishAsync(PublishRequest request, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
AmazonSNSAsync
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 is saved and Amazon SNS immediately delivers it to
subscribers.
To use the Publish
action for publishing 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 Amazon Web Services Region.
publishAsync
in interface AmazonSNSAsync
request
- Input for Publish action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PublishResult> publishAsync(String topicArn, String message)
publishAsync
in interface AmazonSNSAsync
publishAsync(PublishRequest)
public Future<PublishResult> publishAsync(String topicArn, String message, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
publishAsync
in interface AmazonSNSAsync
publishAsync(PublishRequest, com.amazonaws.handlers.AsyncHandler)
public Future<PublishResult> publishAsync(String topicArn, String message, String subject)
publishAsync
in interface AmazonSNSAsync
publishAsync(PublishRequest)
public Future<PublishResult> publishAsync(String topicArn, String message, String subject, AsyncHandler<PublishRequest,PublishResult> asyncHandler)
publishAsync
in interface AmazonSNSAsync
publishAsync(PublishRequest, com.amazonaws.handlers.AsyncHandler)
public Future<PublishBatchResult> publishBatchAsync(PublishBatchRequest request)
AmazonSNSAsync
Publishes up to ten messages to the specified topic. This is a batch version of Publish
. For FIFO
topics, multiple messages within a single batch are published in the order they are sent, and messages are
deduplicated within the batch and across batches for 5 minutes.
The result of publishing each message is reported individually in the response. Because the batch request can
result in a combination of successful and unsuccessful actions, you should check for batch errors even when the
call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the batch message is saved and Amazon SNS immediately delivers the
message to subscribers.
publishBatchAsync
in interface AmazonSNSAsync
public Future<PublishBatchResult> publishBatchAsync(PublishBatchRequest request, AsyncHandler<PublishBatchRequest,PublishBatchResult> asyncHandler)
AmazonSNSAsync
Publishes up to ten messages to the specified topic. This is a batch version of Publish
. For FIFO
topics, multiple messages within a single batch are published in the order they are sent, and messages are
deduplicated within the batch and across batches for 5 minutes.
The result of publishing each message is reported individually in the response. Because the batch request can
result in a combination of successful and unsuccessful actions, you should check for batch errors even when the
call returns an HTTP status code of 200
.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
Some actions take lists of parameters. These lists are specified using the param.n
notation. Values
of n
are integers starting from 1. For example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the batch message is saved and Amazon SNS immediately delivers the
message to subscribers.
publishBatchAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutDataProtectionPolicyResult> putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request)
AmazonSNSAsync
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
putDataProtectionPolicyAsync
in interface AmazonSNSAsync
public Future<PutDataProtectionPolicyResult> putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest request, AsyncHandler<PutDataProtectionPolicyRequest,PutDataProtectionPolicyResult> asyncHandler)
AmazonSNSAsync
Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
putDataProtectionPolicyAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request)
AmazonSNSAsync
Removes a statement from a topic's access control policy.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
removePermissionAsync
in interface AmazonSNSAsync
request
- Input for RemovePermission action.public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
AmazonSNSAsync
Removes a statement from a topic's access control policy.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
removePermissionAsync
in interface AmazonSNSAsync
request
- Input for RemovePermission action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemovePermissionResult> removePermissionAsync(String topicArn, String label)
removePermissionAsync
in interface AmazonSNSAsync
removePermissionAsync(RemovePermissionRequest)
public Future<RemovePermissionResult> removePermissionAsync(String topicArn, String label, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
removePermissionAsync
in interface AmazonSNSAsync
removePermissionAsync(RemovePermissionRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SetEndpointAttributesResult> setEndpointAttributesAsync(SetEndpointAttributesRequest request)
AmazonSNSAsync
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.
setEndpointAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetEndpointAttributes action.public Future<SetEndpointAttributesResult> setEndpointAttributesAsync(SetEndpointAttributesRequest request, AsyncHandler<SetEndpointAttributesRequest,SetEndpointAttributesResult> asyncHandler)
AmazonSNSAsync
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.
setEndpointAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetEndpointAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetPlatformApplicationAttributesResult> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest request)
AmazonSNSAsync
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.
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetPlatformApplicationAttributes action.public Future<SetPlatformApplicationAttributesResult> setPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest request, AsyncHandler<SetPlatformApplicationAttributesRequest,SetPlatformApplicationAttributesResult> asyncHandler)
AmazonSNSAsync
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.
setPlatformApplicationAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetPlatformApplicationAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetSMSAttributesResult> setSMSAttributesAsync(SetSMSAttributesRequest request)
AmazonSNSAsync
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.
setSMSAttributesAsync
in interface AmazonSNSAsync
request
- The input for the SetSMSAttributes action.public Future<SetSMSAttributesResult> setSMSAttributesAsync(SetSMSAttributesRequest request, AsyncHandler<SetSMSAttributesRequest,SetSMSAttributesResult> asyncHandler)
AmazonSNSAsync
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.
setSMSAttributesAsync
in interface AmazonSNSAsync
request
- The input for the SetSMSAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest request)
AmazonSNSAsync
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetSubscriptionAttributes action.public Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest request, AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
AmazonSNSAsync
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetSubscriptionAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(String subscriptionArn, String attributeName, String attributeValue)
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest)
public Future<SetSubscriptionAttributesResult> setSubscriptionAttributesAsync(String subscriptionArn, String attributeName, String attributeValue, AsyncHandler<SetSubscriptionAttributesRequest,SetSubscriptionAttributesResult> asyncHandler)
setSubscriptionAttributesAsync
in interface AmazonSNSAsync
setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SetTopicAttributesResult> setTopicAttributesAsync(SetTopicAttributesRequest request)
AmazonSNSAsync
Allows a topic owner to set an attribute of the topic to a new value.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
setTopicAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetTopicAttributes action.public Future<SetTopicAttributesResult> setTopicAttributesAsync(SetTopicAttributesRequest request, AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
AmazonSNSAsync
Allows a topic owner to set an attribute of the topic to a new value.
To remove the ability to change topic permissions, you must deny permissions to the AddPermission
,
RemovePermission
, and SetTopicAttributes
actions in your IAM policy.
setTopicAttributesAsync
in interface AmazonSNSAsync
request
- Input for SetTopicAttributes action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SetTopicAttributesResult> setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue)
setTopicAttributesAsync
in interface AmazonSNSAsync
setTopicAttributesAsync(SetTopicAttributesRequest)
public Future<SetTopicAttributesResult> setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue, AsyncHandler<SetTopicAttributesRequest,SetTopicAttributesResult> asyncHandler)
setTopicAttributesAsync
in interface AmazonSNSAsync
setTopicAttributesAsync(SetTopicAttributesRequest, com.amazonaws.handlers.AsyncHandler)
public Future<SubscribeResult> subscribeAsync(SubscribeRequest request)
AmazonSNSAsync
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 Amazon Web Services 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 two days.
This action is throttled at 100 transactions per second (TPS).
subscribeAsync
in interface AmazonSNSAsync
request
- Input for Subscribe action.public Future<SubscribeResult> subscribeAsync(SubscribeRequest request, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
AmazonSNSAsync
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 Amazon Web Services 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 two days.
This action is throttled at 100 transactions per second (TPS).
subscribeAsync
in interface AmazonSNSAsync
request
- Input for Subscribe action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubscribeResult> subscribeAsync(String topicArn, String protocol, String endpoint)
subscribeAsync
in interface AmazonSNSAsync
subscribeAsync(SubscribeRequest)
public Future<SubscribeResult> subscribeAsync(String topicArn, String protocol, String endpoint, AsyncHandler<SubscribeRequest,SubscribeResult> asyncHandler)
subscribeAsync
in interface AmazonSNSAsync
subscribeAsync(SubscribeRequest, com.amazonaws.handlers.AsyncHandler)
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonSNSAsync
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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
tagResourceAsync
in interface AmazonSNSAsync
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonSNSAsync
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 Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.
tagResourceAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest request)
AmazonSNSAsync
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 Amazon Web Services 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.
Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
unsubscribeAsync
in interface AmazonSNSAsync
request
- Input for Unsubscribe action.public Future<UnsubscribeResult> unsubscribeAsync(UnsubscribeRequest request, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
AmazonSNSAsync
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 Amazon Web Services 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.
Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.
This action is throttled at 100 transactions per second (TPS).
unsubscribeAsync
in interface AmazonSNSAsync
request
- Input for Unsubscribe action.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UnsubscribeResult> unsubscribeAsync(String subscriptionArn)
unsubscribeAsync
in interface AmazonSNSAsync
unsubscribeAsync(UnsubscribeRequest)
public Future<UnsubscribeResult> unsubscribeAsync(String subscriptionArn, AsyncHandler<UnsubscribeRequest,UnsubscribeResult> asyncHandler)
unsubscribeAsync
in interface AmazonSNSAsync
unsubscribeAsync(UnsubscribeRequest, com.amazonaws.handlers.AsyncHandler)
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonSNSAsync
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResourceAsync
in interface AmazonSNSAsync
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonSNSAsync
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResourceAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<VerifySMSSandboxPhoneNumberResult> verifySMSSandboxPhoneNumberAsync(VerifySMSSandboxPhoneNumberRequest request)
AmazonSNSAsync
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
verifySMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
public Future<VerifySMSSandboxPhoneNumberResult> verifySMSSandboxPhoneNumberAsync(VerifySMSSandboxPhoneNumberRequest request, AsyncHandler<VerifySMSSandboxPhoneNumberRequest,VerifySMSSandboxPhoneNumberResult> asyncHandler)
AmazonSNSAsync
Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.
When you start using Amazon SNS to send SMS messages, your Amazon Web Services account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your Amazon Web Services account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
verifySMSSandboxPhoneNumberAsync
in interface AmazonSNSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonSNS
shutdown
in class AmazonSNSClient
Copyright © 2024. All rights reserved.