Class AbstractAmazonSNS
- java.lang.Object
-
- com.amazonaws.services.sns.AbstractAmazonSNS
-
- All Implemented Interfaces:
AmazonSNS
- Direct Known Subclasses:
AbstractAmazonSNSAsync
public class AbstractAmazonSNS extends Object implements AmazonSNS
Abstract implementation ofAmazonSNS
. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractAmazonSNS()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.ConfirmSubscriptionResult
confirmSubscription(ConfirmSubscriptionRequest request)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlierSubscribe
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 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.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.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.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.void
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com").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.void
setRegion(Region region)
An alternative toAmazonSNS.setEndpoint(String)
, sets the regional endpoint for this client's service calls.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.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.SubscribeResult
subscribe(SubscribeRequest request)
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.SubscribeResult
subscribe(String topicArn, String protocol, String endpoint)
Simplified method form for invoking the Subscribe operation.UnsubscribeResult
unsubscribe(UnsubscribeRequest request)
Deletes a subscription.UnsubscribeResult
unsubscribe(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonSNS
Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAmazonSNS
- 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
public void setRegion(Region region)
Description copied from interface:AmazonSNS
An alternative toAmazonSNS.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAmazonSNS
- 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:
Region.getRegion(com.amazonaws.regions.Regions)
,Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,Region.isServiceSupported(String)
-
addPermission
public AddPermissionResult addPermission(AddPermissionRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Returns:
- Result of the AddPermission operation returned by the service.
-
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 interfaceAmazonSNS
- See Also:
AmazonSNS.addPermission(AddPermissionRequest)
-
confirmSubscription
public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest request)
Description copied from interface:AmazonSNS
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".- Specified by:
confirmSubscription
in interfaceAmazonSNS
- Parameters:
request
- Input for ConfirmSubscription action.- Returns:
- Result of the ConfirmSubscription operation returned by the service.
-
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 interfaceAmazonSNS
- 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 interfaceAmazonSNS
- See Also:
AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)
-
createPlatformApplication
public CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
createPlatformApplication
in interfaceAmazonSNS
- Parameters:
request
- Input for CreatePlatformApplication action.- Returns:
- Result of the CreatePlatformApplication operation returned by the service.
-
createPlatformEndpoint
public CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
createPlatformEndpoint
in interfaceAmazonSNS
- Parameters:
request
- Input for CreatePlatformEndpoint action.- Returns:
- Result of the CreatePlatformEndpoint operation returned by the service.
-
createTopic
public CreateTopicResult createTopic(CreateTopicRequest request)
Description copied from interface:AmazonSNS
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.
- Specified by:
createTopic
in interfaceAmazonSNS
- Parameters:
request
- Input for CreateTopic action.- Returns:
- Result of the CreateTopic operation returned by the service.
-
createTopic
public CreateTopicResult createTopic(String name)
Description copied from interface:AmazonSNS
Simplified method form for invoking the CreateTopic operation.- Specified by:
createTopic
in interfaceAmazonSNS
- See Also:
AmazonSNS.createTopic(CreateTopicRequest)
-
deleteEndpoint
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
Description copied from interface:AmazonSNS
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
- Specified by:
deleteEndpoint
in interfaceAmazonSNS
- Parameters:
request
- Input for DeleteEndpoint action.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
-
deletePlatformApplication
public DeletePlatformApplicationResult deletePlatformApplication(DeletePlatformApplicationRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Parameters:
request
- Input for DeletePlatformApplication action.- Returns:
- Result of the DeletePlatformApplication operation returned by the service.
-
deleteTopic
public DeleteTopicResult deleteTopic(DeleteTopicRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Returns:
- Result of the DeleteTopic operation returned by the service.
-
deleteTopic
public DeleteTopicResult deleteTopic(String topicArn)
Description copied from interface:AmazonSNS
Simplified method form for invoking the DeleteTopic operation.- Specified by:
deleteTopic
in interfaceAmazonSNS
- See Also:
AmazonSNS.deleteTopic(DeleteTopicRequest)
-
getEndpointAttributes
public GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Parameters:
request
- Input for GetEndpointAttributes action.- Returns:
- Result of the GetEndpointAttributes operation returned by the service.
-
getPlatformApplicationAttributes
public GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Parameters:
request
- Input for GetPlatformApplicationAttributes action.- Returns:
- Result of the GetPlatformApplicationAttributes operation returned by the service.
-
getSubscriptionAttributes
public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest request)
Description copied from interface:AmazonSNS
Returns all of the properties of a subscription.
- Specified by:
getSubscriptionAttributes
in interfaceAmazonSNS
- Parameters:
request
- Input for GetSubscriptionAttributes.- Returns:
- Result of the GetSubscriptionAttributes operation returned by the service.
-
getSubscriptionAttributes
public GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)
Description copied from interface:AmazonSNS
Simplified method form for invoking the GetSubscriptionAttributes operation.- Specified by:
getSubscriptionAttributes
in interfaceAmazonSNS
- See Also:
AmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)
-
getTopicAttributes
public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest request)
Description copied from interface:AmazonSNS
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
- Specified by:
getTopicAttributes
in interfaceAmazonSNS
- Parameters:
request
- Input for GetTopicAttributes action.- Returns:
- Result of the GetTopicAttributes operation returned by the service.
-
getTopicAttributes
public GetTopicAttributesResult getTopicAttributes(String topicArn)
Description copied from interface:AmazonSNS
Simplified method form for invoking the GetTopicAttributes operation.- Specified by:
getTopicAttributes
in interfaceAmazonSNS
- See Also:
AmazonSNS.getTopicAttributes(GetTopicAttributesRequest)
-
listEndpointsByPlatformApplication
public ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
listEndpointsByPlatformApplication
in interfaceAmazonSNS
- Parameters:
request
- Input for ListEndpointsByPlatformApplication action.- Returns:
- Result of the ListEndpointsByPlatformApplication operation returned by the service.
-
listPlatformApplications
public ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
listPlatformApplications
in interfaceAmazonSNS
- Parameters:
request
- Input for ListPlatformApplications action.- Returns:
- Result of the ListPlatformApplications operation returned by the service.
-
listPlatformApplications
public ListPlatformApplicationsResult listPlatformApplications()
Description copied from interface:AmazonSNS
Simplified method form for invoking the ListPlatformApplications operation.- Specified by:
listPlatformApplications
in interfaceAmazonSNS
- See Also:
AmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)
-
listSubscriptions
public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
listSubscriptions
in interfaceAmazonSNS
- Parameters:
request
- Input for ListSubscriptions action.- Returns:
- Result of the ListSubscriptions operation returned by the service.
-
listSubscriptions
public ListSubscriptionsResult listSubscriptions()
Description copied from interface:AmazonSNS
Simplified method form for invoking the ListSubscriptions operation.- Specified by:
listSubscriptions
in interfaceAmazonSNS
- 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 interfaceAmazonSNS
- See Also:
AmazonSNS.listSubscriptions(ListSubscriptionsRequest)
-
listSubscriptionsByTopic
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
listSubscriptionsByTopic
in interfaceAmazonSNS
- Parameters:
request
- Input for ListSubscriptionsByTopic action.- Returns:
- Result of the ListSubscriptionsByTopic operation returned by the service.
-
listSubscriptionsByTopic
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)
Description copied from interface:AmazonSNS
Simplified method form for invoking the ListSubscriptionsByTopic operation.- Specified by:
listSubscriptionsByTopic
in interfaceAmazonSNS
- 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 interfaceAmazonSNS
- See Also:
AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)
-
listTopics
public ListTopicsResult listTopics(ListTopicsRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
listTopics
in interfaceAmazonSNS
- Returns:
- Result of the ListTopics operation returned by the service.
-
listTopics
public ListTopicsResult listTopics()
Description copied from interface:AmazonSNS
Simplified method form for invoking the ListTopics operation.- Specified by:
listTopics
in interfaceAmazonSNS
- 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 interfaceAmazonSNS
- See Also:
AmazonSNS.listTopics(ListTopicsRequest)
-
publish
public PublishResult publish(PublishRequest request)
Description copied from interface:AmazonSNS
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.
-
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 interfaceAmazonSNS
- 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 interfaceAmazonSNS
- See Also:
AmazonSNS.publish(PublishRequest)
-
removePermission
public RemovePermissionResult removePermission(RemovePermissionRequest request)
Description copied from interface:AmazonSNS
Removes a statement from a topic's access control policy.
- Specified by:
removePermission
in interfaceAmazonSNS
- Parameters:
request
- Input for RemovePermission action.- Returns:
- Result of the RemovePermission operation returned by the service.
-
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 interfaceAmazonSNS
- See Also:
AmazonSNS.removePermission(RemovePermissionRequest)
-
setEndpointAttributes
public SetEndpointAttributesResult setEndpointAttributes(SetEndpointAttributesRequest request)
Description copied from interface:AmazonSNS
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 interfaceAmazonSNS
- Parameters:
request
- Input for SetEndpointAttributes action.- Returns:
- Result of the SetEndpointAttributes operation returned by the service.
-
setPlatformApplicationAttributes
public SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)
Description copied from interface:AmazonSNS
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.
- Specified by:
setPlatformApplicationAttributes
in interfaceAmazonSNS
- Parameters:
request
- Input for SetPlatformApplicationAttributes action.- Returns:
- Result of the SetPlatformApplicationAttributes operation returned by the service.
-
setSubscriptionAttributes
public SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest request)
Description copied from interface:AmazonSNS
Allows a subscription owner to set an attribute of the topic to a new value.
- Specified by:
setSubscriptionAttributes
in interfaceAmazonSNS
- Parameters:
request
- Input for SetSubscriptionAttributes action.- Returns:
- Result of the SetSubscriptionAttributes operation returned by the service.
-
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 interfaceAmazonSNS
- See Also:
AmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)
-
setTopicAttributes
public SetTopicAttributesResult setTopicAttributes(SetTopicAttributesRequest request)
Description copied from interface:AmazonSNS
Allows a topic owner to set an attribute of the topic to a new value.
- Specified by:
setTopicAttributes
in interfaceAmazonSNS
- Parameters:
request
- Input for SetTopicAttributes action.- Returns:
- Result of the SetTopicAttributes operation returned by the service.
-
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 interfaceAmazonSNS
- See Also:
AmazonSNS.setTopicAttributes(SetTopicAttributesRequest)
-
subscribe
public SubscribeResult subscribe(SubscribeRequest request)
Description copied from interface:AmazonSNS
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.
-
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 interfaceAmazonSNS
- See Also:
AmazonSNS.subscribe(SubscribeRequest)
-
unsubscribe
public UnsubscribeResult unsubscribe(UnsubscribeRequest request)
Description copied from interface:AmazonSNS
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.- Specified by:
unsubscribe
in interfaceAmazonSNS
- Parameters:
request
- Input for Unsubscribe action.- Returns:
- Result of the Unsubscribe operation returned by the service.
-
unsubscribe
public UnsubscribeResult unsubscribe(String subscriptionArn)
Description copied from interface:AmazonSNS
Simplified method form for invoking the Unsubscribe operation.- Specified by:
unsubscribe
in interfaceAmazonSNS
- See Also:
AmazonSNS.unsubscribe(UnsubscribeRequest)
-
shutdown
public void shutdown()
Description copied from interface:AmazonSNS
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
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonSNS
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonSNS
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-