Amazon Web Services - API Amazon Simple Notification Service

Amazon Web Services / Amazon Simple Notification Service

Amazon Simple Notification Service

Amazon Simple Notification Service

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.

License: Apache 2.0 License

Resources

POST

/#CheckIfPhoneNumberIsOptedOut

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CheckIfPhoneNumberIsOptedOutInput`	object	The input for the `CheckIfPhoneNumberIsOptedOut` action.

Properties


                        phoneNumber

PhoneNumber

The phone number for which you want to check the opt out status.

PhoneNumber string

Responses

200Success

Body

Name	Data Type	Description
`CheckIfPhoneNumberIsOptedOutResponse`	object	The response from the `CheckIfPhoneNumberIsOptedOut` action.

Properties


                        isOptedOut

boolean

Indicates whether the phone number is opted out:

true – The phone number is opted out, meaning you cannot publish SMS messages to it.
false – The phone number is opted in, meaning you can publish SMS messages to it.

boolean boolean

480ThrottledException

Body

Name	Data Type	Description
`ThrottledException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

POST

/#ConfirmSubscription

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".

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ConfirmSubscriptionInput`	object	Input for ConfirmSubscription action.

Properties


                        AuthenticateOnUnsubscribe

authenticateOnUnsubscribe

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

authenticateOnUnsubscribe string


                        Token

token

Short-lived token sent to an endpoint during the Subscribe action.

token string


                        TopicArn

topicARN

The ARN of the topic for which you wish to confirm a subscription.

topicARN string

Responses

200Success

Body

Name	Data Type	Description
`ConfirmSubscriptionResponse`	object	Response for ConfirmSubscriptions action.

Properties


                        SubscriptionArn

subscriptionARN

The ARN of the created subscription.

subscriptionARN string

480SubscriptionLimitExceededException

Body

Name	Data Type	Description
`SubscriptionLimitExceededException`

481InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

483InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

484AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#CreatePlatformApplication

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CreatePlatformApplicationInput`	object	Input for CreatePlatformApplication action.

Properties


                        Attributes

MapStringToString

For a list of attributes, see SetPlatformApplicationAttributes

MapStringToString array [object]


                        Platform

String

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

String string


                        Name

String

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

String string

Responses

200Success

Body

Name	Data Type	Description
`CreatePlatformApplicationResponse`	object	Response from CreatePlatformApplication action.

Properties


                        PlatformApplicationArn

String

PlatformApplicationArn is returned.

String string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#CreatePlatformEndpoint

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CreatePlatformEndpointInput`	object	Input for CreatePlatformEndpoint action.

Properties


                        Attributes

MapStringToString

For a list of attributes, see SetEndpointAttributes.

MapStringToString array [object]


                        CustomUserData

String

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

String string


                        Token

String

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

String string


                        PlatformApplicationArn

String

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

String string

Responses

200Success

Body

Name	Data Type	Description
`CreateEndpointResponse`	object	Response from CreateEndpoint action.

Properties


                        EndpointArn

String

EndpointArn returned from CreateEndpoint action.

String string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#CreateTopic

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`CreateTopicInput`	object	Input for CreateTopic action.

Properties


                        Attributes

TopicAttributesMap

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

TopicAttributesMap array [object]


                        Name

topicName

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

topicName string

Responses

200Success

Body

Name	Data Type	Description
`CreateTopicResponse`	object	Response from CreateTopic action.

Properties


                        TopicArn

topicARN

The Amazon Resource Name (ARN) assigned to the created topic.

topicARN string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481TopicLimitExceededException

Body

Name	Data Type	Description
`TopicLimitExceededException`

482InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

484InvalidSecurityException

Body

Name	Data Type	Description
`InvalidSecurityException`

POST

/#DeleteEndpoint

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeleteEndpointInput`	object	Input for DeleteEndpoint action.

Properties


                        EndpointArn

String

EndpointArn of endpoint to delete.

