AmazonSNSClient (AWS SDK for Android

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.sns
Class AmazonSNSClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.sns.AmazonSNSClient

All Implemented Interfaces:: AmazonSNS

Direct Known Subclasses:: AmazonSNSAsyncClient

public class AmazonSNSClient
extends AmazonWebServiceClient
implements AmazonSNS
extends AmazonWebServiceClient
implements AmazonSNS

Client for accessing AmazonSNS. 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 inherited from class com.amazonaws.AmazonWebServiceClient
`LOGGING_AWS_REQUEST_METRIC`

Constructor Summary
`AmazonSNSClient()` Constructs a new client to invoke service methods on AmazonSNS.
`AmazonSNSClient(AWSCredentials awsCredentials)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials.
`AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials and client configuration options.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)` Constructs a new client to invoke service methods on AmazonSNS using the specified AWS account credentials provider.
`AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS 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 AmazonSNS using the specified AWS account credentials provider, client configuration options, and request metric collector.
`AmazonSNSClient(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS.

Method Summary
`void`	`addPermission(AddPermissionRequest addPermissionRequest)` Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
`void`	`addPermission(java.lang.String topicArn, java.lang.String label, java.util.List<java.lang.String> aWSAccountIds, java.util.List<java.lang.String> actionNames)` Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
`ConfirmSubscriptionResult`	`confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`ConfirmSubscriptionResult`	`confirmSubscription(java.lang.String topicArn, java.lang.String token)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`ConfirmSubscriptionResult`	`confirmSubscription(java.lang.String topicArn, java.lang.String token, java.lang.String authenticateOnUnsubscribe)` Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier `Subscribe` action.
`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(java.lang.String name)` Creates a topic to which notifications can be published.
`void`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` Deletes the endpoint from Amazon SNS.
`void`	`deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)` Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
`void`	`deleteTopic(DeleteTopicRequest deleteTopicRequest)` Deletes a topic and all its subscriptions.
`void`	`deleteTopic(java.lang.String topicArn)` Deletes a topic and all its subscriptions.
`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(java.lang.String subscriptionArn)` Returns all of the properties of a subscription.
`GetTopicAttributesResult`	`getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)` Returns all of the properties of a topic.
`GetTopicAttributesResult`	`getTopicAttributes(java.lang.String topicArn)` Returns all of the properties of a topic.
`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()` Lists the platform application objects for the supported push notification services, such as APNS and GCM.
`ListPlatformApplicationsResult`	`listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)` Lists the platform application objects for the supported push notification services, such as APNS and GCM.
`ListSubscriptionsResult`	`listSubscriptions()` Returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)` Returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(java.lang.String nextToken)` Returns a list of the requester's subscriptions.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)` Returns a list of the subscriptions to a specific topic.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(java.lang.String topicArn)` Returns a list of the subscriptions to a specific topic.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(java.lang.String topicArn, java.lang.String nextToken)` Returns a list of the subscriptions to a specific topic.
`ListTopicsResult`	`listTopics()` Returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(ListTopicsRequest listTopicsRequest)` Returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(java.lang.String nextToken)` Returns a list of the requester's topics.
`PublishResult`	`publish(PublishRequest publishRequest)` Sends a message to all of a topic's subscribed endpoints.
`PublishResult`	`publish(java.lang.String topicArn, java.lang.String message)` Sends a message to all of a topic's subscribed endpoints.
`PublishResult`	`publish(java.lang.String topicArn, java.lang.String message, java.lang.String subject)` Sends a message to all of a topic's subscribed endpoints.
`void`	`removePermission(RemovePermissionRequest removePermissionRequest)` Removes a statement from a topic's access control policy.
`void`	`removePermission(java.lang.String topicArn, java.lang.String label)` Removes a statement from a topic's access control policy.
`void`	`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.
`void`	`setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest)` Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
`void`	`setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)` Allows a subscription owner to set an attribute of the topic to a new value.
`void`	`setSubscriptionAttributes(java.lang.String subscriptionArn, java.lang.String attributeName, java.lang.String attributeValue)` Allows a subscription owner to set an attribute of the topic to a new value.
`void`	`setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)` Allows a topic owner to set an attribute of the topic to a new value.
`void`	`setTopicAttributes(java.lang.String topicArn, java.lang.String attributeName, java.lang.String attributeValue)` Allows a topic owner to set an attribute of the topic to a new value.
`SubscribeResult`	`subscribe(java.lang.String topicArn, java.lang.String protocol, java.lang.String endpoint)` Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
`SubscribeResult`	`subscribe(SubscribeRequest subscribeRequest)` Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
`void`	`unsubscribe(java.lang.String subscriptionArn)` Deletes a subscription.
`void`	`unsubscribe(UnsubscribeRequest unsubscribeRequest)` Deletes a subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, addRequestHandler, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.amazonaws.services.sns.AmazonSNS
`setEndpoint, setRegion, shutdown`

Constructor Detail

AmazonSNSClient

public AmazonSNSClient()

Constructs a new client to invoke service methods on AmazonSNS. 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