AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface SNSClient extends AutoCloseable
builder()
method.
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 | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AddPermissionResponse |
addPermission(AddPermissionRequest addPermissionRequest) |
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the
specified actions.
|
static SNSClientBuilder |
builder() |
Create a builder that can be used to configure and create a
SNSClient . |
default CheckIfPhoneNumberIsOptedOutResponse |
checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) |
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
account.
|
default ConfirmSubscriptionResponse |
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. |
static SNSClient |
create() |
Create a
SNSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreatePlatformApplicationResponse |
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.
|
default CreatePlatformEndpointResponse |
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.
|
default CreateTopicResponse |
createTopic(CreateTopicRequest createTopicRequest) |
Creates a topic to which notifications can be published.
|
default DeleteEndpointResponse |
deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) |
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
default DeletePlatformApplicationResponse |
deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest) |
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM.
|
default DeleteTopicResponse |
deleteTopic(DeleteTopicRequest deleteTopicRequest) |
Deletes a topic and all its subscriptions.
|
default GetEndpointAttributesResponse |
getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest) |
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM
and APNS.
|
default GetPlatformApplicationAttributesResponse |
getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) |
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and GCM.
|
default GetSMSAttributesResponse |
getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest) |
Returns the settings for sending SMS messages from your account.
|
default GetSubscriptionAttributesResponse |
getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) |
Returns all of the properties of a subscription.
|
default GetTopicAttributesResponse |
getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) |
Returns all of the properties of a topic.
|
default ListEndpointsByPlatformApplicationResponse |
listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) |
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and
APNS.
|
default ListPhoneNumbersOptedOutResponse |
listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) |
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
default ListPlatformApplicationsResponse |
listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest) |
Lists the platform application objects for the supported push notification services, such as APNS and GCM.
|
default ListSubscriptionsResponse |
listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) |
Returns a list of the requester's subscriptions.
|
default ListSubscriptionsByTopicResponse |
listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) |
Returns a list of the subscriptions to a specific topic.
|
default ListTopicsResponse |
listTopics(ListTopicsRequest listTopicsRequest) |
Returns a list of the requester's topics.
|
default OptInPhoneNumberResponse |
optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest) |
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
the number.
|
default PublishResponse |
publish(PublishRequest publishRequest) |
Sends a message to all of a topic's subscribed endpoints.
|
default RemovePermissionResponse |
removePermission(RemovePermissionRequest removePermissionRequest) |
Removes a statement from a topic's access control policy.
|
static ServiceMetadata |
serviceMetadata() |
|
default SetEndpointAttributesResponse |
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.
|
default SetPlatformApplicationAttributesResponse |
setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) |
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and GCM.
|
default SetSMSAttributesResponse |
setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest) |
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
default SetSubscriptionAttributesResponse |
setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) |
Allows a subscription owner to set an attribute of the topic to a new value.
|
default SetTopicAttributesResponse |
setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) |
Allows a topic owner to set an attribute of the topic to a new value.
|
default SubscribeResponse |
subscribe(SubscribeRequest subscribeRequest) |
Prepares to subscribe an endpoint by sending the endpoint a confirmation message.
|
default UnsubscribeResponse |
unsubscribe(UnsubscribeRequest unsubscribeRequest) |
Deletes a subscription.
|
close
static final String SERVICE_NAME
static SNSClient create()
SNSClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static SNSClientBuilder builder()
SNSClient
.default AddPermissionResponse addPermission(AddPermissionRequest addPermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermissionRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CheckIfPhoneNumberIsOptedOutResponse checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest checkIfPhoneNumberIsOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, SdkBaseException, SdkClientException, SNSException
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the OptInPhoneNumber
action.
checkIfPhoneNumberIsOptedOutRequest
- The input for the CheckIfPhoneNumberIsOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ConfirmSubscriptionResponse confirmSubscription(ConfirmSubscriptionRequest confirmSubscriptionRequest) throws SubscriptionLimitExceededException, InvalidParameterException, NotFoundException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePlatformApplicationResponse createPlatformApplication(CreatePlatformApplicationRequest createPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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 WNS, PlatformPrincipal is "Package Security Identifier". For MPNS,
PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".
For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM,
PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential
is "private key". For Baidu, PlatformCredential is "secret key". 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. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of
the supported push notification services, see Getting Started with Apple Push
Notification Service, Getting Started
with Amazon Device Messaging, Getting Started with Baidu Cloud Push,
Getting Started with Google Cloud
Messaging for Android, Getting
Started with MPNS, or Getting Started
with WNS.
createPlatformApplicationRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePlatformEndpointResponse createPlatformEndpoint(CreatePlatformEndpointRequest createPlatformEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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.
createPlatformEndpointRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateTopicResponse createTopic(CreateTopicRequest createTopicRequest) throws InvalidParameterException, TopicLimitExceededException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Creates a topic to which notifications can be published. Users can create at most 100,000 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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.
deleteEndpointRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeletePlatformApplicationResponse deletePlatformApplication(DeletePlatformApplicationRequest deletePlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteTopicResponse deleteTopic(DeleteTopicRequest deleteTopicRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetEndpointAttributesResponse getEndpointAttributes(GetEndpointAttributesRequest getEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetPlatformApplicationAttributesResponse getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest getPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetSMSAttributesResponse getSMSAttributes(GetSMSAttributesRequest getSMSAttributesRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, SdkBaseException, SdkClientException, SNSException
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributesRequest
- The input for the GetSMSAttributes
request.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetSubscriptionAttributesResponse getSubscriptionAttributes(GetSubscriptionAttributesRequest getSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Returns all of the properties of a subscription.
getSubscriptionAttributesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetTopicAttributesResponse getTopicAttributes(GetTopicAttributesRequest getTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListEndpointsByPlatformApplicationResponse listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest listEndpointsByPlatformApplicationRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPhoneNumbersOptedOutResponse listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest listPhoneNumbersOptedOutRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, SdkBaseException, SdkClientException, SNSException
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
The results for ListPhoneNumbersOptedOut
are paginated, and each page returns up to 100 phone
numbers. If additional phone numbers are available after the first page of results, then a NextToken
string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut
again using the
NextToken
string received from the previous call. When there are no more records to return,
NextToken
will be null.
listPhoneNumbersOptedOutRequest
- The input for the ListPhoneNumbersOptedOut
action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListPlatformApplicationsResponse listPlatformApplications(ListPlatformApplicationsRequest listPlatformApplicationsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListSubscriptionsByTopicResponse listSubscriptionsByTopic(ListSubscriptionsByTopicRequest listSubscriptionsByTopicRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTopicsResponse listTopics(ListTopicsRequest listTopicsRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault OptInPhoneNumberResponse optInPhoneNumber(OptInPhoneNumberRequest optInPhoneNumberRequest) throws ThrottledException, InternalErrorException, AuthorizationErrorException, InvalidParameterException, SdkBaseException, SdkClientException, SNSException
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.
You can opt in a phone number only once every 30 days.
optInPhoneNumberRequest
- Input for the OptInPhoneNumber action.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PublishResponse publish(PublishRequest publishRequest) throws InvalidParameterException, InvalidParameterValueException, InternalErrorException, NotFoundException, EndpointDisabledException, PlatformApplicationDisabledException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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.
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 for the TargetArn parameter. The EndpointArn is returned
when making a call with the CreatePlatformEndpoint
action.
For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.
publishRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
Removes a statement from a topic's access control policy.
removePermissionRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetEndpointAttributesResponse setEndpointAttributes(SetEndpointAttributesRequest setEndpointAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetPlatformApplicationAttributesResponse setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest setPlatformApplicationAttributesRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.
setPlatformApplicationAttributesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetSMSAttributesResponse setSMSAttributes(SetSMSAttributesRequest setSMSAttributesRequest) throws InvalidParameterException, ThrottledException, InternalErrorException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
You can override some of these settings for a single message when you use the Publish
action with
the MessageAttributes.entry.N
parameter. For more information, see Sending an SMS Message in the
Amazon SNS Developer Guide.
setSMSAttributesRequest
- The input for the SetSMSAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.ThrottledException
- Indicates that the rate at which requests have been submitted for this action exceeds the limit for your
account.InternalErrorException
- Indicates an internal service error.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetSubscriptionAttributesResponse setSubscriptionAttributes(SetSubscriptionAttributesRequest setSubscriptionAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Allows a subscription owner to set an attribute of the topic to a new value.
setSubscriptionAttributesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SetTopicAttributesResponse setTopicAttributes(SetTopicAttributesRequest setTopicAttributesRequest) throws InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SubscribeResponse subscribe(SubscribeRequest subscribeRequest) throws SubscriptionLimitExceededException, InvalidParameterException, InternalErrorException, NotFoundException, AuthorizationErrorException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UnsubscribeResponse unsubscribe(UnsubscribeRequest unsubscribeRequest) throws InvalidParameterException, InternalErrorException, AuthorizationErrorException, NotFoundException, SdkBaseException, SdkClientException, SNSException
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
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)SNSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.