AmazonSNSClient (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

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 .

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(ClientConfiguration clientConfiguration)` Constructs a new client to invoke service methods on AmazonSNS.

Method Summary
`void`	`addPermission(AddPermissionRequest addPermissionRequest)` The `AddPermission` action 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)` The `ConfirmSubscription` action 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)` The `CreatePlatformApplication` action 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)` The `CreatePlatformEndpoint` 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)` The `CreateTopic` action creates a topic to which notifications can be published.
`void`	`deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)` The `DeleteEndpoint` action, which is idempotent, deletes the endpoint from SNS.
`void`	`deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest)` The `DeletePlatformApplication` action deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
`void`	`deleteTopic(DeleteTopicRequest deleteTopicRequest)` The `DeleteTopic` action 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)` The `GetEndpointAttributes` retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS.
`GetPlatformApplicationAttributesResult`	`getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest)` The `GetPlatformApplicationAttributes` action retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
`GetSubscriptionAttributesResult`	`getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)` The `GetSubscriptionAttribtues` action returns all of the properties of a subscription.
`GetTopicAttributesResult`	`getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest)` The `GetTopicAttributes` action returns all of the properties of a topic.
`ListEndpointsByPlatformApplicationResult`	`listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest)` The `ListEndpointsByPlatformApplication` action lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS.
`ListPlatformApplicationsResult`	`listPlatformApplications()` The `ListPlatformApplications` action lists the platform application objects for the supported push notification services, such as APNS and GCM.
`ListPlatformApplicationsResult`	`listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest)` The `ListPlatformApplications` action lists the platform application objects for the supported push notification services, such as APNS and GCM.
`ListSubscriptionsResult`	`listSubscriptions()` The `ListSubscriptions` action returns a list of the requester's subscriptions.
`ListSubscriptionsResult`	`listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)` The `ListSubscriptions` action returns a list of the requester's subscriptions.
`ListSubscriptionsByTopicResult`	`listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest)` The `ListSubscriptionsByTopic` action returns a list of the subscriptions to a specific topic.
`ListTopicsResult`	`listTopics()` The `ListTopics` action returns a list of the requester's topics.
`ListTopicsResult`	`listTopics(ListTopicsRequest listTopicsRequest)` The `ListTopics` action returns a list of the requester's topics.
`PublishResult`	`publish(PublishRequest publishRequest)` The `Publish` action sends a message to all of a topic's subscribed endpoints.
`void`	`removePermission(RemovePermissionRequest removePermissionRequest)` The `RemovePermission` action removes a statement from a topic's access control policy.
`void`	`setEndpoint(String endpoint, String serviceName, String regionId)` Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
`void`	`setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest)` The `SetEndpointAttributes` action 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)` The `SetPlatformApplicationAttributes` action sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM.
`void`	`setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)` The `SetSubscriptionAttributes` action allows a subscription owner to set an attribute of the topic to a new value.
`void`	`setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)` The `SetTopicAttributes` action allows a topic owner to set an attribute of the topic to a new value.
`SubscribeResult`	`subscribe(SubscribeRequest subscribeRequest)` The `Subscribe` action prepares to subscribe an endpoint by sending the endpoint a confirmation message.
`void`	`unsubscribe(UnsubscribeRequest unsubscribeRequest)` The `Unsubscribe` action deletes a subscription.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
`addRequestHandler, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, 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