Classes Reference


                    
                    
                    AWSSNSAddPermissionInput

Declaration

Objective-C

@interface AWSSNSAddPermissionInput

Swift

class AWSSNSAddPermissionInput


                    
                    
                    AWSSNSBatchResultErrorEntry

Gives a detailed description of failed messages in the batch.

Required parameters: [Id, Code, SenderFault]

Declaration

Objective-C

@interface AWSSNSBatchResultErrorEntry

Swift

class AWSSNSBatchResultErrorEntry


                    
                    
                    AWSSNSCheckIfPhoneNumberIsOptedOutInput

The input for the CheckIfPhoneNumberIsOptedOut action.

Required parameters: [phoneNumber]

Declaration

Objective-C

@interface AWSSNSCheckIfPhoneNumberIsOptedOutInput

Swift

class AWSSNSCheckIfPhoneNumberIsOptedOutInput


                    
                    
                    AWSSNSCheckIfPhoneNumberIsOptedOutResponse

The response from the CheckIfPhoneNumberIsOptedOut action.

Declaration

Objective-C

@interface AWSSNSCheckIfPhoneNumberIsOptedOutResponse

Swift

class AWSSNSCheckIfPhoneNumberIsOptedOutResponse


                    
                    
                    AWSSNSConfirmSubscriptionInput

Input for ConfirmSubscription action.

Required parameters: [TopicArn, Token]

Declaration

Objective-C

@interface AWSSNSConfirmSubscriptionInput

Swift

class AWSSNSConfirmSubscriptionInput


                    
                    
                    AWSSNSConfirmSubscriptionResponse

Response for ConfirmSubscriptions action.

Declaration

Objective-C

@interface AWSSNSConfirmSubscriptionResponse

Swift

class AWSSNSConfirmSubscriptionResponse


                    
                    
                    AWSSNSCreateEndpointResponse

Response from CreateEndpoint action.

Declaration

Objective-C

@interface AWSSNSCreateEndpointResponse

Swift

class AWSSNSCreateEndpointResponse


                    
                    
                    AWSSNSCreatePlatformApplicationInput

Input for CreatePlatformApplication action.

Required parameters: [Name, Platform, Attributes]

Declaration

Objective-C

@interface AWSSNSCreatePlatformApplicationInput

Swift

class AWSSNSCreatePlatformApplicationInput


                    
                    
                    AWSSNSCreatePlatformApplicationResponse

Response from CreatePlatformApplication action.

Declaration

Objective-C

@interface AWSSNSCreatePlatformApplicationResponse

Swift

class AWSSNSCreatePlatformApplicationResponse


                    
                    
                    AWSSNSCreatePlatformEndpointInput

Input for CreatePlatformEndpoint action.

Required parameters: [PlatformApplicationArn, Token]

Declaration

Objective-C

@interface AWSSNSCreatePlatformEndpointInput

Swift

class AWSSNSCreatePlatformEndpointInput


                    
                    
                    AWSSNSCreateSMSSandboxPhoneNumberInput

Declaration

Objective-C

@interface AWSSNSCreateSMSSandboxPhoneNumberInput

Swift

class AWSSNSCreateSMSSandboxPhoneNumberInput


                    
                    
                    AWSSNSCreateSMSSandboxPhoneNumberResult

Declaration

Objective-C

@interface AWSSNSCreateSMSSandboxPhoneNumberResult

Swift

class AWSSNSCreateSMSSandboxPhoneNumberResult


                    
                    
                    AWSSNSCreateTopicInput

Input for CreateTopic action.

Required parameters: [Name]

Declaration

Objective-C

@interface AWSSNSCreateTopicInput

Swift

class AWSSNSCreateTopicInput


                    
                    
                    AWSSNSCreateTopicResponse

Response from CreateTopic action.

Declaration

Objective-C

@interface AWSSNSCreateTopicResponse

Swift

class AWSSNSCreateTopicResponse


                    
                    
                    AWSSNSDeleteEndpointInput

Input for DeleteEndpoint action.

Required parameters: [EndpointArn]

Declaration

Objective-C

@interface AWSSNSDeleteEndpointInput

Swift

class AWSSNSDeleteEndpointInput


                    
                    
                    AWSSNSDeletePlatformApplicationInput

Input for DeletePlatformApplication action.

Required parameters: [PlatformApplicationArn]

Declaration

Objective-C

