public interface 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 .
| Modifier and Type | Method and Description |
|---|---|
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. |
void |
addPermission(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames)
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. |
ConfirmSubscriptionResult |
confirmSubscription(String topicArn,
String token)
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. |
ConfirmSubscriptionResult |
confirmSubscription(String topicArn,
String token,
String authenticateOnUnsubscribe)
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 action 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. |
CreateTopicResult |
createTopic(String name)
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. |
void |
deleteTopic(String topicArn)
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. |
GetSubscriptionAttributesResult |
getSubscriptionAttributes(String subscriptionArn)
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. |
GetTopicAttributesResult |
getTopicAttributes(String topicArn)
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. |
ListSubscriptionsResult |
listSubscriptions(String nextToken)
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. |
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(String topicArn)
The
ListSubscriptionsByTopic action returns a list of the
subscriptions to a specific topic. |
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(String topicArn,
String nextToken)
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. |
ListTopicsResult |
listTopics(String nextToken)
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. |
PublishResult |
publish(String topicArn,
String message)
The
Publish action sends a message to all of a topic's
subscribed endpoints. |
PublishResult |
publish(String topicArn,
String message,
String subject)
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 |
removePermission(String topicArn,
String label)
The
RemovePermission action removes a statement from a
topic's access control policy. |
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://sns.us-east-1.amazonaws.com").
|
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 |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest)
The
SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value. |
void |
setSubscriptionAttributes(String subscriptionArn,
String attributeName,
String attributeValue)
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. |
void |
setTopicAttributes(String topicArn,
String attributeName,
String attributeValue)
The
SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
SubscribeResult |
subscribe(String topicArn,
String protocol,
String endpoint)
The
Subscribe action prepares to subscribe an endpoint by
sending the endpoint a confirmation message. |
SubscribeResult |
subscribe(SubscribeRequest subscribeRequest)
The
Subscribe action prepares to subscribe an endpoint by
sending the endpoint a confirmation message. |
void |
unsubscribe(String subscriptionArn)
The
Unsubscribe action deletes a subscription. |
void |
unsubscribe(UnsubscribeRequest unsubscribeRequest)
The
Unsubscribe action deletes a subscription. |
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "sns.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://sns.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "sns.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://sns.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws AmazonServiceException, AmazonClientException
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. 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".
confirmSubscriptionRequest - Container for the necessary
parameters to execute the ConfirmSubscription service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
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. 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 .
createPlatformApplicationRequest - Container for the necessary
parameters to execute the CreatePlatformApplication service method on
AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetTopicAttributes action returns all of the
properties of a topic. Topic properties returned might differ based on
the authorization of the user.
getTopicAttributesRequest - Container for the necessary
parameters to execute the GetTopicAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.SubscribeResult subscribe(SubscribeRequest subscribeRequest) throws AmazonServiceException, AmazonClientException
The Subscribe action 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.
subscribeRequest - Container for the necessary parameters to
execute the Subscribe service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws AmazonServiceException, AmazonClientException
The DeleteEndpoint action, which is idempotent, deletes
the endpoint from SNS. For more information, see
Using Amazon SNS Mobile Push Notifications .
deleteEndpointRequest - Container for the necessary parameters to
execute the DeleteEndpoint service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value.
setTopicAttributesRequest - Container for the necessary
parameters to execute the SetTopicAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void removePermission(RemovePermissionRequest removePermissionRequest) throws AmazonServiceException, AmazonClientException
The RemovePermission action removes a statement from a
topic's access control policy.
removePermissionRequest - Container for the necessary parameters
to execute the RemovePermission service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetEndpointAttributes 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 .
getEndpointAttributesRequest - Container for the necessary
parameters to execute the GetEndpointAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
The ListSubscriptions action 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.
listSubscriptionsRequest - Container for the necessary parameters
to execute the ListSubscriptions service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws AmazonServiceException, AmazonClientException
The CreatePlatformEndpoint action 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 .
createPlatformEndpointRequest - Container for the necessary
parameters to execute the CreatePlatformEndpoint service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesRequest - Container for the necessary
parameters to execute the SetSubscriptionAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.CreateTopicResult createTopic(CreateTopicRequest createTopicRequest) throws AmazonServiceException, AmazonClientException
The CreateTopic action 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.
createTopicRequest - Container for the necessary parameters to
execute the CreateTopic service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionTopicLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetSubscriptionAttribtues action returns all of the
properties of a subscription.
getSubscriptionAttributesRequest - Container for the necessary
parameters to execute the GetSubscriptionAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListTopicsResult listTopics(ListTopicsRequest listTopicsRequest) throws AmazonServiceException, AmazonClientException
The ListTopics action 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.
listTopicsRequest - Container for the necessary parameters to
execute the ListTopics service method on AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
The DeletePlatformApplication action 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 .
deletePlatformApplicationRequest - Container for the necessary
parameters to execute the DeletePlatformApplication service method on
AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws AmazonServiceException, AmazonClientException
The ListPlatformApplications action 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 .
listPlatformApplicationsRequest - Container for the necessary
parameters to execute the ListPlatformApplications service method on
AmazonSNS.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest) throws AmazonServiceException, AmazonClientException
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. For more information, see
Using Amazon SNS Mobile Push Notifications .
setEndpointAttributesRequest - Container for the necessary
parameters to execute the SetEndpointAttributes service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void unsubscribe(UnsubscribeRequest unsubscribeRequest) throws AmazonServiceException, AmazonClientException
The Unsubscribe action 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.
unsubscribeRequest - Container for the necessary parameters to
execute the Unsubscribe service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void deleteTopic(DeleteTopicRequest deleteTopicRequest) throws AmazonServiceException, AmazonClientException
The DeleteTopic action 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.
deleteTopicRequest - Container for the necessary parameters to
execute the DeleteTopic service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
The GetPlatformApplicationAttributes action 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 .
getPlatformApplicationAttributesRequest - Container for the
necessary parameters to execute the GetPlatformApplicationAttributes
service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) throws AmazonServiceException, AmazonClientException
The SetPlatformApplicationAttributes action 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 .
setPlatformApplicationAttributesRequest - Container for the
necessary parameters to execute the SetPlatformApplicationAttributes
service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void addPermission(AddPermissionRequest addPermissionRequest) throws AmazonServiceException, AmazonClientException
The AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions.
addPermissionRequest - Container for the necessary parameters to
execute the AddPermission service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws AmazonServiceException, AmazonClientException
The ListEndpointsByPlatformApplication action 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 .
listEndpointsByPlatformApplicationRequest - Container for the
necessary parameters to execute the ListEndpointsByPlatformApplication
service method on AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws AmazonServiceException, AmazonClientException
The ListSubscriptionsByTopic action 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.
listSubscriptionsByTopicRequest - Container for the necessary
parameters to execute the ListSubscriptionsByTopic service method on
AmazonSNS.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.PublishResult publish(PublishRequest publishRequest) throws AmazonServiceException, AmazonClientException
The Publish action 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.
publishRequest - Container for the necessary parameters to
execute the Publish service method on AmazonSNS.NotFoundExceptionPlatformApplicationDisabledExceptionEndpointDisabledExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsResult listSubscriptions() throws AmazonServiceException, AmazonClientException
The ListSubscriptions action 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.
AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListTopicsResult listTopics() throws AmazonServiceException, AmazonClientException
The ListTopics action 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.
AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListPlatformApplicationsResult listPlatformApplications() throws AmazonServiceException, AmazonClientException
The ListPlatformApplications action 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 .
AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ConfirmSubscriptionResult confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe) throws AmazonServiceException, AmazonClientException
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. 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".
topicArn - The ARN of the topic for which you wish to confirm a
subscription.token - Short-lived token sent to an endpoint during the
Subscribe action.authenticateOnUnsubscribe - Disallows unauthenticated
unsubscribes of the subscription. If the value of this parameter is
true and the request has an AWS signature, then only the
topic owner and the subscription owner can unsubscribe the endpoint.
The unsubscribe action requires AWS authentication.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ConfirmSubscriptionResult confirmSubscription(String topicArn, String token) throws AmazonServiceException, AmazonClientException
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. 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".
topicArn - The ARN of the topic for which you wish to confirm a
subscription.token - Short-lived token sent to an endpoint during the
Subscribe action.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetTopicAttributesResult getTopicAttributes(String topicArn) throws AmazonServiceException, AmazonClientException
The GetTopicAttributes action returns all of the
properties of a topic. Topic properties returned might differ based on
the authorization of the user.
topicArn - The ARN of the topic whose properties you want to get.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.SubscribeResult subscribe(String topicArn, String protocol, String endpoint) throws AmazonServiceException, AmazonClientException
The Subscribe action 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.
topicArn - The ARN of the topic you want to subscribe to.protocol - The protocol you want to use. Supported protocols
include: http -- delivery of JSON-encoded
message via HTTP POSThttps -- delivery of
JSON-encoded message via HTTPS POSTemail --
delivery of message via SMTPemail-json --
delivery of JSON-encoded message via SMTPsms --
delivery of message via SMSsqs -- delivery of
JSON-encoded message to an Amazon SQS queueapplication -- delivery of JSON-encoded message to an
EndpointArn for a mobile app and device.endpoint - The endpoint that you want to receive notifications.
Endpoints vary by protocol: http
protocol, the endpoint is an URL beginning with "http://"https protocol, the endpoint is a URL beginning with
"https://"email protocol, the endpoint
is an email addressemail-json protocol,
the endpoint is an email addresssms
protocol, the endpoint is a phone number of an SMS-enabled devicesqs protocol, the endpoint is the ARN of an
Amazon SQS queueapplication protocol,
the endpoint is the EndpointArn of a mobile app and device.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionSubscriptionLimitExceededExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setTopicAttributes(String topicArn, String attributeName, String attributeValue) throws AmazonServiceException, AmazonClientException
The SetTopicAttributes action allows a topic owner to set
an attribute of the topic to a new value.
topicArn - The ARN of the topic to modify.attributeName - The name of the attribute you want to set. Only a
subset of the topic's attributes are mutable. Valid values:
Policy | DisplayName |
DeliveryPolicy
attributeValue - The new value for the attribute.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void removePermission(String topicArn, String label) throws AmazonServiceException, AmazonClientException
The RemovePermission action removes a statement from a
topic's access control policy.
topicArn - The ARN of the topic whose access control policy you
wish to modify.label - The unique label of the statement you want to remove.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsResult listSubscriptions(String nextToken) throws AmazonServiceException, AmazonClientException
The ListSubscriptions action 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.
nextToken - Token returned by the previous
ListSubscriptions request.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue) throws AmazonServiceException, AmazonClientException
The SetSubscriptionAttributes action allows a
subscription owner to set an attribute of the topic to a new value.
subscriptionArn - The ARN of the subscription to modify.attributeName - The name of the attribute you want to set. Only a
subset of the subscriptions attributes are mutable. Valid values:
DeliveryPolicy | RawMessageDelivery
attributeValue - The new value for the attribute in JSON format.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.CreateTopicResult createTopic(String name) throws AmazonServiceException, AmazonClientException
The CreateTopic action 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.
name - The name of the topic you want to create. Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.
AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionTopicLimitExceededExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn) throws AmazonServiceException, AmazonClientException
The GetSubscriptionAttribtues action returns all of the
properties of a subscription.
subscriptionArn - The ARN of the subscription whose properties
you want to get.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListTopicsResult listTopics(String nextToken) throws AmazonServiceException, AmazonClientException
The ListTopics action 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.
nextToken - Token returned by the previous
ListTopics request.AuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void unsubscribe(String subscriptionArn) throws AmazonServiceException, AmazonClientException
The Unsubscribe action 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.
subscriptionArn - The ARN of the subscription to be deleted.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void deleteTopic(String topicArn) throws AmazonServiceException, AmazonClientException
The DeleteTopic action 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.
topicArn - The ARN of the topic you want to delete. NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames) throws AmazonServiceException, AmazonClientException
The AddPermission action adds a statement to a topic's
access control policy, granting access for the specified AWS accounts
to the specified actions.
topicArn - The ARN of the topic whose access control policy you
wish to modify.label - A unique identifier for the new policy statement.aWSAccountIds - The AWS account IDs of the users (principals) who
will be given access to the specified actions. The users must have AWS
accounts, but do not need to be signed up for this service.actionNames - The action you want to allow for the specified
principal(s). Valid values: any Amazon SNS action name.
NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn, String nextToken) throws AmazonServiceException, AmazonClientException
The ListSubscriptionsByTopic action 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.
topicArn - The ARN of the topic for which you wish to find
subscriptions.nextToken - Token returned by the previous
ListSubscriptionsByTopic request.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn) throws AmazonServiceException, AmazonClientException
The ListSubscriptionsByTopic action 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.
topicArn - The ARN of the topic for which you wish to find
subscriptions.NotFoundExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.PublishResult publish(String topicArn, String message) throws AmazonServiceException, AmazonClientException
The Publish action 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.
topicArn - The topic you want to publish to.message - The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send
different messages for each transport protocol, set the value of the
MessageStructure parameter to json and use a
JSON object for the Message parameter. See the Examples
section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Publish call to return an error (no partial
delivery).NotFoundExceptionPlatformApplicationDisabledExceptionEndpointDisabledExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.PublishResult publish(String topicArn, String message, String subject) throws AmazonServiceException, AmazonClientException
The Publish action 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.
topicArn - The topic you want to publish to.message - The message you want to send to the topic. If you want to send the same message to all transport protocols, include the text of the message as a String value.
If you want to send
different messages for each transport protocol, set the value of the
MessageStructure parameter to json and use a
JSON object for the Message parameter. See the Examples
section for the format of the JSON object.
Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).
JSON-specific constraints:
Publish call to return an error (no partial
delivery).subject - Optional parameter to be used as the "Subject" line
when the message is delivered to email endpoints. This field will also
be included, if present, in the standard JSON messages delivered to
other endpoints. Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.
NotFoundExceptionPlatformApplicationDisabledExceptionEndpointDisabledExceptionAuthorizationErrorExceptionInternalErrorExceptionInvalidParameterExceptionAmazonClientException - If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException - If an error response is returned by AmazonSNS indicating
either a problem with the data in the request, or a server side issue.void shutdown()
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 a request.
request - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.