com.amazonaws.services.sns

Interface AmazonSNS

All Known Subinterfaces:

AmazonSNSAsync

All Known Implementing Classes:

AbstractAmazonSNS, AbstractAmazonSNSAsync, AmazonSNSAsyncClient, AmazonSNSClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonSNS

Interface for accessing Amazon SNS.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonSNS instead.

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see 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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddPermissionResult	addPermission(AddPermissionRequest addPermissionRequest) 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.
CheckIfPhoneNumberIsOptedOutResult	checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account.
ConfirmSubscriptionResult	confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action.
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 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.
CreatePlatformEndpointResult	createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest) Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS.
CreateTopicResult	createTopic(CreateTopicRequest createTopicRequest) Creates a topic to which notifications can be published.
CreateTopicResult	createTopic(String name) Simplified method form for invoking the CreateTopic operation.
DeleteEndpointResult	deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) Deletes the endpoint for a device and mobile app from Amazon SNS.
DeletePlatformApplicationResult	deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
DeleteTopicResult	deleteTopic(DeleteTopicRequest deleteTopicRequest) 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 getEndpointAttributesRequest) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
GetPlatformApplicationAttributesResult	getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
GetSMSAttributesResult	getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest) Returns the settings for sending SMS messages from your account.
GetSubscriptionAttributesResult	getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) Returns all of the properties of a subscription.
GetSubscriptionAttributesResult	getSubscriptionAttributes(String subscriptionArn) Simplified method form for invoking the GetSubscriptionAttributes operation.
GetTopicAttributesResult	getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) Returns all of the properties of a topic.
GetTopicAttributesResult	getTopicAttributes(String topicArn) Simplified method form for invoking the GetTopicAttributes operation.
ListEndpointsByPlatformApplicationResult	listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
ListPhoneNumbersOptedOutResult	listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) 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 listPlatformApplicationsRequest) 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 listSubscriptionsRequest) Returns a list of the requester's subscriptions.
ListSubscriptionsResult	listSubscriptions(String nextToken) Simplified method form for invoking the ListSubscriptions operation.
ListSubscriptionsByTopicResult	listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) 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 listTopicsRequest) Returns a list of the requester's topics.
ListTopicsResult	listTopics(String nextToken) Simplified method form for invoking the ListTopics operation.
OptInPhoneNumberResult	optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest) Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
PublishResult	publish(PublishRequest publishRequest) 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 removePermissionRequest) Removes a statement from a topic's access control policy.
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));
SetEndpointAttributesResult	setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest) Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.
SetPlatformApplicationAttributesResult	setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
SetSMSAttributesResult	setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest) Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
SetSubscriptionAttributesResult	setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) 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 setTopicAttributesRequest) 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.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SubscribeResult	subscribe(String topicArn, String protocol, String endpoint) Simplified method form for invoking the Subscribe operation.
SubscribeResult	subscribe(SubscribeRequest subscribeRequest) 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 unsubscribeRequest) Deletes a subscription.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
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.

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
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to 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.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

addPermission

AddPermissionResult addPermission(AddPermissionRequest addPermissionRequest)

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

Parameters:

addPermissionRequest -

Returns:

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

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

Simplified method form for invoking the AddPermission operation.

See Also:

addPermission(AddPermissionRequest)

checkIfPhoneNumberIsOptedOut

CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest)

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

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

Parameters:

checkIfPhoneNumberIsOptedOutRequest - The input for the CheckIfPhoneNumberIsOptedOut action.

Returns:

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

ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

Parameters:

confirmSubscriptionRequest - Input for ConfirmSubscription action.

Returns:

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

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

Simplified method form for invoking the ConfirmSubscription operation.

See Also:

confirmSubscription(ConfirmSubscriptionRequest)

confirmSubscription

ConfirmSubscriptionResult confirmSubscription(String topicArn,
                                              String token)

Simplified method form for invoking the ConfirmSubscription operation.

See Also:

confirmSubscription(ConfirmSubscriptionRequest)

createPlatformApplication

CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest)

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

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

Parameters:

createPlatformApplicationRequest - Input for CreatePlatformApplication action.

Returns:

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

CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest)

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

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

Parameters:

createPlatformEndpointRequest - Input for CreatePlatformEndpoint action.

Returns:

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

CreateTopicResult createTopic(CreateTopicRequest createTopicRequest)

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

Parameters:

createTopicRequest - Input for CreateTopic action.

Returns:

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

CreateTopicResult createTopic(String name)

Simplified method form for invoking the CreateTopic operation.

See Also:

createTopic(CreateTopicRequest)

deleteEndpoint

DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

Parameters:

deleteEndpointRequest - Input for DeleteEndpoint action.

Returns:

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

DeletePlatformApplicationResult deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)

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

Parameters:

deletePlatformApplicationRequest - Input for DeletePlatformApplication action.

Returns:

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

DeleteTopicResult deleteTopic(DeleteTopicRequest deleteTopicRequest)

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

Parameters:

deleteTopicRequest -

Returns:

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

DeleteTopicResult deleteTopic(String topicArn)

Simplified method form for invoking the DeleteTopic operation.

See Also:

