Expand description
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 the Amazon SNS product page. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.
For information on the permissions you need to use this API, see Identity and access management in Amazon SNS in 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.
If you’re using the service, you’re probably looking for SnsClient and Sns.
Structs§
- AddPermission
Input - Check
IfPhone Number IsOpted OutInput The input for the
CheckIfPhoneNumberIsOptedOutaction.- Check
IfPhone Number IsOpted OutResponse The response from the
CheckIfPhoneNumberIsOptedOutaction.- Confirm
Subscription Input Input for ConfirmSubscription action.
- Confirm
Subscription Response Response for ConfirmSubscriptions action.
- Create
Endpoint Response Response from CreateEndpoint action.
- Create
Platform Application Input Input for CreatePlatformApplication action.
- Create
Platform Application Response Response from CreatePlatformApplication action.
- Create
Platform Endpoint Input Input for CreatePlatformEndpoint action.
- CreateSMS
Sandbox Phone Number Input - CreateSMS
Sandbox Phone Number Result - Create
Topic Input Input for CreateTopic action.
- Create
Topic Response Response from CreateTopic action.
- Delete
Endpoint Input Input for DeleteEndpoint action.
- Delete
Platform Application Input Input for DeletePlatformApplication action.
- DeleteSMS
Sandbox Phone Number Input - DeleteSMS
Sandbox Phone Number Result - Delete
Topic Input - GetEndpoint
Attributes Input Input for GetEndpointAttributes action.
- GetEndpoint
Attributes Response Response from GetEndpointAttributes of the EndpointArn.
- GetPlatform
Application Attributes Input Input for GetPlatformApplicationAttributes action.
- GetPlatform
Application Attributes Response Response for GetPlatformApplicationAttributes action.
- GetSMS
Attributes Input The input for the
GetSMSAttributesrequest.- GetSMS
Attributes Response The response from the
GetSMSAttributesrequest.- GetSMS
Sandbox Account Status Input - GetSMS
Sandbox Account Status Result - GetSubscription
Attributes Input Input for GetSubscriptionAttributes.
- GetSubscription
Attributes Response Response for GetSubscriptionAttributes action.
- GetTopic
Attributes Input Input for GetTopicAttributes action.
- GetTopic
Attributes Response Response for GetTopicAttributes action.
- List
Endpoints ByPlatform Application Input Input for ListEndpointsByPlatformApplication action.
- List
Endpoints ByPlatform Application Response Response for ListEndpointsByPlatformApplication action.
- List
Origination Numbers Request - List
Origination Numbers Result - List
Phone Numbers Opted OutInput The input for the
ListPhoneNumbersOptedOutaction.- List
Phone Numbers Opted OutResponse The response from the
ListPhoneNumbersOptedOutaction.- List
Platform Applications Input Input for ListPlatformApplications action.
- List
Platform Applications Response Response for ListPlatformApplications action.
- ListSMS
Sandbox Phone Numbers Input - ListSMS
Sandbox Phone Numbers Result - List
Subscriptions ByTopic Input Input for ListSubscriptionsByTopic action.
- List
Subscriptions ByTopic Response Response for ListSubscriptionsByTopic action.
- List
Subscriptions Input Input for ListSubscriptions action.
- List
Subscriptions Response Response for ListSubscriptions action
- List
Tags ForResource Request - List
Tags ForResource Response - List
Topics Input - List
Topics Response Response for ListTopics action.
- Message
Attribute Value The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.
Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Amazon SNS message attributes and Publishing to a mobile phone in the Amazon SNS Developer Guide.
- OptIn
Phone Number Input Input for the OptInPhoneNumber action.
- OptIn
Phone Number Response The response for the OptInPhoneNumber action.
- Phone
Number Information A list of phone numbers and their metadata.
- Platform
Application Platform application object.
- Publish
Input Input for Publish action.
- Publish
Response Response for Publish action.
- Remove
Permission Input Input for RemovePermission action.
- SMSSandbox
Phone Number A verified or pending destination phone number in the SMS sandbox.
When you start using Amazon SNS to send SMS messages, your AWS account is in the SMS sandbox. The SMS sandbox provides a safe environment for you to try Amazon SNS features without risking your reputation as an SMS sender. While your account is in the SMS sandbox, you can use all of the features of Amazon SNS. However, you can send SMS messages only to verified destination phone numbers. For more information, including how to move out of the sandbox to send messages without restrictions, see SMS sandbox in the Amazon SNS Developer Guide.
- SetEndpoint
Attributes Input Input for SetEndpointAttributes action.
- SetPlatform
Application Attributes Input Input for SetPlatformApplicationAttributes action.
- SetSMS
Attributes Input The input for the SetSMSAttributes action.
- SetSMS
Attributes Response The response for the SetSMSAttributes action.
- SetSubscription
Attributes Input Input for SetSubscriptionAttributes action.
- SetTopic
Attributes Input Input for SetTopicAttributes action.
- SnsClient
- A client for the Amazon SNS API.
- Subscribe
Input Input for Subscribe action.
- Subscribe
Response Response for Subscribe action.
- Subscription
A wrapper type for the attributes of an Amazon SNS subscription.
- Tag
The list of tags to be added to the specified topic.
- TagResource
Request - TagResource
Response - Topic
A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use
GetTopicAttributes.- Unsubscribe
Input Input for Unsubscribe action.
- Untag
Resource Request - Untag
Resource Response - VerifySMS
Sandbox Phone Number Input - VerifySMS
Sandbox Phone Number Result The destination phone number's verification status.
Enums§
- AddPermission
Error - Errors returned by AddPermission
- Check
IfPhone Number IsOpted OutError - Errors returned by CheckIfPhoneNumberIsOptedOut
- Confirm
Subscription Error - Errors returned by ConfirmSubscription
- Create
Platform Application Error - Errors returned by CreatePlatformApplication
- Create
Platform Endpoint Error - Errors returned by CreatePlatformEndpoint
- CreateSMS
Sandbox Phone Number Error - Errors returned by CreateSMSSandboxPhoneNumber
- Create
Topic Error - Errors returned by CreateTopic
- Delete
Endpoint Error - Errors returned by DeleteEndpoint
- Delete
Platform Application Error - Errors returned by DeletePlatformApplication
- DeleteSMS
Sandbox Phone Number Error - Errors returned by DeleteSMSSandboxPhoneNumber
- Delete
Topic Error - Errors returned by DeleteTopic
- GetEndpoint
Attributes Error - Errors returned by GetEndpointAttributes
- GetPlatform
Application Attributes Error - Errors returned by GetPlatformApplicationAttributes
- GetSMS
Attributes Error - Errors returned by GetSMSAttributes
- GetSMS
Sandbox Account Status Error - Errors returned by GetSMSSandboxAccountStatus
- GetSubscription
Attributes Error - Errors returned by GetSubscriptionAttributes
- GetTopic
Attributes Error - Errors returned by GetTopicAttributes
- List
Endpoints ByPlatform Application Error - Errors returned by ListEndpointsByPlatformApplication
- List
Origination Numbers Error - Errors returned by ListOriginationNumbers
- List
Phone Numbers Opted OutError - Errors returned by ListPhoneNumbersOptedOut
- List
Platform Applications Error - Errors returned by ListPlatformApplications
- ListSMS
Sandbox Phone Numbers Error - Errors returned by ListSMSSandboxPhoneNumbers
- List
Subscriptions ByTopic Error - Errors returned by ListSubscriptionsByTopic
- List
Subscriptions Error - Errors returned by ListSubscriptions
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Topics Error - Errors returned by ListTopics
- OptIn
Phone Number Error - Errors returned by OptInPhoneNumber
- Publish
Error - Errors returned by Publish
- Remove
Permission Error - Errors returned by RemovePermission
- SetEndpoint
Attributes Error - Errors returned by SetEndpointAttributes
- SetPlatform
Application Attributes Error - Errors returned by SetPlatformApplicationAttributes
- SetSMS
Attributes Error - Errors returned by SetSMSAttributes
- SetSubscription
Attributes Error - Errors returned by SetSubscriptionAttributes
- SetTopic
Attributes Error - Errors returned by SetTopicAttributes
- Subscribe
Error - Errors returned by Subscribe
- TagResource
Error - Errors returned by TagResource
- Unsubscribe
Error - Errors returned by Unsubscribe
- Untag
Resource Error - Errors returned by UntagResource
- VerifySMS
Sandbox Phone Number Error - Errors returned by VerifySMSSandboxPhoneNumber
Traits§
- Sns
- Trait representing the capabilities of the Amazon SNS API. Amazon SNS clients implement this trait.