com.amazonaws.services.sns

Class AmazonSNSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.sns.AmazonSNSClient

All Implemented Interfaces:

AmazonSNS

Direct Known Subclasses:

AmazonSNSAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonSNSClient
extends AmazonWebServiceClient
implements AmazonSNS

Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all modeled exceptions

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonSNSClient() Deprecated. use AmazonSNSClientBuilder.defaultClient()
AmazonSNSClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonSNSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AmazonSNSClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddPermissionResult	addPermission(AddPermissionRequest request) Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
AddPermissionResult	addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames) Simplified method form for invoking the AddPermission operation.
static AmazonSNSClientBuilder	builder()
CheckIfPhoneNumberIsOptedOutResult	checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request) Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
ConfirmSubscriptionResult	confirmSubscription(ConfirmSubscriptionRequest request) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
ConfirmSubscriptionResult	confirmSubscription(String topicArn, String token) Simplified method form for invoking the ConfirmSubscription operation.
ConfirmSubscriptionResult	confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe) Simplified method form for invoking the ConfirmSubscription operation.
CreatePlatformApplicationResult	createPlatformApplication(CreatePlatformApplicationRequest request) 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.
CreatePlatformEndpointResult	createPlatformEndpoint(CreatePlatformEndpointRequest request) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
CreateTopicResult	createTopic(CreateTopicRequest request) Creates a topic to which notifications can be published.
CreateTopicResult	createTopic(String name) Simplified method form for invoking the CreateTopic operation.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest request) Deletes the endpoint for a device and mobile app from Amazon SNS.
DeletePlatformApplicationResult	deletePlatformApplication(DeletePlatformApplicationRequest request) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
DeleteTopicResult	deleteTopic(DeleteTopicRequest request) Deletes a topic and all its subscriptions.
DeleteTopicResult	deleteTopic(String topicArn) Simplified method form for invoking the DeleteTopic operation.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetEndpointAttributesResult	getEndpointAttributes(GetEndpointAttributesRequest request) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
GetPlatformApplicationAttributesResult	getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
GetSMSAttributesResult	getSMSAttributes(GetSMSAttributesRequest request) Returns the settings for sending SMS messages from your account.
GetSubscriptionAttributesResult	getSubscriptionAttributes(GetSubscriptionAttributesRequest request) Returns all of the properties of a subscription.
GetSubscriptionAttributesResult	getSubscriptionAttributes(String subscriptionArn) Simplified method form for invoking the GetSubscriptionAttributes operation.
GetTopicAttributesResult	getTopicAttributes(GetTopicAttributesRequest request) Returns all of the properties of a topic.
GetTopicAttributesResult	getTopicAttributes(String topicArn) Simplified method form for invoking the GetTopicAttributes operation.
ListEndpointsByPlatformApplicationResult	listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
ListPhoneNumbersOptedOutResult	listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request) Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
ListPlatformApplicationsResult	listPlatformApplications() Simplified method form for invoking the ListPlatformApplications operation.
ListPlatformApplicationsResult	listPlatformApplications(ListPlatformApplicationsRequest request) Lists the platform application objects for the supported push notification services, such as APNS and GCM.
ListSubscriptionsResult	listSubscriptions() Simplified method form for invoking the ListSubscriptions operation.
ListSubscriptionsResult	listSubscriptions(ListSubscriptionsRequest request) Returns a list of the requester's subscriptions.
ListSubscriptionsResult	listSubscriptions(String nextToken) Simplified method form for invoking the ListSubscriptions operation.
ListSubscriptionsByTopicResult	listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request) Returns a list of the subscriptions to a specific topic.
ListSubscriptionsByTopicResult	listSubscriptionsByTopic(String topicArn) Simplified method form for invoking the ListSubscriptionsByTopic operation.
ListSubscriptionsByTopicResult	listSubscriptionsByTopic(String topicArn, String nextToken) Simplified method form for invoking the ListSubscriptionsByTopic operation.
ListTopicsResult	listTopics() Simplified method form for invoking the ListTopics operation.
ListTopicsResult	listTopics(ListTopicsRequest request) Returns a list of the requester's topics.
ListTopicsResult	listTopics(String nextToken) Simplified method form for invoking the ListTopics operation.
OptInPhoneNumberResult	optInPhoneNumber(OptInPhoneNumberRequest request) Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
PublishResult	publish(PublishRequest request) Sends a message to all of a topic's subscribed endpoints.
PublishResult	publish(String topicArn, String message) Simplified method form for invoking the Publish operation.
PublishResult	publish(String topicArn, String message, String subject) Simplified method form for invoking the Publish operation.
RemovePermissionResult	removePermission(RemovePermissionRequest request) Removes a statement from a topic's access control policy.
RemovePermissionResult	removePermission(String topicArn, String label) Simplified method form for invoking the RemovePermission operation.
SetEndpointAttributesResult	setEndpointAttributes(SetEndpointAttributesRequest request) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
SetPlatformApplicationAttributesResult	setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
SetSMSAttributesResult	setSMSAttributes(SetSMSAttributesRequest request) Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
SetSubscriptionAttributesResult	setSubscriptionAttributes(SetSubscriptionAttributesRequest request) Allows a subscription owner to set an attribute of the topic to a new value.
SetSubscriptionAttributesResult	setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue) Simplified method form for invoking the SetSubscriptionAttributes operation.
SetTopicAttributesResult	setTopicAttributes(SetTopicAttributesRequest request) Allows a topic owner to set an attribute of the topic to a new value.
SetTopicAttributesResult	setTopicAttributes(String topicArn, String attributeName, String attributeValue) Simplified method form for invoking the SetTopicAttributes operation.
SubscribeResult	subscribe(String topicArn, String protocol, String endpoint) Simplified method form for invoking the Subscribe operation.
SubscribeResult	subscribe(SubscribeRequest request) Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
UnsubscribeResult	unsubscribe(String subscriptionArn) Simplified method form for invoking the Unsubscribe operation.
UnsubscribeResult	unsubscribe(UnsubscribeRequest request) Deletes a subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all modeled exceptions

