Interface AmazonSNS
- All Known Subinterfaces:
AmazonSNSAsync
- All Known Implementing Classes:
AbstractAmazonSNS
,AbstractAmazonSNSAsync
,AmazonSNSAsyncClient
,AmazonSNSClient
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
-
Method Summary
Modifier and TypeMethodDescriptionaddPermission
(AddPermissionRequest addPermissionRequest) Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.Simplified method form for invoking the AddPermission operation.confirmSubscription
(ConfirmSubscriptionRequest confirmSubscriptionRequest) Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlierSubscribe
action.confirmSubscription
(String topicArn, String token) Simplified method form for invoking the ConfirmSubscription operation.confirmSubscription
(String topicArn, String token, String authenticateOnUnsubscribe) Simplified method form for invoking the ConfirmSubscription operation.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.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.createTopic
(CreateTopicRequest createTopicRequest) Creates a topic to which notifications can be published.createTopic
(String name) Simplified method form for invoking the CreateTopic operation.deleteEndpoint
(DeleteEndpointRequest deleteEndpointRequest) Deletes the endpoint from Amazon SNS.deletePlatformApplication
(DeletePlatformApplicationRequest deletePlatformApplicationRequest) Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.deleteTopic
(DeleteTopicRequest deleteTopicRequest) Deletes a topic and all its subscriptions.deleteTopic
(String topicArn) Simplified method form for invoking the DeleteTopic operation.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.getEndpointAttributes
(GetEndpointAttributesRequest getEndpointAttributesRequest) Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.getPlatformApplicationAttributes
(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.getSubscriptionAttributes
(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) Returns all of the properties of a subscription.getSubscriptionAttributes
(String subscriptionArn) Simplified method form for invoking the GetSubscriptionAttributes operation.getTopicAttributes
(GetTopicAttributesRequest getTopicAttributesRequest) Returns all of the properties of a topic.getTopicAttributes
(String topicArn) Simplified method form for invoking the GetTopicAttributes operation.listEndpointsByPlatformApplication
(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.Simplified method form for invoking the ListPlatformApplications operation.listPlatformApplications
(ListPlatformApplicationsRequest listPlatformApplicationsRequest) Lists the platform application objects for the supported push notification services, such as APNS and GCM.Simplified method form for invoking the ListSubscriptions operation.listSubscriptions
(ListSubscriptionsRequest listSubscriptionsRequest) Returns a list of the requester's subscriptions.listSubscriptions
(String nextToken) Simplified method form for invoking the ListSubscriptions operation.listSubscriptionsByTopic
(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) Returns a list of the subscriptions to a specific topic.listSubscriptionsByTopic
(String topicArn) Simplified method form for invoking the ListSubscriptionsByTopic operation.listSubscriptionsByTopic
(String topicArn, String nextToken) Simplified method form for invoking the ListSubscriptionsByTopic operation.Simplified method form for invoking the ListTopics operation.listTopics
(ListTopicsRequest listTopicsRequest) Returns a list of the requester's topics.listTopics
(String nextToken) Simplified method form for invoking the ListTopics operation.publish
(PublishRequest publishRequest) Sends a message to all of a topic's subscribed endpoints.Simplified method form for invoking the Publish operation.Simplified method form for invoking the Publish operation.removePermission
(RemovePermissionRequest removePermissionRequest) Removes a statement from a topic's access control policy.removePermission
(String topicArn, String label) Simplified method form for invoking the RemovePermission operation.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com").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.setPlatformApplicationAttributes
(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.void
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.setSubscriptionAttributes
(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) Allows a subscription owner to set an attribute of the topic to a new value.setSubscriptionAttributes
(String subscriptionArn, String attributeName, String attributeValue) Simplified method form for invoking the SetSubscriptionAttributes operation.setTopicAttributes
(SetTopicAttributesRequest setTopicAttributesRequest) Allows a topic owner to set an attribute of the topic to a new value.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.subscribe
(SubscribeRequest subscribeRequest) Prepares to subscribe an endpoint by sending the endpoint a confirmation message.Simplified method form for invoking the Subscribe operation.unsubscribe
(UnsubscribeRequest unsubscribeRequest) Deletes a subscription.unsubscribe
(String subscriptionArn) Simplified method form for invoking the Unsubscribe operation.
-
Method Details
-
setEndpoint
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
An alternative tosetEndpoint(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. SeeRegion.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:
-
addPermission
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.
-
addPermission
AddPermissionResult addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames) Simplified method form for invoking the AddPermission operation.- See Also:
-
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 theAuthenticateOnUnsubscribe
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.
-
confirmSubscription
ConfirmSubscriptionResult confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe) Simplified method form for invoking the ConfirmSubscription operation. -
confirmSubscription
Simplified method form for invoking the ConfirmSubscription operation. -
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 APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when usingCreatePlatformApplication
is then used as an attribute for theCreatePlatformEndpoint
action. For more information, see Using Amazon SNS Mobile Push Notifications.- 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.
-
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 fromCreatePlatformApplication
. The EndpointArn that is returned when usingCreatePlatformEndpoint
can then be used by thePublish
action to send a message to a mobile app or by theSubscribe
action for subscription to a topic. TheCreatePlatformEndpoint
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.
-
createTopic
Creates a topic to which notifications can be published. Users can create at most 3000 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.
-
createTopic
Simplified method form for invoking the CreateTopic operation.- See Also:
-
deleteEndpoint
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
- 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.
-
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.
-
deleteTopic
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.
-
deleteTopic
Simplified method form for invoking the DeleteTopic operation.- See Also:
-
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.
-
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.
-
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.
-
getSubscriptionAttributes
Simplified method form for invoking the GetSubscriptionAttributes operation. -
getTopicAttributes
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.
-
getTopicAttributes
Simplified method form for invoking the GetTopicAttributes operation. -
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 callListEndpointsByPlatformApplication
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.
-
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 callListPlatformApplications
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.
-
listPlatformApplications
ListPlatformApplicationsResult listPlatformApplications()Simplified method form for invoking the ListPlatformApplications operation. -
listSubscriptions
Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a
NextToken
is also returned. Use theNextToken
parameter in a newListSubscriptions
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.
-
listSubscriptions
ListSubscriptionsResult listSubscriptions()Simplified method form for invoking the ListSubscriptions operation. -
listSubscriptions
Simplified method form for invoking the ListSubscriptions operation. -
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 theNextToken
parameter in a newListSubscriptionsByTopic
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.
-
listSubscriptionsByTopic
Simplified method form for invoking the ListSubscriptionsByTopic operation. -
listSubscriptionsByTopic
Simplified method form for invoking the ListSubscriptionsByTopic operation. -
listTopics
Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a
NextToken
is also returned. Use theNextToken
parameter in a newListTopics
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.
-
listTopics
ListTopicsResult listTopics()Simplified method form for invoking the ListTopics operation.- See Also:
-
listTopics
Simplified method form for invoking the ListTopics operation.- See Also:
-
publish
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 selected.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. The EndpointArn is returned when making a call with theCreatePlatformEndpoint
action. The second example below shows a request and response for publishing to a mobile endpoint.- 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.
-
publish
Simplified method form for invoking the Publish operation.- See Also:
-
publish
Simplified method form for invoking the Publish operation.- See Also:
-
removePermission
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.
-
removePermission
Simplified method form for invoking the RemovePermission operation. -
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.
-
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.
- 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.
-
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.
-
setSubscriptionAttributes
SetSubscriptionAttributesResult setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue) Simplified method form for invoking the SetSubscriptionAttributes operation. -
setTopicAttributes
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.
-
setTopicAttributes
SetTopicAttributesResult setTopicAttributes(String topicArn, String attributeName, String attributeValue) Simplified method form for invoking the SetTopicAttributes operation. -
subscribe
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.
-
subscribe
Simplified method form for invoking the Subscribe operation.- See Also:
-
unsubscribe
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 theUnsubscribe
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.
-
unsubscribe
Simplified method form for invoking the Unsubscribe operation.- See Also:
-
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
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.
-