String string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#DeletePlatformApplication

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeletePlatformApplicationInput`	object	Input for DeletePlatformApplication action.

Properties


                        PlatformApplicationArn

String

PlatformApplicationArn of platform application object to delete.

String string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#DeleteTopic

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`DeleteTopicInput`	object

Properties


                        TopicArn

topicARN

The ARN of the topic you want to delete.

topicARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#GetEndpointAttributes

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetEndpointAttributesInput`	object	Input for GetEndpointAttributes action.

Properties


                        EndpointArn

String

EndpointArn for GetEndpointAttributes input.

String string

Responses

200Success

Body

Name	Data Type	Description
`GetEndpointAttributesResponse`	object	Response from GetEndpointAttributes of the EndpointArn.

Properties


                        Attributes

MapStringToString

Attributes include the following:

CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

MapStringToString array [object]

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#GetPlatformApplicationAttributes

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetPlatformApplicationAttributesInput`	object	Input for GetPlatformApplicationAttributes action.

Properties


                        PlatformApplicationArn

String

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

String string

Responses

200Success

Body

Name	Data Type	Description
`GetPlatformApplicationAttributesResponse`	object	Response for GetPlatformApplicationAttributes action.

Properties


                        Attributes

MapStringToString

Attributes include the following:

EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

MapStringToString array [object]

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#GetSMSAttributes

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetSMSAttributesInput`	object	The input for the `GetSMSAttributes` request.

Properties


                        attributes

ListString

A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

For all attribute names, see SetSMSAttributes.

If you don't use this parameter, Amazon SNS returns all SMS attributes.

ListString array [String]

String string

Responses

200Success

Body

Name	Data Type	Description
`GetSMSAttributesResponse`	object	The response from the `GetSMSAttributes` request.

Properties


                        attributes

MapStringToString

The SMS attribute names and their values.

MapStringToString array [object]

480ThrottledException

Body

Name	Data Type	Description
`ThrottledException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

POST

/#GetSubscriptionAttributes

Returns all of the properties of a subscription.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetSubscriptionAttributesInput`	object	Input for GetSubscriptionAttributes.

Properties


                        SubscriptionArn

subscriptionARN

The ARN of the subscription whose properties you want to get.

subscriptionARN string

Responses

200Success

Body

Name	Data Type	Description
`GetSubscriptionAttributesResponse`	object	Response for GetSubscriptionAttributes action.

Properties


                        Attributes

SubscriptionAttributesMap

A map of the subscription's attributes. Attributes in this map include the following:

ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.
DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
FilterPolicy – The filter policy JSON that is assigned to the subscription.
Owner – The AWS account ID of the subscription's owner.
PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
SubscriptionArn – The subscription's ARN.
TopicArn – The topic ARN that the subscription is associated with.

SubscriptionAttributesMap array [object]

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#GetTopicAttributes

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`GetTopicAttributesInput`	object	Input for GetTopicAttributes action.

Properties


                        TopicArn

topicARN

The ARN of the topic whose properties you want to get.

topicARN string

Responses

200Success

Body

Name	Data Type	Description
`GetTopicAttributesResponse`	object	Response for GetTopicAttributes action.

Properties


                        Attributes

TopicAttributesMap

A map of the topic's attributes. Attributes in this map include the following:

TopicArn – the topic's ARN
Owner – the AWS account ID of the topic's owner
Policy – the JSON serialization of the topic's access control policy
DisplayName – the human-readable name used in the "From" field for notifications to email and email-json endpoints
SubscriptionsPending – the number of subscriptions pending confirmation on this topic
SubscriptionsConfirmed – the number of confirmed subscriptions on this topic
SubscriptionsDeleted – the number of deleted subscriptions on this topic
DeliveryPolicy – the JSON serialization of the topic's delivery policy
EffectiveDeliveryPolicy – the JSON serialization of the effective delivery policy that takes into account system defaults

TopicAttributesMap array [object]

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

484InvalidSecurityException

Body

Name	Data Type	Description
`InvalidSecurityException`

POST

/#ListEndpointsByPlatformApplication

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.

This action is throttled at 30 transactions per second (TPS).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string
`NextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListEndpointsByPlatformApplicationInput`	object	Input for ListEndpointsByPlatformApplication action.

