Package software.amazon.sns

Class AmazonSNSExtendedClient

java.lang.Object
software.amazon.sns.AmazonSNSExtendedClient
All Implemented Interfaces:
com.amazonaws.services.sns.AmazonSNS
public class AmazonSNSExtendedClient extends Object

  • Field Summary

    Fields inherited from interface com.amazonaws.services.sns.AmazonSNS

    ENDPOINT_PREFIX

  • Constructor Summary

    Constructors
    Constructor
    Description
    AmazonSNSExtendedClient(com.amazonaws.services.sns.AmazonSNS snsClient, SNSExtendedClientConfiguration snsExtendedClientConfiguration)
    Constructs a new Amazon SNS extended client to invoke service methods on Amazon SNS with extended functionality using the specified Amazon SNS client object.
    AmazonSNSExtendedClient(com.amazonaws.services.sns.AmazonSNS snsClient, SNSExtendedClientConfiguration snsExtendedClientConfiguration, software.amazon.payloadoffloading.PayloadStore payloadStore)
    Constructs a new Amazon SNS extended client to invoke service methods on Amazon SNS with extended functionality using the specified Amazon SNS client object and Payload Store object.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.amazonaws.services.sns.model.AddPermissionResult
    addPermission(com.amazonaws.services.sns.model.AddPermissionRequest addPermissionRequest)
    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
    com.amazonaws.services.sns.model.AddPermissionResult
    addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
    Simplified method form for invoking the AddPermission operation.
    com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutResult
    checkIfPhoneNumberIsOptedOut(com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)
    Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
    com.amazonaws.services.sns.model.ConfirmSubscriptionResult
    confirmSubscription(com.amazonaws.services.sns.model.ConfirmSubscriptionRequest confirmSubscriptionRequest)
    Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
    com.amazonaws.services.sns.model.ConfirmSubscriptionResult
    confirmSubscription(String topicArn, String token)
    Simplified method form for invoking the ConfirmSubscription operation.
    com.amazonaws.services.sns.model.ConfirmSubscriptionResult
    confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe)
    Simplified method form for invoking the ConfirmSubscription operation.
    com.amazonaws.services.sns.model.CreatePlatformApplicationResult
    createPlatformApplication(com.amazonaws.services.sns.model.CreatePlatformApplicationRequest createPlatformApplicationRequest)
    Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register.
    com.amazonaws.services.sns.model.CreatePlatformEndpointResult
    createPlatformEndpoint(com.amazonaws.services.sns.model.CreatePlatformEndpointRequest createPlatformEndpointRequest)
    Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
    com.amazonaws.services.sns.model.CreateTopicResult
    createTopic(com.amazonaws.services.sns.model.CreateTopicRequest createTopicRequest)
    Creates a topic to which notifications can be published.
    com.amazonaws.services.sns.model.CreateTopicResult
    createTopic(String name)
    Simplified method form for invoking the CreateTopic operation.
    com.amazonaws.services.sns.model.DeleteEndpointResult
    deleteEndpoint(com.amazonaws.services.sns.model.DeleteEndpointRequest deleteEndpointRequest)
    Deletes the endpoint for a device and mobile app from Amazon SNS.
    com.amazonaws.services.sns.model.DeletePlatformApplicationResult
    deletePlatformApplication(com.amazonaws.services.sns.model.DeletePlatformApplicationRequest deletePlatformApplicationRequest)
    Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
    com.amazonaws.services.sns.model.DeleteTopicResult
    deleteTopic(com.amazonaws.services.sns.model.DeleteTopicRequest deleteTopicRequest)
    Deletes a topic and all its subscriptions.
    com.amazonaws.services.sns.model.DeleteTopicResult
    deleteTopic(String topicArn)
    Simplified method form for invoking the DeleteTopic operation.
    com.amazonaws.ResponseMetadata
    getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
    com.amazonaws.services.sns.model.GetEndpointAttributesResult
    getEndpointAttributes(com.amazonaws.services.sns.model.GetEndpointAttributesRequest getEndpointAttributesRequest)
    Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
    com.amazonaws.services.sns.model.GetPlatformApplicationAttributesResult
    getPlatformApplicationAttributes(com.amazonaws.services.sns.model.GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)
    Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
    com.amazonaws.services.sns.model.GetSMSAttributesResult
    getSMSAttributes(com.amazonaws.services.sns.model.GetSMSAttributesRequest getSMSAttributesRequest)
    Returns the settings for sending SMS messages from your account.
    com.amazonaws.services.sns.model.GetSubscriptionAttributesResult
    getSubscriptionAttributes(com.amazonaws.services.sns.model.GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
    Returns all of the properties of a subscription.
    com.amazonaws.services.sns.model.GetSubscriptionAttributesResult
    getSubscriptionAttributes(String subscriptionArn)
    Simplified method form for invoking the GetSubscriptionAttributes operation.
    com.amazonaws.services.sns.model.GetTopicAttributesResult
    getTopicAttributes(com.amazonaws.services.sns.model.GetTopicAttributesRequest getTopicAttributesRequest)
    Returns all of the properties of a topic.
    com.amazonaws.services.sns.model.GetTopicAttributesResult
    getTopicAttributes(String topicArn)
    Simplified method form for invoking the GetTopicAttributes operation.
    com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationResult
    listEndpointsByPlatformApplication(com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)
    Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
    com.amazonaws.services.sns.model.ListPhoneNumbersOptedOutResult
    listPhoneNumbersOptedOut(com.amazonaws.services.sns.model.ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)
    Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
    com.amazonaws.services.sns.model.ListPlatformApplicationsResult
    listPlatformApplications()
    Simplified method form for invoking the ListPlatformApplications operation.
    com.amazonaws.services.sns.model.ListPlatformApplicationsResult
    listPlatformApplications(com.amazonaws.services.sns.model.ListPlatformApplicationsRequest listPlatformApplicationsRequest)
    Lists the platform application objects for the supported push notification services, such as APNS and GCM.
    com.amazonaws.services.sns.model.ListSubscriptionsResult
    listSubscriptions()
    Simplified method form for invoking the ListSubscriptions operation.
    com.amazonaws.services.sns.model.ListSubscriptionsResult
    listSubscriptions(com.amazonaws.services.sns.model.ListSubscriptionsRequest listSubscriptionsRequest)
    Returns a list of the requester's subscriptions.
    com.amazonaws.services.sns.model.ListSubscriptionsResult
    listSubscriptions(String nextToken)
    Simplified method form for invoking the ListSubscriptions operation.
    com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult
    listSubscriptionsByTopic(com.amazonaws.services.sns.model.ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)
    Returns a list of the subscriptions to a specific topic.
    com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult
    listSubscriptionsByTopic(String topicArn)
    Simplified method form for invoking the ListSubscriptionsByTopic operation.
    com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult
    listSubscriptionsByTopic(String topicArn, String nextToken)
    Simplified method form for invoking the ListSubscriptionsByTopic operation.
    com.amazonaws.services.sns.model.ListTagsForResourceResult
    listTagsForResource(com.amazonaws.services.sns.model.ListTagsForResourceRequest request)
    List all tags added to the specified Amazon SNS topic.
    com.amazonaws.services.sns.model.ListTopicsResult
    listTopics()
    Simplified method form for invoking the ListTopics operation.
    com.amazonaws.services.sns.model.ListTopicsResult
    listTopics(com.amazonaws.services.sns.model.ListTopicsRequest listTopicsRequest)
    Returns a list of the requester's topics.
    com.amazonaws.services.sns.model.ListTopicsResult
    listTopics(String nextToken)
    Simplified method form for invoking the ListTopics operation.
    com.amazonaws.services.sns.model.OptInPhoneNumberResult
    optInPhoneNumber(com.amazonaws.services.sns.model.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.
    com.amazonaws.services.sns.model.PublishResult
    publish(com.amazonaws.services.sns.model.PublishRequest publishRequest)
    Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.
    com.amazonaws.services.sns.model.PublishResult
    publish(String topicArn, String message)
    Simplified method form for invoking the Publish operation.
    com.amazonaws.services.sns.model.PublishResult
    publish(String topicArn, String message, String subject)
    Simplified method form for invoking the Publish operation.
    com.amazonaws.services.sns.model.RemovePermissionResult
    removePermission(com.amazonaws.services.sns.model.RemovePermissionRequest removePermissionRequest)
    Removes a statement from a topic's access control policy.
    com.amazonaws.services.sns.model.RemovePermissionResult
    removePermission(String topicArn, String label)
    Simplified method form for invoking the RemovePermission operation.
    void
    setEndpoint(String endpoint)
    Deprecated.
    use AwsClientBuilder.setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    com.amazonaws.services.sns.model.SetEndpointAttributesResult
    setEndpointAttributes(com.amazonaws.services.sns.model.SetEndpointAttributesRequest setEndpointAttributesRequest)
    Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
    com.amazonaws.services.sns.model.SetPlatformApplicationAttributesResult
    setPlatformApplicationAttributes(com.amazonaws.services.sns.model.SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)
    Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
    void
    setRegion(com.amazonaws.regions.Region region)
    Deprecated.
    use AwsClientBuilder.setRegion(String)
    com.amazonaws.services.sns.model.SetSMSAttributesResult
    setSMSAttributes(com.amazonaws.services.sns.model.SetSMSAttributesRequest setSMSAttributesRequest)
    Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
    com.amazonaws.services.sns.model.SetSubscriptionAttributesResult
    setSubscriptionAttributes(com.amazonaws.services.sns.model.SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
    Allows a subscription owner to set an attribute of the subscription to a new value.
    com.amazonaws.services.sns.model.SetSubscriptionAttributesResult
    setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue)
    Simplified method form for invoking the SetSubscriptionAttributes operation.
    com.amazonaws.services.sns.model.SetTopicAttributesResult
    setTopicAttributes(com.amazonaws.services.sns.model.SetTopicAttributesRequest setTopicAttributesRequest)
    Allows a topic owner to set an attribute of the topic to a new value.
    com.amazonaws.services.sns.model.SetTopicAttributesResult
    setTopicAttributes(String topicArn, String attributeName, String attributeValue)
    Simplified method form for invoking the SetTopicAttributes operation.
    void
    shutdown()
    Shuts down this client object, releasing any resources that might be held open.
    com.amazonaws.services.sns.model.SubscribeResult
    subscribe(com.amazonaws.services.sns.model.SubscribeRequest subscribeRequest)
    Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
    com.amazonaws.services.sns.model.SubscribeResult
    subscribe(String topicArn, String protocol, String endpoint)
    Simplified method form for invoking the Subscribe operation.
    com.amazonaws.services.sns.model.TagResourceResult
    tagResource(com.amazonaws.services.sns.model.TagResourceRequest request)
    Add tags to the specified Amazon SNS topic.
    com.amazonaws.services.sns.model.UnsubscribeResult
    unsubscribe(com.amazonaws.services.sns.model.UnsubscribeRequest unsubscribeRequest)
    Deletes a subscription.
    com.amazonaws.services.sns.model.UnsubscribeResult
    unsubscribe(String subscriptionArn)
    Simplified method form for invoking the Unsubscribe operation.
    com.amazonaws.services.sns.model.UntagResourceResult
    untagResource(com.amazonaws.services.sns.model.UntagResourceRequest request)
    Remove tags from the specified Amazon SNS topic.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AmazonSNSExtendedClient

      public AmazonSNSExtendedClient(com.amazonaws.services.sns.AmazonSNS snsClient, SNSExtendedClientConfiguration snsExtendedClientConfiguration)
      Constructs a new Amazon SNS extended client to invoke service methods on Amazon SNS with extended functionality using the specified Amazon SNS client object.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      snsClient - The Amazon SNS client to use to connect to Amazon SNS.
      snsExtendedClientConfiguration - The sns extended client configuration options controlling the functionality of this client.

    • AmazonSNSExtendedClient

      public AmazonSNSExtendedClient(com.amazonaws.services.sns.AmazonSNS snsClient, SNSExtendedClientConfiguration snsExtendedClientConfiguration, software.amazon.payloadoffloading.PayloadStore payloadStore)
      Constructs a new Amazon SNS extended client to invoke service methods on Amazon SNS with extended functionality using the specified Amazon SNS client object and Payload Store object.

      All service calls made using this new client object are blocking, and will not return until the service call completes.

      Parameters:
      snsClient - The Amazon SNS client to use to connect to Amazon SNS.
      snsExtendedClientConfiguration - The sns extended client configuration options controlling the functionality of this client.
      payloadStore - The Payload Store that handles logic for saving to the desired extended storage.

  • Method Details

    • publish

      public com.amazonaws.services.sns.model.PublishResult publish(com.amazonaws.services.sns.model.PublishRequest publishRequest)

      Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.

      If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

      When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

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

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

      Specified by:
      publish in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      publishRequest - Input for Publish action.
      Returns:
      Result of the Publish operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InvalidParameterValueException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.EndpointDisabledException - Exception error indicating endpoint disabled.
      com.amazonaws.services.sns.model.PlatformApplicationDisabledException - Exception error indicating platform application disabled.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • publish

      public com.amazonaws.services.sns.model.PublishResult publish(String topicArn, String message)
      Simplified method form for invoking the Publish operation.
      Specified by:
      publish in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      message -
      See Also:

    • getEndpointAttributes

      public com.amazonaws.services.sns.model.GetEndpointAttributesResult getEndpointAttributes(com.amazonaws.services.sns.model.GetEndpointAttributesRequest getEndpointAttributesRequest)

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

      Specified by:
      getEndpointAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      getEndpointAttributesRequest - Input for GetEndpointAttributes action.
      Returns:
      Result of the GetEndpointAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • setEndpoint

      @Deprecated public void setEndpoint(String endpoint)
      Deprecated.
      use AwsClientBuilder.setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
      Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

      Callers can pass in just the endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

      For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

      This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Specified by:
      setEndpoint in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      endpoint - The endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

    • setRegion

      @Deprecated public void setRegion(com.amazonaws.regions.Region region)
      Deprecated.
      use AwsClientBuilder.setRegion(String)
      An alternative to AmazonSNS.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

      By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

      This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

      Specified by:
      setRegion in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      region - The region this client will communicate with. See Region.getRegion(Regions) for accessing a given region. Must not be null and must be a region where the service is available.
      See Also:
      • Region.getRegion(Regions)
      • Region.createClient(Class, AWSCredentialsProvider, ClientConfiguration)
      • Region.isServiceSupported(String)

    • addPermission

      public com.amazonaws.services.sns.model.AddPermissionResult addPermission(com.amazonaws.services.sns.model.AddPermissionRequest addPermissionRequest)

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

      Specified by:
      addPermission in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      addPermissionRequest -
      Returns:
      Result of the AddPermission operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • addPermission

      public com.amazonaws.services.sns.model.AddPermissionResult addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
      Simplified method form for invoking the AddPermission operation.
      Specified by:
      addPermission in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      label -
      aWSAccountIds -
      actionNames -
      See Also:
      • AmazonSNS.addPermission(AddPermissionRequest)

    • checkIfPhoneNumberIsOptedOut

      public com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(com.amazonaws.services.sns.model.CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)

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

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

      Specified by:
      checkIfPhoneNumberIsOptedOut in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      checkIfPhoneNumberIsOptedOutRequest - The input for the CheckIfPhoneNumberIsOptedOut action.
      Returns:
      Result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      See Also:

    • confirmSubscription

      public com.amazonaws.services.sns.model.ConfirmSubscriptionResult confirmSubscription(com.amazonaws.services.sns.model.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".

      Specified by:
      confirmSubscription in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      confirmSubscriptionRequest - Input for ConfirmSubscription action.
      Returns:
      Result of the ConfirmSubscription operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.SubscriptionLimitExceededException - Indicates that the customer already owns the maximum allowed number of subscriptions.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • confirmSubscription

      public com.amazonaws.services.sns.model.ConfirmSubscriptionResult confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe)
      Simplified method form for invoking the ConfirmSubscription operation.
      Specified by:
      confirmSubscription in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      token -
      authenticateOnUnsubscribe -
      See Also:
      • AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)

    • confirmSubscription

      public com.amazonaws.services.sns.model.ConfirmSubscriptionResult confirmSubscription(String topicArn, String token)
      Simplified method form for invoking the ConfirmSubscription operation.
      Specified by:
      confirmSubscription in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      token -
      See Also:
      • AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)

    • createPlatformApplication

      public com.amazonaws.services.sns.model.CreatePlatformApplicationResult createPlatformApplication(com.amazonaws.services.sns.model.CreatePlatformApplicationRequest createPlatformApplicationRequest)

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

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

      Specified by:
      createPlatformApplication in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      createPlatformApplicationRequest - Input for CreatePlatformApplication action.
      Returns:
      Result of the CreatePlatformApplication operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • createPlatformEndpoint

      public com.amazonaws.services.sns.model.CreatePlatformEndpointResult createPlatformEndpoint(com.amazonaws.services.sns.model.CreatePlatformEndpointRequest createPlatformEndpointRequest)

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

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

      Specified by:
      createPlatformEndpoint in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.
      Returns:
      Result of the CreatePlatformEndpoint operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • createTopic

      public com.amazonaws.services.sns.model.CreateTopicResult createTopic(com.amazonaws.services.sns.model.CreateTopicRequest createTopicRequest)

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

      Specified by:
      createTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      createTopicRequest - Input for CreateTopic action.
      Returns:
      Result of the CreateTopic operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.TopicLimitExceededException - Indicates that the customer already owns the maximum allowed number of topics.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • createTopic

      public com.amazonaws.services.sns.model.CreateTopicResult createTopic(String name)
      Simplified method form for invoking the CreateTopic operation.
      Specified by:
      createTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      name -
      See Also:
      • AmazonSNS.createTopic(CreateTopicRequest)

    • deleteEndpoint

      public com.amazonaws.services.sns.model.DeleteEndpointResult deleteEndpoint(com.amazonaws.services.sns.model.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.

      Specified by:
      deleteEndpoint in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      deleteEndpointRequest - Input for DeleteEndpoint action.
      Returns:
      Result of the DeleteEndpoint operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • deletePlatformApplication

      public com.amazonaws.services.sns.model.DeletePlatformApplicationResult deletePlatformApplication(com.amazonaws.services.sns.model.DeletePlatformApplicationRequest deletePlatformApplicationRequest)

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

      Specified by:
      deletePlatformApplication in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      deletePlatformApplicationRequest - Input for DeletePlatformApplication action.
      Returns:
      Result of the DeletePlatformApplication operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • deleteTopic

      public com.amazonaws.services.sns.model.DeleteTopicResult deleteTopic(com.amazonaws.services.sns.model.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.

      Specified by:
      deleteTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      deleteTopicRequest -
      Returns:
      Result of the DeleteTopic operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • deleteTopic

      public com.amazonaws.services.sns.model.DeleteTopicResult deleteTopic(String topicArn)
      Simplified method form for invoking the DeleteTopic operation.
      Specified by:
      deleteTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      See Also:
      • AmazonSNS.deleteTopic(DeleteTopicRequest)

    • getPlatformApplicationAttributes

      public com.amazonaws.services.sns.model.GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(com.amazonaws.services.sns.model.GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)

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

      Specified by:
      getPlatformApplicationAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.
      Returns:
      Result of the GetPlatformApplicationAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • getSMSAttributes

      public com.amazonaws.services.sns.model.GetSMSAttributesResult getSMSAttributes(com.amazonaws.services.sns.model.GetSMSAttributesRequest getSMSAttributesRequest)

      Returns the settings for sending SMS messages from your account.

      These settings are set with the SetSMSAttributes action.

      Specified by:
      getSMSAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      getSMSAttributesRequest - The input for the GetSMSAttributes request.
      Returns:
      Result of the GetSMSAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      See Also:

    • getSubscriptionAttributes

      public com.amazonaws.services.sns.model.GetSubscriptionAttributesResult getSubscriptionAttributes(com.amazonaws.services.sns.model.GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)

      Returns all of the properties of a subscription.

      Specified by:
      getSubscriptionAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      getSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.
      Returns:
      Result of the GetSubscriptionAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • getSubscriptionAttributes

      public com.amazonaws.services.sns.model.GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)
      Simplified method form for invoking the GetSubscriptionAttributes operation.
      Specified by:
      getSubscriptionAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      subscriptionArn -
      See Also:
      • AmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)

    • getTopicAttributes

      public com.amazonaws.services.sns.model.GetTopicAttributesResult getTopicAttributes(com.amazonaws.services.sns.model.GetTopicAttributesRequest getTopicAttributesRequest)

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

      Specified by:
      getTopicAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      getTopicAttributesRequest - Input for GetTopicAttributes action.
      Returns:
      Result of the GetTopicAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • getTopicAttributes

      public com.amazonaws.services.sns.model.GetTopicAttributesResult getTopicAttributes(String topicArn)
      Simplified method form for invoking the GetTopicAttributes operation.
      Specified by:
      getTopicAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      See Also:
      • AmazonSNS.getTopicAttributes(GetTopicAttributesRequest)

    • listEndpointsByPlatformApplication

      public com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(com.amazonaws.services.sns.model.ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)

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

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

      Specified by:
      listEndpointsByPlatformApplication in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.
      Returns:
      Result of the ListEndpointsByPlatformApplication operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • listPhoneNumbersOptedOut

      public com.amazonaws.services.sns.model.ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(com.amazonaws.services.sns.model.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.

      Specified by:
      listPhoneNumbersOptedOut in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.
      Returns:
      Result of the ListPhoneNumbersOptedOut operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      See Also:

    • listPlatformApplications

      public com.amazonaws.services.sns.model.ListPlatformApplicationsResult listPlatformApplications(com.amazonaws.services.sns.model.ListPlatformApplicationsRequest listPlatformApplicationsRequest)

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

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

      Specified by:
      listPlatformApplications in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listPlatformApplicationsRequest - Input for ListPlatformApplications action.
      Returns:
      Result of the ListPlatformApplications operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • listPlatformApplications

      public com.amazonaws.services.sns.model.ListPlatformApplicationsResult listPlatformApplications()
      Simplified method form for invoking the ListPlatformApplications operation.
      Specified by:
      listPlatformApplications in interface com.amazonaws.services.sns.AmazonSNS
      See Also:
      • AmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)

    • listSubscriptions

      public com.amazonaws.services.sns.model.ListSubscriptionsResult listSubscriptions(com.amazonaws.services.sns.model.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).

      Specified by:
      listSubscriptions in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listSubscriptionsRequest - Input for ListSubscriptions action.
      Returns:
      Result of the ListSubscriptions operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • listSubscriptions

      public com.amazonaws.services.sns.model.ListSubscriptionsResult listSubscriptions()
      Simplified method form for invoking the ListSubscriptions operation.
      Specified by:
      listSubscriptions in interface com.amazonaws.services.sns.AmazonSNS
      See Also:
      • AmazonSNS.listSubscriptions(ListSubscriptionsRequest)

    • listSubscriptions

      public com.amazonaws.services.sns.model.ListSubscriptionsResult listSubscriptions(String nextToken)
      Simplified method form for invoking the ListSubscriptions operation.
      Specified by:
      listSubscriptions in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      nextToken -
      See Also:
      • AmazonSNS.listSubscriptions(ListSubscriptionsRequest)

    • listSubscriptionsByTopic

      public com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult listSubscriptionsByTopic(com.amazonaws.services.sns.model.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).

      Specified by:
      listSubscriptionsByTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.
      Returns:
      Result of the ListSubscriptionsByTopic operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • listSubscriptionsByTopic

      public com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)
      Simplified method form for invoking the ListSubscriptionsByTopic operation.
      Specified by:
      listSubscriptionsByTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      See Also:
      • AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

    • listSubscriptionsByTopic

      public com.amazonaws.services.sns.model.ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn, String nextToken)
      Simplified method form for invoking the ListSubscriptionsByTopic operation.
      Specified by:
      listSubscriptionsByTopic in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      nextToken -
      See Also:
      • AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

    • listTopics

      public com.amazonaws.services.sns.model.ListTopicsResult listTopics(com.amazonaws.services.sns.model.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).

      Specified by:
      listTopics in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      listTopicsRequest -
      Returns:
      Result of the ListTopics operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • listTopics

      public com.amazonaws.services.sns.model.ListTopicsResult listTopics()
      Simplified method form for invoking the ListTopics operation.
      Specified by:
      listTopics in interface com.amazonaws.services.sns.AmazonSNS
      See Also:
      • AmazonSNS.listTopics(ListTopicsRequest)

    • listTopics

      public com.amazonaws.services.sns.model.ListTopicsResult listTopics(String nextToken)
      Simplified method form for invoking the ListTopics operation.
      Specified by:
      listTopics in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      nextToken -
      See Also:
      • AmazonSNS.listTopics(ListTopicsRequest)

    • optInPhoneNumber

      public com.amazonaws.services.sns.model.OptInPhoneNumberResult optInPhoneNumber(com.amazonaws.services.sns.model.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.

      Specified by:
      optInPhoneNumber in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      optInPhoneNumberRequest - Input for the OptInPhoneNumber action.
      Returns:
      Result of the OptInPhoneNumber operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      See Also:

    • publish

      public com.amazonaws.services.sns.model.PublishResult publish(String topicArn, String message, String subject)
      Simplified method form for invoking the Publish operation.
      Specified by:
      publish in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      message -
      subject -
      See Also:
      • AmazonSNS.publish(PublishRequest)

    • removePermission

      public com.amazonaws.services.sns.model.RemovePermissionResult removePermission(com.amazonaws.services.sns.model.RemovePermissionRequest removePermissionRequest)

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

      Specified by:
      removePermission in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      removePermissionRequest - Input for RemovePermission action.
      Returns:
      Result of the RemovePermission operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • removePermission

      public com.amazonaws.services.sns.model.RemovePermissionResult removePermission(String topicArn, String label)
      Simplified method form for invoking the RemovePermission operation.
      Specified by:
      removePermission in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      label -
      See Also:
      • AmazonSNS.removePermission(RemovePermissionRequest)

    • setEndpointAttributes

      public com.amazonaws.services.sns.model.SetEndpointAttributesResult setEndpointAttributes(com.amazonaws.services.sns.model.SetEndpointAttributesRequest setEndpointAttributesRequest)

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

      Specified by:
      setEndpointAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      setEndpointAttributesRequest - Input for SetEndpointAttributes action.
      Returns:
      Result of the SetEndpointAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • setPlatformApplicationAttributes

      public com.amazonaws.services.sns.model.SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(com.amazonaws.services.sns.model.SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)

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

      Specified by:
      setPlatformApplicationAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.
      Returns:
      Result of the SetPlatformApplicationAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • setSMSAttributes

      public com.amazonaws.services.sns.model.SetSMSAttributesResult setSMSAttributes(com.amazonaws.services.sns.model.SetSMSAttributesRequest setSMSAttributesRequest)

      Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

      You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.

      Specified by:
      setSMSAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      setSMSAttributesRequest - The input for the SetSMSAttributes action.
      Returns:
      Result of the SetSMSAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • setSubscriptionAttributes

      public com.amazonaws.services.sns.model.SetSubscriptionAttributesResult setSubscriptionAttributes(com.amazonaws.services.sns.model.SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)

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

      Specified by:
      setSubscriptionAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.
      Returns:
      Result of the SetSubscriptionAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.FilterPolicyLimitExceededException - Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the AWS Support Center.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • setSubscriptionAttributes

      public com.amazonaws.services.sns.model.SetSubscriptionAttributesResult setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue)
      Simplified method form for invoking the SetSubscriptionAttributes operation.
      Specified by:
      setSubscriptionAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      subscriptionArn -
      attributeName -
      attributeValue -
      See Also:
      • AmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)

    • setTopicAttributes

      public com.amazonaws.services.sns.model.SetTopicAttributesResult setTopicAttributes(com.amazonaws.services.sns.model.SetTopicAttributesRequest setTopicAttributesRequest)

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

      Specified by:
      setTopicAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      setTopicAttributesRequest - Input for SetTopicAttributes action.
      Returns:
      Result of the SetTopicAttributes operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • setTopicAttributes

      public com.amazonaws.services.sns.model.SetTopicAttributesResult setTopicAttributes(String topicArn, String attributeName, String attributeValue)
      Simplified method form for invoking the SetTopicAttributes operation.
      Specified by:
      setTopicAttributes in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      attributeName -
      attributeValue -
      See Also:
      • AmazonSNS.setTopicAttributes(SetTopicAttributesRequest)

    • subscribe

      public com.amazonaws.services.sns.model.SubscribeResult subscribe(com.amazonaws.services.sns.model.SubscribeRequest subscribeRequest)

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

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

      Specified by:
      subscribe in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      subscribeRequest - Input for Subscribe action.
      Returns:
      Result of the Subscribe operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.SubscriptionLimitExceededException - Indicates that the customer already owns the maximum allowed number of subscriptions.
      com.amazonaws.services.sns.model.FilterPolicyLimitExceededException - Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the AWS Support Center.
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      See Also:

    • subscribe

      public com.amazonaws.services.sns.model.SubscribeResult subscribe(String topicArn, String protocol, String endpoint)
      Simplified method form for invoking the Subscribe operation.
      Specified by:
      subscribe in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      topicArn -
      protocol -
      endpoint -
      See Also:
      • AmazonSNS.subscribe(SubscribeRequest)

    • unsubscribe

      public com.amazonaws.services.sns.model.UnsubscribeResult unsubscribe(com.amazonaws.services.sns.model.UnsubscribeRequest unsubscribeRequest)

      Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

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

      Specified by:
      unsubscribe in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      unsubscribeRequest - Input for Unsubscribe action.
      Returns:
      Result of the Unsubscribe operation returned by the service.
      Throws:
      com.amazonaws.services.sns.model.InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.
      com.amazonaws.services.sns.model.InternalErrorException - Indicates an internal service error.
      com.amazonaws.services.sns.model.AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.
      com.amazonaws.services.sns.model.NotFoundException - Indicates that the requested resource does not exist.
      See Also:

    • unsubscribe

      public com.amazonaws.services.sns.model.UnsubscribeResult unsubscribe(String subscriptionArn)
      Simplified method form for invoking the Unsubscribe operation.
      Specified by:
      unsubscribe in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      subscriptionArn -
      See Also:
      • AmazonSNS.unsubscribe(UnsubscribeRequest)

    • shutdown

      public void shutdown()
      Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      Specified by:
      shutdown in interface com.amazonaws.services.sns.AmazonSNS

    • getCachedResponseMetadata

      public com.amazonaws.ResponseMetadata getCachedResponseMetadata(com.amazonaws.AmazonWebServiceRequest request)
      Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

      Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

      Specified by:
      getCachedResponseMetadata in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.

    • listTagsForResource

      public com.amazonaws.services.sns.model.ListTagsForResourceResult listTagsForResource(com.amazonaws.services.sns.model.ListTagsForResourceRequest request)
      List all tags added to the specified Amazon SNS topic.
      Specified by:
      listTagsForResource in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      request - The originally executed request
      Returns:
      Result of the ListTagsForResource operation returned by the service

    • tagResource

      public com.amazonaws.services.sns.model.TagResourceResult tagResource(com.amazonaws.services.sns.model.TagResourceRequest request)
      Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
      Specified by:
      tagResource in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      request - The originally executed request
      Returns:
      Result of the TagResource operation returned by the service.

    • untagResource

      public com.amazonaws.services.sns.model.UntagResourceResult untagResource(com.amazonaws.services.sns.model.UntagResourceRequest request)
      Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
      Specified by:
      untagResource in interface com.amazonaws.services.sns.AmazonSNS
      Parameters:
      request - The originally executed request
      Returns:
      Result of the UntagResource operation returned by the service.