Constructor Detail

AmazonSNSClient

@Deprecated
public AmazonSNSClient()

Deprecated. use AmazonSNSClientBuilder.defaultClient()

Constructs a new client to invoke service methods on Amazon SNS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonSNSClient

@Deprecated
public AmazonSNSClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon SNS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonSNSClient

@Deprecated
public AmazonSNSClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonSNSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials.

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

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonSNSClient

@Deprecated
public AmazonSNSClient(AWSCredentials awsCredentials,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials and client configuration options.

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

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).

AmazonSNSClient

@Deprecated
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider.

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

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonSNSClient

@Deprecated
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider and client configuration options.

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

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).

AmazonSNSClient

@Deprecated
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
                                   ClientConfiguration clientConfiguration,
                                   RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider, client configuration options, and request metric collector.

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

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AmazonSNSClientBuilder builder()

addPermission

public AddPermissionResult addPermission(AddPermissionRequest request)

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 AmazonSNS

Parameters:

addPermissionRequest -

Returns:

Result of the AddPermission operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

addPermission

public AddPermissionResult addPermission(String topicArn,
                                         String label,
                                         List<String> aWSAccountIds,
                                         List<String> actionNames)

Description copied from interface: AmazonSNS

Simplified method form for invoking the AddPermission operation.

Specified by:

addPermission in interface AmazonSNS

See Also:

AmazonSNS.addPermission(AddPermissionRequest)

checkIfPhoneNumberIsOptedOut

public CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)

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 AmazonSNS

Parameters:

checkIfPhoneNumberIsOptedOutRequest - The input for the CheckIfPhoneNumberIsOptedOut action.

Returns:

Result of the CheckIfPhoneNumberIsOptedOut operation returned by the service.

Throws:

ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

InternalErrorException - Indicates an internal service error.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

See Also:

AWS API Documentation

confirmSubscription

public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest request)

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 AmazonSNS

Parameters:

confirmSubscriptionRequest - Input for ConfirmSubscription action.

Returns:

Result of the ConfirmSubscription operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

confirmSubscription

public ConfirmSubscriptionResult confirmSubscription(String topicArn,
                                                     String token,
                                                     String authenticateOnUnsubscribe)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ConfirmSubscription operation.

