Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

@aws-sdk/client-sns

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

Index

Enumerations

Classes

$Command AddPermissionCommand AuthorizationErrorException BatchEntryIdsNotDistinctException BatchRequestTooLongException CheckIfPhoneNumberIsOptedOutCommand ConcurrentAccessException ConfirmSubscriptionCommand CreatePlatformApplicationCommand CreatePlatformEndpointCommand CreateSMSSandboxPhoneNumberCommand CreateTopicCommand DeleteEndpointCommand DeletePlatformApplicationCommand DeleteSMSSandboxPhoneNumberCommand DeleteTopicCommand EmptyBatchRequestException EndpointDisabledException FilterPolicyLimitExceededException GetDataProtectionPolicyCommand GetEndpointAttributesCommand GetPlatformApplicationAttributesCommand GetSMSAttributesCommand GetSMSSandboxAccountStatusCommand GetSubscriptionAttributesCommand GetTopicAttributesCommand InternalErrorException InvalidBatchEntryIdException InvalidParameterException InvalidParameterValueException InvalidSecurityException KMSAccessDeniedException KMSDisabledException KMSInvalidStateException KMSNotFoundException KMSOptInRequired KMSThrottlingException ListEndpointsByPlatformApplicationCommand ListOriginationNumbersCommand ListPhoneNumbersOptedOutCommand ListPlatformApplicationsCommand ListSMSSandboxPhoneNumbersCommand ListSubscriptionsByTopicCommand ListSubscriptionsCommand ListTagsForResourceCommand ListTopicsCommand NotFoundException OptInPhoneNumberCommand OptedOutException PlatformApplicationDisabledException PublishBatchCommand PublishCommand PutDataProtectionPolicyCommand RemovePermissionCommand ResourceNotFoundException SNS SNSClient SNSServiceException SetEndpointAttributesCommand SetPlatformApplicationAttributesCommand SetSMSAttributesCommand SetSubscriptionAttributesCommand SetTopicAttributesCommand StaleTagException SubscribeCommand SubscriptionLimitExceededException TagLimitExceededException TagPolicyException TagResourceCommand ThrottledException TooManyEntriesInBatchRequestException TopicLimitExceededException UnsubscribeCommand UntagResourceCommand UserErrorException ValidationException VerificationException VerifySMSSandboxPhoneNumberCommand __Client

Interfaces

