Class AmazonSNSClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.sns.AmazonSNSClient
-
- All Implemented Interfaces:
AmazonSNS
- Direct Known Subclasses:
AmazonSNSAsyncClient
@ThreadSafe public class AmazonSNSClient extends AmazonWebServiceClient implements AmazonSNS
Client for accessing Amazon SNS. All service calls made using this client are blocking, and will not return until the service call completes.Amazon Simple Notification Service Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.
-
-
Field Summary
Fields Modifier and Type Field Description protected static ClientConfigurationFactory
configFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AmazonSNSClient()
Constructs a new client to invoke service methods on Amazon SNS.AmazonSNSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials.AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider.AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider and client configuration options.AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider, client configuration options, and request metric collector.AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials and client configuration options.AmazonSNSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.ConfirmSubscriptionResult
confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)
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 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 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.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.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.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.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.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.SubscribeResult
subscribe(SubscribeRequest subscribeRequest)
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 unsubscribeRequest)
Deletes a subscription.UnsubscribeResult
unsubscribe(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.amazonaws.services.sns.AmazonSNS
setEndpoint, setRegion, shutdown
-
-
-
-
Field Detail
-
configFactory
protected static final ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
-
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
-
-
Constructor Detail
-
AmazonSNSClient
public AmazonSNSClient()
Constructs a new client to invoke service methods on Amazon SNS. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonSNSClient
public AmazonSNSClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).- See Also:
DefaultAWSCredentialsProviderChain
-
AmazonSNSClient
public AmazonSNSClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AmazonSNSClient
public AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).
-
AmazonSNSClient
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AmazonSNSClient
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).
-
AmazonSNSClient
public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Amazon SNS using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Detail
-
addPermission
public 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.
- Specified by:
addPermission
in interfaceAmazonSNS
- 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
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 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".- Specified by:
confirmSubscription
in interfaceAmazonSNS
- 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
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 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.- Specified by:
createPlatformApplication
in interfaceAmazonSNS
- 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
public 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.- Specified by:
createPlatformEndpoint
in interfaceAmazonSNS
- 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
public CreateTopicResult createTopic(CreateTopicRequest createTopicRequest)
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:
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
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 deleteEndpointRequest)
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:
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
public 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.
- Specified by:
deletePlatformApplication
in interfaceAmazonSNS
- 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
public 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.
- Specified by:
deleteTopic
in interfaceAmazonSNS
- 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
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 getEndpointAttributesRequest)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
- Specified by:
getEndpointAttributes
in interfaceAmazonSNS
- 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
public 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.
- Specified by:
getPlatformApplicationAttributes
in interfaceAmazonSNS
- 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
public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
- Specified by:
getSubscriptionAttributes
in interfaceAmazonSNS
- 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
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 getTopicAttributesRequest)
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
- Specified by:
getTopicAttributes
in interfaceAmazonSNS
- 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
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 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.- Specified by:
listEndpointsByPlatformApplication
in interfaceAmazonSNS
- 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
public 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.- Specified by:
listPlatformApplications
in interfaceAmazonSNS
- 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
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 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 theNextToken
parameter in a newListSubscriptions
call to get further results.- Specified by:
listSubscriptions
in interfaceAmazonSNS
- 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
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 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.- Specified by:
listSubscriptionsByTopic
in interfaceAmazonSNS
- 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
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 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 theNextToken
parameter in a newListTopics
call to get further results.- Specified by:
listTopics
in interfaceAmazonSNS
- 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
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 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 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.- Specified by:
publish
in interfaceAmazonSNS
- 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
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 removePermissionRequest)
Removes a statement from a topic's access control policy.
- Specified by:
removePermission
in interfaceAmazonSNS
- 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
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 setEndpointAttributesRequest)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
- Specified by:
setEndpointAttributes
in interfaceAmazonSNS
- 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
public 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.
- Specified by:
setPlatformApplicationAttributes
in interfaceAmazonSNS
- 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
public SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new value.
- Specified by:
setSubscriptionAttributes
in interfaceAmazonSNS
- 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
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 setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
- Specified by:
setTopicAttributes
in interfaceAmazonSNS
- 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
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 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.- Specified by:
subscribe
in interfaceAmazonSNS
- 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
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 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 theUnsubscribe
request was unintended.- Specified by:
unsubscribe
in interfaceAmazonSNS
- 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
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)
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAmazonSNS
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-
-