@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonSNSClient extends AmazonWebServiceClient implements AmazonSNS
Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see https://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 and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
protected List<Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all modeled exceptions
|
client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonSNSClient()
Deprecated.
|
AmazonSNSClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonSNSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonSNSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonSNSClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AddPermissionResult |
addPermission(AddPermissionRequest request)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the
specified actions.
|
AddPermissionResult |
addPermission(String topicArn,
String label,
List<String> aWSAccountIds,
List<String> actionNames)
Simplified method form for invoking the AddPermission operation.
|
static AmazonSNSClientBuilder |
builder() |
CheckIfPhoneNumberIsOptedOutResult |
checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your
account.
|
ConfirmSubscriptionResult |
confirmSubscription(ConfirmSubscriptionRequest request)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier
Subscribe action. |
ConfirmSubscriptionResult |
confirmSubscription(String topicArn,
String token)
Simplified method form for invoking the ConfirmSubscription operation.
|
ConfirmSubscriptionResult |
confirmSubscription(String topicArn,
String token,
String authenticateOnUnsubscribe)
Simplified method form for invoking the ConfirmSubscription operation.
|
CreatePlatformApplicationResult |
createPlatformApplication(CreatePlatformApplicationRequest request)
Creates a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging), to which devices and mobile apps may register.
|
CreatePlatformEndpointResult |
createPlatformEndpoint(CreatePlatformEndpointRequest request)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM
(Firebase Cloud Messaging) and APNS.
|
CreateTopicResult |
createTopic(CreateTopicRequest request)
Creates a topic to which notifications can be published.
|
CreateTopicResult |
createTopic(String name)
Simplified method form for invoking the CreateTopic operation.
|
DeleteEndpointResult |
deleteEndpoint(DeleteEndpointRequest request)
Deletes the endpoint for a device and mobile app from Amazon SNS.
|
DeletePlatformApplicationResult |
deletePlatformApplication(DeletePlatformApplicationRequest request)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
DeleteTopicResult |
deleteTopic(DeleteTopicRequest request)
Deletes a topic and all its subscriptions.
|
DeleteTopicResult |
deleteTopic(String topicArn)
Simplified method form for invoking the DeleteTopic operation.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEndpointAttributesResult |
getEndpointAttributes(GetEndpointAttributesRequest request)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM
(Firebase Cloud Messaging) and APNS.
|
GetPlatformApplicationAttributesResult |
getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)
Retrieves the attributes of the platform application object for the supported push notification services, such as
APNS and GCM (Firebase Cloud Messaging).
|
GetSMSAttributesResult |
getSMSAttributes(GetSMSAttributesRequest request)
Returns the settings for sending SMS messages from your account.
|
GetSubscriptionAttributesResult |
getSubscriptionAttributes(GetSubscriptionAttributesRequest request)
Returns all of the properties of a subscription.
|
GetSubscriptionAttributesResult |
getSubscriptionAttributes(String subscriptionArn)
Simplified method form for invoking the GetSubscriptionAttributes operation.
|
GetTopicAttributesResult |
getTopicAttributes(GetTopicAttributesRequest request)
Returns all of the properties of a topic.
|
GetTopicAttributesResult |
getTopicAttributes(String topicArn)
Simplified method form for invoking the GetTopicAttributes operation.
|
ListEndpointsByPlatformApplicationResult |
listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM
(Firebase Cloud Messaging) and APNS.
|
ListPhoneNumbersOptedOutResult |
listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request)
Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.
|
ListPlatformApplicationsResult |
listPlatformApplications()
Simplified method form for invoking the ListPlatformApplications operation.
|
ListPlatformApplicationsResult |
listPlatformApplications(ListPlatformApplicationsRequest request)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging).
|
ListSubscriptionsResult |
listSubscriptions()
Simplified method form for invoking the ListSubscriptions operation.
|
ListSubscriptionsResult |
listSubscriptions(ListSubscriptionsRequest request)
Returns a list of the requester's subscriptions.
|
ListSubscriptionsResult |
listSubscriptions(String nextToken)
Simplified method form for invoking the ListSubscriptions operation.
|
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)
Returns a list of the subscriptions to a specific topic.
|
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(String topicArn)
Simplified method form for invoking the ListSubscriptionsByTopic operation.
|
ListSubscriptionsByTopicResult |
listSubscriptionsByTopic(String topicArn,
String nextToken)
Simplified method form for invoking the ListSubscriptionsByTopic operation.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List all tags added to the specified Amazon SNS topic.
|
ListTopicsResult |
listTopics()
Simplified method form for invoking the ListTopics operation.
|
ListTopicsResult |
listTopics(ListTopicsRequest request)
Returns a list of the requester's topics.
|
ListTopicsResult |
listTopics(String nextToken)
Simplified method form for invoking the ListTopics operation.
|
OptInPhoneNumberResult |
optInPhoneNumber(OptInPhoneNumberRequest request)
Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to
the number.
|
PublishResult |
publish(PublishRequest request)
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to
a mobile platform endpoint (when you specify the
TargetArn ). |
PublishResult |
publish(String topicArn,
String message)
Simplified method form for invoking the Publish operation.
|
PublishResult |
publish(String topicArn,
String message,
String subject)
Simplified method form for invoking the Publish operation.
|
RemovePermissionResult |
removePermission(RemovePermissionRequest request)
Removes a statement from a topic's access control policy.
|
RemovePermissionResult |
removePermission(String topicArn,
String label)
Simplified method form for invoking the RemovePermission operation.
|
SetEndpointAttributesResult |
setEndpointAttributes(SetEndpointAttributesRequest request)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM
(Firebase Cloud Messaging) and APNS.
|
SetPlatformApplicationAttributesResult |
setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)
Sets the attributes of the platform application object for the supported push notification services, such as APNS
and GCM (Firebase Cloud Messaging).
|
SetSMSAttributesResult |
setSMSAttributes(SetSMSAttributesRequest request)
Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.
|
SetSubscriptionAttributesResult |
setSubscriptionAttributes(SetSubscriptionAttributesRequest request)
Allows a subscription owner to set an attribute of the subscription to a new value.
|
SetSubscriptionAttributesResult |
setSubscriptionAttributes(String subscriptionArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetSubscriptionAttributes operation.
|
SetTopicAttributesResult |
setTopicAttributes(SetTopicAttributesRequest request)
Allows a topic owner to set an attribute of the topic to a new value.
|
SetTopicAttributesResult |
setTopicAttributes(String topicArn,
String attributeName,
String attributeValue)
Simplified method form for invoking the SetTopicAttributes operation.
|
SubscribeResult |
subscribe(String topicArn,
String protocol,
String endpoint)
Simplified method form for invoking the Subscribe operation.
|
SubscribeResult |
subscribe(SubscribeRequest request)
Subscribes an endpoint to an Amazon SNS topic.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Add tags to the specified Amazon SNS topic.
|
UnsubscribeResult |
unsubscribe(String subscriptionArn)
Simplified method form for invoking the Unsubscribe operation.
|
UnsubscribeResult |
unsubscribe(UnsubscribeRequest request)
Deletes a subscription.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove tags from the specified Amazon SNS topic.
|
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
protected final List<Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
@Deprecated public AmazonSNSClient()
AmazonSNSClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonSNSClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AmazonSNSClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonSNSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonSNSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonSNSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Amazon SNS (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AmazonSNSClientBuilder builder()
public AddPermissionResult addPermission(AddPermissionRequest request)
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
addPermission
in interface AmazonSNS
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.public AddPermissionResult addPermission(String topicArn, String label, List<String> aWSAccountIds, List<String> actionNames)
AmazonSNS
addPermission
in interface AmazonSNS
AmazonSNS.addPermission(AddPermissionRequest)
public CheckIfPhoneNumberIsOptedOutResult checkIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest request)
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.
checkIfPhoneNumberIsOptedOut
in interface AmazonSNS
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.public ConfirmSubscriptionResult confirmSubscription(ConfirmSubscriptionRequest request)
Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an
earlier Subscribe
action. If the token is valid, the action creates a new subscription and returns
its Amazon Resource Name (ARN). This call requires an AWS signature only when the
AuthenticateOnUnsubscribe
flag is set to "true".
confirmSubscription
in interface AmazonSNS
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.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter
polices, submit an SNS Limit Increase case in the AWS Support Center.public ConfirmSubscriptionResult confirmSubscription(String topicArn, String token, String authenticateOnUnsubscribe)
AmazonSNS
confirmSubscription
in interface AmazonSNS
AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)
public ConfirmSubscriptionResult confirmSubscription(String topicArn, String token)
AmazonSNS
confirmSubscription
in interface AmazonSNS
AmazonSNS.confirmSubscription(ConfirmSubscriptionRequest)
public CreatePlatformApplicationResult createPlatformApplication(CreatePlatformApplicationRequest request)
Creates a platform application object for one of the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify
PlatformPrincipal
and PlatformCredential
attributes when using the
CreatePlatformApplication
action.
PlatformPrincipal
and PlatformCredential
are received from the notification service.
For ADM
, PlatformPrincipal
is client id
and
PlatformCredential
is client secret
.
For Baidu
, PlatformPrincipal
is API key
and
PlatformCredential
is secret key
.
For APNS
and APNS_SANDBOX
, PlatformPrincipal
is
SSL certificate
and PlatformCredential
is private key
.
For GCM
(Firebase Cloud Messaging), there is no PlatformPrincipal
and the
PlatformCredential
is API key
.
For MPNS
, PlatformPrincipal
is TLS certificate
and
PlatformCredential
is private key
.
For WNS
, PlatformPrincipal
is Package Security Identifier
and
PlatformCredential
is secret key
.
You can use the returned PlatformApplicationArn
as an attribute for the
CreatePlatformEndpoint
action.
createPlatformApplication
in interface AmazonSNS
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.public CreatePlatformEndpointResult createPlatformEndpoint(CreatePlatformEndpointRequest request)
Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM
(Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint
requires the
PlatformApplicationArn
that is returned from CreatePlatformApplication
. You can use the
returned EndpointArn
to send a message to a mobile app or by the Subscribe
action for
subscription to a topic. The CreatePlatformEndpoint
action is idempotent, so if the requester
already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without
creating a new endpoint. For more information, see Using Amazon SNS Mobile Push
Notifications.
When using CreatePlatformEndpoint
with Baidu, two attributes must be provided: ChannelId and UserId.
The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint
for Baidu.
createPlatformEndpoint
in interface AmazonSNS
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.public CreateTopicResult createTopic(CreateTopicRequest request)
Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
createTopic
in interface AmazonSNS
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.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.public CreateTopicResult createTopic(String name)
AmazonSNS
createTopic
in interface AmazonSNS
AmazonSNS.createTopic(CreateTopicRequest)
public DeleteEndpointResult deleteEndpoint(DeleteEndpointRequest request)
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.
deleteEndpoint
in interface AmazonSNS
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.public DeletePlatformApplicationResult deletePlatformApplication(DeletePlatformApplicationRequest request)
Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
deletePlatformApplication
in interface AmazonSNS
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.public DeleteTopicResult deleteTopic(DeleteTopicRequest request)
Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.
deleteTopic
in interface AmazonSNS
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.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.public DeleteTopicResult deleteTopic(String topicArn)
AmazonSNS
deleteTopic
in interface AmazonSNS
AmazonSNS.deleteTopic(DeleteTopicRequest)
public GetEndpointAttributesResult getEndpointAttributes(GetEndpointAttributesRequest request)
Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
getEndpointAttributes
in interface AmazonSNS
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.public GetPlatformApplicationAttributesResult getPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest request)
Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.
getPlatformApplicationAttributes
in interface AmazonSNS
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.public GetSMSAttributesResult getSMSAttributes(GetSMSAttributesRequest request)
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes
action.
getSMSAttributes
in interface AmazonSNS
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.public GetSubscriptionAttributesResult getSubscriptionAttributes(GetSubscriptionAttributesRequest request)
Returns all of the properties of a subscription.
getSubscriptionAttributes
in interface AmazonSNS
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.public GetSubscriptionAttributesResult getSubscriptionAttributes(String subscriptionArn)
AmazonSNS
getSubscriptionAttributes
in interface AmazonSNS
AmazonSNS.getSubscriptionAttributes(GetSubscriptionAttributesRequest)
public GetTopicAttributesResult getTopicAttributes(GetTopicAttributesRequest request)
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
getTopicAttributes
in interface AmazonSNS
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.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.public GetTopicAttributesResult getTopicAttributes(String topicArn)
AmazonSNS
getTopicAttributes
in interface AmazonSNS
AmazonSNS.getTopicAttributes(GetTopicAttributesRequest)
public ListEndpointsByPlatformApplicationResult listEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest request)
Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM
(Firebase Cloud Messaging) 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.
This action is throttled at 30 transactions per second (TPS).
listEndpointsByPlatformApplication
in interface AmazonSNS
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.public ListPhoneNumbersOptedOutResult listPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest request)
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.
listPhoneNumbersOptedOut
in interface AmazonSNS
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.public ListPlatformApplicationsResult listPlatformApplications(ListPlatformApplicationsRequest request)
Lists the platform application objects for the supported push notification services, such as APNS and GCM
(Firebase Cloud Messaging). 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.
This action is throttled at 15 transactions per second (TPS).
listPlatformApplications
in interface AmazonSNS
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.public ListPlatformApplicationsResult listPlatformApplications()
AmazonSNS
listPlatformApplications
in interface AmazonSNS
AmazonSNS.listPlatformApplications(ListPlatformApplicationsRequest)
public ListSubscriptionsResult listSubscriptions(ListSubscriptionsRequest request)
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.
This action is throttled at 30 transactions per second (TPS).
listSubscriptions
in interface AmazonSNS
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.public ListSubscriptionsResult listSubscriptions()
AmazonSNS
listSubscriptions
in interface AmazonSNS
AmazonSNS.listSubscriptions(ListSubscriptionsRequest)
public ListSubscriptionsResult listSubscriptions(String nextToken)
AmazonSNS
listSubscriptions
in interface AmazonSNS
AmazonSNS.listSubscriptions(ListSubscriptionsRequest)
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(ListSubscriptionsByTopicRequest request)
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.
This action is throttled at 30 transactions per second (TPS).
listSubscriptionsByTopic
in interface AmazonSNS
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.public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn)
AmazonSNS
listSubscriptionsByTopic
in interface AmazonSNS
AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)
public ListSubscriptionsByTopicResult listSubscriptionsByTopic(String topicArn, String nextToken)
AmazonSNS
listSubscriptionsByTopic
in interface AmazonSNS
AmazonSNS.listSubscriptionsByTopic(ListSubscriptionsByTopicRequest)
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.
listTagsForResource
in interface AmazonSNS
listTagsForResourceRequest
- ResourceNotFoundException
- Can't tag resource. Verify that the topic exists.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.public ListTopicsResult listTopics(ListTopicsRequest request)
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.
This action is throttled at 30 transactions per second (TPS).
listTopics
in interface AmazonSNS
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.public ListTopicsResult listTopics()
AmazonSNS
listTopics
in interface AmazonSNS
AmazonSNS.listTopics(ListTopicsRequest)
public ListTopicsResult listTopics(String nextToken)
AmazonSNS
listTopics
in interface AmazonSNS
AmazonSNS.listTopics(ListTopicsRequest)
public OptInPhoneNumberResult optInPhoneNumber(OptInPhoneNumberRequest request)
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.
optInPhoneNumber
in interface AmazonSNS
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.public PublishResult publish(PublishRequest request)
Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to
a mobile platform endpoint (when you specify the TargetArn
).
If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.
When a messageId
is returned, the message has been saved and Amazon SNS will attempt to deliver it
shortly.
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.
You can publish messages only to topics and endpoints in the same AWS Region.
publish
in interface AmazonSNS
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.KMSDisabledException
- The request was rejected because the specified customer master key (CMK) isn't enabled.KMSInvalidStateException
- The request was rejected because the state of the specified resource isn't valid for this request. For
more information, see How
Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer
Guide.KMSNotFoundException
- The request was rejected because the specified entity or resource can't be found.KMSOptInRequiredException
- The AWS access key ID needs a subscription for the service.KMSThrottlingException
- The request was denied due to request throttling. For more information about throttling, see Limits
in the AWS Key Management Service Developer Guide.KMSAccessDeniedException
- The ciphertext references a key that doesn't exist or that you don't have access to.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.public PublishResult publish(String topicArn, String message)
AmazonSNS
publish
in interface AmazonSNS
AmazonSNS.publish(PublishRequest)
public PublishResult publish(String topicArn, String message, String subject)
AmazonSNS
publish
in interface AmazonSNS
AmazonSNS.publish(PublishRequest)
public RemovePermissionResult removePermission(RemovePermissionRequest request)
Removes a statement from a topic's access control policy.
removePermission
in interface AmazonSNS
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.public RemovePermissionResult removePermission(String topicArn, String label)
AmazonSNS
removePermission
in interface AmazonSNS
AmazonSNS.removePermission(RemovePermissionRequest)
public SetEndpointAttributesResult setEndpointAttributes(SetEndpointAttributesRequest request)
Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
setEndpointAttributes
in interface AmazonSNS
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.public SetPlatformApplicationAttributesResult setPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest request)
Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.
setPlatformApplicationAttributes
in interface AmazonSNS
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.public SetSMSAttributesResult setSMSAttributes(SetSMSAttributesRequest request)
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 Publishing to a mobile phone in
the Amazon SNS Developer Guide.
setSMSAttributes
in interface AmazonSNS
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.public SetSubscriptionAttributesResult setSubscriptionAttributes(SetSubscriptionAttributesRequest request)
Allows a subscription owner to set an attribute of the subscription to a new value.
setSubscriptionAttributes
in interface AmazonSNS
setSubscriptionAttributesRequest
- Input for SetSubscriptionAttributes action.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter
polices, submit an SNS Limit Increase case in the AWS Support Center.InternalErrorException
- Indicates an internal service error.NotFoundException
- Indicates that the requested resource does not exist.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.public SetSubscriptionAttributesResult setSubscriptionAttributes(String subscriptionArn, String attributeName, String attributeValue)
AmazonSNS
setSubscriptionAttributes
in interface AmazonSNS
AmazonSNS.setSubscriptionAttributes(SetSubscriptionAttributesRequest)
public SetTopicAttributesResult setTopicAttributes(SetTopicAttributesRequest request)
Allows a topic owner to set an attribute of the topic to a new value.
setTopicAttributes
in interface AmazonSNS
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.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.public SetTopicAttributesResult setTopicAttributes(String topicArn, String attributeName, String attributeValue)
AmazonSNS
setTopicAttributes
in interface AmazonSNS
AmazonSNS.setTopicAttributes(SetTopicAttributesRequest)
public SubscribeResult subscribe(SubscribeRequest request)
Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and
the topic are not in the same AWS account, the endpoint owner must the ConfirmSubscription
action to
confirm the subscription.
You call the ConfirmSubscription
action with the token from the subscription response. Confirmation
tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
subscribe
in interface AmazonSNS
subscribeRequest
- Input for Subscribe action.SubscriptionLimitExceededException
- Indicates that the customer already owns the maximum allowed number of subscriptions.FilterPolicyLimitExceededException
- Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter
polices, submit an SNS Limit Increase case in the AWS Support Center.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.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.public SubscribeResult subscribe(String topicArn, String protocol, String endpoint)
AmazonSNS
subscribe
in interface AmazonSNS
AmazonSNS.subscribe(SubscribeRequest)
public TagResourceResult tagResource(TagResourceRequest request)
Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
Adding more than 50 tags to a topic isn't recommended.
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
Tagging actions are limited to 10 TPS per AWS account, per AWS region. If your application requires a higher throughput, file a technical support request.
tagResource
in interface AmazonSNS
tagResourceRequest
- ResourceNotFoundException
- Can't tag resource. Verify that the topic exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.public UnsubscribeResult unsubscribe(UnsubscribeRequest request)
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.
This action is throttled at 100 transactions per second (TPS).
unsubscribe
in interface AmazonSNS
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.InvalidSecurityException
- The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using
Signature Version 4.public UnsubscribeResult unsubscribe(String subscriptionArn)
AmazonSNS
unsubscribe
in interface AmazonSNS
AmazonSNS.unsubscribe(UnsubscribeRequest)
public UntagResourceResult untagResource(UntagResourceRequest request)
Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
untagResource
in interface AmazonSNS
untagResourceRequest
- ResourceNotFoundException
- Can't tag resource. Verify that the topic exists.TagLimitExceededException
- Can't add more than 50 tags to a topic.StaleTagException
- A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then
retry the operation.TagPolicyException
- The request doesn't comply with the IAM tag policy. Correct your request and then retry it.InvalidParameterException
- Indicates that a request parameter does not comply with the associated constraints.AuthorizationErrorException
- Indicates that the user has been denied access to the requested resource.ConcurrentAccessException
- Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonSNS
request
- The originally executed requestCopyright © 2020. All rights reserved.