AddPermissionCommandInput AddPermissionCommandOutput AddPermissionInput BatchResultErrorEntry CheckIfPhoneNumberIsOptedOutCommandInput CheckIfPhoneNumberIsOptedOutCommandOutput CheckIfPhoneNumberIsOptedOutInput CheckIfPhoneNumberIsOptedOutResponse ClientDefaults ConfirmSubscriptionCommandInput ConfirmSubscriptionCommandOutput ConfirmSubscriptionInput ConfirmSubscriptionResponse CreateEndpointResponse CreatePlatformApplicationCommandInput CreatePlatformApplicationCommandOutput CreatePlatformApplicationInput CreatePlatformApplicationResponse CreatePlatformEndpointCommandInput CreatePlatformEndpointCommandOutput CreatePlatformEndpointInput CreateSMSSandboxPhoneNumberCommandInput CreateSMSSandboxPhoneNumberCommandOutput CreateSMSSandboxPhoneNumberInput CreateSMSSandboxPhoneNumberResult CreateTopicCommandInput CreateTopicCommandOutput CreateTopicInput CreateTopicResponse DeleteEndpointCommandInput DeleteEndpointCommandOutput DeleteEndpointInput DeletePlatformApplicationCommandInput DeletePlatformApplicationCommandOutput DeletePlatformApplicationInput DeleteSMSSandboxPhoneNumberCommandInput DeleteSMSSandboxPhoneNumberCommandOutput DeleteSMSSandboxPhoneNumberInput DeleteSMSSandboxPhoneNumberResult DeleteTopicCommandInput DeleteTopicCommandOutput DeleteTopicInput Endpoint GetDataProtectionPolicyCommandInput GetDataProtectionPolicyCommandOutput GetDataProtectionPolicyInput GetDataProtectionPolicyResponse GetEndpointAttributesCommandInput GetEndpointAttributesCommandOutput GetEndpointAttributesInput GetEndpointAttributesResponse GetPlatformApplicationAttributesCommandInput GetPlatformApplicationAttributesCommandOutput GetPlatformApplicationAttributesInput GetPlatformApplicationAttributesResponse GetSMSAttributesCommandInput GetSMSAttributesCommandOutput GetSMSAttributesInput GetSMSAttributesResponse GetSMSSandboxAccountStatusCommandInput GetSMSSandboxAccountStatusCommandOutput GetSMSSandboxAccountStatusInput GetSMSSandboxAccountStatusResult GetSubscriptionAttributesCommandInput GetSubscriptionAttributesCommandOutput GetSubscriptionAttributesInput GetSubscriptionAttributesResponse GetTopicAttributesCommandInput GetTopicAttributesCommandOutput GetTopicAttributesInput GetTopicAttributesResponse ListEndpointsByPlatformApplicationCommandInput ListEndpointsByPlatformApplicationCommandOutput ListEndpointsByPlatformApplicationInput ListEndpointsByPlatformApplicationResponse ListOriginationNumbersCommandInput ListOriginationNumbersCommandOutput ListOriginationNumbersRequest ListOriginationNumbersResult ListPhoneNumbersOptedOutCommandInput ListPhoneNumbersOptedOutCommandOutput ListPhoneNumbersOptedOutInput ListPhoneNumbersOptedOutResponse ListPlatformApplicationsCommandInput ListPlatformApplicationsCommandOutput ListPlatformApplicationsInput ListPlatformApplicationsResponse ListSMSSandboxPhoneNumbersCommandInput ListSMSSandboxPhoneNumbersCommandOutput ListSMSSandboxPhoneNumbersInput ListSMSSandboxPhoneNumbersResult ListSubscriptionsByTopicCommandInput ListSubscriptionsByTopicCommandOutput ListSubscriptionsByTopicInput ListSubscriptionsByTopicResponse ListSubscriptionsCommandInput ListSubscriptionsCommandOutput ListSubscriptionsInput ListSubscriptionsResponse ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTagsForResourceRequest ListTagsForResourceResponse ListTopicsCommandInput ListTopicsCommandOutput ListTopicsInput ListTopicsResponse MessageAttributeValue OptInPhoneNumberCommandInput OptInPhoneNumberCommandOutput OptInPhoneNumberInput OptInPhoneNumberResponse PhoneNumberInformation PlatformApplication PublishBatchCommandInput PublishBatchCommandOutput PublishBatchInput PublishBatchRequestEntry PublishBatchResponse PublishBatchResultEntry PublishCommandInput PublishCommandOutput PublishInput PublishResponse PutDataProtectionPolicyCommandInput PutDataProtectionPolicyCommandOutput PutDataProtectionPolicyInput RemovePermissionCommandInput RemovePermissionCommandOutput RemovePermissionInput SMSSandboxPhoneNumber SNSClientConfig SNSClientResolvedConfig SNSPaginationConfiguration SetEndpointAttributesCommandInput SetEndpointAttributesCommandOutput SetEndpointAttributesInput SetPlatformApplicationAttributesCommandInput SetPlatformApplicationAttributesCommandOutput SetPlatformApplicationAttributesInput SetSMSAttributesCommandInput SetSMSAttributesCommandOutput SetSMSAttributesInput SetSMSAttributesResponse SetSubscriptionAttributesCommandInput SetSubscriptionAttributesCommandOutput SetSubscriptionAttributesInput SetTopicAttributesCommandInput SetTopicAttributesCommandOutput SetTopicAttributesInput SubscribeCommandInput SubscribeCommandOutput SubscribeInput SubscribeResponse Subscription Tag TagResourceCommandInput TagResourceCommandOutput TagResourceRequest TagResourceResponse Topic UnsubscribeCommandInput UnsubscribeCommandOutput UnsubscribeInput UntagResourceCommandInput UntagResourceCommandOutput UntagResourceRequest UntagResourceResponse VerifySMSSandboxPhoneNumberCommandInput VerifySMSSandboxPhoneNumberCommandOutput VerifySMSSandboxPhoneNumberInput VerifySMSSandboxPhoneNumberResult __MetadataBearer

Type Aliases

Functions

SDK - Clients

SDK - Commands