deleteTopic(DeleteTopicRequest)

getEndpointAttributes

GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest)

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

Parameters:

getEndpointAttributesRequest - Input for GetEndpointAttributes action.

Returns:

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

GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)

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

Parameters:

getPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.

Returns:

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

GetSMSAttributesResult getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest)

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Parameters:

getSMSAttributesRequest - The input for the GetSMSAttributes request.

Returns:

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

GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)

Returns all of the properties of a subscription.

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

GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)

Simplified method form for invoking the GetSubscriptionAttributes operation.

See Also:

getSubscriptionAttributes(GetSubscriptionAttributesRequest)

getTopicAttributes

GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)

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

Parameters:

getTopicAttributesRequest - Input for GetTopicAttributes action.

Returns:

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

GetTopicAttributesResult getTopicAttributes(String topicArn)

Simplified method form for invoking the GetTopicAttributes operation.

See Also:

getTopicAttributes(GetTopicAttributesRequest)

listEndpointsByPlatformApplication

ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)

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

Parameters:

listEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.

Returns:

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

ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest)

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

Parameters:

listPhoneNumbersOptedOutRequest - The input for the ListPhoneNumbersOptedOut action.

Returns:

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

ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)

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

Parameters:

listPlatformApplicationsRequest - Input for ListPlatformApplications action.

Returns:

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

ListPlatformApplicationsResult listPlatformApplications()

Simplified method form for invoking the ListPlatformApplications operation.

See Also:

listPlatformApplications(ListPlatformApplicationsRequest)

listSubscriptions

ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

Parameters:

listSubscriptionsRequest - Input for ListSubscriptions action.

Returns:

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

ListSubscriptionsResult listSubscriptions()

Simplified method form for invoking the ListSubscriptions operation.

See Also:

listSubscriptions(ListSubscriptionsRequest)

listSubscriptions

ListSubscriptionsResult listSubscriptions(String nextToken)

Simplified method form for invoking the ListSubscriptions operation.

See Also:

listSubscriptions(ListSubscriptionsRequest)

listSubscriptionsByTopic

ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

Parameters:

listSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.

Returns:

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

ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)

Simplified method form for invoking the ListSubscriptionsByTopic operation.

See Also:

listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

listSubscriptionsByTopic

ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn,
                                                        String nextToken)

Simplified method form for invoking the ListSubscriptionsByTopic operation.

See Also:

listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

listTopics

ListTopicsResult listTopics(ListTopicsRequest listTopicsRequest)

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

Parameters:

listTopicsRequest -

Returns:

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

ListTopicsResult listTopics()

Simplified method form for invoking the ListTopics operation.

See Also:

listTopics(ListTopicsRequest)

listTopics

ListTopicsResult listTopics(String nextToken)

Simplified method form for invoking the ListTopics operation.

See Also:

listTopics(ListTopicsRequest)

optInPhoneNumber

OptInPhoneNumberResult optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest)

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

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

Parameters:

optInPhoneNumberRequest - Input for the OptInPhoneNumber action.

Returns:

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

PublishResult publish(PublishRequest publishRequest)

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

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

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

Parameters:

publishRequest - Input for Publish action.

Returns:

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

PublishResult publish(String topicArn,
                      String message)

Simplified method form for invoking the Publish operation.

See Also:

publish(PublishRequest)

publish

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

Simplified method form for invoking the Publish operation.

See Also:

publish(PublishRequest)

removePermission

RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)

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

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

RemovePermissionResult removePermission(String topicArn,
                                        String label)

Simplified method form for invoking the RemovePermission operation.

See Also:

removePermission(RemovePermissionRequest)

setEndpointAttributes

SetEndpointAttributesResult setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)

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

Parameters:

setEndpointAttributesRequest - Input for SetEndpointAttributes action.

Returns:

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

SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)

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

Parameters:

setPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.

Returns:

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

SetSMSAttributesResult setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest)

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

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

Parameters:

setSMSAttributesRequest - The input for the SetSMSAttributes action.

Returns:

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

SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)

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

Parameters:

setSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.

Returns:

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

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

Simplified method form for invoking the SetSubscriptionAttributes operation.

See Also:

setSubscriptionAttributes(SetSubscriptionAttributesRequest)

setTopicAttributes

SetTopicAttributesResult setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)

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

Parameters:

setTopicAttributesRequest - Input for SetTopicAttributes action.

Returns:

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

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

Simplified method form for invoking the SetTopicAttributes operation.

See Also:

setTopicAttributes(SetTopicAttributesRequest)

subscribe

SubscribeResult subscribe(SubscribeRequest subscribeRequest)

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

Parameters:

subscribeRequest - Input for Subscribe action.

Returns:

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

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

Simplified method form for invoking the Subscribe operation.

See Also:

subscribe(SubscribeRequest)

unsubscribe

UnsubscribeResult unsubscribe(UnsubscribeRequest unsubscribeRequest)

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

Parameters:

unsubscribeRequest - Input for Unsubscribe action.

Returns:

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

UnsubscribeResult unsubscribe(String subscriptionArn)

Simplified method form for invoking the Unsubscribe operation.

See Also:

unsubscribe(UnsubscribeRequest)

shutdown

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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