AWSSNS Class Reference

Inherits from AWSService : NSObject
Declared in AWSSNSService.h
AWSSNSService.m

Overview

Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSSNSService.h

+ defaultSNS

Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

+ (instancetype)defaultSNS

Return Value

The default service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
    AWSServiceManager.default().defaultServiceConfiguration = configuration

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
      AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                      identityPoolId:@"YourIdentityPoolId"];
      AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                           credentialsProvider:credentialsProvider];
      [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;

      return YES;
  }

Then call the following to get the default service client:

Swift

 let SNS = AWSSNS.default()

Objective-C

 AWSSNS *SNS = [AWSSNS defaultSNS];

Declared In

AWSSNSService.h

+ registerSNSWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerSNSWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSSNS.register(with: configuration!, forKey: "USWest2SNS")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSSNS registerSNSWithConfiguration:configuration forKey:@"USWest2SNS"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let SNS = AWSSNS(forKey: "USWest2SNS")

Objective-C

 AWSSNS *SNS = [AWSSNS SNSForKey:@"USWest2SNS"];

Warning: After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSSNSService.h

+ SNSForKey:

Retrieves the service client associated with the key. You need to call + registerSNSWithConfiguration:forKey: before invoking this method.

+ (instancetype)SNSForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

Swift

 func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
    let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
    AWSSNS.register(with: configuration!, forKey: "USWest2SNS")

    return true
}

Objective-C

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
     AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                     identityPoolId:@"YourIdentityPoolId"];
     AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                          credentialsProvider:credentialsProvider];

     [AWSSNS registerSNSWithConfiguration:configuration forKey:@"USWest2SNS"];

     return YES;
 }

Then call the following to get the service client:

Swift

 let SNS = AWSSNS(forKey: "USWest2SNS")

Objective-C

 AWSSNS *SNS = [AWSSNS SNSForKey:@"USWest2SNS"];

Declared In

AWSSNSService.h

+ removeSNSForKey:

Removes the service client associated with the key and release it.

+ (void)removeSNSForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSSNSService.h

– addPermission:

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

- (AWSTask *)addPermission:(AWSSNSAddPermissionInput *)request

Parameters

request

A container for the necessary parameters to execute the AddPermission service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– addPermission:completionHandler:

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

- (void)addPermission:(AWSSNSAddPermissionInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the AddPermission service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– checkIfPhoneNumberIsOptedOut:

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

- (AWSTask<AWSSNSCheckIfPhoneNumberIsOptedOutResponse*> *)checkIfPhoneNumberIsOptedOut:(AWSSNSCheckIfPhoneNumberIsOptedOutInput *)request

Parameters

request

A container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSCheckIfPhoneNumberIsOptedOutResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– checkIfPhoneNumberIsOptedOut:completionHandler:

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.

- (void)checkIfPhoneNumberIsOptedOut:(AWSSNSCheckIfPhoneNumberIsOptedOutInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSCheckIfPhoneNumberIsOptedOutResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– confirmSubscription:

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to "true".

- (AWSTask<AWSSNSConfirmSubscriptionResponse*> *)confirmSubscription:(AWSSNSConfirmSubscriptionInput *)request

Parameters

request

A container for the necessary parameters to execute the ConfirmSubscription service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSConfirmSubscriptionResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorSubscriptionLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorNotFound, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– confirmSubscription:completionHandler:

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

- (void)confirmSubscription:(AWSSNSConfirmSubscriptionInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSConfirmSubscriptionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ConfirmSubscription service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorSubscriptionLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorNotFound, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– createPlatformApplication:

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is "Package Security Identifier". For MPNS, PlatformPrincipal is "TLS certificate". For Baidu, PlatformPrincipal is "API key".

For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". For WNS, PlatformCredential is "secret key". For MPNS, PlatformCredential is "private key". For Baidu, PlatformCredential is "secret key". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.

- (AWSTask<AWSSNSCreatePlatformApplicationResponse*> *)createPlatformApplication:(AWSSNSCreatePlatformApplicationInput *)request

Parameters

request

A container for the necessary parameters to execute the CreatePlatformApplication service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSCreatePlatformApplicationResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– createPlatformApplication:completionHandler:

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.

- (void)createPlatformApplication:(AWSSNSCreatePlatformApplicationInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSCreatePlatformApplicationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreatePlatformApplication service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– createPlatformEndpoint:

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

- (AWSTask<AWSSNSCreateEndpointResponse*> *)createPlatformEndpoint:(AWSSNSCreatePlatformEndpointInput *)request

Parameters

request

A container for the necessary parameters to execute the CreatePlatformEndpoint service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSCreateEndpointResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– createPlatformEndpoint:completionHandler:

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.

- (void)createPlatformEndpoint:(AWSSNSCreatePlatformEndpointInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSCreateEndpointResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreatePlatformEndpoint service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– createTopic:

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

- (AWSTask<AWSSNSCreateTopicResponse*> *)createTopic:(AWSSNSCreateTopicInput *)request

Parameters

request

A container for the necessary parameters to execute the CreateTopic service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSCreateTopicResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorTopicLimitExceeded, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– createTopic:completionHandler:

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.

- (void)createTopic:(AWSSNSCreateTopicInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSCreateTopicResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the CreateTopic service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorTopicLimitExceeded, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– deleteEndpoint:

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

- (AWSTask *)deleteEndpoint:(AWSSNSDeleteEndpointInput *)request

Parameters

request

A container for the necessary parameters to execute the DeleteEndpoint service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– deleteEndpoint:completionHandler:

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.

- (void)deleteEndpoint:(AWSSNSDeleteEndpointInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteEndpoint service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– deletePlatformApplication:

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

- (AWSTask *)deletePlatformApplication:(AWSSNSDeletePlatformApplicationInput *)request

Parameters

request

A container for the necessary parameters to execute the DeletePlatformApplication service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– deletePlatformApplication:completionHandler:

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.

- (void)deletePlatformApplication:(AWSSNSDeletePlatformApplicationInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeletePlatformApplication service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– deleteTopic:

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

- (AWSTask *)deleteTopic:(AWSSNSDeleteTopicInput *)request

Parameters

request

A container for the necessary parameters to execute the DeleteTopic service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– deleteTopic:completionHandler:

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.

- (void)deleteTopic:(AWSSNSDeleteTopicInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the DeleteTopic service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– getEndpointAttributes:

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

- (AWSTask<AWSSNSGetEndpointAttributesResponse*> *)getEndpointAttributes:(AWSSNSGetEndpointAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the GetEndpointAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSGetEndpointAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– getEndpointAttributes:completionHandler:

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.

- (void)getEndpointAttributes:(AWSSNSGetEndpointAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSGetEndpointAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetEndpointAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– getPlatformApplicationAttributes:

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

- (AWSTask<AWSSNSGetPlatformApplicationAttributesResponse*> *)getPlatformApplicationAttributes:(AWSSNSGetPlatformApplicationAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the GetPlatformApplicationAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSGetPlatformApplicationAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– getPlatformApplicationAttributes:completionHandler:

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.

- (void)getPlatformApplicationAttributes:(AWSSNSGetPlatformApplicationAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSGetPlatformApplicationAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetPlatformApplicationAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– getSMSAttributes:

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

- (AWSTask<AWSSNSGetSMSAttributesResponse*> *)getSMSAttributes:(AWSSNSGetSMSAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the GetSMSAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSGetSMSAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– getSMSAttributes:completionHandler:

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

- (void)getSMSAttributes:(AWSSNSGetSMSAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSGetSMSAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetSMSAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– getSubscriptionAttributes:

Returns all of the properties of a subscription.

- (AWSTask<AWSSNSGetSubscriptionAttributesResponse*> *)getSubscriptionAttributes:(AWSSNSGetSubscriptionAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the GetSubscriptionAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSGetSubscriptionAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– getSubscriptionAttributes:completionHandler:

Returns all of the properties of a subscription.

- (void)getSubscriptionAttributes:(AWSSNSGetSubscriptionAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSGetSubscriptionAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetSubscriptionAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– getTopicAttributes:

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

- (AWSTask<AWSSNSGetTopicAttributesResponse*> *)getTopicAttributes:(AWSSNSGetTopicAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the GetTopicAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSGetTopicAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– getTopicAttributes:completionHandler:

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

- (void)getTopicAttributes:(AWSSNSGetTopicAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSGetTopicAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the GetTopicAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listEndpointsByPlatformApplication:

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

- (AWSTask<AWSSNSListEndpointsByPlatformApplicationResponse*> *)listEndpointsByPlatformApplication:(AWSSNSListEndpointsByPlatformApplicationInput *)request

Parameters

request

A container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListEndpointsByPlatformApplicationResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– listEndpointsByPlatformApplication:completionHandler:

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.

- (void)listEndpointsByPlatformApplication:(AWSSNSListEndpointsByPlatformApplicationInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListEndpointsByPlatformApplicationResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListEndpointsByPlatformApplication service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– listPhoneNumbersOptedOut:

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

- (AWSTask<AWSSNSListPhoneNumbersOptedOutResponse*> *)listPhoneNumbersOptedOut:(AWSSNSListPhoneNumbersOptedOutInput *)request

Parameters

request

A container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListPhoneNumbersOptedOutResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– listPhoneNumbersOptedOut:completionHandler:

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.

- (void)listPhoneNumbersOptedOut:(AWSSNSListPhoneNumbersOptedOutInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListPhoneNumbersOptedOutResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPhoneNumbersOptedOut service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– listPlatformApplications:

Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

- (AWSTask<AWSSNSListPlatformApplicationsResponse*> *)listPlatformApplications:(AWSSNSListPlatformApplicationsInput *)request

Parameters

request

A container for the necessary parameters to execute the ListPlatformApplications service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListPlatformApplicationsResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listPlatformApplications:completionHandler:

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.

- (void)listPlatformApplications:(AWSSNSListPlatformApplicationsInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListPlatformApplicationsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListPlatformApplications service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listSubscriptions:

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

- (AWSTask<AWSSNSListSubscriptionsResponse*> *)listSubscriptions:(AWSSNSListSubscriptionsInput *)request

Parameters

request

A container for the necessary parameters to execute the ListSubscriptions service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListSubscriptionsResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listSubscriptions:completionHandler:

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.

- (void)listSubscriptions:(AWSSNSListSubscriptionsInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListSubscriptionsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListSubscriptions service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listSubscriptionsByTopic:

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

- (AWSTask<AWSSNSListSubscriptionsByTopicResponse*> *)listSubscriptionsByTopic:(AWSSNSListSubscriptionsByTopicInput *)request

Parameters

request

A container for the necessary parameters to execute the ListSubscriptionsByTopic service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListSubscriptionsByTopicResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listSubscriptionsByTopic:completionHandler:

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.

- (void)listSubscriptionsByTopic:(AWSSNSListSubscriptionsByTopicInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListSubscriptionsByTopicResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListSubscriptionsByTopic service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listTopics:

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

- (AWSTask<AWSSNSListTopicsResponse*> *)listTopics:(AWSSNSListTopicsInput *)request

Parameters

request

A container for the necessary parameters to execute the ListTopics service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSListTopicsResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– listTopics:completionHandler:

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.

- (void)listTopics:(AWSSNSListTopicsInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSListTopicsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the ListTopics service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– optInPhoneNumber:

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

- (AWSTask<AWSSNSOptInPhoneNumberResponse*> *)optInPhoneNumber:(AWSSNSOptInPhoneNumberInput *)request

Parameters

request

A container for the necessary parameters to execute the OptInPhoneNumber service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSOptInPhoneNumberResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– optInPhoneNumber:completionHandler:

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.

- (void)optInPhoneNumber:(AWSSNSOptInPhoneNumberInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSOptInPhoneNumberResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the OptInPhoneNumber service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorThrottled, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter.

Declared In

AWSSNSService.h

– publish:

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

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. The second example below shows a request and response for publishing to a mobile endpoint.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

- (AWSTask<AWSSNSPublishResponse*> *)publish:(AWSSNSPublishInput *)request

Parameters

request

A container for the necessary parameters to execute the Publish service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSPublishResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInvalidParameterValue, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorEndpointDisabled, AWSSNSErrorPlatformApplicationDisabled, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– publish:completionHandler:

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

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. The second example below shows a request and response for publishing to a mobile endpoint.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

- (void)publish:(AWSSNSPublishInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSPublishResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the Publish service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInvalidParameterValue, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorEndpointDisabled, AWSSNSErrorPlatformApplicationDisabled, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– removePermission:

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

- (AWSTask *)removePermission:(AWSSNSRemovePermissionInput *)request

Parameters

request

A container for the necessary parameters to execute the RemovePermission service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– removePermission:completionHandler:

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

- (void)removePermission:(AWSSNSRemovePermissionInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the RemovePermission service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– setEndpointAttributes:

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

- (AWSTask *)setEndpointAttributes:(AWSSNSSetEndpointAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the SetEndpointAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– setEndpointAttributes:completionHandler:

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.

- (void)setEndpointAttributes:(AWSSNSSetEndpointAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetEndpointAttributes service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– setPlatformApplicationAttributes:

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

- (AWSTask *)setPlatformApplicationAttributes:(AWSSNSSetPlatformApplicationAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the SetPlatformApplicationAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– setPlatformApplicationAttributes:completionHandler:

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.

- (void)setPlatformApplicationAttributes:(AWSSNSSetPlatformApplicationAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetPlatformApplicationAttributes service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– setSMSAttributes:

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.

- (AWSTask<AWSSNSSetSMSAttributesResponse*> *)setSMSAttributes:(AWSSNSSetSMSAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the SetSMSAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSSetSMSAttributesResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorThrottled, AWSSNSErrorInternalError.

Declared In

AWSSNSService.h

– setSMSAttributes:completionHandler:

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.

- (void)setSMSAttributes:(AWSSNSSetSMSAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSSetSMSAttributesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetSMSAttributes service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorThrottled, AWSSNSErrorInternalError.

Declared In

AWSSNSService.h

– setSubscriptionAttributes:

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

- (AWSTask *)setSubscriptionAttributes:(AWSSNSSetSubscriptionAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the SetSubscriptionAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– setSubscriptionAttributes:completionHandler:

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

- (void)setSubscriptionAttributes:(AWSSNSSetSubscriptionAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetSubscriptionAttributes service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– setTopicAttributes:

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

- (AWSTask *)setTopicAttributes:(AWSSNSSetTopicAttributesInput *)request

Parameters

request

A container for the necessary parameters to execute the SetTopicAttributes service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– setTopicAttributes:completionHandler:

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

- (void)setTopicAttributes:(AWSSNSSetTopicAttributesInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the SetTopicAttributes service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– subscribe:

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.

- (AWSTask<AWSSNSSubscribeResponse*> *)subscribe:(AWSSNSSubscribeInput *)request

Parameters

request

A container for the necessary parameters to execute the Subscribe service method.

Return Value

An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSSubscribeResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorSubscriptionLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– subscribe:completionHandler:

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.

- (void)subscribe:(AWSSNSSubscribeInput *)request completionHandler:(void ( ^ _Nullable ) ( AWSSNSSubscribeResponse *_Nullable response , NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the Subscribe service method.

completionHandler

The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorSubscriptionLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

Declared In

AWSSNSService.h

– unsubscribe:

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

- (AWSTask *)unsubscribe:(AWSSNSUnsubscribeInput *)request

Parameters

request

A container for the necessary parameters to execute the Unsubscribe service method.

Return Value

An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h

– unsubscribe:completionHandler:

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.

- (void)unsubscribe:(AWSSNSUnsubscribeInput *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

Parameters

request

A container for the necessary parameters to execute the Unsubscribe service method.

completionHandler

The completion handler to call when the load request is complete. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound.

Declared In

AWSSNSService.h