public class AmazonSNSClient extends AmazonWebServiceClient implements AmazonSNS
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.
LOGGING_AWS_REQUEST_METRIC| Constructor and 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(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(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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Amazon SNS.
|
| Modifier and Type | Method and Description |
|---|---|
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(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 earlier
Subscribe 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.
|
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(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.
|
void |
removePermission(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
|
void |
removePermission(String topicArn,
String label)
Simplified method form for invoking the RemovePermission operation.
|
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(String subscriptionArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetSubscriptionAttributes
operation.
|
void |
setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
|
void |
setTopicAttributes(String topicArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetTopicAttributes operation.
|
SubscribeResult |
subscribe(String topicArn,
String protocol,
String endpoint)
Simplified method form for invoking the Subscribe operation.
|
SubscribeResult |
subscribe(SubscribeRequest subscribeRequest)
Prepares to subscribe an endpoint by sending the endpoint a confirmation
message.
|
void |
unsubscribe(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.
|
void |
unsubscribe(UnsubscribeRequest unsubscribeRequest)
Deletes a subscription.
|
addRequestHandler, addRequestHandler, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AmazonSNSClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic AmazonSNSClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client
connects to Amazon SNS (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic AmazonSNSClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic 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.
addPermission in interface AmazonSNSaddPermissionRequest - 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.public void addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
AmazonSNSaddPermission in interface AmazonSNSAmazonSNS.addPermission(AddPermissionRequest)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 the AuthenticateOnUnsubscribe flag is set to "true".
confirmSubscription in interface AmazonSNSconfirmSubscriptionRequest - Input for ConfirmSubscription action.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.public ConfirmSubscriptionResult confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe)
AmazonSNSconfirmSubscription in interface AmazonSNSAmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)public ConfirmSubscriptionResult confirmSubscription(String topicArn, String token)
AmazonSNSconfirmSubscription in interface AmazonSNSAmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)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 using
CreatePlatformApplication is then used as an attribute for
the CreatePlatformEndpoint action. For more information, see
Using Amazon SNS Mobile Push Notifications.
createPlatformApplication in interface AmazonSNScreatePlatformApplicationRequest - Input for CreatePlatformApplication action.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.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 from CreatePlatformApplication. The
EndpointArn that is returned when using
CreatePlatformEndpoint can then be used by the
Publish action to send a message to a mobile app or by the
Subscribe action for subscription to a topic. The
CreatePlatformEndpoint 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.
createPlatformEndpoint in interface AmazonSNScreatePlatformEndpointRequest - Input for CreatePlatformEndpoint action.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.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.
createTopic in interface AmazonSNScreateTopicRequest - Input for CreateTopic action.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.public CreateTopicResult createTopic(String name)
AmazonSNScreateTopic in interface AmazonSNSAmazonSNS.createTopic(CreateTopicRequest)public void deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest)
Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
deleteEndpoint in interface AmazonSNSdeleteEndpointRequest - Input for DeleteEndpoint action.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.public void 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.
deletePlatformApplication in interface AmazonSNSdeletePlatformApplicationRequest - Input for DeletePlatformApplication action.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.public void 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.
deleteTopic in interface AmazonSNSdeleteTopicRequest - 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.public void deleteTopic(String topicArn)
AmazonSNSdeleteTopic in interface AmazonSNSAmazonSNS.deleteTopic(DeleteTopicRequest)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.
getEndpointAttributes in interface AmazonSNSgetEndpointAttributesRequest - Input for GetEndpointAttributes action.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.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.
getPlatformApplicationAttributes in interface AmazonSNSgetPlatformApplicationAttributesRequest - Input for GetPlatformApplicationAttributes action.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.public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest)
Returns all of the properties of a subscription.
getSubscriptionAttributes in interface AmazonSNSgetSubscriptionAttributesRequest - Input for GetSubscriptionAttributes.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.public GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)
AmazonSNSgetSubscriptionAttributes in interface AmazonSNSAmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)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.
getTopicAttributes in interface AmazonSNSgetTopicAttributesRequest - Input for GetTopicAttributes action.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.public GetTopicAttributesResult getTopicAttributes(String topicArn)
AmazonSNSgetTopicAttributes in interface AmazonSNSAmazonSNS.getTopicAttributes(GetTopicAttributesRequest)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 call
ListEndpointsByPlatformApplication 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.
listEndpointsByPlatformApplication in interface AmazonSNSlistEndpointsByPlatformApplicationRequest - Input for ListEndpointsByPlatformApplication action.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.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 call ListPlatformApplications
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.
listPlatformApplications in interface AmazonSNSlistPlatformApplicationsRequest - Input for ListPlatformApplications action.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.public ListPlatformApplicationsResult listPlatformApplications()
AmazonSNSlistPlatformApplications in interface AmazonSNSAmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)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 the
NextToken parameter in a new ListSubscriptions
call to get further results.
listSubscriptions in interface AmazonSNSlistSubscriptionsRequest - Input for ListSubscriptions action.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.public ListSubscriptionsResult listSubscriptions()
AmazonSNSlistSubscriptions in interface AmazonSNSAmazonSNS.listSubscriptions(ListSubscriptionsRequest)public ListSubscriptionsResult listSubscriptions(String nextToken)
AmazonSNSlistSubscriptions in interface AmazonSNSAmazonSNS.listSubscriptions(ListSubscriptionsRequest)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 the
NextToken parameter in a new
ListSubscriptionsByTopic call to get further results.
listSubscriptionsByTopic in interface AmazonSNSlistSubscriptionsByTopicRequest - Input for ListSubscriptionsByTopic action.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.public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)
AmazonSNSlistSubscriptionsByTopic in interface AmazonSNSAmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn, String nextToken)
AmazonSNSlistSubscriptionsByTopic in interface AmazonSNSAmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)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 the NextToken
parameter in a new ListTopics call to get further results.
listTopics in interface AmazonSNSlistTopicsRequest - 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.public ListTopicsResult listTopics()
AmazonSNSlistTopics in interface AmazonSNSAmazonSNS.listTopics(ListTopicsRequest)public ListTopicsResult listTopics(String nextToken)
AmazonSNSlistTopics in interface AmazonSNSAmazonSNS.listTopics(ListTopicsRequest)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 the CreatePlatformEndpoint action. The second example
below shows a request and response for publishing to a mobile endpoint.
publish in interface AmazonSNSpublishRequest - Input for Publish action.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.public PublishResult publish(String topicArn, String message)
AmazonSNSpublish in interface AmazonSNSAmazonSNS.publish(PublishRequest)public PublishResult publish(String topicArn, String message, String subject)
AmazonSNSpublish in interface AmazonSNSAmazonSNS.publish(PublishRequest)public void removePermission(RemovePermissionRequest removePermissionRequest)
Removes a statement from a topic's access control policy.
removePermission in interface AmazonSNSremovePermissionRequest - Input for RemovePermission action.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.public void removePermission(String topicArn, String label)
AmazonSNSremovePermission in interface AmazonSNSAmazonSNS.removePermission(RemovePermissionRequest)public 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. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributes in interface AmazonSNSsetEndpointAttributesRequest - Input for SetEndpointAttributes action.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.public void 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.
setPlatformApplicationAttributes in interface AmazonSNSsetPlatformApplicationAttributesRequest - Input for SetPlatformApplicationAttributes action.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.public void setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributes in interface AmazonSNSsetSubscriptionAttributesRequest - Input for SetSubscriptionAttributes action.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.public void setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue)
AmazonSNSsetSubscriptionAttributes in interface AmazonSNSAmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)public void setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest)
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributes in interface AmazonSNSsetTopicAttributesRequest - Input for SetTopicAttributes action.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.public void setTopicAttributes(String topicArn, String attributeName, String attributeValue)
AmazonSNSsetTopicAttributes in interface AmazonSNSAmazonSNS.setTopicAttributes(SetTopicAttributesRequest)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.
subscribe in interface AmazonSNSsubscribeRequest - Input for Subscribe action.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.public SubscribeResult subscribe(String topicArn, String protocol, String endpoint)
AmazonSNSsubscribe in interface AmazonSNSAmazonSNS.subscribe(SubscribeRequest)public void 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 the Unsubscribe request was
unintended.
unsubscribe in interface AmazonSNSunsubscribeRequest - Input for Unsubscribe action.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.public void unsubscribe(String subscriptionArn)
AmazonSNSunsubscribe in interface AmazonSNSAmazonSNS.unsubscribe(UnsubscribeRequest)public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata in interface AmazonSNSrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.