Namespace Amazon.SimpleNotificationService.Model

Classes

AddPermissionRequest: Container for the parameters to the AddPermission operation. Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

AddPermissionResponse: This is the response object from the AddPermission operation.

AuthorizationErrorException: Indicates that the user has been denied access to the requested resource.

Container for the parameters to the CheckIfPhoneNumberIsOptedOut operation. 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.

CheckIfPhoneNumberIsOptedOutResponse

The response from the

CheckIfPhoneNumberIsOptedOut

action.

ConcurrentAccessException: Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

ConfirmSubscriptionRequest

Container for the parameters to the ConfirmSubscription operation. 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".

ConfirmSubscriptionResponse: Response for ConfirmSubscriptions action.

CreatePlatformApplicationRequest

Container for the parameters to the CreatePlatformApplication operation. 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

client id

and

PlatformCredential

client secret

For

Baidu

PlatformPrincipal

API key

and

PlatformCredential

secret key

For

APNS

and

APNS_SANDBOX

PlatformPrincipal

SSL certificate

and

PlatformCredential

private
                                                                                   key

For
```
GCM
```
(Firebase Cloud Messaging), there is no
```
PlatformPrincipal
```
and the
```
PlatformCredential
```
is
```
API key
```
.

For

MPNS

PlatformPrincipal

TLS certificate

and

PlatformCredential

private key

For

WNS

PlatformPrincipal

Package Security Identifier

and

PlatformCredential

secret key

You can use the returned

PlatformApplicationArn

as an attribute for the

CreatePlatformEndpoint

action.

CreatePlatformApplicationResponse: Response from CreatePlatformApplication action.

CreatePlatformEndpointRequest

Container for the parameters to the CreatePlatformEndpoint operation. 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.

CreatePlatformEndpointResponse: Response from CreateEndpoint action.

CreateTopicRequest: Container for the parameters to the CreateTopic operation. 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.

CreateTopicResponse: Response from CreateTopic action.

DeleteEndpointRequest

Container for the parameters to the DeleteEndpoint operation. 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.

DeleteEndpointResponse: This is the response object from the DeleteEndpoint operation.

DeletePlatformApplicationRequest: Container for the parameters to the DeletePlatformApplication operation. 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.

DeletePlatformApplicationResponse: This is the response object from the DeletePlatformApplication operation.

DeleteTopicRequest: Container for the parameters to the DeleteTopic operation. 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.

DeleteTopicResponse: This is the response object from the DeleteTopic operation.

Endpoint: Endpoint for mobile app and device.

EndpointDisabledException: Exception error indicating endpoint disabled.

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.

GetEndpointAttributesRequest: Container for the parameters to the GetEndpointAttributes operation. 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.

GetEndpointAttributesResponse: Response from GetEndpointAttributes of the EndpointArn.

GetPlatformApplicationAttributesRequest: Container for the parameters to the GetPlatformApplicationAttributes operation. 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.

GetPlatformApplicationAttributesResponse: Response for GetPlatformApplicationAttributes action.

GetSMSAttributesRequest

Container for the parameters to the GetSMSAttributes operation. Returns the settings for sending SMS messages from your account.

These settings are set with the

SetSMSAttributes

action.

GetSMSAttributesResponse

The response from the

GetSMSAttributes

request.

GetSubscriptionAttributesRequest: Container for the parameters to the GetSubscriptionAttributes operation. Returns all of the properties of a subscription.

GetSubscriptionAttributesResponse: Response for GetSubscriptionAttributes action.

GetTopicAttributesRequest: Container for the parameters to the GetTopicAttributes operation. Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

GetTopicAttributesResponse: Response for GetTopicAttributes action.

InternalErrorException: Indicates an internal service error.

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.

InvalidSecurityException: The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

KMSAccessDeniedException: The ciphertext references a key that doesn't exist or that you don't have access to.

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.

ListEndpointsByPlatformApplicationRequest

Container for the parameters to the ListEndpointsByPlatformApplication operation. 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).

ListEndpointsByPlatformApplicationResponse: Response for ListEndpointsByPlatformApplication action.

ListPhoneNumbersOptedOutRequest

Container for the parameters to the ListPhoneNumbersOptedOut operation. 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.

ListPhoneNumbersOptedOutResponse

The response from the

ListPhoneNumbersOptedOut

action.

ListPlatformApplicationsRequest

