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.
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CheckIfPhoneNumberIsOptedOutInput
|
object |
The input for the |
phoneNumber
|
PhoneNumber |
The phone number for which you want to check the opt out status. |
||||
|
Name | Data Type | Description |
---|---|---|
CheckIfPhoneNumberIsOptedOutResponse
|
object |
The response from the |
isOptedOut
|
boolean |
Indicates whether the phone number is opted out:
|
||||
|
Name | Data Type | Description |
---|---|---|
ThrottledException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
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".
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ConfirmSubscriptionInput
|
object |
Input for ConfirmSubscription action. |
AuthenticateOnUnsubscribe
|
authenticateOnUnsubscribe |
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is |
||||
|
||||||
Token
|
token |
Short-lived token sent to an endpoint during the |
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic for which you wish to confirm a subscription. |
||||
|
Name | Data Type | Description |
---|---|---|
ConfirmSubscriptionResponse
|
object |
Response for ConfirmSubscriptions action. |
SubscriptionArn
|
subscriptionARN |
The ARN of the created subscription. |
||||
|
Name | Data Type | Description |
---|---|---|
SubscriptionLimitExceededException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreatePlatformApplicationInput
|
object |
Input for CreatePlatformApplication action. |
Attributes
|
MapStringToString |
For a list of attributes, see SetPlatformApplicationAttributes |
||||
|
||||||
Platform
|
String |
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). |
||||
|
||||||
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. |
||||
|
Name | Data Type | Description |
---|---|---|
CreatePlatformApplicationResponse
|
object |
Response from CreatePlatformApplication action. |
PlatformApplicationArn
|
String |
PlatformApplicationArn is returned. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreatePlatformEndpointInput
|
object |
Input for CreatePlatformEndpoint action. |
Attributes
|
MapStringToString |
For a list of attributes, see SetEndpointAttributes. |
||||
|
||||||
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. |
||||
|
||||||
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. |
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateEndpointResponse
|
object |
Response from CreateEndpoint action. |
EndpointArn
|
String |
EndpointArn returned from CreateEndpoint action. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
CreateTopicInput
|
object |
Input for CreateTopic action. |
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
|
||||
|
||||||
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. |
||||
|
Name | Data Type | Description |
---|---|---|
CreateTopicResponse
|
object |
Response from CreateTopic action. |
TopicArn
|
topicARN |
The Amazon Resource Name (ARN) assigned to the created topic. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
TopicLimitExceededException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteEndpointInput
|
object |
Input for DeleteEndpoint action. |
EndpointArn
|
String |
EndpointArn of endpoint to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeletePlatformApplicationInput
|
object |
Input for DeletePlatformApplication action. |
PlatformApplicationArn
|
String |
PlatformApplicationArn of platform application object to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
DeleteTopicInput
|
object |
TopicArn
|
topicARN |
The ARN of the topic you want to delete. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetEndpointAttributesInput
|
object |
Input for GetEndpointAttributes action. |
EndpointArn
|
String |
EndpointArn for GetEndpointAttributes input. |
||||
|
Name | Data Type | Description |
---|---|---|
GetEndpointAttributesResponse
|
object |
Response from GetEndpointAttributes of the EndpointArn. |
Attributes
|
MapStringToString |
Attributes include the following:
|
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetPlatformApplicationAttributesInput
|
object |
Input for GetPlatformApplicationAttributes action. |
PlatformApplicationArn
|
String |
PlatformApplicationArn for GetPlatformApplicationAttributesInput. |
||||
|
Name | Data Type | Description |
---|---|---|
GetPlatformApplicationAttributesResponse
|
object |
Response for GetPlatformApplicationAttributes action. |
Attributes
|
MapStringToString |
Attributes include the following:
|
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Returns the settings for sending SMS messages from your account.
These settings are set with the SetSMSAttributes
action.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetSMSAttributesInput
|
object |
The input for the |
attributes
|
ListString |
A list of the individual attribute names, such as For all attribute names, see SetSMSAttributes. If you don't use this parameter, Amazon SNS returns all SMS attributes. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
GetSMSAttributesResponse
|
object |
The response from the |
attributes
|
MapStringToString |
The SMS attribute names and their values. |
||||
|
Name | Data Type | Description |
---|---|---|
ThrottledException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Returns all of the properties of a subscription.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetSubscriptionAttributesInput
|
object |
Input for GetSubscriptionAttributes. |
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription whose properties you want to get. |
||||
|
Name | Data Type | Description |
---|---|---|
GetSubscriptionAttributesResponse
|
object |
Response for GetSubscriptionAttributes action. |
Attributes
|
SubscriptionAttributesMap |
A map of the subscription's attributes. Attributes in this map include the following:
|
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
GetTopicAttributesInput
|
object |
Input for GetTopicAttributes action. |
TopicArn
|
topicARN |
The ARN of the topic whose properties you want to get. |
||||
|
Name | Data Type | Description |
---|---|---|
GetTopicAttributesResponse
|
object |
Response for GetTopicAttributes action. |
Attributes
|
TopicAttributesMap |
A map of the topic's attributes. Attributes in this map include the following:
|
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListEndpointsByPlatformApplicationInput
|
object |
Input for ListEndpointsByPlatformApplication action. |
NextToken
|
String |
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. |
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. |
||||
|
Name | Data Type | Description |
---|---|---|
ListEndpointsByPlatformApplicationResponse
|
object |
Response for ListEndpointsByPlatformApplication action. |
NextToken
|
String |
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. |
|||||||||||||||||
|
|||||||||||||||||||
Endpoints
|
ListOfEndpoints |
Endpoints returned for ListEndpointsByPlatformApplication action. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListPhoneNumbersOptedOutInput
|
object |
The input for the |
nextToken
|
string |
A |
||||
|
Name | Data Type | Description |
---|---|---|
ListPhoneNumbersOptedOutResponse
|
object |
The response from the |
nextToken
|
string |
A |
|||||||||||
|
|||||||||||||
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. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
ThrottledException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListPlatformApplicationsInput
|
object |
Input for ListPlatformApplications action. |
NextToken
|
String |
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. |
||||
|
Name | Data Type | Description |
---|---|---|
ListPlatformApplicationsResponse
|
object |
Response for ListPlatformApplications action. |
NextToken
|
String |
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results. |
|||||||||||||||||
|
|||||||||||||||||||
PlatformApplications
|
ListOfPlatformApplications |
Platform applications returned when calling ListPlatformApplications action. |
|||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListSubscriptionsByTopicInput
|
object |
Input for ListSubscriptionsByTopic action. |
NextToken
|
nextToken |
Token returned by the previous |
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic for which you wish to find subscriptions. |
||||
|
Name | Data Type | Description |
---|---|---|
ListSubscriptionsByTopicResponse
|
object |
Response for ListSubscriptionsByTopic action. |
NextToken
|
nextToken |
Token to pass along to the next |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Subscriptions
|
SubscriptionsList |
A list of subscriptions. |
||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListSubscriptionsInput
|
object |
Input for ListSubscriptions action. |
NextToken
|
nextToken |
Token returned by the previous |
||||
|
Name | Data Type | Description |
---|---|---|
ListSubscriptionsResponse
|
object |
Response for ListSubscriptions action |
NextToken
|
nextToken |
Token to pass along to the next |
||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||
Subscriptions
|
SubscriptionsList |
A list of subscriptions. |
||||||||||||||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string | |
NextToken
|
string |
Pagination token |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
ListTopicsInput
|
object |
NextToken
|
nextToken |
Token returned by the previous |
||||
|
Name | Data Type | Description |
---|---|---|
ListTopicsResponse
|
object |
Response for ListTopics action. |
NextToken
|
nextToken |
Token to pass along to the next |
||||||||||||||
|
||||||||||||||||
Topics
|
TopicsList |
A list of topic ARNs. |
||||||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
OptInPhoneNumberInput
|
object |
Input for the OptInPhoneNumber action. |
phoneNumber
|
PhoneNumber |
The phone number to opt in. |
||||
|
Name | Data Type | Description |
---|---|---|
OptInPhoneNumberResponse
|
object |
The response for the OptInPhoneNumber action. |
Name | Data Type | Description |
---|---|---|
ThrottledException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
PublishInput
|
object |
Input for Publish action. |
MessageAttributes
|
MessageAttributeMap |
Message attributes for Publish action. |
||||
|
||||||
MessageStructure
|
messageStructure |
Set
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: |
||||
|
||||||
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. |
||||
|
||||||
Message
|
message |
The message you want to send. The 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 Constraints:
JSON-specific constraints:
|
||||
|
||||||
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 |
||||
|
||||||
TargetArn
|
String |
Either TopicArn or EndpointArn, but not both. If you don't specify a value for the |
||||
|
||||||
TopicArn
|
topicARN |
The topic you want to publish to. If you don't specify a value for the |
||||
|
Name | Data Type | Description |
---|---|---|
PublishResponse
|
object |
Response for Publish action. |
MessageId
|
messageId |
Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterValueException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
EndpointDisabledException
|
Name | Data Type | Description |
---|---|---|
PlatformApplicationDisabledException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
KMSDisabledException
|
Name | Data Type | Description |
---|---|---|
KMSInvalidStateException
|
Name | Data Type | Description |
---|---|---|
KMSNotFoundException
|
Name | Data Type | Description |
---|---|---|
KMSOptInRequired
|
Name | Data Type | Description |
---|---|---|
KMSThrottlingException
|
Name | Data Type | Description |
---|---|---|
KMSAccessDeniedException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
Removes a statement from a topic's access control policy.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetEndpointAttributesInput
|
object |
Input for SetEndpointAttributes action. |
Attributes
|
MapStringToString |
A map of the endpoint attributes. Attributes in this map include the following:
|
||||
|
||||||
EndpointArn
|
String |
EndpointArn used for SetEndpointAttributes action. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetPlatformApplicationAttributesInput
|
object |
Input for SetPlatformApplicationAttributes action. |
Attributes
|
MapStringToString |
A map of the platform application attributes. Attributes in this map include the following:
|
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn for SetPlatformApplicationAttributes action. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
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.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetSMSAttributesInput
|
object |
The input for the SetSMSAttributes action. |
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. 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.
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide. |
||||
|
Name | Data Type | Description |
---|---|---|
SetSMSAttributesResponse
|
object |
The response for the SetSMSAttributes action. |
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
ThrottledException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Allows a subscription owner to set an attribute of the subscription to a new value.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetSubscriptionAttributesInput
|
object |
Input for SetSubscriptionAttributes action. |
AttributeValue
|
attributeValue |
The new value for the attribute in JSON format. |
||||
|
||||||
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
|
||||
|
||||||
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription to modify. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
FilterPolicyLimitExceededException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Allows a topic owner to set an attribute of the topic to a new value.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SetTopicAttributesInput
|
object |
Input for SetTopicAttributes action. |
AttributeValue
|
attributeValue |
The new value for the attribute. |
||||
|
||||||
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
|
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic to modify. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription
action with the token from the confirmation message. Confirmation tokens are valid for three days.
This action is throttled at 100 transactions per second (TPS).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
SubscribeInput
|
object |
Input for Subscribe action. |
ReturnSubscriptionArn
|
boolean |
Sets whether the response from the If you set this parameter to If you set this parameter to The default value is |
||||
|
||||||
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
|
||||
|
||||||
Endpoint
|
endpoint |
The endpoint that you want to receive notifications. Endpoints vary by protocol:
|
||||
|
||||||
Protocol
|
protocol |
The protocol you want to use. Supported protocols include:
|
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic you want to subscribe to. |
||||
|
Name | Data Type | Description |
---|---|---|
SubscribeResponse
|
object |
Response for Subscribe action. |
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter |
||||
|
Name | Data Type | Description |
---|---|---|
SubscriptionLimitExceededException
|
Name | Data Type | Description |
---|---|---|
FilterPolicyLimitExceededException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
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).
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
UnsubscribeInput
|
object |
Input for Unsubscribe action. |
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription to be deleted. |
||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Name | Data Type | Description |
---|---|---|
Version
|
string | |
Action
|
string |
Name | Data Type | Description |
---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Name | Data Type | Description |
---|---|---|
AddPermissionInput
|
object |
ActionName
|
ActionsList |
The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name. |
|||||||||||
|
|||||||||||||
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. |
|||||||||||
|
|||||||||||||
Label
|
label |
A unique identifier for the new policy statement. |
|||||||||||
|
|||||||||||||
TopicArn
|
topicARN |
The ARN of the topic whose access control policy you wish to modify. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
ActionsList
|
array [action] | |||||
|
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ActionName
|
ActionsList |
The action you want to allow for the specified principal(s). Valid values: any Amazon SNS action name. |
|||||||||||
|
|||||||||||||
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. |
|||||||||||
|
|||||||||||||
Label
|
label |
A unique identifier for the new policy statement. |
|||||||||||
|
|||||||||||||
TopicArn
|
topicARN |
The ARN of the topic whose access control policy you wish to modify. |
|||||||||||
|
Name | Data Type | Description |
---|---|---|
AuthorizationErrorException
|
Name | Data Type | Description |
---|---|---|
Binary
|
string |
The input for the CheckIfPhoneNumberIsOptedOut
action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
phoneNumber
|
PhoneNumber |
The phone number for which you want to check the opt out status. |
||||
|
The response from the CheckIfPhoneNumberIsOptedOut
action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
isOptedOut
|
boolean |
Indicates whether the phone number is opted out:
|
||||
|
Input for ConfirmSubscription action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
AuthenticateOnUnsubscribe
|
authenticateOnUnsubscribe |
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is |
||||
|
||||||
Token
|
token |
Short-lived token sent to an endpoint during the |
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic for which you wish to confirm a subscription. |
||||
|
Response for ConfirmSubscriptions action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SubscriptionArn
|
subscriptionARN |
The ARN of the created subscription. |
||||
|
Response from CreateEndpoint action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
EndpointArn
|
String |
EndpointArn returned from CreateEndpoint action. |
||||
|
Input for CreatePlatformApplication action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
For a list of attributes, see SetPlatformApplicationAttributes |
||||
|
||||||
Platform
|
String |
The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging). |
||||
|
||||||
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. |
||||
|
Response from CreatePlatformApplication action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
PlatformApplicationArn
|
String |
PlatformApplicationArn is returned. |
||||
|
Input for CreatePlatformEndpoint action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
For a list of attributes, see SetEndpointAttributes. |
||||
|
||||||
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. |
||||
|
||||||
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. |
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint. |
||||
|
Input for CreateTopic action.
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
|
||||
|
||||||
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. |
||||
|
Response from CreateTopic action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
TopicArn
|
topicARN |
The Amazon Resource Name (ARN) assigned to the created topic. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
DelegatesList
|
array [delegate] | |||||
|
Input for DeleteEndpoint action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
EndpointArn
|
String |
EndpointArn of endpoint to delete. |
||||
|
Input for DeletePlatformApplication action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
PlatformApplicationArn
|
String |
PlatformApplicationArn of platform application object to delete. |
||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
TopicArn
|
topicARN |
The ARN of the topic you want to delete. |
||||
|
Endpoint for mobile app and device.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
Attributes for endpoint. |
||||
|
||||||
EndpointArn
|
String |
EndpointArn for mobile app and device. |
||||
|
Name | Data Type | Description |
---|---|---|
EndpointDisabledException
|
Name | Data Type | Description |
---|---|---|
FilterPolicyLimitExceededException
|
Input for GetEndpointAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
EndpointArn
|
String |
EndpointArn for GetEndpointAttributes input. |
||||
|
Response from GetEndpointAttributes of the EndpointArn.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
Attributes include the following:
|
||||
|
Input for GetPlatformApplicationAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
PlatformApplicationArn
|
String |
PlatformApplicationArn for GetPlatformApplicationAttributesInput. |
||||
|
Response for GetPlatformApplicationAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
Attributes include the following:
|
||||
|
The input for the GetSMSAttributes
request.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
attributes
|
ListString |
A list of the individual attribute names, such as For all attribute names, see SetSMSAttributes. If you don't use this parameter, Amazon SNS returns all SMS attributes. |
|||||||||||
|
The response from the GetSMSAttributes
request.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
attributes
|
MapStringToString |
The SMS attribute names and their values. |
||||
|
Input for GetSubscriptionAttributes.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription whose properties you want to get. |
||||
|
Response for GetSubscriptionAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
SubscriptionAttributesMap |
A map of the subscription's attributes. Attributes in this map include the following:
|
||||
|
Input for GetTopicAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
TopicArn
|
topicARN |
The ARN of the topic whose properties you want to get. |
||||
|
Response for GetTopicAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
TopicAttributesMap |
A map of the topic's attributes. Attributes in this map include the following:
|
||||
|
Name | Data Type | Description |
---|---|---|
InternalErrorException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterException
|
Name | Data Type | Description |
---|---|---|
InvalidParameterValueException
|
Name | Data Type | Description |
---|---|---|
InvalidSecurityException
|
Name | Data Type | Description |
---|---|---|
KMSAccessDeniedException
|
Name | Data Type | Description |
---|---|---|
KMSDisabledException
|
Name | Data Type | Description |
---|---|---|
KMSInvalidStateException
|
Name | Data Type | Description |
---|---|---|
KMSNotFoundException
|
Name | Data Type | Description |
---|---|---|
KMSOptInRequired
|
Name | Data Type | Description |
---|---|---|
KMSThrottlingException
|
Input for ListEndpointsByPlatformApplication action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
NextToken
|
String |
NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results. |
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action. |
||||
|
Response for ListEndpointsByPlatformApplication action.
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
String |
NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
Endpoints
|
ListOfEndpoints |
Endpoints returned for ListEndpointsByPlatformApplication action. |
|||||||||||||||||||||||||||||||
|
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ListOfEndpoints
|
array [Endpoint] | |||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ListOfPlatformApplications
|
array [PlatformApplication] | |||||||||||||||||||||||||
Properties
|
The input for the ListPhoneNumbersOptedOut
action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
nextToken
|
string |
A |
||||
|
The response from the ListPhoneNumbersOptedOut
action.
Name | Data Type | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
nextToken
|
string |
A |
|||||||||||
|
|||||||||||||
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. |
|||||||||||
|
Input for ListPlatformApplications action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
NextToken
|
String |
NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results. |
||||
|
Response for ListPlatformApplications action.
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
String |
NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results. |
|||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||
PlatformApplications
|
ListOfPlatformApplications |
Platform applications returned when calling ListPlatformApplications action. |
|||||||||||||||||||||||||||||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
ListString
|
array [String] | |||||
|
Response for ListSubscriptionsByTopic action.
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
nextToken |
Token to pass along to the next |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subscriptions
|
SubscriptionsList |
A list of subscriptions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Input for ListSubscriptions action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
NextToken
|
nextToken |
Token returned by the previous |
||||
|
Response for ListSubscriptions action
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
NextToken
|
nextToken |
Token to pass along to the next |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subscriptions
|
SubscriptionsList |
A list of subscriptions. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
NextToken
|
nextToken |
Token returned by the previous |
||||
|
Response for ListTopics action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
NextToken
|
nextToken |
Token to pass along to the next |
||||
|
||||||
Topics
|
TopicsList |
A list of topic ARNs. |
||||
Name | Data Type | Description |
---|---|---|
MapStringToString
|
array [object] |
Name | Data Type | Description |
---|---|---|
MessageAttributeMap
|
array [object] |
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.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
BinaryValue
|
Binary |
Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images. |
||||
|
||||||
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. |
||||
|
||||||
DataType
|
String |
Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types. |
||||
|
Name | Data Type | Description |
---|---|---|
NotFoundException
|
Input for the OptInPhoneNumber action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
phoneNumber
|
PhoneNumber |
The phone number to opt in. |
||||
|
The response for the OptInPhoneNumber action.
Name | Data Type | Description |
---|---|---|
OptInPhoneNumberResponse
|
object |
The response for the OptInPhoneNumber action. |
Name | Data Type | Description |
---|---|---|
PhoneNumber
|
string |
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
PhoneNumberList
|
array [PhoneNumber] | |||||
|
Platform application object.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
Attributes for platform application object. |
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn for platform application object. |
||||
|
Name | Data Type | Description |
---|---|---|
PlatformApplicationDisabledException
|
Input for Publish action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageAttributes
|
MessageAttributeMap |
Message attributes for Publish action. |
||||
|
||||||
MessageStructure
|
messageStructure |
Set
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: |
||||
|
||||||
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. |
||||
|
||||||
Message
|
message |
The message you want to send. The 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 Constraints:
JSON-specific constraints:
|
||||
|
||||||
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 |
||||
|
||||||
TargetArn
|
String |
Either TopicArn or EndpointArn, but not both. If you don't specify a value for the |
||||
|
||||||
TopicArn
|
topicARN |
The topic you want to publish to. If you don't specify a value for the |
||||
|
Response for Publish action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
MessageId
|
messageId |
Unique identifier assigned to the published message. Length Constraint: Maximum 100 characters |
||||
|
Input for SetEndpointAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
A map of the endpoint attributes. Attributes in this map include the following:
|
||||
|
||||||
EndpointArn
|
String |
EndpointArn used for SetEndpointAttributes action. |
||||
|
Input for SetPlatformApplicationAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
Attributes
|
MapStringToString |
A map of the platform application attributes. Attributes in this map include the following:
|
||||
|
||||||
PlatformApplicationArn
|
String |
PlatformApplicationArn for SetPlatformApplicationAttributes action. |
||||
|
The input for the SetSMSAttributes action.
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. 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.
To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide. |
||||
|
The response for the SetSMSAttributes action.
Name | Data Type | Description |
---|---|---|
SetSMSAttributesResponse
|
object |
The response for the SetSMSAttributes action. |
Input for SetSubscriptionAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
AttributeValue
|
attributeValue |
The new value for the attribute in JSON format. |
||||
|
||||||
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
|
||||
|
||||||
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription to modify. |
||||
|
Input for SetTopicAttributes action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
AttributeValue
|
attributeValue |
The new value for the attribute. |
||||
|
||||||
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
|
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic to modify. |
||||
|
Name | Data Type | Description |
---|---|---|
String
|
string |
Input for Subscribe action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
ReturnSubscriptionArn
|
boolean |
Sets whether the response from the If you set this parameter to If you set this parameter to The default value is |
||||
|
||||||
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
|
||||
|
||||||
Endpoint
|
endpoint |
The endpoint that you want to receive notifications. Endpoints vary by protocol:
|
||||
|
||||||
Protocol
|
protocol |
The protocol you want to use. Supported protocols include:
|
||||
|
||||||
TopicArn
|
topicARN |
The ARN of the topic you want to subscribe to. |
||||
|
Response for Subscribe action.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
SubscriptionArn
|
subscriptionARN |
The ARN of the subscription if it is confirmed, or the string "pending confirmation" if the subscription requires confirmation. However, if the API request parameter |
||||
|
A wrapper type for the attributes of an Amazon SNS subscription.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
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. |
||||
|
Name | Data Type | Description |
---|---|---|
SubscriptionAttributesMap
|
array [object] |
Name | Data Type | Description |
---|---|---|
SubscriptionLimitExceededException
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SubscriptionsList
|
array [Subscription] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
ThrottledException
|
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes
.
Name | Data Type | Description | ||||
---|---|---|---|---|---|---|
TopicArn
|
topicARN |
The topic's ARN. |
||||
|
Name | Data Type | Description |
---|---|---|
TopicAttributesMap
|
array [object] |
Name | Data Type | Description |
---|---|---|
TopicLimitExceededException
|