Interface SnsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SnsAsyncClient extends AwsClient
Service client for accessing Amazon SNS asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. 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.

  • Field Details

  • Method Details

    • addPermission

      default CompletableFuture<AddPermissionResponse> addPermission(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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • addPermission

      default CompletableFuture<AddPermissionResponse> addPermission(Consumer<AddPermissionRequest.Builder> 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.


      This is a convenience which creates an instance of the AddPermissionRequest.Builder avoiding the need to create one manually via AddPermissionRequest.builder()

      Parameters:
      addPermissionRequest - A Consumer that will call methods on AddPermissionRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • checkIfPhoneNumberIsOptedOut

      default CompletableFuture<CheckIfPhoneNumberIsOptedOutResponse> checkIfPhoneNumberIsOptedOut(Consumer<CheckIfPhoneNumberIsOptedOutRequest.Builder> 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.


      This is a convenience which creates an instance of the CheckIfPhoneNumberIsOptedOutRequest.Builder avoiding the need to create one manually via CheckIfPhoneNumberIsOptedOutRequest.builder()

      Parameters:
      checkIfPhoneNumberIsOptedOutRequest - A Consumer that will call methods on CheckIfPhoneNumberIsOptedOutRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • SdkException 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 type.
      See Also:

    • confirmSubscription

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


      This is a convenience which creates an instance of the ConfirmSubscriptionRequest.Builder avoiding the need to create one manually via ConfirmSubscriptionRequest.builder()

      Parameters:
      confirmSubscriptionRequest - A Consumer that will call methods on ConfirmSubscriptionRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • SdkException 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 type.
      See Also:

    • 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 (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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createPlatformApplication

      default CompletableFuture<CreatePlatformApplicationResponse> createPlatformApplication(Consumer<CreatePlatformApplicationRequest.Builder> 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.


      This is a convenience which creates an instance of the CreatePlatformApplicationRequest.Builder avoiding the need to create one manually via CreatePlatformApplicationRequest.builder()

      Parameters:
      createPlatformApplicationRequest - A Consumer that will call methods on CreatePlatformApplicationRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 (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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createPlatformEndpoint

      default CompletableFuture<CreatePlatformEndpointResponse> createPlatformEndpoint(Consumer<CreatePlatformEndpointRequest.Builder> 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.


      This is a convenience which creates an instance of the CreatePlatformEndpointRequest.Builder avoiding the need to create one manually via CreatePlatformEndpointRequest.builder()

      Parameters:
      createPlatformEndpointRequest - A Consumer that will call methods on CreatePlatformEndpointRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • createSMSSandboxPhoneNumber

      default CompletableFuture<CreateSmsSandboxPhoneNumberResponse> createSMSSandboxPhoneNumber(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.

      Parameters:
      createSmsSandboxPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the CreateSMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • OptedOutException Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.
      • UserErrorException 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 Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • createSMSSandboxPhoneNumber

      default CompletableFuture<CreateSmsSandboxPhoneNumberResponse> createSMSSandboxPhoneNumber(Consumer<CreateSmsSandboxPhoneNumberRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateSmsSandboxPhoneNumberRequest.Builder avoiding the need to create one manually via CreateSmsSandboxPhoneNumberRequest.builder()

      Parameters:
      createSmsSandboxPhoneNumberRequest - A Consumer that will call methods on CreateSmsSandboxPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • OptedOutException Indicates that the specified phone number opted out of receiving SMS messages from your Amazon Web Services account. You can't send SMS messages to phone numbers that opt out.
      • UserErrorException 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 Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • createTopic

      default CompletableFuture<CreateTopicResponse> createTopic(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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • createTopic

      default CompletableFuture<CreateTopicResponse> createTopic(Consumer<CreateTopicRequest.Builder> 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.


      This is a convenience which creates an instance of the CreateTopicRequest.Builder avoiding the need to create one manually via CreateTopicRequest.builder()

      Parameters:
      createTopicRequest - A Consumer that will call methods on CreateTopicRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteEndpoint

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


      This is a convenience which creates an instance of the DeleteEndpointRequest.Builder avoiding the need to create one manually via DeleteEndpointRequest.builder()

      Parameters:
      deleteEndpointRequest - A Consumer that will call methods on DeleteEndpointRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 (Firebase Cloud Messaging). 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deletePlatformApplication

      default CompletableFuture<DeletePlatformApplicationResponse> deletePlatformApplication(Consumer<DeletePlatformApplicationRequest.Builder> 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.


      This is a convenience which creates an instance of the DeletePlatformApplicationRequest.Builder avoiding the need to create one manually via DeletePlatformApplicationRequest.builder()

      Parameters:
      deletePlatformApplicationRequest - A Consumer that will call methods on DeletePlatformApplicationRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • deleteSMSSandboxPhoneNumber

      default CompletableFuture<DeleteSmsSandboxPhoneNumberResponse> deleteSMSSandboxPhoneNumber(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.

      Parameters:
      deleteSmsSandboxPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • UserErrorException 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 Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • deleteSMSSandboxPhoneNumber

      default CompletableFuture<DeleteSmsSandboxPhoneNumberResponse> deleteSMSSandboxPhoneNumber(Consumer<DeleteSmsSandboxPhoneNumberRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteSmsSandboxPhoneNumberRequest.Builder avoiding the need to create one manually via DeleteSmsSandboxPhoneNumberRequest.builder()

      Parameters:
      deleteSmsSandboxPhoneNumberRequest - A Consumer that will call methods on DeleteSmsSandboxPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • UserErrorException 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 Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • InvalidStateException Indicates that the specified state is not a valid state for an event source.
      • 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.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • deleteTopic

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


      This is a convenience which creates an instance of the DeleteTopicRequest.Builder avoiding the need to create one manually via DeleteTopicRequest.builder()

      Parameters:
      deleteTopicRequest - A Consumer that will call methods on DeleteTopicRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • InvalidStateException Indicates that the specified state is not a valid state for an event source.
      • 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.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • getDataProtectionPolicy

      default CompletableFuture<GetDataProtectionPolicyResponse> getDataProtectionPolicy(GetDataProtectionPolicyRequest getDataProtectionPolicyRequest)

      Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

      Parameters:
      getDataProtectionPolicyRequest -
      Returns:
      A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • getDataProtectionPolicy

      default CompletableFuture<GetDataProtectionPolicyResponse> getDataProtectionPolicy(Consumer<GetDataProtectionPolicyRequest.Builder> getDataProtectionPolicyRequest)

      Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.


      This is a convenience which creates an instance of the GetDataProtectionPolicyRequest.Builder avoiding the need to create one manually via GetDataProtectionPolicyRequest.builder()

      Parameters:
      getDataProtectionPolicyRequest - A Consumer that will call methods on GetDataProtectionPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataProtectionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • 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 (Firebase Cloud Messaging) 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • getEndpointAttributes

      default CompletableFuture<GetEndpointAttributesResponse> getEndpointAttributes(Consumer<GetEndpointAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the GetEndpointAttributesRequest.Builder avoiding the need to create one manually via GetEndpointAttributesRequest.builder()

      Parameters:
      getEndpointAttributesRequest - A Consumer that will call methods on GetEndpointAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 (Firebase Cloud Messaging). 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • getPlatformApplicationAttributes

      default CompletableFuture<GetPlatformApplicationAttributesResponse> getPlatformApplicationAttributes(Consumer<GetPlatformApplicationAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the GetPlatformApplicationAttributesRequest.Builder avoiding the need to create one manually via GetPlatformApplicationAttributesRequest.builder()

      Parameters:
      getPlatformApplicationAttributesRequest - A Consumer that will call methods on GetPlatformApplicationAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • getSMSAttributes

      default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes(GetSmsAttributesRequest getSmsAttributesRequest)

      Returns the settings for sending SMS messages from your Amazon Web Services 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • getSMSAttributes

      default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes(Consumer<GetSmsAttributesRequest.Builder> getSmsAttributesRequest)

      Returns the settings for sending SMS messages from your Amazon Web Services account.

      These settings are set with the SetSMSAttributes action.


      This is a convenience which creates an instance of the GetSmsAttributesRequest.Builder avoiding the need to create one manually via GetSmsAttributesRequest.builder()

      Parameters:
      getSmsAttributesRequest - A Consumer that will call methods on GetSmsAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • getSMSAttributes

      default CompletableFuture<GetSmsAttributesResponse> getSMSAttributes()

      Returns the settings for sending SMS messages from your Amazon Web Services account.

      These settings are set with the SetSMSAttributes action.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • getSMSSandboxAccountStatus

      default CompletableFuture<GetSmsSandboxAccountStatusResponse> getSMSSandboxAccountStatus(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.

      Parameters:
      getSmsSandboxAccountStatusRequest -
      Returns:
      A Java Future containing the result of the GetSMSSandboxAccountStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • getSMSSandboxAccountStatus

      default CompletableFuture<GetSmsSandboxAccountStatusResponse> getSMSSandboxAccountStatus(Consumer<GetSmsSandboxAccountStatusRequest.Builder> 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.


      This is a convenience which creates an instance of the GetSmsSandboxAccountStatusRequest.Builder avoiding the need to create one manually via GetSmsSandboxAccountStatusRequest.builder()

      Parameters:
      getSmsSandboxAccountStatusRequest - A Consumer that will call methods on GetSmsSandboxAccountStatusRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSMSSandboxAccountStatus operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • getSubscriptionAttributes

      default CompletableFuture<GetSubscriptionAttributesResponse> getSubscriptionAttributes(Consumer<GetSubscriptionAttributesRequest.Builder> getSubscriptionAttributesRequest)

      Returns all of the properties of a subscription.


      This is a convenience which creates an instance of the GetSubscriptionAttributesRequest.Builder avoiding the need to create one manually via GetSubscriptionAttributesRequest.builder()

      Parameters:
      getSubscriptionAttributesRequest - A Consumer that will call methods on GetSubscriptionAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • getTopicAttributes

      default CompletableFuture<GetTopicAttributesResponse> getTopicAttributes(Consumer<GetTopicAttributesRequest.Builder> getTopicAttributesRequest)

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


      This is a convenience which creates an instance of the GetTopicAttributesRequest.Builder avoiding the need to create one manually via GetTopicAttributesRequest.builder()

      Parameters:
      getTopicAttributesRequest - A Consumer that will call methods on GetTopicAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • listEndpointsByPlatformApplication

      default CompletableFuture<ListEndpointsByPlatformApplicationResponse> listEndpointsByPlatformApplication(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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listEndpointsByPlatformApplication

      default CompletableFuture<ListEndpointsByPlatformApplicationResponse> listEndpointsByPlatformApplication(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> 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).


      This is a convenience which creates an instance of the ListEndpointsByPlatformApplicationRequest.Builder avoiding the need to create one manually via ListEndpointsByPlatformApplicationRequest.builder()

      Parameters:
      listEndpointsByPlatformApplicationRequest - A Consumer that will call methods on ListEndpointsByPlatformApplicationRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listEndpointsByPlatformApplicationPaginator

      default ListEndpointsByPlatformApplicationPublisher listEndpointsByPlatformApplicationPaginator(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)

      This is a variant of listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest) operation.

      Parameters:
      listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listEndpointsByPlatformApplicationPaginator

      default ListEndpointsByPlatformApplicationPublisher listEndpointsByPlatformApplicationPaginator(Consumer<ListEndpointsByPlatformApplicationRequest.Builder> listEndpointsByPlatformApplicationRequest)

      This is a variant of listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListEndpointsByPlatformApplicationPublisher publisher = client.listEndpointsByPlatformApplicationPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listEndpointsByPlatformApplication(software.amazon.awssdk.services.sns.model.ListEndpointsByPlatformApplicationRequest) operation.


      This is a convenience which creates an instance of the ListEndpointsByPlatformApplicationRequest.Builder avoiding the need to create one manually via ListEndpointsByPlatformApplicationRequest.builder()

      Parameters:
      listEndpointsByPlatformApplicationRequest - A Consumer that will call methods on ListEndpointsByPlatformApplicationRequest.Builder to create a request. Input for ListEndpointsByPlatformApplication action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listOriginationNumbers

      default CompletableFuture<ListOriginationNumbersResponse> listOriginationNumbers(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.

      Parameters:
      listOriginationNumbersRequest -
      Returns:
      A Java Future containing the result of the ListOriginationNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • listOriginationNumbers

      default CompletableFuture<ListOriginationNumbersResponse> listOriginationNumbers(Consumer<ListOriginationNumbersRequest.Builder> 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.


      This is a convenience which creates an instance of the ListOriginationNumbersRequest.Builder avoiding the need to create one manually via ListOriginationNumbersRequest.builder()

      Parameters:
      listOriginationNumbersRequest - A Consumer that will call methods on ListOriginationNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListOriginationNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • listOriginationNumbersPaginator

      default ListOriginationNumbersPublisher listOriginationNumbersPaginator(ListOriginationNumbersRequest listOriginationNumbersRequest)

      This is a variant of listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersPublisher publisher = client.listOriginationNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersPublisher publisher = client.listOriginationNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest) operation.

      Parameters:
      listOriginationNumbersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • listOriginationNumbersPaginator

      default ListOriginationNumbersPublisher listOriginationNumbersPaginator(Consumer<ListOriginationNumbersRequest.Builder> listOriginationNumbersRequest)

      This is a variant of listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersPublisher publisher = client.listOriginationNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListOriginationNumbersPublisher publisher = client.listOriginationNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListOriginationNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listOriginationNumbers(software.amazon.awssdk.services.sns.model.ListOriginationNumbersRequest) operation.


      This is a convenience which creates an instance of the ListOriginationNumbersRequest.Builder avoiding the need to create one manually via ListOriginationNumbersRequest.builder()

      Parameters:
      listOriginationNumbersRequest - A Consumer that will call methods on ListOriginationNumbersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPhoneNumbersOptedOut

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


      This is a convenience which creates an instance of the ListPhoneNumbersOptedOutRequest.Builder avoiding the need to create one manually via ListPhoneNumbersOptedOutRequest.builder()

      Parameters:
      listPhoneNumbersOptedOutRequest - A Consumer that will call methods on ListPhoneNumbersOptedOutRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPhoneNumbersOptedOut

      default CompletableFuture<ListPhoneNumbersOptedOutResponse> listPhoneNumbersOptedOut()

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPhoneNumbersOptedOutPaginator

      default ListPhoneNumbersOptedOutPublisher listPhoneNumbersOptedOutPaginator()

      This is a variant of listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPhoneNumbersOptedOutPaginator

      default ListPhoneNumbersOptedOutPublisher listPhoneNumbersOptedOutPaginator(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)

      This is a variant of listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation.

      Parameters:
      listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPhoneNumbersOptedOutPaginator

      default ListPhoneNumbersOptedOutPublisher listPhoneNumbersOptedOutPaginator(Consumer<ListPhoneNumbersOptedOutRequest.Builder> listPhoneNumbersOptedOutRequest)

      This is a variant of listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPhoneNumbersOptedOutPublisher publisher = client.listPhoneNumbersOptedOutPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPhoneNumbersOptedOut(software.amazon.awssdk.services.sns.model.ListPhoneNumbersOptedOutRequest) operation.


      This is a convenience which creates an instance of the ListPhoneNumbersOptedOutRequest.Builder avoiding the need to create one manually via ListPhoneNumbersOptedOutRequest.builder()

      Parameters:
      listPhoneNumbersOptedOutRequest - A Consumer that will call methods on ListPhoneNumbersOptedOutRequest.Builder to create a request. The input for the ListPhoneNumbersOptedOut action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplications

      default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications(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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplications

      default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications(Consumer<ListPlatformApplicationsRequest.Builder> 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).


      This is a convenience which creates an instance of the ListPlatformApplicationsRequest.Builder avoiding the need to create one manually via ListPlatformApplicationsRequest.builder()

      Parameters:
      listPlatformApplicationsRequest - A Consumer that will call methods on ListPlatformApplicationsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplications

      default CompletableFuture<ListPlatformApplicationsResponse> listPlatformApplications()

      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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplicationsPaginator

      default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator()

      This is a variant of listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplicationsPaginator

      default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator(ListPlatformApplicationsRequest listPlatformApplicationsRequest)

      This is a variant of listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation.

      Parameters:
      listPlatformApplicationsRequest - Input for ListPlatformApplications action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listPlatformApplicationsPaginator

      default ListPlatformApplicationsPublisher listPlatformApplicationsPaginator(Consumer<ListPlatformApplicationsRequest.Builder> listPlatformApplicationsRequest)

      This is a variant of listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListPlatformApplicationsPublisher publisher = client.listPlatformApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformApplications(software.amazon.awssdk.services.sns.model.ListPlatformApplicationsRequest) operation.


      This is a convenience which creates an instance of the ListPlatformApplicationsRequest.Builder avoiding the need to create one manually via ListPlatformApplicationsRequest.builder()

      Parameters:
      listPlatformApplicationsRequest - A Consumer that will call methods on ListPlatformApplicationsRequest.Builder to create a request. Input for ListPlatformApplications action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSMSSandboxPhoneNumbers

      default CompletableFuture<ListSmsSandboxPhoneNumbersResponse> listSMSSandboxPhoneNumbers(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.

      Parameters:
      listSmsSandboxPhoneNumbersRequest -
      Returns:
      A Java Future containing the result of the ListSMSSandboxPhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • listSMSSandboxPhoneNumbers

      default CompletableFuture<ListSmsSandboxPhoneNumbersResponse> listSMSSandboxPhoneNumbers(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> 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.


      This is a convenience which creates an instance of the ListSmsSandboxPhoneNumbersRequest.Builder avoiding the need to create one manually via ListSmsSandboxPhoneNumbersRequest.builder()

      Parameters:
      listSmsSandboxPhoneNumbersRequest - A Consumer that will call methods on ListSmsSandboxPhoneNumbersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSMSSandboxPhoneNumbers operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • listSMSSandboxPhoneNumbersPaginator

      default ListSMSSandboxPhoneNumbersPublisher listSMSSandboxPhoneNumbersPaginator(ListSmsSandboxPhoneNumbersRequest listSmsSandboxPhoneNumbersRequest)

      This is a variant of listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersPublisher publisher = client.listSMSSandboxPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersPublisher publisher = client.listSMSSandboxPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest) operation.

      Parameters:
      listSmsSandboxPhoneNumbersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • listSMSSandboxPhoneNumbersPaginator

      default ListSMSSandboxPhoneNumbersPublisher listSMSSandboxPhoneNumbersPaginator(Consumer<ListSmsSandboxPhoneNumbersRequest.Builder> listSmsSandboxPhoneNumbersRequest)

      This is a variant of listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersPublisher publisher = client.listSMSSandboxPhoneNumbersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSMSSandboxPhoneNumbersPublisher publisher = client.listSMSSandboxPhoneNumbersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSMSSandboxPhoneNumbers(software.amazon.awssdk.services.sns.model.ListSmsSandboxPhoneNumbersRequest) operation.


      This is a convenience which creates an instance of the ListSmsSandboxPhoneNumbersRequest.Builder avoiding the need to create one manually via ListSmsSandboxPhoneNumbersRequest.builder()

      Parameters:
      listSmsSandboxPhoneNumbersRequest - A Consumer that will call methods on ListSmsSandboxPhoneNumbersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • 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.

      This action is throttled at 30 transactions per second (TPS).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions(Consumer<ListSubscriptionsRequest.Builder> 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).


      This is a convenience which creates an instance of the ListSubscriptionsRequest.Builder avoiding the need to create one manually via ListSubscriptionsRequest.builder()

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptions

      default CompletableFuture<ListSubscriptionsResponse> listSubscriptions()

      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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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.

      This action is throttled at 30 transactions per second (TPS).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsByTopic

      default CompletableFuture<ListSubscriptionsByTopicResponse> listSubscriptionsByTopic(Consumer<ListSubscriptionsByTopicRequest.Builder> 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).


      This is a convenience which creates an instance of the ListSubscriptionsByTopicRequest.Builder avoiding the need to create one manually via ListSubscriptionsByTopicRequest.builder()

      Parameters:
      listSubscriptionsByTopicRequest - A Consumer that will call methods on ListSubscriptionsByTopicRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsByTopicPaginator

      default ListSubscriptionsByTopicPublisher listSubscriptionsByTopicPaginator(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)

      This is a variant of listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest) operation.

      Parameters:
      listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsByTopicPaginator

      default ListSubscriptionsByTopicPublisher listSubscriptionsByTopicPaginator(Consumer<ListSubscriptionsByTopicRequest.Builder> listSubscriptionsByTopicRequest)

      This is a variant of listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsByTopicPublisher publisher = client.listSubscriptionsByTopicPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscriptionsByTopic(software.amazon.awssdk.services.sns.model.ListSubscriptionsByTopicRequest) operation.


      This is a convenience which creates an instance of the ListSubscriptionsByTopicRequest.Builder avoiding the need to create one manually via ListSubscriptionsByTopicRequest.builder()

      Parameters:
      listSubscriptionsByTopicRequest - A Consumer that will call methods on ListSubscriptionsByTopicRequest.Builder to create a request. Input for ListSubscriptionsByTopic action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator()

      This is a variant of listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(ListSubscriptionsRequest listSubscriptionsRequest)

      This is a variant of listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.

      Parameters:
      listSubscriptionsRequest - Input for ListSubscriptions action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listSubscriptionsPaginator

      default ListSubscriptionsPublisher listSubscriptionsPaginator(Consumer<ListSubscriptionsRequest.Builder> listSubscriptionsRequest)

      This is a variant of listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListSubscriptionsPublisher publisher = client.listSubscriptionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListSubscriptionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSubscriptions(software.amazon.awssdk.services.sns.model.ListSubscriptionsRequest) operation.


      This is a convenience which creates an instance of the ListSubscriptionsRequest.Builder avoiding the need to create one manually via ListSubscriptionsRequest.builder()

      Parameters:
      listSubscriptionsRequest - A Consumer that will call methods on ListSubscriptionsRequest.Builder to create a request. Input for ListSubscriptions action.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(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.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • 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.

      This action is throttled at 30 transactions per second (TPS).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTopics

      default CompletableFuture<ListTopicsResponse> listTopics(Consumer<ListTopicsRequest.Builder> 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).


      This is a convenience which creates an instance of the ListTopicsRequest.Builder avoiding the need to create one manually via ListTopicsRequest.builder()

      Parameters:
      listTopicsRequest - A Consumer that will call methods on ListTopicsRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTopics

      default CompletableFuture<ListTopicsResponse> listTopics()

      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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTopicsPaginator

      default ListTopicsPublisher listTopicsPaginator()

      This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTopicsPaginator

      default ListTopicsPublisher listTopicsPaginator(ListTopicsRequest listTopicsRequest)

      This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.

      Parameters:
      listTopicsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • listTopicsPaginator

      default ListTopicsPublisher listTopicsPaginator(Consumer<ListTopicsRequest.Builder> listTopicsRequest)

      This is a variant of listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.sns.paginators.ListTopicsPublisher publisher = client.listTopicsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sns.model.ListTopicsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.sns.model.ListTopicsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTopics(software.amazon.awssdk.services.sns.model.ListTopicsRequest) operation.


      This is a convenience which creates an instance of the ListTopicsRequest.Builder avoiding the need to create one manually via ListTopicsRequest.builder()

      Parameters:
      listTopicsRequest - A Consumer that will call methods on ListTopicsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • optInPhoneNumber

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


      This is a convenience which creates an instance of the OptInPhoneNumberRequest.Builder avoiding the need to create one manually via OptInPhoneNumberRequest.builder()

      Parameters:
      optInPhoneNumberRequest - A Consumer that will call methods on OptInPhoneNumberRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services 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.
      • SdkException 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 type.
      See Also:

    • publish

      default CompletableFuture<PublishResponse> publish(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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • KmsDisabledException The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
      • KmsInvalidStateException The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.
      • KmsNotFoundException The request was rejected because the specified entity or resource can't be found.
      • KmsOptInRequiredException The Amazon Web Services access key ID needs a subscription for the service.
      • KmsThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
      • KmsAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • publish

      default CompletableFuture<PublishResponse> publish(Consumer<PublishRequest.Builder> 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.


      This is a convenience which creates an instance of the PublishRequest.Builder avoiding the need to create one manually via PublishRequest.builder()

      Parameters:
      publishRequest - A Consumer that will call methods on PublishRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • KmsDisabledException The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
      • KmsInvalidStateException The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.
      • KmsNotFoundException The request was rejected because the specified entity or resource can't be found.
      • KmsOptInRequiredException The Amazon Web Services access key ID needs a subscription for the service.
      • KmsThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
      • KmsAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • publishBatch

      default CompletableFuture<PublishBatchResponse> publishBatch(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.

      Parameters:
      publishBatchRequest -
      Returns:
      A Java Future containing the result of the PublishBatch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
      • BatchRequestTooLongException The length of all the batch messages put together is more than the limit.
      • EmptyBatchRequestException The batch request doesn't contain any entries.
      • InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
      • TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
      • KmsDisabledException The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
      • KmsInvalidStateException The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.
      • KmsNotFoundException The request was rejected because the specified entity or resource can't be found.
      • KmsOptInRequiredException The Amazon Web Services access key ID needs a subscription for the service.
      • KmsThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
      • KmsAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • publishBatch

      default CompletableFuture<PublishBatchResponse> publishBatch(Consumer<PublishBatchRequest.Builder> 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.


      This is a convenience which creates an instance of the PublishBatchRequest.Builder avoiding the need to create one manually via PublishBatchRequest.builder()

      Parameters:
      publishBatchRequest - A Consumer that will call methods on PublishBatchRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PublishBatch operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • BatchEntryIdsNotDistinctException Two or more batch entries in the request have the same Id.
      • BatchRequestTooLongException The length of all the batch messages put together is more than the limit.
      • EmptyBatchRequestException The batch request doesn't contain any entries.
      • InvalidBatchEntryIdException The Id of a batch entry in a batch request doesn't abide by the specification.
      • TooManyEntriesInBatchRequestException The batch request contains more entries than permissible.
      • KmsDisabledException The request was rejected because the specified Amazon Web Services KMS key isn't enabled.
      • KmsInvalidStateException The request was rejected because the state of the specified resource isn't valid for this request. For more information, see Key states of Amazon Web Services KMS keys in the Key Management Service Developer Guide.
      • KmsNotFoundException The request was rejected because the specified entity or resource can't be found.
      • KmsOptInRequiredException The Amazon Web Services access key ID needs a subscription for the service.
      • KmsThrottlingException The request was denied due to request throttling. For more information about throttling, see Limits in the Key Management Service Developer Guide.
      • KmsAccessDeniedException The ciphertext references a key that doesn't exist or that you don't have access to.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • ValidationException Indicates that a parameter in the request is invalid.
      • SdkException 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 type.
      See Also:

    • putDataProtectionPolicy

      default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(PutDataProtectionPolicyRequest putDataProtectionPolicyRequest)

      Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

      Parameters:
      putDataProtectionPolicyRequest -
      Returns:
      A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • putDataProtectionPolicy

      default CompletableFuture<PutDataProtectionPolicyResponse> putDataProtectionPolicy(Consumer<PutDataProtectionPolicyRequest.Builder> putDataProtectionPolicyRequest)

      Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.


      This is a convenience which creates an instance of the PutDataProtectionPolicyRequest.Builder avoiding the need to create one manually via PutDataProtectionPolicyRequest.builder()

      Parameters:
      putDataProtectionPolicyRequest - A Consumer that will call methods on PutDataProtectionPolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutDataProtectionPolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • removePermission

      default CompletableFuture<RemovePermissionResponse> removePermission(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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • removePermission

      default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> 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.


      This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need to create one manually via RemovePermissionRequest.builder()

      Parameters:
      removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 (Firebase Cloud Messaging) 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • setEndpointAttributes

      default CompletableFuture<SetEndpointAttributesResponse> setEndpointAttributes(Consumer<SetEndpointAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the SetEndpointAttributesRequest.Builder avoiding the need to create one manually via SetEndpointAttributesRequest.builder()

      Parameters:
      setEndpointAttributesRequest - A Consumer that will call methods on SetEndpointAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 (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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • setPlatformApplicationAttributes

      default CompletableFuture<SetPlatformApplicationAttributesResponse> setPlatformApplicationAttributes(Consumer<SetPlatformApplicationAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the SetPlatformApplicationAttributesRequest.Builder avoiding the need to create one manually via SetPlatformApplicationAttributesRequest.builder()

      Parameters:
      setPlatformApplicationAttributesRequest - A Consumer that will call methods on SetPlatformApplicationAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException 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 type.
      See Also:

    • 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 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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Amazon Web Services account.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • SdkException 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 type.
      See Also:

    • setSMSAttributes

      default CompletableFuture<SetSmsAttributesResponse> setSMSAttributes(Consumer<SetSmsAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the SetSmsAttributesRequest.Builder avoiding the need to create one manually via SetSmsAttributesRequest.builder()

      Parameters:
      setSmsAttributesRequest - A Consumer that will call methods on SetSmsAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 Amazon Web Services account.
      • InternalErrorException Indicates an internal service error.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • SdkException 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 type.
      See Also:

    • setSubscriptionAttributes

      default CompletableFuture<SetSubscriptionAttributesResponse> setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)

      Allows a subscription owner to set an attribute of the subscription 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • 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.
      • SdkException 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 type.
      See Also:

    • setSubscriptionAttributes

      default CompletableFuture<SetSubscriptionAttributesResponse> setSubscriptionAttributes(Consumer<SetSubscriptionAttributesRequest.Builder> setSubscriptionAttributesRequest)

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


      This is a convenience which creates an instance of the SetSubscriptionAttributesRequest.Builder avoiding the need to create one manually via SetSubscriptionAttributesRequest.builder()

      Parameters:
      setSubscriptionAttributesRequest - A Consumer that will call methods on SetSubscriptionAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • 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.
      • SdkException 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 type.
      See Also:

    • setTopicAttributes

      default CompletableFuture<SetTopicAttributesResponse> setTopicAttributes(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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • setTopicAttributes

      default CompletableFuture<SetTopicAttributesResponse> setTopicAttributes(Consumer<SetTopicAttributesRequest.Builder> 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.


      This is a convenience which creates an instance of the SetTopicAttributesRequest.Builder avoiding the need to create one manually via SetTopicAttributesRequest.builder()

      Parameters:
      setTopicAttributesRequest - A Consumer that will call methods on SetTopicAttributesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • subscribe

      default CompletableFuture<SubscribeResponse> subscribe(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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubscriptionLimitExceededException Indicates that the customer already owns the maximum allowed number of subscriptions.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • subscribe

      default CompletableFuture<SubscribeResponse> subscribe(Consumer<SubscribeRequest.Builder> 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).


      This is a convenience which creates an instance of the SubscribeRequest.Builder avoiding the need to create one manually via SubscribeRequest.builder()

      Parameters:
      subscribeRequest - A Consumer that will call methods on SubscribeRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • SubscriptionLimitExceededException Indicates that the customer already owns the maximum allowed number of subscriptions.
      • FilterPolicyLimitExceededException Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.
      • ReplayLimitExceededException Indicates that the request parameter has exceeded the maximum number of concurrent message replays.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(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.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> 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.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • 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 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).

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • unsubscribe

      default CompletableFuture<UnsubscribeResponse> unsubscribe(Consumer<UnsubscribeRequest.Builder> 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).


      This is a convenience which creates an instance of the UnsubscribeRequest.Builder avoiding the need to create one manually via UnsubscribeRequest.builder()

      Parameters:
      unsubscribeRequest - A Consumer that will call methods on UnsubscribeRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidSecurityException The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.
      • SdkException 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 type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • TagLimitExceededException Can't add more than 50 tags to a topic.
      • StaleTagException A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
      • TagPolicyException The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • ConcurrentAccessException Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
      • SdkException 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 type.
      See Also:

    • verifySMSSandboxPhoneNumber

      default CompletableFuture<VerifySmsSandboxPhoneNumberResponse> verifySMSSandboxPhoneNumber(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.

      Parameters:
      verifySmsSandboxPhoneNumberRequest -
      Returns:
      A Java Future containing the result of the VerifySMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • VerificationException Indicates that the one-time password (OTP) used for verification is invalid.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • verifySMSSandboxPhoneNumber

      default CompletableFuture<VerifySmsSandboxPhoneNumberResponse> verifySMSSandboxPhoneNumber(Consumer<VerifySmsSandboxPhoneNumberRequest.Builder> 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.


      This is a convenience which creates an instance of the VerifySmsSandboxPhoneNumberRequest.Builder avoiding the need to create one manually via VerifySmsSandboxPhoneNumberRequest.builder()

      Parameters:
      verifySmsSandboxPhoneNumberRequest - A Consumer that will call methods on VerifySmsSandboxPhoneNumberRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifySMSSandboxPhoneNumber operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
      • InternalErrorException Indicates an internal service error.
      • InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
      • ResourceNotFoundException Can’t perform the action on the specified resource. Make sure that the resource exists.
      • VerificationException Indicates that the one-time password (OTP) used for verification is invalid.
      • ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.
      • SdkException 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 type.
      See Also:

    • serviceClientConfiguration

      default SnsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • 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.