Properties


                        NextToken

String

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

String string


                        PlatformApplicationArn

String

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

String string

Responses

200Success

Body

Name	Data Type	Description
`ListEndpointsByPlatformApplicationResponse`	object	Response for ListEndpointsByPlatformApplication action.

Properties


                        NextToken

String

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

String string


                        Endpoints

ListOfEndpoints

Endpoints returned for ListEndpointsByPlatformApplication action.

ListOfEndpoints array [Endpoint]


                        Endpoint

object

Endpoint for mobile app and device.

Properties

`Attributes`	MapStringToString	Attributes for endpoint.
`EndpointArn`	String	EndpointArn for mobile app and device.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#ListPhoneNumbersOptedOut

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListPhoneNumbersOptedOutInput`	object	The input for the `ListPhoneNumbersOptedOut` action.

Properties


                        nextToken

string

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

string string

Responses

200Success

Body

Name	Data Type	Description
`ListPhoneNumbersOptedOutResponse`	object	The response from the `ListPhoneNumbersOptedOut` action.

Properties


                        nextToken

string

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

string string


                        phoneNumbers

PhoneNumberList

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

PhoneNumberList array [PhoneNumber]

PhoneNumber string

480ThrottledException

Body

Name	Data Type	Description
`ThrottledException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

POST

/#ListPlatformApplications

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.

This action is throttled at 15 transactions per second (TPS).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string
`NextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListPlatformApplicationsInput`	object	Input for ListPlatformApplications action.

Properties


                        NextToken

String

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

String string

Responses

200Success

Body

Name	Data Type	Description
`ListPlatformApplicationsResponse`	object	Response for ListPlatformApplications action.

Properties


                        NextToken

String

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

String string


                        PlatformApplications

ListOfPlatformApplications

Platform applications returned when calling ListPlatformApplications action.

ListOfPlatformApplications array [PlatformApplication]


                        PlatformApplication

object

Platform application object.

Properties

`Attributes`	MapStringToString	Attributes for platform application object.
`PlatformApplicationArn`	String	PlatformApplicationArn for platform application object.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#ListSubscriptionsByTopic

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).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string
`NextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListSubscriptionsByTopicInput`	object	Input for ListSubscriptionsByTopic action.

Properties


                        NextToken

nextToken

Token returned by the previous ListSubscriptionsByTopic request.

nextToken string


                        TopicArn

topicARN

The ARN of the topic for which you wish to find subscriptions.

topicARN string

Responses

200Success

Body

Name	Data Type	Description
`ListSubscriptionsByTopicResponse`	object	Response for ListSubscriptionsByTopic action.

Properties


                        NextToken

nextToken

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

nextToken string


                        Subscriptions

SubscriptionsList

A list of subscriptions.

SubscriptionsList array [Subscription]


                        Subscription

object

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

Properties

`TopicArn`	topicARN	The ARN of the subscription's topic.
`Endpoint`	endpoint	The subscription's endpoint (format depends on the protocol).
`Protocol`	protocol	The subscription's protocol.
`Owner`	account	The subscription's owner.
`SubscriptionArn`	subscriptionARN	The subscription's ARN.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#ListSubscriptions

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).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string
`NextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListSubscriptionsInput`	object	Input for ListSubscriptions action.

Properties


                        NextToken

nextToken

Token returned by the previous ListSubscriptions request.

nextToken string

Responses

200Success

Body

Name	Data Type	Description
`ListSubscriptionsResponse`	object	Response for ListSubscriptions action

Properties


                        NextToken

nextToken

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

nextToken string


                        Subscriptions

SubscriptionsList

A list of subscriptions.

SubscriptionsList array [Subscription]


                        Subscription

object

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

Properties

`TopicArn`	topicARN	The ARN of the subscription's topic.
`Endpoint`	endpoint	The subscription's endpoint (format depends on the protocol).
`Protocol`	protocol	The subscription's protocol.
`Owner`	account	The subscription's owner.
`SubscriptionArn`	subscriptionARN	The subscription's ARN.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#ListTopics

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).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string
`NextToken`	string	Pagination token

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`ListTopicsInput`	object