@interface AWSSNSDeletePlatformApplicationInput

Swift

class AWSSNSDeletePlatformApplicationInput


                    
                    
                    AWSSNSDeleteSMSSandboxPhoneNumberInput

Declaration

Objective-C

@interface AWSSNSDeleteSMSSandboxPhoneNumberInput

Swift

class AWSSNSDeleteSMSSandboxPhoneNumberInput


                    
                    
                    AWSSNSDeleteSMSSandboxPhoneNumberResult

Declaration

Objective-C

@interface AWSSNSDeleteSMSSandboxPhoneNumberResult

Swift

class AWSSNSDeleteSMSSandboxPhoneNumberResult


                    
                    
                    AWSSNSDeleteTopicInput

Declaration

Objective-C

@interface AWSSNSDeleteTopicInput

Swift

class AWSSNSDeleteTopicInput


                    
                    
                    AWSSNSEndpoint

The endpoint for mobile app and device.

Declaration

Objective-C

@interface AWSSNSEndpoint

Swift

class AWSSNSEndpoint


                    
                    
                    AWSSNSGetDataProtectionPolicyInput

Declaration

Objective-C

@interface AWSSNSGetDataProtectionPolicyInput

Swift

class AWSSNSGetDataProtectionPolicyInput


                    
                    
                    AWSSNSGetDataProtectionPolicyResponse

Declaration

Objective-C

@interface AWSSNSGetDataProtectionPolicyResponse

Swift

class AWSSNSGetDataProtectionPolicyResponse


                    
                    
                    AWSSNSGetEndpointAttributesInput

Input for GetEndpointAttributes action.

Required parameters: [EndpointArn]

Declaration

Objective-C

@interface AWSSNSGetEndpointAttributesInput

Swift

class AWSSNSGetEndpointAttributesInput


                    
                    
                    AWSSNSGetEndpointAttributesResponse

Response from GetEndpointAttributes of the EndpointArn.

Declaration

Objective-C

@interface AWSSNSGetEndpointAttributesResponse

Swift

class AWSSNSGetEndpointAttributesResponse


                    
                    
                    AWSSNSGetPlatformApplicationAttributesInput

Input for GetPlatformApplicationAttributes action.

Required parameters: [PlatformApplicationArn]

Declaration

Objective-C

@interface AWSSNSGetPlatformApplicationAttributesInput

Swift

class AWSSNSGetPlatformApplicationAttributesInput


                    
                    
                    AWSSNSGetPlatformApplicationAttributesResponse

Response for GetPlatformApplicationAttributes action.

Declaration

Objective-C

@interface AWSSNSGetPlatformApplicationAttributesResponse

Swift

class AWSSNSGetPlatformApplicationAttributesResponse


                    
                    
                    AWSSNSGetSMSAttributesInput

The input for the GetSMSAttributes request.

Declaration

Objective-C

@interface AWSSNSGetSMSAttributesInput

Swift

class AWSSNSGetSMSAttributesInput


                    
                    
                    AWSSNSGetSMSAttributesResponse

The response from the GetSMSAttributes request.

Declaration

Objective-C

@interface AWSSNSGetSMSAttributesResponse

Swift

class AWSSNSGetSMSAttributesResponse


                    
                    
                    AWSSNSGetSMSSandboxAccountStatusInput

Declaration

Objective-C

@interface AWSSNSGetSMSSandboxAccountStatusInput

Swift

class AWSSNSGetSMSSandboxAccountStatusInput


                    
                    
                    AWSSNSGetSMSSandboxAccountStatusResult

Declaration

Objective-C

@interface AWSSNSGetSMSSandboxAccountStatusResult

Swift

class AWSSNSGetSMSSandboxAccountStatusResult


                    
                    
                    AWSSNSGetSubscriptionAttributesInput

Input for GetSubscriptionAttributes.

Required parameters: [SubscriptionArn]

Declaration

Objective-C

@interface AWSSNSGetSubscriptionAttributesInput

Swift

class AWSSNSGetSubscriptionAttributesInput


                    
                    
                    AWSSNSGetSubscriptionAttributesResponse

Response for GetSubscriptionAttributes action.

Declaration

Objective-C

@interface AWSSNSGetSubscriptionAttributesResponse

Swift

class AWSSNSGetSubscriptionAttributesResponse


                    
                    
                    AWSSNSGetTopicAttributesInput

Input for GetTopicAttributes action.

