com.amazonaws.services.sns.AmazonSNSAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sns Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sns;
import javax.annotation.Generated;
import com.amazonaws.services.sns.model.*;
/**
* Interface for accessing Amazon SNS asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.sns.AbstractAmazonSNSAsync} instead.
*
*
* Amazon Simple Notification Service
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSNSAsync extends AmazonSNS {
/**
*
* 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.
*
*
*
* @param addPermissionRequest
* @return A Java Future containing the result of the AddPermission operation returned by the service.
* @sample AmazonSNSAsync.AddPermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future addPermissionAsync(AddPermissionRequest addPermissionRequest);
/**
*
* 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.
*
*
*
* @param addPermissionRequest
* @param 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.
* @return A Java Future containing the result of the AddPermission operation returned by the service.
* @sample AmazonSNSAsyncHandler.AddPermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future addPermissionAsync(AddPermissionRequest addPermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the AddPermission operation.
*
* @see #addPermissionAsync(AddPermissionRequest)
*/
java.util.concurrent.Future addPermissionAsync(String topicArn, String label, java.util.List aWSAccountIds,
java.util.List actionNames);
/**
* Simplified method form for invoking the AddPermission operation with an AsyncHandler.
*
* @see #addPermissionAsync(AddPermissionRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future addPermissionAsync(String topicArn, String label, java.util.List aWSAccountIds,
java.util.List actionNames, com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param checkIfPhoneNumberIsOptedOutRequest
* The input for the CheckIfPhoneNumberIsOptedOut action.
* @return A Java Future containing the result of the CheckIfPhoneNumberIsOptedOut operation returned by the
* service.
* @sample AmazonSNSAsync.CheckIfPhoneNumberIsOptedOut
* @see AWS API Documentation
*/
java.util.concurrent.Future checkIfPhoneNumberIsOptedOutAsync(
CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest);
/**
*
* 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.
*
*
* @param checkIfPhoneNumberIsOptedOutRequest
* The input for the CheckIfPhoneNumberIsOptedOut action.
* @param 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.
* @return A Java Future containing the result of the CheckIfPhoneNumberIsOptedOut operation returned by the
* service.
* @sample AmazonSNSAsyncHandler.CheckIfPhoneNumberIsOptedOut
* @see AWS API Documentation
*/
java.util.concurrent.Future checkIfPhoneNumberIsOptedOutAsync(
CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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".
*
*
* @param confirmSubscriptionRequest
* Input for ConfirmSubscription action.
* @return A Java Future containing the result of the ConfirmSubscription operation returned by the service.
* @sample AmazonSNSAsync.ConfirmSubscription
* @see AWS API
* Documentation
*/
java.util.concurrent.Future confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest);
/**
*
* Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
* earlier Subscribe action. 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".
*
*
* @param confirmSubscriptionRequest
* Input for ConfirmSubscription action.
* @param 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.
* @return A Java Future containing the result of the ConfirmSubscription operation returned by the service.
* @sample AmazonSNSAsyncHandler.ConfirmSubscription
* @see AWS API
* Documentation
*/
java.util.concurrent.Future confirmSubscriptionAsync(ConfirmSubscriptionRequest confirmSubscriptionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ConfirmSubscription operation.
*
* @see #confirmSubscriptionAsync(ConfirmSubscriptionRequest)
*/
java.util.concurrent.Future confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe);
/**
* Simplified method form for invoking the ConfirmSubscription operation with an AsyncHandler.
*
* @see #confirmSubscriptionAsync(ConfirmSubscriptionRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future confirmSubscriptionAsync(String topicArn, String token, String authenticateOnUnsubscribe,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ConfirmSubscription operation.
*
* @see #confirmSubscriptionAsync(ConfirmSubscriptionRequest)
*/
java.util.concurrent.Future confirmSubscriptionAsync(String topicArn, String token);
/**
* Simplified method form for invoking the ConfirmSubscription operation with an AsyncHandler.
*
* @see #confirmSubscriptionAsync(ConfirmSubscriptionRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future confirmSubscriptionAsync(String topicArn, String token,
com.amazonaws.handlers.AsyncHandler 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. 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is
* secret key.
*
*
* -
*
* For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The
* PlatformCredential is API key.
*
*
* -
*
* For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The
* PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the
* file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS
* recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
*
*
* -
*
* 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.
*
*
* @param createPlatformApplicationRequest
* Input for CreatePlatformApplication action.
* @return A Java Future containing the result of the CreatePlatformApplication operation returned by the service.
* @sample AmazonSNSAsync.CreatePlatformApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createPlatformApplicationAsync(
CreatePlatformApplicationRequest createPlatformApplicationRequest);
/**
*
* Creates a platform application object for one of the supported push notification services, such as APNS and GCM
* (Firebase Cloud Messaging), to which devices and mobile apps may register. 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 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 Baidu, PlatformPrincipal is API key and PlatformCredential is
* secret key.
*
*
* -
*
* For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The
* PlatformCredential is API key.
*
*
* -
*
* For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The
* PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the
* file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS
* recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.
*
*
* -
*
* 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.
*
*
* @param createPlatformApplicationRequest
* Input for CreatePlatformApplication action.
* @param 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.
* @return A Java Future containing the result of the CreatePlatformApplication operation returned by the service.
* @sample AmazonSNSAsyncHandler.CreatePlatformApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createPlatformApplicationAsync(
CreatePlatformApplicationRequest createPlatformApplicationRequest,
com.amazonaws.handlers.AsyncHandler 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. 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.
*
*
* @param createPlatformEndpointRequest
* Input for CreatePlatformEndpoint action.
* @return A Java Future containing the result of the CreatePlatformEndpoint operation returned by the service.
* @sample AmazonSNSAsync.CreatePlatformEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest);
/**
*
* Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM
* (Firebase Cloud Messaging) and APNS. 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.
*
*
* @param createPlatformEndpointRequest
* Input for CreatePlatformEndpoint action.
* @param 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.
* @return A Java Future containing the result of the CreatePlatformEndpoint operation returned by the service.
* @sample AmazonSNSAsyncHandler.CreatePlatformEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createPlatformEndpointAsync(CreatePlatformEndpointRequest createPlatformEndpointRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* 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.
*
*
* @param createSMSSandboxPhoneNumberRequest
* @return A Java Future containing the result of the CreateSMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsync.CreateSMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future createSMSSandboxPhoneNumberAsync(
CreateSMSSandboxPhoneNumberRequest createSMSSandboxPhoneNumberRequest);
/**
*
* 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.
*
*
* @param createSMSSandboxPhoneNumberRequest
* @param 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.
* @return A Java Future containing the result of the CreateSMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsyncHandler.CreateSMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future createSMSSandboxPhoneNumberAsync(
CreateSMSSandboxPhoneNumberRequest createSMSSandboxPhoneNumberRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param createTopicRequest
* Input for CreateTopic action.
* @return A Java Future containing the result of the CreateTopic operation returned by the service.
* @sample AmazonSNSAsync.CreateTopic
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTopicAsync(CreateTopicRequest createTopicRequest);
/**
*
* 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.
*
*
* @param createTopicRequest
* Input for CreateTopic action.
* @param 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.
* @return A Java Future containing the result of the CreateTopic operation returned by the service.
* @sample AmazonSNSAsyncHandler.CreateTopic
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTopicAsync(CreateTopicRequest createTopicRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the CreateTopic operation.
*
* @see #createTopicAsync(CreateTopicRequest)
*/
java.util.concurrent.Future createTopicAsync(String name);
/**
* Simplified method form for invoking the CreateTopic operation with an AsyncHandler.
*
* @see #createTopicAsync(CreateTopicRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future createTopicAsync(String name,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteEndpointRequest
* Input for DeleteEndpoint action.
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* @sample AmazonSNSAsync.DeleteEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest);
/**
*
* 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.
*
*
* @param deleteEndpointRequest
* Input for DeleteEndpoint action.
* @param 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.
* @return A Java Future containing the result of the DeleteEndpoint operation returned by the service.
* @sample AmazonSNSAsyncHandler.DeleteEndpoint
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteEndpointAsync(DeleteEndpointRequest deleteEndpointRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deletePlatformApplicationRequest
* Input for DeletePlatformApplication action.
* @return A Java Future containing the result of the DeletePlatformApplication operation returned by the service.
* @sample AmazonSNSAsync.DeletePlatformApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deletePlatformApplicationAsync(
DeletePlatformApplicationRequest deletePlatformApplicationRequest);
/**
*
* 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.
*
*
* @param deletePlatformApplicationRequest
* Input for DeletePlatformApplication action.
* @param 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.
* @return A Java Future containing the result of the DeletePlatformApplication operation returned by the service.
* @sample AmazonSNSAsyncHandler.DeletePlatformApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deletePlatformApplicationAsync(
DeletePlatformApplicationRequest deletePlatformApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteSMSSandboxPhoneNumberRequest
* @return A Java Future containing the result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsync.DeleteSMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteSMSSandboxPhoneNumberAsync(
DeleteSMSSandboxPhoneNumberRequest deleteSMSSandboxPhoneNumberRequest);
/**
*
* 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.
*
*
* @param deleteSMSSandboxPhoneNumberRequest
* @param 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.
* @return A Java Future containing the result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsyncHandler.DeleteSMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteSMSSandboxPhoneNumberAsync(
DeleteSMSSandboxPhoneNumberRequest deleteSMSSandboxPhoneNumberRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deleteTopicRequest
* @return A Java Future containing the result of the DeleteTopic operation returned by the service.
* @sample AmazonSNSAsync.DeleteTopic
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteTopicAsync(DeleteTopicRequest deleteTopicRequest);
/**
*
* 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.
*
*
* @param deleteTopicRequest
* @param 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.
* @return A Java Future containing the result of the DeleteTopic operation returned by the service.
* @sample AmazonSNSAsyncHandler.DeleteTopic
* @see AWS API
* Documentation
*/
java.util.concurrent.Future deleteTopicAsync(DeleteTopicRequest deleteTopicRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the DeleteTopic operation.
*
* @see #deleteTopicAsync(DeleteTopicRequest)
*/
java.util.concurrent.Future deleteTopicAsync(String topicArn);
/**
* Simplified method form for invoking the DeleteTopic operation with an AsyncHandler.
*
* @see #deleteTopicAsync(DeleteTopicRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future deleteTopicAsync(String topicArn,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon
* SNS topic.
*
*
* @param getDataProtectionPolicyRequest
* @return A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
* @sample AmazonSNSAsync.GetDataProtectionPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest);
/**
*
* Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon
* SNS topic.
*
*
* @param getDataProtectionPolicyRequest
* @param 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.
* @return A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetDataProtectionPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getDataProtectionPolicyAsync(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getEndpointAttributesRequest
* Input for GetEndpointAttributes action.
* @return A Java Future containing the result of the GetEndpointAttributes operation returned by the service.
* @sample AmazonSNSAsync.GetEndpointAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest);
/**
*
* Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM
* (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push
* Notifications.
*
*
* @param getEndpointAttributesRequest
* Input for GetEndpointAttributes action.
* @param 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.
* @return A Java Future containing the result of the GetEndpointAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetEndpointAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getEndpointAttributesAsync(GetEndpointAttributesRequest getEndpointAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getPlatformApplicationAttributesRequest
* Input for GetPlatformApplicationAttributes action.
* @return A Java Future containing the result of the GetPlatformApplicationAttributes operation returned by the
* service.
* @sample AmazonSNSAsync.GetPlatformApplicationAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future getPlatformApplicationAttributesAsync(
GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest);
/**
*
* Retrieves the attributes of the platform application object for the supported push notification services, such as
* APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push
* Notifications.
*
*
* @param getPlatformApplicationAttributesRequest
* Input for GetPlatformApplicationAttributes action.
* @param 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.
* @return A Java Future containing the result of the GetPlatformApplicationAttributes operation returned by the
* service.
* @sample AmazonSNSAsyncHandler.GetPlatformApplicationAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future getPlatformApplicationAttributesAsync(
GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns the settings for sending SMS messages from your Amazon Web Services account.
*
*
* These settings are set with the SetSMSAttributes action.
*
*
* @param getSMSAttributesRequest
* The input for the GetSMSAttributes request.
* @return A Java Future containing the result of the GetSMSAttributes operation returned by the service.
* @sample AmazonSNSAsync.GetSMSAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest);
/**
*
* Returns the settings for sending SMS messages from your Amazon Web Services account.
*
*
* These settings are set with the SetSMSAttributes action.
*
*
* @param getSMSAttributesRequest
* The input for the GetSMSAttributes request.
* @param 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.
* @return A Java Future containing the result of the GetSMSAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetSMSAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getSMSAttributesAsync(GetSMSAttributesRequest getSMSAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param getSMSSandboxAccountStatusRequest
* @return A Java Future containing the result of the GetSMSSandboxAccountStatus operation returned by the service.
* @sample AmazonSNSAsync.GetSMSSandboxAccountStatus
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSMSSandboxAccountStatusAsync(
GetSMSSandboxAccountStatusRequest getSMSSandboxAccountStatusRequest);
/**
*
* 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.
*
*
* @param getSMSSandboxAccountStatusRequest
* @param 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.
* @return A Java Future containing the result of the GetSMSSandboxAccountStatus operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetSMSSandboxAccountStatus
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSMSSandboxAccountStatusAsync(
GetSMSSandboxAccountStatusRequest getSMSSandboxAccountStatusRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns all of the properties of a subscription.
*
*
* @param getSubscriptionAttributesRequest
* Input for GetSubscriptionAttributes.
* @return A Java Future containing the result of the GetSubscriptionAttributes operation returned by the service.
* @sample AmazonSNSAsync.GetSubscriptionAttributes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSubscriptionAttributesAsync(
GetSubscriptionAttributesRequest getSubscriptionAttributesRequest);
/**
*
* Returns all of the properties of a subscription.
*
*
* @param getSubscriptionAttributesRequest
* Input for GetSubscriptionAttributes.
* @param 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.
* @return A Java Future containing the result of the GetSubscriptionAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetSubscriptionAttributes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getSubscriptionAttributesAsync(
GetSubscriptionAttributesRequest getSubscriptionAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the GetSubscriptionAttributes operation.
*
* @see #getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest)
*/
java.util.concurrent.Future getSubscriptionAttributesAsync(String subscriptionArn);
/**
* Simplified method form for invoking the GetSubscriptionAttributes operation with an AsyncHandler.
*
* @see #getSubscriptionAttributesAsync(GetSubscriptionAttributesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future getSubscriptionAttributesAsync(String subscriptionArn,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of
* the user.
*
*
* @param getTopicAttributesRequest
* Input for GetTopicAttributes action.
* @return A Java Future containing the result of the GetTopicAttributes operation returned by the service.
* @sample AmazonSNSAsync.GetTopicAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest);
/**
*
* Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of
* the user.
*
*
* @param getTopicAttributesRequest
* Input for GetTopicAttributes action.
* @param 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.
* @return A Java Future containing the result of the GetTopicAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.GetTopicAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getTopicAttributesAsync(GetTopicAttributesRequest getTopicAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the GetTopicAttributes operation.
*
* @see #getTopicAttributesAsync(GetTopicAttributesRequest)
*/
java.util.concurrent.Future getTopicAttributesAsync(String topicArn);
/**
* Simplified method form for invoking the GetTopicAttributes operation with an AsyncHandler.
*
* @see #getTopicAttributesAsync(GetTopicAttributesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future getTopicAttributesAsync(String topicArn,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param listEndpointsByPlatformApplicationRequest
* Input for ListEndpointsByPlatformApplication action.
* @return A Java Future containing the result of the ListEndpointsByPlatformApplication operation returned by the
* service.
* @sample AmazonSNSAsync.ListEndpointsByPlatformApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future listEndpointsByPlatformApplicationAsync(
ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest);
/**
*
* Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM
* (Firebase Cloud Messaging) and APNS. 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).
*
*
* @param listEndpointsByPlatformApplicationRequest
* Input for ListEndpointsByPlatformApplication action.
* @param 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.
* @return A Java Future containing the result of the ListEndpointsByPlatformApplication operation returned by the
* service.
* @sample AmazonSNSAsyncHandler.ListEndpointsByPlatformApplication
* @see AWS API Documentation
*/
java.util.concurrent.Future listEndpointsByPlatformApplicationAsync(
ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listOriginationNumbersRequest
* @return A Java Future containing the result of the ListOriginationNumbers operation returned by the service.
* @sample AmazonSNSAsync.ListOriginationNumbers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listOriginationNumbersAsync(ListOriginationNumbersRequest listOriginationNumbersRequest);
/**
*
* 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.
*
*
* @param listOriginationNumbersRequest
* @param 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.
* @return A Java Future containing the result of the ListOriginationNumbers operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListOriginationNumbers
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listOriginationNumbersAsync(ListOriginationNumbersRequest listOriginationNumbersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listPhoneNumbersOptedOutRequest
* The input for the ListPhoneNumbersOptedOut action.
* @return A Java Future containing the result of the ListPhoneNumbersOptedOut operation returned by the service.
* @sample AmazonSNSAsync.ListPhoneNumbersOptedOut
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest);
/**
*
* 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.
*
*
* @param listPhoneNumbersOptedOutRequest
* The input for the ListPhoneNumbersOptedOut action.
* @param 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.
* @return A Java Future containing the result of the ListPhoneNumbersOptedOut operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListPhoneNumbersOptedOut
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param listPlatformApplicationsRequest
* Input for ListPlatformApplications action.
* @return A Java Future containing the result of the ListPlatformApplications operation returned by the service.
* @sample AmazonSNSAsync.ListPlatformApplications
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest);
/**
*
* 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).
*
*
* @param listPlatformApplicationsRequest
* Input for ListPlatformApplications action.
* @param 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.
* @return A Java Future containing the result of the ListPlatformApplications operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListPlatformApplications
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listPlatformApplicationsAsync(ListPlatformApplicationsRequest listPlatformApplicationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListPlatformApplications operation.
*
* @see #listPlatformApplicationsAsync(ListPlatformApplicationsRequest)
*/
java.util.concurrent.Future listPlatformApplicationsAsync();
/**
* Simplified method form for invoking the ListPlatformApplications operation with an AsyncHandler.
*
* @see #listPlatformApplicationsAsync(ListPlatformApplicationsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listPlatformApplicationsAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listSMSSandboxPhoneNumbersRequest
* @return A Java Future containing the result of the ListSMSSandboxPhoneNumbers operation returned by the service.
* @sample AmazonSNSAsync.ListSMSSandboxPhoneNumbers
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listSMSSandboxPhoneNumbersAsync(
ListSMSSandboxPhoneNumbersRequest listSMSSandboxPhoneNumbersRequest);
/**
*
* 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.
*
*
* @param listSMSSandboxPhoneNumbersRequest
* @param 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.
* @return A Java Future containing the result of the ListSMSSandboxPhoneNumbers operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListSMSSandboxPhoneNumbers
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listSMSSandboxPhoneNumbersAsync(
ListSMSSandboxPhoneNumbersRequest listSMSSandboxPhoneNumbersRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param listSubscriptionsRequest
* Input for ListSubscriptions action.
* @return A Java Future containing the result of the ListSubscriptions operation returned by the service.
* @sample AmazonSNSAsync.ListSubscriptions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest);
/**
*
* 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).
*
*
* @param listSubscriptionsRequest
* Input for ListSubscriptions action.
* @param 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.
* @return A Java Future containing the result of the ListSubscriptions operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListSubscriptions
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listSubscriptionsAsync(ListSubscriptionsRequest listSubscriptionsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListSubscriptions operation.
*
* @see #listSubscriptionsAsync(ListSubscriptionsRequest)
*/
java.util.concurrent.Future listSubscriptionsAsync();
/**
* Simplified method form for invoking the ListSubscriptions operation with an AsyncHandler.
*
* @see #listSubscriptionsAsync(ListSubscriptionsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listSubscriptionsAsync(
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListSubscriptions operation.
*
* @see #listSubscriptionsAsync(ListSubscriptionsRequest)
*/
java.util.concurrent.Future listSubscriptionsAsync(String nextToken);
/**
* Simplified method form for invoking the ListSubscriptions operation with an AsyncHandler.
*
* @see #listSubscriptionsAsync(ListSubscriptionsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listSubscriptionsAsync(String nextToken,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param listSubscriptionsByTopicRequest
* Input for ListSubscriptionsByTopic action.
* @return A Java Future containing the result of the ListSubscriptionsByTopic operation returned by the service.
* @sample AmazonSNSAsync.ListSubscriptionsByTopic
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest);
/**
*
* 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).
*
*
* @param listSubscriptionsByTopicRequest
* Input for ListSubscriptionsByTopic action.
* @param 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.
* @return A Java Future containing the result of the ListSubscriptionsByTopic operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListSubscriptionsByTopic
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListSubscriptionsByTopic operation.
*
* @see #listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest)
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(String topicArn);
/**
* Simplified method form for invoking the ListSubscriptionsByTopic operation with an AsyncHandler.
*
* @see #listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(String topicArn,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListSubscriptionsByTopic operation.
*
* @see #listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest)
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(String topicArn, String nextToken);
/**
* Simplified method form for invoking the ListSubscriptionsByTopic operation with an AsyncHandler.
*
* @see #listSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listSubscriptionsByTopicAsync(String topicArn, String nextToken,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonSNSAsync.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* 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.
*
*
* @param listTagsForResourceRequest
* @param 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.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListTagsForResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param listTopicsRequest
* @return A Java Future containing the result of the ListTopics operation returned by the service.
* @sample AmazonSNSAsync.ListTopics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTopicsAsync(ListTopicsRequest listTopicsRequest);
/**
*
* 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).
*
*
* @param listTopicsRequest
* @param 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.
* @return A Java Future containing the result of the ListTopics operation returned by the service.
* @sample AmazonSNSAsyncHandler.ListTopics
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listTopicsAsync(ListTopicsRequest listTopicsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListTopics operation.
*
* @see #listTopicsAsync(ListTopicsRequest)
*/
java.util.concurrent.Future listTopicsAsync();
/**
* Simplified method form for invoking the ListTopics operation with an AsyncHandler.
*
* @see #listTopicsAsync(ListTopicsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listTopicsAsync(com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the ListTopics operation.
*
* @see #listTopicsAsync(ListTopicsRequest)
*/
java.util.concurrent.Future listTopicsAsync(String nextToken);
/**
* Simplified method form for invoking the ListTopics operation with an AsyncHandler.
*
* @see #listTopicsAsync(ListTopicsRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future listTopicsAsync(String nextToken,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* You can opt in a phone number only once every 30 days.
*
*
* @param optInPhoneNumberRequest
* Input for the OptInPhoneNumber action.
* @return A Java Future containing the result of the OptInPhoneNumber operation returned by the service.
* @sample AmazonSNSAsync.OptInPhoneNumber
* @see AWS API
* Documentation
*/
java.util.concurrent.Future optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest);
/**
*
* Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
* the number.
*
*
* You can opt in a phone number only once every 30 days.
*
*
* @param optInPhoneNumberRequest
* Input for the OptInPhoneNumber action.
* @param 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.
* @return A Java Future containing the result of the OptInPhoneNumber operation returned by the service.
* @sample AmazonSNSAsyncHandler.OptInPhoneNumber
* @see AWS API
* Documentation
*/
java.util.concurrent.Future optInPhoneNumberAsync(OptInPhoneNumberRequest optInPhoneNumberRequest,
com.amazonaws.handlers.AsyncHandler 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).
*
*
* 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.
*
*
*
* @param publishRequest
* Input for Publish action.
* @return A Java Future containing the result of the Publish operation returned by the service.
* @sample AmazonSNSAsync.Publish
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishAsync(PublishRequest publishRequest);
/**
*
* Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to
* a mobile platform endpoint (when you specify the TargetArn).
*
*
* 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.
*
*
*
* @param publishRequest
* Input for Publish action.
* @param 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.
* @return A Java Future containing the result of the Publish operation returned by the service.
* @sample AmazonSNSAsyncHandler.Publish
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishAsync(PublishRequest publishRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the Publish operation.
*
* @see #publishAsync(PublishRequest)
*/
java.util.concurrent.Future publishAsync(String topicArn, String message);
/**
* Simplified method form for invoking the Publish operation with an AsyncHandler.
*
* @see #publishAsync(PublishRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future publishAsync(String topicArn, String message,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the Publish operation.
*
* @see #publishAsync(PublishRequest)
*/
java.util.concurrent.Future publishAsync(String topicArn, String message, String subject);
/**
* Simplified method form for invoking the Publish operation with an AsyncHandler.
*
* @see #publishAsync(PublishRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future publishAsync(String topicArn, String message, String subject,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param publishBatchRequest
* @return A Java Future containing the result of the PublishBatch operation returned by the service.
* @sample AmazonSNSAsync.PublishBatch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishBatchAsync(PublishBatchRequest publishBatchRequest);
/**
*
* 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.
*
*
* @param publishBatchRequest
* @param 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.
* @return A Java Future containing the result of the PublishBatch operation returned by the service.
* @sample AmazonSNSAsyncHandler.PublishBatch
* @see AWS API
* Documentation
*/
java.util.concurrent.Future publishBatchAsync(PublishBatchRequest publishBatchRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
*
*
* @param putDataProtectionPolicyRequest
* @return A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
* @sample AmazonSNSAsync.PutDataProtectionPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest);
/**
*
* Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.
*
*
* @param putDataProtectionPolicyRequest
* @param 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.
* @return A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
* @sample AmazonSNSAsyncHandler.PutDataProtectionPolicy
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putDataProtectionPolicyAsync(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param removePermissionRequest
* Input for RemovePermission action.
* @return A Java Future containing the result of the RemovePermission operation returned by the service.
* @sample AmazonSNSAsync.RemovePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future removePermissionAsync(RemovePermissionRequest removePermissionRequest);
/**
*
* 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.
*
*
*
* @param removePermissionRequest
* Input for RemovePermission action.
* @param 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.
* @return A Java Future containing the result of the RemovePermission operation returned by the service.
* @sample AmazonSNSAsyncHandler.RemovePermission
* @see AWS API
* Documentation
*/
java.util.concurrent.Future removePermissionAsync(RemovePermissionRequest removePermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the RemovePermission operation.
*
* @see #removePermissionAsync(RemovePermissionRequest)
*/
java.util.concurrent.Future removePermissionAsync(String topicArn, String label);
/**
* Simplified method form for invoking the RemovePermission operation with an AsyncHandler.
*
* @see #removePermissionAsync(RemovePermissionRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future removePermissionAsync(String topicArn, String label,
com.amazonaws.handlers.AsyncHandler 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. For more information, see Using Amazon SNS Mobile Push
* Notifications.
*
*
* @param setEndpointAttributesRequest
* Input for SetEndpointAttributes action.
* @return A Java Future containing the result of the SetEndpointAttributes operation returned by the service.
* @sample AmazonSNSAsync.SetEndpointAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest);
/**
*
* Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM
* (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push
* Notifications.
*
*
* @param setEndpointAttributesRequest
* Input for SetEndpointAttributes action.
* @param 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.
* @return A Java Future containing the result of the SetEndpointAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.SetEndpointAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setEndpointAttributesAsync(SetEndpointAttributesRequest setEndpointAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param setPlatformApplicationAttributesRequest
* Input for SetPlatformApplicationAttributes action.
* @return A Java Future containing the result of the SetPlatformApplicationAttributes operation returned by the
* service.
* @sample AmazonSNSAsync.SetPlatformApplicationAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future setPlatformApplicationAttributesAsync(
SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest);
/**
*
* Sets the attributes of the platform application object for the supported push notification services, such as APNS
* and GCM (Firebase Cloud Messaging). 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.
*
*
* @param setPlatformApplicationAttributesRequest
* Input for SetPlatformApplicationAttributes action.
* @param 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.
* @return A Java Future containing the result of the SetPlatformApplicationAttributes operation returned by the
* service.
* @sample AmazonSNSAsyncHandler.SetPlatformApplicationAttributes
* @see AWS API Documentation
*/
java.util.concurrent.Future setPlatformApplicationAttributesAsync(
SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param setSMSAttributesRequest
* The input for the SetSMSAttributes action.
* @return A Java Future containing the result of the SetSMSAttributes operation returned by the service.
* @sample AmazonSNSAsync.SetSMSAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest);
/**
*
* 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.
*
*
*
* @param setSMSAttributesRequest
* The input for the SetSMSAttributes action.
* @param 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.
* @return A Java Future containing the result of the SetSMSAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.SetSMSAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setSMSAttributesAsync(SetSMSAttributesRequest setSMSAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Allows a subscription owner to set an attribute of the subscription to a new value.
*
*
* @param setSubscriptionAttributesRequest
* Input for SetSubscriptionAttributes action.
* @return A Java Future containing the result of the SetSubscriptionAttributes operation returned by the service.
* @sample AmazonSNSAsync.SetSubscriptionAttributes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future setSubscriptionAttributesAsync(
SetSubscriptionAttributesRequest setSubscriptionAttributesRequest);
/**
*
* Allows a subscription owner to set an attribute of the subscription to a new value.
*
*
* @param setSubscriptionAttributesRequest
* Input for SetSubscriptionAttributes action.
* @param 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.
* @return A Java Future containing the result of the SetSubscriptionAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.SetSubscriptionAttributes
* @see AWS
* API Documentation
*/
java.util.concurrent.Future setSubscriptionAttributesAsync(
SetSubscriptionAttributesRequest setSubscriptionAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the SetSubscriptionAttributes operation.
*
* @see #setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest)
*/
java.util.concurrent.Future setSubscriptionAttributesAsync(String subscriptionArn, String attributeName,
String attributeValue);
/**
* Simplified method form for invoking the SetSubscriptionAttributes operation with an AsyncHandler.
*
* @see #setSubscriptionAttributesAsync(SetSubscriptionAttributesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future setSubscriptionAttributesAsync(String subscriptionArn, String attributeName,
String attributeValue, com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
* @param setTopicAttributesRequest
* Input for SetTopicAttributes action.
* @return A Java Future containing the result of the SetTopicAttributes operation returned by the service.
* @sample AmazonSNSAsync.SetTopicAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest);
/**
*
* 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.
*
*
*
* @param setTopicAttributesRequest
* Input for SetTopicAttributes action.
* @param 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.
* @return A Java Future containing the result of the SetTopicAttributes operation returned by the service.
* @sample AmazonSNSAsyncHandler.SetTopicAttributes
* @see AWS API
* Documentation
*/
java.util.concurrent.Future setTopicAttributesAsync(SetTopicAttributesRequest setTopicAttributesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the SetTopicAttributes operation.
*
* @see #setTopicAttributesAsync(SetTopicAttributesRequest)
*/
java.util.concurrent.Future setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue);
/**
* Simplified method form for invoking the SetTopicAttributes operation with an AsyncHandler.
*
* @see #setTopicAttributesAsync(SetTopicAttributesRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future setTopicAttributesAsync(String topicArn, String attributeName, String attributeValue,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param subscribeRequest
* Input for Subscribe action.
* @return A Java Future containing the result of the Subscribe operation returned by the service.
* @sample AmazonSNSAsync.Subscribe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future subscribeAsync(SubscribeRequest subscribeRequest);
/**
*
* 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).
*
*
* @param subscribeRequest
* Input for Subscribe action.
* @param 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.
* @return A Java Future containing the result of the Subscribe operation returned by the service.
* @sample AmazonSNSAsyncHandler.Subscribe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future subscribeAsync(SubscribeRequest subscribeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the Subscribe operation.
*
* @see #subscribeAsync(SubscribeRequest)
*/
java.util.concurrent.Future subscribeAsync(String topicArn, String protocol, String endpoint);
/**
* Simplified method form for invoking the Subscribe operation with an AsyncHandler.
*
* @see #subscribeAsync(SubscribeRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future subscribeAsync(String topicArn, String protocol, String endpoint,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonSNSAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* 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.
*
*
*
*
* @param tagResourceRequest
* @param 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.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AmazonSNSAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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).
*
*
* @param unsubscribeRequest
* Input for Unsubscribe action.
* @return A Java Future containing the result of the Unsubscribe operation returned by the service.
* @sample AmazonSNSAsync.Unsubscribe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future unsubscribeAsync(UnsubscribeRequest unsubscribeRequest);
/**
*
* 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).
*
*
* @param unsubscribeRequest
* Input for Unsubscribe action.
* @param 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.
* @return A Java Future containing the result of the Unsubscribe operation returned by the service.
* @sample AmazonSNSAsyncHandler.Unsubscribe
* @see AWS API
* Documentation
*/
java.util.concurrent.Future unsubscribeAsync(UnsubscribeRequest unsubscribeRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
* Simplified method form for invoking the Unsubscribe operation.
*
* @see #unsubscribeAsync(UnsubscribeRequest)
*/
java.util.concurrent.Future unsubscribeAsync(String subscriptionArn);
/**
* Simplified method form for invoking the Unsubscribe operation with an AsyncHandler.
*
* @see #unsubscribeAsync(UnsubscribeRequest, com.amazonaws.handlers.AsyncHandler)
*/
java.util.concurrent.Future unsubscribeAsync(String subscriptionArn,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer
* Guide.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonSNSAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer
* Guide.
*
*
* @param untagResourceRequest
* @param 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.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AmazonSNSAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param verifySMSSandboxPhoneNumberRequest
* @return A Java Future containing the result of the VerifySMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsync.VerifySMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future verifySMSSandboxPhoneNumberAsync(
VerifySMSSandboxPhoneNumberRequest verifySMSSandboxPhoneNumberRequest);
/**
*
* 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.
*
*
* @param verifySMSSandboxPhoneNumberRequest
* @param 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.
* @return A Java Future containing the result of the VerifySMSSandboxPhoneNumber operation returned by the service.
* @sample AmazonSNSAsyncHandler.VerifySMSSandboxPhoneNumber
* @see AWS API Documentation
*/
java.util.concurrent.Future verifySMSSandboxPhoneNumberAsync(
VerifySMSSandboxPhoneNumberRequest verifySMSSandboxPhoneNumberRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}