Properties


                        NextToken

nextToken

Token returned by the previous ListTopics request.

nextToken string

Responses

200Success

Body

Name	Data Type	Description
`ListTopicsResponse`	object	Response for ListTopics action.

Properties


                        NextToken

nextToken

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

nextToken string


                        Topics

TopicsList

A list of topic ARNs.

TopicsList array [Topic]


                        Topic

object

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

Properties


                        TopicArn

topicARN

The topic's ARN.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#OptInPhoneNumber

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`OptInPhoneNumberInput`	object	Input for the OptInPhoneNumber action.

Properties


                        phoneNumber

PhoneNumber

The phone number to opt in.

PhoneNumber string

Responses

200Success

Body

Name	Data Type	Description
`OptInPhoneNumberResponse`	object	The response for the OptInPhoneNumber action.

480ThrottledException

Body

Name	Data Type	Description
`ThrottledException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

POST

/#Publish

Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`PublishInput`	object	Input for Publish action.

Properties


                        MessageAttributes

MessageAttributeMap

Message attributes for Publish action.

MessageAttributeMap array [object]


                        MessageStructure

messageStructure

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

Valid value: json

messageStructure string


                        Subject

subject

Optional parameter to be used as the "Subject" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

subject string


                        Message

message

The message you want to send.

The Message parameter is always a string. If you set MessageStructure to json, you must string-encode the Message parameter.

If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints:

With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

The total size limit for a single SMS Publish action is 1,600 characters.

JSON-specific constraints:

Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

message string


                        PhoneNumber

String

The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

String string


                        TargetArn

String

Either TopicArn or EndpointArn, but not both.

If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

String string


                        TopicArn

topicARN

The topic you want to publish to.

If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

topicARN string

Responses

200Success

Body

Name	Data Type	Description
`PublishResponse`	object	Response for Publish action.

Properties


                        MessageId

messageId

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

messageId string

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InvalidParameterValueException

Body

Name	Data Type	Description
`InvalidParameterValueException`

482InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

484EndpointDisabledException

Body

Name	Data Type	Description
`EndpointDisabledException`

485PlatformApplicationDisabledException

Body

Name	Data Type	Description
`PlatformApplicationDisabledException`

486AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

487KMSDisabledException

Body

Name	Data Type	Description
`KMSDisabledException`

488KMSInvalidStateException

Body

Name	Data Type	Description
`KMSInvalidStateException`

489KMSNotFoundException

Body

Name	Data Type	Description
`KMSNotFoundException`

490KMSOptInRequired

Body

Name	Data Type	Description
`KMSOptInRequired`

491KMSThrottlingException

Body

Name	Data Type	Description
`KMSThrottlingException`

492KMSAccessDeniedException

Body

Name	Data Type	Description
`KMSAccessDeniedException`

493InvalidSecurityException

Body

Name	Data Type	Description
`InvalidSecurityException`

POST

/#RemovePermission

Removes a statement from a topic's access control policy.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`RemovePermissionInput`	object	Input for RemovePermission action.

Properties


                        Label

label

The unique label of the statement you want to remove.

label string


                        TopicArn

topicARN

The ARN of the topic whose access control policy you wish to modify.

topicARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#SetEndpointAttributes

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`SetEndpointAttributesInput`	object	Input for SetEndpointAttributes action.

Properties


                        Attributes

MapStringToString

A map of the endpoint attributes. Attributes in this map include the following:

CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

MapStringToString array [object]


                        EndpointArn

String

EndpointArn used for SetEndpointAttributes action.

String string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#SetPlatformApplicationAttributes

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`SetPlatformApplicationAttributesInput`	object	Input for SetPlatformApplicationAttributes action.

Properties


                        Attributes

MapStringToString

A map of the platform application attributes. Attributes in this map include the following:

PlatformCredential – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
PlatformPrincipal – The principal 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".
EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

MapStringToString array [object]


                        PlatformApplicationArn

String

PlatformApplicationArn for SetPlatformApplicationAttributes action.

String string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

POST

/#SetSMSAttributes

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.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`SetSMSAttributesInput`	object	The input for the SetSMSAttributes action.

Properties


                        attributes

MapStringToString

The default settings for sending SMS messages from your account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:

Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

MapStringToString array [object]

Responses

200Success

Body

Name	Data Type	Description
`SetSMSAttributesResponse`	object	The response for the SetSMSAttributes action.

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481ThrottledException

Body

Name	Data Type	Description
`ThrottledException`

482InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#SetSubscriptionAttributes

Allows a subscription owner to set an attribute of the subscription to a new value.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`SetSubscriptionAttributesInput`	object	Input for SetSubscriptionAttributes action.

Properties


                        AttributeValue

attributeValue

The new value for the attribute in JSON format.

attributeValue string


                        AttributeName

attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

attributeName string


                        SubscriptionArn

subscriptionARN

The ARN of the subscription to modify.

subscriptionARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481FilterPolicyLimitExceededException

Body

Name	Data Type	Description
`FilterPolicyLimitExceededException`

482InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

484AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

POST

/#SetTopicAttributes

Allows a topic owner to set an attribute of the topic to a new value.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`SetTopicAttributesInput`	object	Input for SetTopicAttributes action.

Properties


                        AttributeValue

attributeValue

The new value for the attribute.

attributeValue string


                        AttributeName

attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

attributeName string


                        TopicArn

topicARN

The ARN of the topic to modify.

topicARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

483AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

484InvalidSecurityException

Body

Name	Data Type	Description
`InvalidSecurityException`

POST

/#Unsubscribe

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).

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`UnsubscribeInput`	object	Input for Unsubscribe action.

Properties


                        SubscriptionArn

subscriptionARN

The ARN of the subscription to be deleted.

subscriptionARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

484InvalidSecurityException

Body

Name	Data Type	Description
`InvalidSecurityException`

POST

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

Request

Query

Name	Data Type	Description
`Action`	string
`Version`	string

Header

Name	Data Type	Description
`X-Amz-Content-Sha256`	string
`X-Amz-Date`	string
`X-Amz-Algorithm`	string
`X-Amz-Credential`	string
`X-Amz-Security-Token`	string
`X-Amz-Signature`	string
`X-Amz-SignedHeaders`	string

Body

Name	Data Type	Description
`AddPermissionInput`	object

Properties


                        ActionName

ActionsList

The action you want to allow for the specified principal(s).

Valid values: any Amazon SNS action name.

ActionsList array [action]

action string


                        AWSAccountId

DelegatesList

The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

DelegatesList array [delegate]

delegate string


                        Label

label

A unique identifier for the new policy statement.

label string


                        TopicArn

topicARN

The ARN of the topic whose access control policy you wish to modify.

topicARN string

Responses

200Success

480InvalidParameterException

Body

Name	Data Type	Description
`InvalidParameterException`

481InternalErrorException

Body

Name	Data Type	Description
`InternalErrorException`

482AuthorizationErrorException

Body

Name	Data Type	Description
`AuthorizationErrorException`

483NotFoundException

Body

Name	Data Type	Description
`NotFoundException`

Models

ActionsList

AddPermissionInput

Properties

Name Data Type Description


                        ActionName

ActionsList

The action you want to allow for the specified principal(s).

Valid values: any Amazon SNS action name.

ActionsList array [action]

action string


                        AWSAccountId

DelegatesList

The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

DelegatesList array [delegate]

delegate string


                        Label

label

A unique identifier for the new policy statement.

label string


                        TopicArn

topicARN

The ARN of the topic whose access control policy you wish to modify.

topicARN string

AuthorizationErrorException

Binary

CheckIfPhoneNumberIsOptedOutInput

CheckIfPhoneNumberIsOptedOutResponse

ConfirmSubscriptionInput

Input for ConfirmSubscription action.

Properties

Name Data Type Description


                        AuthenticateOnUnsubscribe

authenticateOnUnsubscribe

authenticateOnUnsubscribe string


                        Token

token

Short-lived token sent to an endpoint during the Subscribe action.

token string


                        TopicArn

topicARN

The ARN of the topic for which you wish to confirm a subscription.

topicARN string

ConfirmSubscriptionResponse

CreateEndpointResponse

CreatePlatformApplicationInput

Input for CreatePlatformApplication action.

Properties

Name Data Type Description


                        Attributes

MapStringToString

For a list of attributes, see SetPlatformApplicationAttributes

MapStringToString array [object]


                        Platform

String

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

String string


                        Name

String

Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

String string

CreatePlatformApplicationResponse

CreatePlatformEndpointInput

Input for CreatePlatformEndpoint action.

Properties

Name Data Type Description


                        Attributes

MapStringToString

For a list of attributes, see SetEndpointAttributes.

MapStringToString array [object]


                        CustomUserData

String

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

String string


                        Token

String

String string


                        PlatformApplicationArn

String

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

String string

CreateTopicInput

Input for CreateTopic action.

Properties

Name Data Type Description


                        Attributes

TopicAttributesMap

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

TopicAttributesMap array [object]


                        Name

topicName

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

topicName string

CreateTopicResponse

DelegatesList

DeleteEndpointInput

DeletePlatformApplicationInput

DeleteTopicInput

Endpoint

EndpointDisabledException

FilterPolicyLimitExceededException

GetEndpointAttributesInput

GetEndpointAttributesResponse

GetPlatformApplicationAttributesInput

GetPlatformApplicationAttributesResponse

GetSMSAttributesInput

GetSMSAttributesResponse

GetSubscriptionAttributesInput

GetSubscriptionAttributesResponse

GetTopicAttributesInput

GetTopicAttributesResponse

InternalErrorException

InvalidParameterException

InvalidParameterValueException

InvalidSecurityException

KMSAccessDeniedException

KMSDisabledException

KMSInvalidStateException

KMSNotFoundException

KMSOptInRequired

KMSThrottlingException

ListEndpointsByPlatformApplicationInput

ListEndpointsByPlatformApplicationResponse

Response for ListEndpointsByPlatformApplication action.

Properties

Name Data Type Description


                        NextToken

String

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

String string


                        Endpoints

ListOfEndpoints

Endpoints returned for ListEndpointsByPlatformApplication action.

ListOfEndpoints array [Endpoint]


                        Endpoint

object

Endpoint for mobile app and device.

Properties


                        Attributes

MapStringToString

Attributes for endpoint.

MapStringToString array [object]


                        EndpointArn

String

EndpointArn for mobile app and device.

String string

ListOfEndpoints

Name Data Type Description

ListOfEndpoints array [Endpoint]


                        Endpoint

object

Endpoint for mobile app and device.

Properties


                        Attributes

MapStringToString

Attributes for endpoint.

MapStringToString array [object]


                        EndpointArn

String

EndpointArn for mobile app and device.

String string

ListOfPlatformApplications

Name Data Type Description

ListOfPlatformApplications array [PlatformApplication]


                        PlatformApplication

object

Platform application object.

Properties


                        Attributes

MapStringToString

Attributes for platform application object.

MapStringToString array [object]


                        PlatformApplicationArn

String

PlatformApplicationArn for platform application object.

String string

ListPhoneNumbersOptedOutInput

ListPhoneNumbersOptedOutResponse

The response from the ListPhoneNumbersOptedOut action.

Properties

Name Data Type Description


                        nextToken

string

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

string string


                        phoneNumbers

PhoneNumberList

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

PhoneNumberList array [PhoneNumber]

PhoneNumber string

ListPlatformApplicationsInput

ListPlatformApplicationsResponse

Response for ListPlatformApplications action.

Properties

Name Data Type Description


                        NextToken

String

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

String string


                        PlatformApplications

ListOfPlatformApplications

Platform applications returned when calling ListPlatformApplications action.

ListOfPlatformApplications array [PlatformApplication]


                        PlatformApplication

object

Platform application object.

Properties


                        Attributes

MapStringToString

Attributes for platform application object.

MapStringToString array [object]


                        PlatformApplicationArn

String

PlatformApplicationArn for platform application object.

String string

ListString

ListSubscriptionsByTopicInput

ListSubscriptionsByTopicResponse

Response for ListSubscriptionsByTopic action.

Properties

Name Data Type Description


                        NextToken

nextToken

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

nextToken string


                        Subscriptions

SubscriptionsList

A list of subscriptions.

SubscriptionsList array [Subscription]


                        Subscription

object

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

Properties


                        TopicArn

topicARN

The ARN of the subscription's topic.

topicARN string


                        Endpoint

endpoint

The subscription's endpoint (format depends on the protocol).

endpoint string


                        Protocol

protocol

The subscription's protocol.

protocol string


                        Owner

account

The subscription's owner.

account string


                        SubscriptionArn

subscriptionARN

The subscription's ARN.

subscriptionARN string

ListSubscriptionsInput

ListSubscriptionsResponse

Response for ListSubscriptions action

Properties

Name Data Type Description


                        NextToken

nextToken

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

nextToken string


                        Subscriptions

SubscriptionsList

A list of subscriptions.

SubscriptionsList array [Subscription]


                        Subscription

object

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

Properties


                        TopicArn

topicARN

The ARN of the subscription's topic.

topicARN string


                        Endpoint

endpoint

The subscription's endpoint (format depends on the protocol).

endpoint string


                        Protocol

protocol

The subscription's protocol.

protocol string


                        Owner

account

The subscription's owner.

account string


                        SubscriptionArn

subscriptionARN

The subscription's ARN.

subscriptionARN string

ListTopicsInput

ListTopicsResponse

Response for ListTopics action.

Properties

Name Data Type Description


                        NextToken

nextToken

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

nextToken string


                        Topics

TopicsList

A list of topic ARNs.

TopicsList array [Topic]


                        Topic

object

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

Properties


                        TopicArn

topicARN

The topic's ARN.

topicARN string

MapStringToString

MessageAttributeMap

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 Using Amazon SNS Message Attributes.

Properties

Name Data Type Description


                        BinaryValue

Binary

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

Binary string


                        StringValue

String

Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

String string


                        DataType

String

Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

String string

NotFoundException

OptInPhoneNumberInput

OptInPhoneNumberResponse

PhoneNumber

PhoneNumberList

PlatformApplication

PlatformApplicationDisabledException

PublishInput

Input for Publish action.

Properties

Name Data Type Description


                        MessageAttributes

MessageAttributeMap

Message attributes for Publish action.

MessageAttributeMap array [object]


                        MessageStructure

messageStructure

be a syntactically valid JSON object; and
contain at least a top-level JSON key of "default" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., "http").

Valid value: json

messageStructure string


                        Subject

subject

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

subject string


                        Message

message

The message you want to send.

The Message parameter is always a string. If you set MessageStructure to json, you must string-encode the Message parameter.

Constraints:

With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).
For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

The total size limit for a single SMS Publish action is 1,600 characters.

JSON-specific constraints:

Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.
The values will be parsed (unescaped) before they are used in outgoing messages.
Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).
Values have a minimum length of 0 (the empty string, "", is allowed).
Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).
Non-string values will cause the key to be ignored.
Keys that do not correspond to supported transport protocols are ignored.
Duplicate keys are not allowed.
Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

message string


                        PhoneNumber

String

The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

String string


                        TargetArn

String

Either TopicArn or EndpointArn, but not both.

If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

String string


                        TopicArn

topicARN

The topic you want to publish to.

If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

topicARN string

PublishResponse

RemovePermissionInput

SetEndpointAttributesInput

Input for SetEndpointAttributes action.

Properties

Name Data Type Description


                        Attributes

MapStringToString

A map of the endpoint attributes. Attributes in this map include the following:

CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.
Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.
Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

MapStringToString array [object]


                        EndpointArn

String

EndpointArn used for SetEndpointAttributes action.

String string

SetPlatformApplicationAttributesInput

Input for SetPlatformApplicationAttributes action.

Properties

Name Data Type Description


                        Attributes

MapStringToString

A map of the platform application attributes. Attributes in this map include the following:

PlatformCredential – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret".
PlatformPrincipal – The principal 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".
EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.
EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.
EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.
EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.
SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.
SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

MapStringToString array [object]


                        PlatformApplicationArn

String

PlatformApplicationArn for SetPlatformApplicationAttributes action.

String string

SetSMSAttributesInput

The input for the SetSMSAttributes action.

Properties

Name Data Type Description


                        attributes

MapStringToString

The default settings for sending SMS messages from your account. You can set values for the following attribute names:

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.
Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

Time that the message was published (in UTC)
Message ID
Destination phone number
Message type
Delivery status
Message price (in USD)
Part number (a message is split into multiple parts if it is too long for a single message)
Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

MapStringToString array [object]

SetSMSAttributesResponse

SetSubscriptionAttributesInput

Input for SetSubscriptionAttributes action.

Properties

Name Data Type Description


                        AttributeValue

attributeValue

The new value for the attribute in JSON format.

attributeValue string


                        AttributeName

attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

attributeName string


                        SubscriptionArn

subscriptionARN

The ARN of the subscription to modify.

subscriptionARN string

SetTopicAttributesInput

Input for SetTopicAttributes action.

Properties

Name Data Type Description


                        AttributeValue

attributeValue

The new value for the attribute.

attributeValue string


                        AttributeName

attributeName

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName – The display name to use for a topic with SMS subscriptions.
Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

attributeName string


                        TopicArn

topicARN

The ARN of the topic to modify.

topicARN string

String

SubscribeInput

Input for Subscribe action.

Properties

Name Data Type Description


                        ReturnSubscriptionArn

boolean

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of "pending subscription" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

The default value is false.

boolean boolean


                        Attributes

SubscriptionAttributesMap

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

SubscriptionAttributesMap array [object]


                        Endpoint

endpoint

The endpoint that you want to receive notifications. Endpoints vary by protocol:

For the http protocol, the endpoint is an URL beginning with "http://"
For the https protocol, the endpoint is a URL beginning with "https://"
For the email protocol, the endpoint is an email address
For the email-json protocol, the endpoint is an email address
For the sms protocol, the endpoint is a phone number of an SMS-enabled device
For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue
For the application protocol, the endpoint is the EndpointArn of a mobile app and device.
For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

endpoint string


                        Protocol

protocol

The protocol you want to use. Supported protocols include:

http – delivery of JSON-encoded message via HTTP POST
https – delivery of JSON-encoded message via HTTPS POST
email – delivery of message via SMTP
email-json – delivery of JSON-encoded message via SMTP
sms – delivery of message via SMS
sqs – delivery of JSON-encoded message to an Amazon SQS queue
application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device.
lambda – delivery of JSON-encoded message to an AWS Lambda function.

protocol string


                        TopicArn

topicARN

The ARN of the topic you want to subscribe to.

topicARN string

SubscribeResponse

Subscription

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

Properties

Name Data Type Description


                        TopicArn

topicARN

The ARN of the subscription's topic.

topicARN string


                        Endpoint

endpoint

The subscription's endpoint (format depends on the protocol).

endpoint string


                        Protocol

protocol

The subscription's protocol.

protocol string


                        Owner

account

The subscription's owner.

account string


                        SubscriptionArn

subscriptionARN

The subscription's ARN.

subscriptionARN string

SubscriptionAttributesMap

SubscriptionLimitExceededException

SubscriptionsList

Name Data Type Description

SubscriptionsList array [Subscription]


                        Subscription

object

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

Properties


                        TopicArn

topicARN

The ARN of the subscription's topic.

topicARN string


                        Endpoint

endpoint

The subscription's endpoint (format depends on the protocol).

endpoint string


                        Protocol

protocol

The subscription's protocol.

protocol string


                        Owner

account

The subscription's owner.

account string


                        SubscriptionArn

subscriptionARN

The subscription's ARN.

subscriptionARN string

ThrottledException

Topic

TopicAttributesMap

TopicLimitExceededException

TopicsList