Container for the parameters to the ListPlatformApplications operation. 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).

ListPlatformApplicationsResponse: Response for ListPlatformApplications action.

ListSubscriptionsByTopicRequest

Container for the parameters to the ListSubscriptionsByTopic operation. 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).

ListSubscriptionsByTopicResponse: Response for ListSubscriptionsByTopic action.

ListSubscriptionsRequest

Container for the parameters to the ListSubscriptions operation. 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).

ListSubscriptionsResponse: Response for ListSubscriptions action

ListTagsForResourceRequest: Container for the parameters to the ListTagsForResource operation. 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.

ListTagsForResourceResponse: This is the response object from the ListTagsForResource operation.

ListTopicsRequest

Container for the parameters to the ListTopics operation. 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).

ListTopicsResponse: Response for ListTopics action.

MessageAttributeValue

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.

NotFoundException: Indicates that the requested resource does not exist.

OptInPhoneNumberRequest

Container for the parameters to the OptInPhoneNumber operation. 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.

OptInPhoneNumberResponse: The response for the OptInPhoneNumber action.

PlatformApplication: Platform application object.

PlatformApplicationDisabledException: Exception error indicating platform application disabled.

PublishRequest

Container for the parameters to the Publish operation. 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.

PublishResponse: Response for Publish action.

RemovePermissionRequest: Container for the parameters to the RemovePermission operation. Removes a statement from a topic's access control policy.

RemovePermissionResponse: This is the response object from the RemovePermission operation.

ResourceNotFoundException: Can't tag resource. Verify that the topic exists.

SetEndpointAttributesRequest: Container for the parameters to the SetEndpointAttributes operation. 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.

SetEndpointAttributesResponse: This is the response object from the SetEndpointAttributes operation.

SetPlatformApplicationAttributesRequest: Container for the parameters to the SetPlatformApplicationAttributes operation. 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.

SetPlatformApplicationAttributesResponse: This is the response object from the SetPlatformApplicationAttributes operation.

SetSMSAttributesRequest

Container for the parameters to the SetSMSAttributes operation. 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.

SetSMSAttributesResponse: The response for the SetSMSAttributes action.

SetSubscriptionAttributesRequest: Container for the parameters to the SetSubscriptionAttributes operation. Allows a subscription owner to set an attribute of the subscription to a new value.

SetSubscriptionAttributesResponse: This is the response object from the SetSubscriptionAttributes operation.

SetTopicAttributesRequest: Container for the parameters to the SetTopicAttributes operation. Allows a topic owner to set an attribute of the topic to a new value.

SetTopicAttributesResponse: This is the response object from the SetTopicAttributes operation.

SimpleNotificationServicePaginatorFactory: Paginators for the SimpleNotificationService service

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.

SubscribeRequest

Container for the parameters to the Subscribe operation. 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).

SubscribeResponse: Response for Subscribe action.

Subscription: A wrapper type for the attributes of an Amazon SNS subscription.

SubscriptionLimitExceededException: Indicates that the customer already owns the maximum allowed number of subscriptions.

Tag: The list of tags to be added to the specified topic.

TagLimitExceededException: Can't add more than 50 tags to a topic.

TagPolicyException: The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

TagResourceRequest

Container for the parameters to the TagResource operation. 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.

TagResourceResponse: This is the response object from the TagResource operation.

ThrottledException: Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

Topic

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use

GetTopicAttributes

TopicLimitExceededException: Indicates that the customer already owns the maximum allowed number of topics.

UnsubscribeRequest

Container for the parameters to the Unsubscribe operation. 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).

UnsubscribeResponse: This is the response object from the Unsubscribe operation.

UntagResourceRequest: Container for the parameters to the UntagResource operation. Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

UntagResourceResponse: This is the response object from the UntagResource operation.

Interfaces

IListEndpointsByPlatformApplicationPaginator: Paginator for the ListEndpointsByPlatformApplication operation

IListPlatformApplicationsPaginator: Paginator for the ListPlatformApplications operation

IListSubscriptionsByTopicPaginator: Paginator for the ListSubscriptionsByTopic operation

IListSubscriptionsPaginator: Paginator for the ListSubscriptions operation

IListTopicsPaginator: Paginator for the ListTopics operation

ISimpleNotificationServicePaginatorFactory: Paginators for the SimpleNotificationService service

Table of Contents

Namespace Amazon.SimpleNotificationService.Model

Classes

Interfaces