AddPermissionCommand AddPermissionCommandInput AddPermissionCommandOutput CheckIfPhoneNumberIsOptedOutCommand CheckIfPhoneNumberIsOptedOutCommandInput CheckIfPhoneNumberIsOptedOutCommandOutput ConfirmSubscriptionCommand ConfirmSubscriptionCommandInput ConfirmSubscriptionCommandOutput CreatePlatformApplicationCommand CreatePlatformApplicationCommandInput CreatePlatformApplicationCommandOutput CreatePlatformEndpointCommand CreatePlatformEndpointCommandInput CreatePlatformEndpointCommandOutput CreateSMSSandboxPhoneNumberCommand CreateSMSSandboxPhoneNumberCommandInput CreateSMSSandboxPhoneNumberCommandOutput CreateTopicCommand CreateTopicCommandInput CreateTopicCommandOutput DeleteEndpointCommand DeleteEndpointCommandInput DeleteEndpointCommandOutput DeletePlatformApplicationCommand DeletePlatformApplicationCommandInput DeletePlatformApplicationCommandOutput DeleteSMSSandboxPhoneNumberCommand DeleteSMSSandboxPhoneNumberCommandInput DeleteSMSSandboxPhoneNumberCommandOutput DeleteTopicCommand DeleteTopicCommandInput DeleteTopicCommandOutput GetDataProtectionPolicyCommand GetDataProtectionPolicyCommandInput GetDataProtectionPolicyCommandOutput GetEndpointAttributesCommand GetEndpointAttributesCommandInput GetEndpointAttributesCommandOutput GetPlatformApplicationAttributesCommand GetPlatformApplicationAttributesCommandInput GetPlatformApplicationAttributesCommandOutput GetSMSAttributesCommand GetSMSAttributesCommandInput GetSMSAttributesCommandOutput GetSMSSandboxAccountStatusCommand GetSMSSandboxAccountStatusCommandInput GetSMSSandboxAccountStatusCommandOutput GetSubscriptionAttributesCommand GetSubscriptionAttributesCommandInput GetSubscriptionAttributesCommandOutput GetTopicAttributesCommand GetTopicAttributesCommandInput GetTopicAttributesCommandOutput ListEndpointsByPlatformApplicationCommand ListEndpointsByPlatformApplicationCommandInput ListEndpointsByPlatformApplicationCommandOutput ListOriginationNumbersCommand ListOriginationNumbersCommandInput ListOriginationNumbersCommandOutput ListPhoneNumbersOptedOutCommand ListPhoneNumbersOptedOutCommandInput ListPhoneNumbersOptedOutCommandOutput ListPlatformApplicationsCommand ListPlatformApplicationsCommandInput ListPlatformApplicationsCommandOutput ListSMSSandboxPhoneNumbersCommand ListSMSSandboxPhoneNumbersCommandInput ListSMSSandboxPhoneNumbersCommandOutput ListSubscriptionsByTopicCommand ListSubscriptionsByTopicCommandInput ListSubscriptionsByTopicCommandOutput ListSubscriptionsCommand ListSubscriptionsCommandInput ListSubscriptionsCommandOutput ListTagsForResourceCommand ListTagsForResourceCommandInput ListTagsForResourceCommandOutput ListTopicsCommand ListTopicsCommandInput ListTopicsCommandOutput OptInPhoneNumberCommand OptInPhoneNumberCommandInput OptInPhoneNumberCommandOutput PublishBatchCommand PublishBatchCommandInput PublishBatchCommandOutput PublishCommand PublishCommandInput PublishCommandOutput PutDataProtectionPolicyCommand PutDataProtectionPolicyCommandInput PutDataProtectionPolicyCommandOutput RemovePermissionCommand RemovePermissionCommandInput RemovePermissionCommandOutput SetEndpointAttributesCommand SetEndpointAttributesCommandInput SetEndpointAttributesCommandOutput SetPlatformApplicationAttributesCommand SetPlatformApplicationAttributesCommandInput SetPlatformApplicationAttributesCommandOutput SetSMSAttributesCommand SetSMSAttributesCommandInput SetSMSAttributesCommandOutput SetSubscriptionAttributesCommand SetSubscriptionAttributesCommandInput SetSubscriptionAttributesCommandOutput SetTopicAttributesCommand SetTopicAttributesCommandInput SetTopicAttributesCommandOutput SubscribeCommand SubscribeCommandInput SubscribeCommandOutput TagResourceCommand TagResourceCommandInput TagResourceCommandOutput UnsubscribeCommand UnsubscribeCommandInput UnsubscribeCommandOutput UntagResourceCommand UntagResourceCommandInput UntagResourceCommandOutput VerifySMSSandboxPhoneNumberCommand VerifySMSSandboxPhoneNumberCommandInput VerifySMSSandboxPhoneNumberCommandOutput

SDK - Paginators

SDK - Waiters