Required parameters: [TopicArn]

Declaration

Objective-C

@interface AWSSNSGetTopicAttributesInput

Swift

class AWSSNSGetTopicAttributesInput


                    
                    
                    AWSSNSGetTopicAttributesResponse

Response for GetTopicAttributes action.

Declaration

Objective-C

@interface AWSSNSGetTopicAttributesResponse

Swift

class AWSSNSGetTopicAttributesResponse


                    
                    
                    AWSSNSListEndpointsByPlatformApplicationInput

Input for ListEndpointsByPlatformApplication action.

Required parameters: [PlatformApplicationArn]

Declaration

Objective-C

@interface AWSSNSListEndpointsByPlatformApplicationInput

Swift

class AWSSNSListEndpointsByPlatformApplicationInput


                    
                    
                    AWSSNSListEndpointsByPlatformApplicationResponse

Response for ListEndpointsByPlatformApplication action.

Declaration

Objective-C

@interface AWSSNSListEndpointsByPlatformApplicationResponse

Swift

class AWSSNSListEndpointsByPlatformApplicationResponse


                    
                    
                    AWSSNSListOriginationNumbersRequest

Declaration

Objective-C

@interface AWSSNSListOriginationNumbersRequest

Swift

class AWSSNSListOriginationNumbersRequest


                    
                    
                    AWSSNSListOriginationNumbersResult

Declaration

Objective-C

@interface AWSSNSListOriginationNumbersResult

Swift

class AWSSNSListOriginationNumbersResult


                    
                    
                    AWSSNSListPhoneNumbersOptedOutInput

The input for the ListPhoneNumbersOptedOut action.

Declaration

Objective-C

@interface AWSSNSListPhoneNumbersOptedOutInput

Swift

class AWSSNSListPhoneNumbersOptedOutInput


                    
                    
                    AWSSNSListPhoneNumbersOptedOutResponse

The response from the ListPhoneNumbersOptedOut action.

Declaration

Objective-C

@interface AWSSNSListPhoneNumbersOptedOutResponse

Swift

class AWSSNSListPhoneNumbersOptedOutResponse


                    
                    
                    AWSSNSListPlatformApplicationsInput

Input for ListPlatformApplications action.

Declaration

Objective-C

@interface AWSSNSListPlatformApplicationsInput

Swift

class AWSSNSListPlatformApplicationsInput


                    
                    
                    AWSSNSListPlatformApplicationsResponse

Response for ListPlatformApplications action.

Declaration

Objective-C

@interface AWSSNSListPlatformApplicationsResponse

Swift

class AWSSNSListPlatformApplicationsResponse


                    
                    
                    AWSSNSListSMSSandboxPhoneNumbersInput

Declaration

Objective-C

@interface AWSSNSListSMSSandboxPhoneNumbersInput

Swift

class AWSSNSListSMSSandboxPhoneNumbersInput


                    
                    
                    AWSSNSListSMSSandboxPhoneNumbersResult

Declaration

Objective-C

@interface AWSSNSListSMSSandboxPhoneNumbersResult

Swift

class AWSSNSListSMSSandboxPhoneNumbersResult


                    
                    
                    AWSSNSListSubscriptionsByTopicInput

Input for ListSubscriptionsByTopic action.

Required parameters: [TopicArn]

Declaration

Objective-C

@interface AWSSNSListSubscriptionsByTopicInput

Swift

class AWSSNSListSubscriptionsByTopicInput


                    
                    
                    AWSSNSListSubscriptionsByTopicResponse

Response for ListSubscriptionsByTopic action.

Declaration

Objective-C

@interface AWSSNSListSubscriptionsByTopicResponse

Swift

class AWSSNSListSubscriptionsByTopicResponse


                    
                    
                    AWSSNSListSubscriptionsInput

Input for ListSubscriptions action.

Declaration

Objective-C

@interface AWSSNSListSubscriptionsInput

Swift

class AWSSNSListSubscriptionsInput


                    
                    
                    AWSSNSListSubscriptionsResponse

Response for ListSubscriptions action

Declaration

Objective-C

@interface AWSSNSListSubscriptionsResponse

Swift

class AWSSNSListSubscriptionsResponse


                    
                    
                    AWSSNSListTagsForResourceRequest

Declaration

Objective-C

@interface AWSSNSListTagsForResourceRequest

Swift