Specified by:

confirmSubscription in interface AmazonSNS

See Also:

AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)

confirmSubscription

public ConfirmSubscriptionResult confirmSubscription(String topicArn,
                                                     String token)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ConfirmSubscription operation.

Specified by:

confirmSubscription in interface AmazonSNS

See Also:

AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)

createPlatformApplication

public CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest request)

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 AmazonSNS

Parameters:

createPlatformApplicationRequest - Input for CreatePlatformApplication action.

Returns:

Result of the CreatePlatformApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createPlatformEndpoint

public CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest request)

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 AmazonSNS

Parameters:

createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.

Returns:

Result of the CreatePlatformEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTopic

public CreateTopicResult createTopic(CreateTopicRequest request)

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 AmazonSNS

Parameters:

createTopicRequest - Input for CreateTopic action.

Returns:

Result of the CreateTopic operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createTopic

public CreateTopicResult createTopic(String name)

Description copied from interface: AmazonSNS

Simplified method form for invoking the CreateTopic operation.

Specified by:

createTopic in interface AmazonSNS

See Also:

AmazonSNS.createTopic(CreateTopicRequest)

deleteEndpoint

public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)

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 AmazonSNS

Parameters:

deleteEndpointRequest - Input for DeleteEndpoint action.

Returns:

Result of the DeleteEndpoint operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deletePlatformApplication

public DeletePlatformApplicationResult deletePlatformApplication(DeletePlatformApplicationRequest request)

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 AmazonSNS

Parameters:

deletePlatformApplicationRequest - Input for DeletePlatformApplication action.

Returns:

Result of the DeletePlatformApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTopic

public DeleteTopicResult deleteTopic(DeleteTopicRequest request)

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 AmazonSNS

Parameters:

deleteTopicRequest -

Returns:

Result of the DeleteTopic operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteTopic

public DeleteTopicResult deleteTopic(String topicArn)

Description copied from interface: AmazonSNS

Simplified method form for invoking the DeleteTopic operation.

Specified by:

deleteTopic in interface AmazonSNS

See Also:

AmazonSNS.deleteTopic(DeleteTopicRequest)

getEndpointAttributes

public GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest request)

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 AmazonSNS

Parameters:

getEndpointAttributesRequest - Input for GetEndpointAttributes action.

Returns:

Result of the GetEndpointAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getPlatformApplicationAttributes

public GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)

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 AmazonSNS

Parameters:

getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.

Returns:

Result of the GetPlatformApplicationAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSMSAttributes

public GetSMSAttributesResult getSMSAttributes(GetSMSAttributesRequest request)

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Specified by:

getSMSAttributes in interface AmazonSNS

Parameters:

getSMSAttributesRequest - The input for the GetSMSAttributes request.

Returns:

Result of the GetSMSAttributes operation returned by the service.

Throws:

ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

InternalErrorException - Indicates an internal service error.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

See Also:

AWS API Documentation

getSubscriptionAttributes

public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest request)

Returns all of the properties of a subscription.

Specified by:

getSubscriptionAttributes in interface AmazonSNS

Parameters:

getSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.

Returns:

Result of the GetSubscriptionAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getSubscriptionAttributes

public GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)

Description copied from interface: AmazonSNS

Simplified method form for invoking the GetSubscriptionAttributes operation.

Specified by:

getSubscriptionAttributes in interface AmazonSNS

See Also:

AmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)

getTopicAttributes

public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest request)

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 AmazonSNS

Parameters:

getTopicAttributesRequest - Input for GetTopicAttributes action.

Returns:

Result of the GetTopicAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTopicAttributes

public GetTopicAttributesResult getTopicAttributes(String topicArn)

Description copied from interface: AmazonSNS

Simplified method form for invoking the GetTopicAttributes operation.

Specified by:

getTopicAttributes in interface AmazonSNS

See Also:

AmazonSNS.getTopicAttributes(GetTopicAttributesRequest)

listEndpointsByPlatformApplication

public ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)

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.

Specified by:

listEndpointsByPlatformApplication in interface AmazonSNS

Parameters:

listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.

Returns:

Result of the ListEndpointsByPlatformApplication operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPhoneNumbersOptedOut

public ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request)

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 AmazonSNS

Parameters:

listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.

Returns:

Result of the ListPhoneNumbersOptedOut operation returned by the service.

Throws:

ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

InternalErrorException - Indicates an internal service error.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

See Also:

AWS API Documentation

listPlatformApplications

public ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest request)

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.

Specified by:

listPlatformApplications in interface AmazonSNS

Parameters:

listPlatformApplicationsRequest - Input for ListPlatformApplications action.

Returns:

Result of the ListPlatformApplications operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listPlatformApplications

public ListPlatformApplicationsResult listPlatformApplications()

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListPlatformApplications operation.

Specified by:

listPlatformApplications in interface AmazonSNS

See Also:

AmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)

listSubscriptions

public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest request)

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.

Specified by:

listSubscriptions in interface AmazonSNS

Parameters:

listSubscriptionsRequest - Input for ListSubscriptions action.

Returns:

Result of the ListSubscriptions operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSubscriptions

public ListSubscriptionsResult listSubscriptions()

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListSubscriptions operation.

Specified by:

listSubscriptions in interface AmazonSNS

See Also:

AmazonSNS.listSubscriptions(ListSubscriptionsRequest)

listSubscriptions

public ListSubscriptionsResult listSubscriptions(String nextToken)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListSubscriptions operation.

Specified by:

listSubscriptions in interface AmazonSNS

See Also:

AmazonSNS.listSubscriptions(ListSubscriptionsRequest)

listSubscriptionsByTopic

public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)

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.

Specified by:

listSubscriptionsByTopic in interface AmazonSNS

Parameters:

listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.

Returns:

Result of the ListSubscriptionsByTopic operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listSubscriptionsByTopic

public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListSubscriptionsByTopic operation.

Specified by:

listSubscriptionsByTopic in interface AmazonSNS

See Also:

AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

listSubscriptionsByTopic

public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn,
                                                               String nextToken)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListSubscriptionsByTopic operation.

Specified by:

listSubscriptionsByTopic in interface AmazonSNS

See Also:

AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

listTopics

public ListTopicsResult listTopics(ListTopicsRequest request)

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.

Specified by:

listTopics in interface AmazonSNS

Parameters:

listTopicsRequest -

Returns:

Result of the ListTopics operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listTopics

public ListTopicsResult listTopics()

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListTopics operation.

Specified by:

listTopics in interface AmazonSNS

See Also:

AmazonSNS.listTopics(ListTopicsRequest)

listTopics

public ListTopicsResult listTopics(String nextToken)

Description copied from interface: AmazonSNS

Simplified method form for invoking the ListTopics operation.

Specified by:

listTopics in interface AmazonSNS

See Also:

AmazonSNS.listTopics(ListTopicsRequest)

optInPhoneNumber

public OptInPhoneNumberResult optInPhoneNumber(OptInPhoneNumberRequest request)

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

Specified by:

optInPhoneNumber in interface AmazonSNS

Parameters:

optInPhoneNumberRequest - Input for the OptInPhoneNumber action.

Returns:

Result of the OptInPhoneNumber operation returned by the service.

Throws:

ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

InternalErrorException - Indicates an internal service error.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

See Also:

AWS API Documentation

publish

public PublishResult publish(PublishRequest request)

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

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

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

Specified by:

publish in interface AmazonSNS

Parameters:

publishRequest - Input for Publish action.

Returns:

Result of the Publish operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

publish

public PublishResult publish(String topicArn,
                             String message)

Description copied from interface: AmazonSNS

Simplified method form for invoking the Publish operation.

Specified by:

publish in interface AmazonSNS

See Also:

AmazonSNS.publish(PublishRequest)

publish

public PublishResult publish(String topicArn,
                             String message,
                             String subject)

Description copied from interface: AmazonSNS

Simplified method form for invoking the Publish operation.

Specified by:

publish in interface AmazonSNS

See Also:

AmazonSNS.publish(PublishRequest)

removePermission

public RemovePermissionResult removePermission(RemovePermissionRequest request)

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

Specified by:

removePermission in interface AmazonSNS

Parameters:

