Package software.amazon.awssdk.services.sns

Interface SNSAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface SNSAsyncClient
extends AutoCloseable

Service client for accessing Amazon SNS asynchronously. This can be created using the static builder() method. 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 http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddPermissionResponse>	addPermission(AddPermissionRequest addPermissionRequest)	Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
static SNSAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a SNSAsyncClient.
default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse>	checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)	Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
default CompletableFuture<ConfirmSubscriptionResponse>	confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)	Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
static SNSAsyncClient	create()	Create a SNSAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreatePlatformApplicationResponse>	createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)	Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.
default CompletableFuture<CreatePlatformEndpointResponse>	createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)	Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
default CompletableFuture<CreateTopicResponse>	createTopic(CreateTopicRequest createTopicRequest)	Creates a topic to which notifications can be published.
default CompletableFuture<DeleteEndpointResponse>	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)	Deletes the endpoint for a device and mobile app from Amazon SNS.
default CompletableFuture<DeletePlatformApplicationResponse>	deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)	Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
default CompletableFuture<DeleteTopicResponse>	deleteTopic(DeleteTopicRequest deleteTopicRequest)	Deletes a topic and all its subscriptions.
default CompletableFuture<GetEndpointAttributesResponse>	getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)	Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
default CompletableFuture<GetPlatformApplicationAttributesResponse>	getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)	Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
default CompletableFuture<GetSMSAttributesResponse>	getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)	Returns the settings for sending SMS messages from your account.
default CompletableFuture<GetSubscriptionAttributesResponse>	getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)	Returns all of the properties of a subscription.
default CompletableFuture<GetTopicAttributesResponse>	getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)	Returns all of the properties of a topic.
default CompletableFuture<ListEndpointsByPlatformApplicationResponse>	listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)	Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
default CompletableFuture<ListPhoneNumbersOptedOutResponse>	listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)	Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
default CompletableFuture<ListPlatformApplicationsResponse>	listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)	Lists the platform application objects for the supported push notification services, such as APNS and GCM.
default CompletableFuture<ListSubscriptionsResponse>	listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)	Returns a list of the requester's subscriptions.
default CompletableFuture<ListSubscriptionsByTopicResponse>	listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)	Returns a list of the subscriptions to a specific topic.
default CompletableFuture<ListTopicsResponse>	listTopics(ListTopicsRequest listTopicsRequest)	Returns a list of the requester's topics.
default CompletableFuture<OptInPhoneNumberResponse>	optInPhoneNumber(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.
default CompletableFuture<PublishResponse>	publish(PublishRequest publishRequest)	Sends a message to all of a topic's subscribed endpoints.
default CompletableFuture<RemovePermissionResponse>	removePermission(RemovePermissionRequest removePermissionRequest)	Removes a statement from a topic's access control policy.
default CompletableFuture<SetEndpointAttributesResponse>	setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)	Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
default CompletableFuture<SetPlatformApplicationAttributesResponse>	setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)	Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
default CompletableFuture<SetSMSAttributesResponse>	setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest)	Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
default CompletableFuture<SetSubscriptionAttributesResponse>	setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)	Allows a subscription owner to set an attribute of the topic to a new value.
default CompletableFuture<SetTopicAttributesResponse>	setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)	Allows a topic owner to set an attribute of the topic to a new value.
default CompletableFuture<SubscribeResponse>	subscribe(SubscribeRequest subscribeRequest)	Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
default CompletableFuture<UnsubscribeResponse>	unsubscribe(UnsubscribeRequest unsubscribeRequest)	Deletes a subscription.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static SNSAsyncClient create()

Create a SNSAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SNSAsyncClientBuilder builder()

Create a builder that can be used to configure and create a SNSAsyncClient.

addPermission

default CompletableFuture<AddPermissionResponse> addPermission(AddPermissionRequest addPermissionRequest)

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

Parameters:

addPermissionRequest -

Returns:

A Java Future containing the result of the AddPermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

checkIfPhoneNumberIsOptedOut

default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Parameters:

checkIfPhoneNumberIsOptedOutRequest - The input for the CheckIfPhoneNumberIsOptedOut action.

Returns:

A Java Future containing the result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

confirmSubscription