class AWSSNSListTagsForResourceRequest


                    
                    
                    AWSSNSListTagsForResourceResponse

Declaration

Objective-C

@interface AWSSNSListTagsForResourceResponse

Swift

class AWSSNSListTagsForResourceResponse


                    
                    
                    AWSSNSListTopicsInput

Declaration

Objective-C

@interface AWSSNSListTopicsInput

Swift

class AWSSNSListTopicsInput


                    
                    
                    AWSSNSListTopicsResponse

Response for ListTopics action.

Declaration

Objective-C

@interface AWSSNSListTopicsResponse

Swift

class AWSSNSListTopicsResponse


                    
                    
                    AWSSNSMessageAttributeValue

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.

Required parameters: [DataType]

Declaration

Objective-C

@interface AWSSNSMessageAttributeValue

Swift

class AWSSNSMessageAttributeValue


                    
                    
                    AWSSNSOptInPhoneNumberInput

Input for the OptInPhoneNumber action.

Required parameters: [phoneNumber]

Declaration

Objective-C

@interface AWSSNSOptInPhoneNumberInput

Swift

class AWSSNSOptInPhoneNumberInput


                    
                    
                    AWSSNSOptInPhoneNumberResponse

The response for the OptInPhoneNumber action.

Declaration

Objective-C

@interface AWSSNSOptInPhoneNumberResponse

Swift

class AWSSNSOptInPhoneNumberResponse


                    
                    
                    AWSSNSPhoneNumberInformation

A list of phone numbers and their metadata.

Declaration

Objective-C

@interface AWSSNSPhoneNumberInformation

Swift

class AWSSNSPhoneNumberInformation


                    
                    
                    AWSSNSPlatformApplication

Platform application object.

Declaration

Objective-C

@interface AWSSNSPlatformApplication

Swift

class AWSSNSPlatformApplication


                    
                    
                    AWSSNSPublishBatchInput

Declaration

Objective-C

@interface AWSSNSPublishBatchInput

Swift

class AWSSNSPublishBatchInput


                    
                    
                    AWSSNSPublishBatchRequestEntry

Contains the details of a single Amazon SNS message along with an Id that identifies a message within the batch.

Required parameters: [Id, Message]

Declaration

Objective-C

@interface AWSSNSPublishBatchRequestEntry

Swift

class AWSSNSPublishBatchRequestEntry


                    
                    
                    AWSSNSPublishBatchResponse

Declaration

Objective-C

@interface AWSSNSPublishBatchResponse

Swift

class AWSSNSPublishBatchResponse


                    
                    
                    AWSSNSPublishBatchResultEntry

Encloses data related to a successful message in a batch request for topic.

Declaration

Objective-C

@interface AWSSNSPublishBatchResultEntry

Swift

class AWSSNSPublishBatchResultEntry


                    
                    
                    AWSSNSPublishInput

Input for Publish action.

Required parameters: [Message]

Declaration

Objective-C

@interface AWSSNSPublishInput

Swift

class AWSSNSPublishInput


                    
                    
                    AWSSNSPublishResponse

Response for Publish action.

Declaration

Objective-C

@interface AWSSNSPublishResponse

Swift

class AWSSNSPublishResponse


                    
                    
                    AWSSNSPutDataProtectionPolicyInput

Declaration

Objective-C

@interface AWSSNSPutDataProtectionPolicyInput

Swift

class AWSSNSPutDataProtectionPolicyInput


                    
                    
                    AWSSNSRemovePermissionInput

Input for RemovePermission action.

Required parameters: [TopicArn, Label]

Declaration

Objective-C

@interface AWSSNSRemovePermissionInput

Swift

class AWSSNSRemovePermissionInput


                    
                    
                    AWSSNSSMSSandboxPhoneNumber

A verified or pending destination phone number in the SMS sandbox.

When you start using Amazon SNS to send SMS messages, your Amazon Web Services 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 Amazon Web Services 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.

Declaration

Objective-C

@interface AWSSNSSMSSandboxPhoneNumber

Swift

class AWSSNSSMSSandboxPhoneNumber


                    
                    
                    AWSSNSSetEndpointAttributesInput

Input for SetEndpointAttributes action.

Required parameters: [EndpointArn, Attributes]

Declaration

Objective-C

@interface AWSSNSSetEndpointAttributesInput

Swift

class AWSSNSSetEndpointAttributesInput


                    
                    
                    AWSSNSSetPlatformApplicationAttributesInput

Input for SetPlatformApplicationAttributes action.

Required parameters: [PlatformApplicationArn, Attributes]

Declaration

Objective-C

@interface AWSSNSSetPlatformApplicationAttributesInput

Swift

class AWSSNSSetPlatformApplicationAttributesInput


                    
                    
                    AWSSNSSetSMSAttributesInput

The input for the SetSMSAttributes action.

Required parameters: [attributes]

Declaration

Objective-C

@interface AWSSNSSetSMSAttributesInput

Swift

class AWSSNSSetSMSAttributesInput


                    
                    
                    AWSSNSSetSMSAttributesResponse

The response for the SetSMSAttributes action.

Declaration

Objective-C

@interface AWSSNSSetSMSAttributesResponse

Swift

class AWSSNSSetSMSAttributesResponse


                    
                    
                    AWSSNSSetSubscriptionAttributesInput

Input for SetSubscriptionAttributes action.

Required parameters: [SubscriptionArn, AttributeName]

Declaration

Objective-C

@interface AWSSNSSetSubscriptionAttributesInput

Swift

class AWSSNSSetSubscriptionAttributesInput


                    
                    
                    AWSSNSSetTopicAttributesInput

Input for SetTopicAttributes action.

Required parameters: [TopicArn, AttributeName]

Declaration

Objective-C

@interface AWSSNSSetTopicAttributesInput

Swift

class AWSSNSSetTopicAttributesInput


                    
                    
                    AWSSNSSubscribeInput

Input for Subscribe action.

Required parameters: [TopicArn, Protocol]

Declaration

Objective-C

@interface AWSSNSSubscribeInput

Swift

class AWSSNSSubscribeInput


                    
                    
                    AWSSNSSubscribeResponse

Response for Subscribe action.

Declaration

Objective-C

@interface AWSSNSSubscribeResponse

Swift

class AWSSNSSubscribeResponse


                    
                    
                    AWSSNSSubscription

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

Declaration

Objective-C

@interface AWSSNSSubscription

Swift

class AWSSNSSubscription


                    
                    
                    AWSSNSTag

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

Required parameters: [Key, Value]

Declaration

Objective-C

@interface AWSSNSTag

Swift

class AWSSNSTag


                    
                    
                    AWSSNSTagResourceRequest

Declaration

Objective-C

@interface AWSSNSTagResourceRequest

Swift

class AWSSNSTagResourceRequest


                    
                    
                    AWSSNSTagResourceResponse

Declaration

Objective-C

@interface AWSSNSTagResourceResponse

Swift

class AWSSNSTagResourceResponse


                    
                    
                    AWSSNSTopic

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

Declaration

Objective-C

@interface AWSSNSTopic

Swift

class AWSSNSTopic


                    
                    
                    AWSSNSUnsubscribeInput

Input for Unsubscribe action.

Required parameters: [SubscriptionArn]

Declaration

Objective-C

@interface AWSSNSUnsubscribeInput

Swift

class AWSSNSUnsubscribeInput


                    
                    
                    AWSSNSUntagResourceRequest

Declaration

Objective-C

@interface AWSSNSUntagResourceRequest

Swift

class AWSSNSUntagResourceRequest


                    
                    
                    AWSSNSUntagResourceResponse

Declaration

Objective-C

@interface AWSSNSUntagResourceResponse

Swift

class AWSSNSUntagResourceResponse


                    
                    
                    AWSSNSVerifySMSSandboxPhoneNumberInput

Declaration

Objective-C

@interface AWSSNSVerifySMSSandboxPhoneNumberInput

Swift

class AWSSNSVerifySMSSandboxPhoneNumberInput


                    
                    
                    AWSSNSVerifySMSSandboxPhoneNumberResult

The destination phone number’s verification status.

Declaration

Objective-C

@interface AWSSNSVerifySMSSandboxPhoneNumberResult

Swift

class AWSSNSVerifySMSSandboxPhoneNumberResult


                    
                    
                    AWSSNSResources

Undocumented

Declaration

Objective-C

@interface AWSSNSResources : NSObject

+ (instancetype)sharedInstance;

- (NSDictionary *)JSONObject;

@end

Swift

class AWSSNSResources : NSObject


                    
                    
                    AWSSNS

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.

Declaration

Objective-C

@interface AWSSNS

Swift

class AWSSNS