removePermissionRequest - Input for RemovePermission action.

Returns:

Result of the RemovePermission operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

removePermission

public RemovePermissionResult removePermission(String topicArn,
                                               String label)

Description copied from interface: AmazonSNS

Simplified method form for invoking the RemovePermission operation.

Specified by:

removePermission in interface AmazonSNS

See Also:

AmazonSNS.removePermission(RemovePermissionRequest)

setEndpointAttributes

public SetEndpointAttributesResult setEndpointAttributes(SetEndpointAttributesRequest request)

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 AmazonSNS

Parameters:

setEndpointAttributesRequest - Input for SetEndpointAttributes action.

Returns:

Result of the SetEndpointAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

setPlatformApplicationAttributes

public SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)

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 AmazonSNS

Parameters:

setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.

Returns:

Result of the SetPlatformApplicationAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

setSMSAttributes

public SetSMSAttributesResult setSMSAttributes(SetSMSAttributesRequest request)

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 AmazonSNS

Parameters:

setSMSAttributesRequest - The input for the SetSMSAttributes action.

Returns:

Result of the SetSMSAttributes operation returned by the service.

Throws:

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

ThrottledException - Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

InternalErrorException - Indicates an internal service error.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

See Also:

AWS API Documentation

setSubscriptionAttributes

public SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest request)

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

Specified by:

setSubscriptionAttributes in interface AmazonSNS

Parameters:

setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.

Returns:

Result of the SetSubscriptionAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

setSubscriptionAttributes

public SetSubscriptionAttributesResult setSubscriptionAttributes(String subscriptionArn,
                                                                 String attributeName,
                                                                 String attributeValue)

Description copied from interface: AmazonSNS

Simplified method form for invoking the SetSubscriptionAttributes operation.

Specified by:

setSubscriptionAttributes in interface AmazonSNS

See Also:

AmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)

setTopicAttributes

public SetTopicAttributesResult setTopicAttributes(SetTopicAttributesRequest request)

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

Specified by:

setTopicAttributes in interface AmazonSNS

Parameters:

setTopicAttributesRequest - Input for SetTopicAttributes action.

Returns:

Result of the SetTopicAttributes operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

setTopicAttributes

public SetTopicAttributesResult setTopicAttributes(String topicArn,
                                                   String attributeName,
                                                   String attributeValue)

Description copied from interface: AmazonSNS

Simplified method form for invoking the SetTopicAttributes operation.

Specified by:

setTopicAttributes in interface AmazonSNS

See Also:

AmazonSNS.setTopicAttributes(SetTopicAttributesRequest)

subscribe

public SubscribeResult subscribe(SubscribeRequest request)

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.

Specified by:

subscribe in interface AmazonSNS

Parameters:

subscribeRequest - Input for Subscribe action.

Returns:

Result of the Subscribe operation returned by the service.

Throws:

SubscriptionLimitExceededException - Indicates that the customer already owns the maximum allowed number of subscriptions.

InvalidParameterException - Indicates that a request parameter does not comply with the associated constraints.

InternalErrorException - Indicates an internal service error.

NotFoundException - Indicates that the requested resource does not exist.

AuthorizationErrorException - Indicates that the user has been denied access to the requested resource.

See Also:

AWS API Documentation

subscribe

public SubscribeResult subscribe(String topicArn,
                                 String protocol,
                                 String endpoint)

Description copied from interface: AmazonSNS

Simplified method form for invoking the Subscribe operation.

Specified by:

subscribe in interface AmazonSNS

See Also:

AmazonSNS.subscribe(SubscribeRequest)

unsubscribe

public UnsubscribeResult unsubscribe(UnsubscribeRequest request)

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.

Specified by:

unsubscribe in interface AmazonSNS

Parameters:

unsubscribeRequest - Input for Unsubscribe action.

Returns:

Result of the Unsubscribe operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

unsubscribe

public UnsubscribeResult unsubscribe(String subscriptionArn)

Description copied from interface: AmazonSNS

Simplified method form for invoking the Unsubscribe operation.

Specified by:

unsubscribe in interface AmazonSNS

See Also:

AmazonSNS.unsubscribe(UnsubscribeRequest)

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonSNS

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.