default CompletableFuture<ConfirmSubscriptionResponse> confirmSubscription(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".

Parameters:

confirmSubscriptionRequest - Input for ConfirmSubscription action.

Returns:

A Java Future containing the result of the ConfirmSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• SubscriptionLimitExceededException Indicates that the customer already owns the maximum allowed number of subscriptions.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• NotFoundException Indicates that the requested resource does not exist.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createPlatformApplication

default CompletableFuture<CreatePlatformApplicationResponse> createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".

For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.

Parameters:

createPlatformApplicationRequest - Input for CreatePlatformApplication action.

Returns:

A Java Future containing the result of the CreatePlatformApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createPlatformEndpoint

default CompletableFuture<CreatePlatformEndpointResponse> createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

Parameters:

createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.

Returns:

A Java Future containing the result of the CreatePlatformEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createTopic

default CompletableFuture<CreateTopicResponse> createTopic(CreateTopicRequest createTopicRequest)

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

Parameters:

createTopicRequest - Input for CreateTopic action.

Returns:

A Java Future containing the result of the CreateTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• TopicLimitExceededException Indicates that the customer already owns the maximum allowed number of topics.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteEndpoint

default CompletableFuture<DeleteEndpointResponse> deleteEndpoint(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.

Parameters:

deleteEndpointRequest - Input for DeleteEndpoint action.

Returns:

A Java Future containing the result of the DeleteEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deletePlatformApplication

default CompletableFuture<DeletePlatformApplicationResponse> deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

deletePlatformApplicationRequest - Input for DeletePlatformApplication action.

Returns:

A Java Future containing the result of the DeletePlatformApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteTopic

default CompletableFuture<DeleteTopicResponse> deleteTopic(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.

Parameters:

deleteTopicRequest -

Returns:

A Java Future containing the result of the DeleteTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getEndpointAttributes

default CompletableFuture<GetEndpointAttributesResponse> getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

getEndpointAttributesRequest - Input for GetEndpointAttributes action.

Returns:

A Java Future containing the result of the GetEndpointAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getPlatformApplicationAttributes

default CompletableFuture<GetPlatformApplicationAttributesResponse> getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.

Returns:

A Java Future containing the result of the GetPlatformApplicationAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getSMSAttributes

default CompletableFuture<GetSMSAttributesResponse> getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Parameters:

getSMSAttributesRequest - The input for the GetSMSAttributes request.

Returns:

A Java Future containing the result of the GetSMSAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getSubscriptionAttributes

default CompletableFuture<GetSubscriptionAttributesResponse> getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)

Returns all of the properties of a subscription.

Parameters:

getSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.

Returns:

A Java Future containing the result of the GetSubscriptionAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getTopicAttributes

default CompletableFuture<GetTopicAttributesResponse> getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

Parameters:

getTopicAttributesRequest - Input for GetTopicAttributes action.

Returns:

A Java Future containing the result of the GetTopicAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listEndpointsByPlatformApplication

default CompletableFuture<ListEndpointsByPlatformApplicationResponse> listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.

Returns:

A Java Future containing the result of the ListEndpointsByPlatformApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listPhoneNumbersOptedOut

default CompletableFuture<ListPhoneNumbersOptedOutResponse> listPhoneNumbersOptedOut(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.

Parameters:

listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.

Returns:

A Java Future containing the result of the ListPhoneNumbersOptedOut operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listPlatformApplications

default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)

Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

listPlatformApplicationsRequest - Input for ListPlatformApplications action.

Returns:

A Java Future containing the result of the ListPlatformApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSubscriptions

default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(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.

Parameters:

listSubscriptionsRequest - Input for ListSubscriptions action.

Returns:

A Java Future containing the result of the ListSubscriptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listSubscriptionsByTopic

default CompletableFuture<ListSubscriptionsByTopicResponse> listSubscriptionsByTopic(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.

Parameters:

listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.

Returns:

A Java Future containing the result of the ListSubscriptionsByTopic operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTopics

default CompletableFuture<ListTopicsResponse> listTopics(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.

Parameters:

listTopicsRequest -

Returns:

A Java Future containing the result of the ListTopics operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

optInPhoneNumber

default CompletableFuture<OptInPhoneNumberResponse> optInPhoneNumber(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.

Parameters:

optInPhoneNumberRequest - Input for the OptInPhoneNumber action.

Returns:

A Java Future containing the result of the OptInPhoneNumber operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

publish

default CompletableFuture<PublishResponse> publish(PublishRequest publishRequest)

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

Parameters:

publishRequest - Input for Publish action.

Returns:

A Java Future containing the result of the Publish operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InvalidParameterValueException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• EndpointDisabledException Exception error indicating endpoint disabled.
• PlatformApplicationDisabledException Exception error indicating platform application disabled.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removePermission

default CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)

Removes a statement from a topic's access control policy.

Parameters:

removePermissionRequest - Input for RemovePermission action.

Returns:

A Java Future containing the result of the RemovePermission operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setEndpointAttributes

default CompletableFuture<SetEndpointAttributesResponse> setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Parameters:

setEndpointAttributesRequest - Input for SetEndpointAttributes action.

Returns:

A Java Future containing the result of the SetEndpointAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setPlatformApplicationAttributes

default CompletableFuture<SetPlatformApplicationAttributesResponse> setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

Parameters:

setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.

Returns:

A Java Future containing the result of the SetPlatformApplicationAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setSMSAttributes

default CompletableFuture<SetSMSAttributesResponse> setSMSAttributes(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 Sending an SMS Message in the Amazon SNS Developer Guide.

Parameters:

setSMSAttributesRequest - The input for the SetSMSAttributes action.

Returns:

A Java Future containing the result of the SetSMSAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setSubscriptionAttributes

default CompletableFuture<SetSubscriptionAttributesResponse> setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)

Allows a subscription owner to set an attribute of the topic to a new value.

Parameters:

setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.

Returns:

A Java Future containing the result of the SetSubscriptionAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

setTopicAttributes

default CompletableFuture<SetTopicAttributesResponse> setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)

Allows a topic owner to set an attribute of the topic to a new value.

Parameters:

setTopicAttributesRequest - Input for SetTopicAttributes action.

Returns:

A Java Future containing the result of the SetTopicAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

subscribe

default CompletableFuture<SubscribeResponse> subscribe(SubscribeRequest subscribeRequest)

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

Parameters:

subscribeRequest - Input for Subscribe action.

Returns:

A Java Future containing the result of the Subscribe operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• SubscriptionLimitExceededException Indicates that the customer already owns the maximum allowed number of subscriptions.
• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• NotFoundException Indicates that the requested resource does not exist.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

unsubscribe

default CompletableFuture<UnsubscribeResponse> unsubscribe(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 AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

Parameters:

unsubscribeRequest - Input for Unsubscribe action.

Returns:

A Java Future containing the result of the Unsubscribe operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
• InternalErrorException Indicates an internal service error.
• AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
• NotFoundException Indicates that the requested resource does not exist.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• SNSException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation