AWSSNS

Objective-C

@interface AWSSNS

Swift

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

  • The service configuration used to instantiate this service client.

    Warning

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

    Declaration

    Objective-C

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

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

    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];

    Declaration

    Objective-C

    + (nonnull instancetype)defaultSNS;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

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

    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.

    Declaration

    Objective-C

    + (void)registerSNSWithConfiguration:(id)configuration
                              forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.
    key

    A string to identify the service client.

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

    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"];

    Declaration

    Objective-C

    + (nonnull instancetype)SNSForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

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

    Warning

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

    Declaration

    Objective-C

    + (void)removeSNSForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Adds a statement to a topic’s access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSAddPermissionInput

    Declaration

    Objective-C

    - (id)addPermission:(nonnull AWSSNSAddPermissionInput *)request;

    Swift

    func addPermission(_ request: AWSSNSAddPermissionInput) -> Any!

    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.

  • Adds a statement to a topic’s access control policy, granting access for the specified Amazon Web Services accounts to the specified actions.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSAddPermissionInput

    Declaration

    Objective-C

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

    Swift

    func addPermission(_ request: AWSSNSAddPermissionInput) async throws

    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.

  • Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services 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.

    See

    AWSSNSCheckIfPhoneNumberIsOptedOutInput

    See

    AWSSNSCheckIfPhoneNumberIsOptedOutResponse

    Declaration

    Objective-C

    - (id)checkIfPhoneNumberIsOptedOut:
    (nonnull AWSSNSCheckIfPhoneNumberIsOptedOutInput *)request;

    Swift

    func checkIfPhoneNumberIsOptedOut(_ request: AWSSNSCheckIfPhoneNumberIsOptedOutInput) -> Any!

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

  • Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services 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.

    See

    AWSSNSCheckIfPhoneNumberIsOptedOutInput

    See

    AWSSNSCheckIfPhoneNumberIsOptedOutResponse

    Declaration

    Objective-C

    - (void)
    checkIfPhoneNumberIsOptedOut:
        (nonnull AWSSNSCheckIfPhoneNumberIsOptedOutInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSSNSCheckIfPhoneNumberIsOptedOutResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func checkIfPhoneNumberIsOptedOut(_ request: AWSSNSCheckIfPhoneNumberIsOptedOutInput) async throws -> AWSSNSCheckIfPhoneNumberIsOptedOutResponse

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

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

    See

    AWSSNSConfirmSubscriptionInput

    See

    AWSSNSConfirmSubscriptionResponse

    Declaration

    Objective-C

    - (id)confirmSubscription:(nonnull AWSSNSConfirmSubscriptionInput *)request;

    Swift

    func confirmSubscription(_ request: AWSSNSConfirmSubscriptionInput) -> Any!

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded.

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

    See

    AWSSNSConfirmSubscriptionInput

    See

    AWSSNSConfirmSubscriptionResponse

    Declaration

    Objective-C

    - (void)confirmSubscription:(nonnull AWSSNSConfirmSubscriptionInput *)request
          completionHandler:
              (void (^_Nullable)(AWSSNSConfirmSubscriptionResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func confirmSubscription(_ request: AWSSNSConfirmSubscriptionInput) async throws -> AWSSNSConfirmSubscriptionResponse

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded.

  • Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

    PlatformPrincipal and PlatformCredential are received from the notification service.

    • For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

    • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

    • For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

    • For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.

    • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.

    • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.

    • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

    • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

    You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

    See

    AWSSNSCreatePlatformApplicationInput

    See

    AWSSNSCreatePlatformApplicationResponse

    Declaration

    Objective-C

    - (id)createPlatformApplication:
    (nonnull AWSSNSCreatePlatformApplicationInput *)request;

    Swift

    func createPlatformApplication(_ request: AWSSNSCreatePlatformApplicationInput) -> Any!

    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.

  • Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

    PlatformPrincipal and PlatformCredential are received from the notification service.

    • For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

    • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

    • For APNS and APNS_SANDBOX using certificate credentials, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

    • For APNS and APNS_SANDBOX using token credentials, PlatformPrincipal is signing key ID and PlatformCredential is signing key.

    • For GCM (Firebase Cloud Messaging) using key credentials, there is no PlatformPrincipal. The PlatformCredential is API key.

    • For GCM (Firebase Cloud Messaging) using token credentials, there is no PlatformPrincipal. The PlatformCredential is a JSON formatted private key file. When using the Amazon Web Services CLI, the file must be in string format and special characters must be ignored. To format the file correctly, Amazon SNS recommends using the following command: SERVICE_JSON=`jq @json <<< cat service.json`.

    • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

    • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

    You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

    See

    AWSSNSCreatePlatformApplicationInput

    See

    AWSSNSCreatePlatformApplicationResponse

    Declaration

    Objective-C

    - (void)createPlatformApplication:
            (nonnull AWSSNSCreatePlatformApplicationInput *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSSNSCreatePlatformApplicationResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func createPlatformApplication(_ request: AWSSNSCreatePlatformApplicationInput) async throws -> AWSSNSCreatePlatformApplicationResponse

    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.

  • Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn 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.

    See

    AWSSNSCreatePlatformEndpointInput

    See

    AWSSNSCreateEndpointResponse

    Declaration

    Objective-C

    - (id)createPlatformEndpoint:
    (nonnull AWSSNSCreatePlatformEndpointInput *)request;

    Swift

    func createPlatformEndpoint(_ request: AWSSNSCreatePlatformEndpointInput) -> Any!

    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.

  • Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn 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.

    See

    AWSSNSCreatePlatformEndpointInput

    See

    AWSSNSCreateEndpointResponse

    Declaration

    Objective-C

    - (void)createPlatformEndpoint:
            (nonnull AWSSNSCreatePlatformEndpointInput *)request
             completionHandler:
                 (void (^_Nullable)(AWSSNSCreateEndpointResponse *_Nullable,
                                    NSError *_Nullable))completionHandler;

    Swift

    func createPlatformEndpoint(_ request: AWSSNSCreatePlatformEndpointInput) async throws -> AWSSNSCreateEndpointResponse

    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.

  • Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

    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.

    See

    AWSSNSCreateSMSSandboxPhoneNumberInput

    See

    AWSSNSCreateSMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (id)createSMSSandboxPhoneNumber:
    (nonnull AWSSNSCreateSMSSandboxPhoneNumberInput *)request;

    Swift

    func createSMSSandboxPhoneNumber(_ request: AWSSNSCreateSMSSandboxPhoneNumberInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Adds a destination phone number to an Amazon Web Services account in the SMS sandbox and sends a one-time password (OTP) to that phone number.

    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.

    See

    AWSSNSCreateSMSSandboxPhoneNumberInput

    See

    AWSSNSCreateSMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (void)createSMSSandboxPhoneNumber:
            (nonnull AWSSNSCreateSMSSandboxPhoneNumberInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSSNSCreateSMSSandboxPhoneNumberResult *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func createSMSSandboxPhoneNumber(_ request: AWSSNSCreateSMSSandboxPhoneNumberInput) async throws -> AWSSNSCreateSMSSandboxPhoneNumberResult

    Parameters

    request

    A container for the necessary parameters to execute the CreateSMSSandboxPhoneNumber 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: AWSSNSErrorAuthorizationError, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter, AWSSNSErrorOptedOut, AWSSNSErrorUserError, AWSSNSErrorThrottled.

  • Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. 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.

    See

    AWSSNSCreateTopicInput

    See

    AWSSNSCreateTopicResponse

    Declaration

    Objective-C

    - (id)createTopic:(nonnull AWSSNSCreateTopicInput *)request;

    Swift

    func createTopic(_ request: AWSSNSCreateTopicInput) -> Any!

    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, AWSSNSErrorInvalidSecurity, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorConcurrentAccess.

  • Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see Creating an Amazon SNS topic in the Amazon SNS Developer Guide. 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.

    See

    AWSSNSCreateTopicInput

    See

    AWSSNSCreateTopicResponse

    Declaration

    Objective-C

    - (void)createTopic:(nonnull AWSSNSCreateTopicInput *)request
    completionHandler:(void (^_Nullable)(AWSSNSCreateTopicResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func createTopic(_ request: AWSSNSCreateTopicInput) async throws -> AWSSNSCreateTopicResponse

    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, AWSSNSErrorInvalidSecurity, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorConcurrentAccess.

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

    See

    AWSSNSDeleteEndpointInput

    Declaration

    Objective-C

    - (id)deleteEndpoint:(nonnull AWSSNSDeleteEndpointInput *)request;

    Swift

    func deleteEndpoint(_ request: AWSSNSDeleteEndpointInput) -> Any!

    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.

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

    See

    AWSSNSDeleteEndpointInput

    Declaration

    Objective-C

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

    Swift

    func deleteEndpoint(_ request: AWSSNSDeleteEndpointInput) async throws

    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.

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

    See

    AWSSNSDeletePlatformApplicationInput

    Declaration

    Objective-C

    - (id)deletePlatformApplication:
    (nonnull AWSSNSDeletePlatformApplicationInput *)request;

    Swift

    func deletePlatformApplication(_ request: AWSSNSDeletePlatformApplicationInput) -> Any!

    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.

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

    See

    AWSSNSDeletePlatformApplicationInput

    Declaration

    Objective-C

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

    Swift

    func deletePlatformApplication(_ request: AWSSNSDeletePlatformApplicationInput) async throws

    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.

  • Deletes an Amazon Web Services account’s verified or pending phone number from 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.

    See

    AWSSNSDeleteSMSSandboxPhoneNumberInput

    See

    AWSSNSDeleteSMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (id)deleteSMSSandboxPhoneNumber:
    (nonnull AWSSNSDeleteSMSSandboxPhoneNumberInput *)request;

    Swift

    func deleteSMSSandboxPhoneNumber(_ request: AWSSNSDeleteSMSSandboxPhoneNumberInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Deletes an Amazon Web Services account’s verified or pending phone number from 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.

    See

    AWSSNSDeleteSMSSandboxPhoneNumberInput

    See

    AWSSNSDeleteSMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (void)deleteSMSSandboxPhoneNumber:
            (nonnull AWSSNSDeleteSMSSandboxPhoneNumberInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSSNSDeleteSMSSandboxPhoneNumberResult *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func deleteSMSSandboxPhoneNumber(_ request: AWSSNSDeleteSMSSandboxPhoneNumberInput) async throws -> AWSSNSDeleteSMSSandboxPhoneNumberResult

    Parameters

    request

    A container for the necessary parameters to execute the DeleteSMSSandboxPhoneNumber 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: AWSSNSErrorAuthorizationError, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter, AWSSNSErrorResourceNotFound, AWSSNSErrorUserError, AWSSNSErrorThrottled.

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

    See

    AWSSNSDeleteTopicInput

    Declaration

    Objective-C

    - (id)deleteTopic:(nonnull AWSSNSDeleteTopicInput *)request;

    Swift

    func deleteTopic(_ request: AWSSNSDeleteTopicInput) -> Any!

    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, AWSSNSErrorInvalidState, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorConcurrentAccess.

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

    See

    AWSSNSDeleteTopicInput

    Declaration

    Objective-C

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

    Swift

    func deleteTopic(_ request: AWSSNSDeleteTopicInput) async throws

    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, AWSSNSErrorInvalidState, AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorNotFound, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorConcurrentAccess.

  • Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

    See

    AWSSNSGetDataProtectionPolicyInput

    See

    AWSSNSGetDataProtectionPolicyResponse

    Declaration

    Objective-C

    - (id)getDataProtectionPolicy:
    (nonnull AWSSNSGetDataProtectionPolicyInput *)request;

    Swift

    func getDataProtectionPolicy(_ request: AWSSNSGetDataProtectionPolicyInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the specified inline DataProtectionPolicy document that is stored in the specified Amazon SNS topic.

    See

    AWSSNSGetDataProtectionPolicyInput

    See

    AWSSNSGetDataProtectionPolicyResponse

    Declaration

    Objective-C

    - (void)getDataProtectionPolicy:
            (nonnull AWSSNSGetDataProtectionPolicyInput *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSSNSGetDataProtectionPolicyResponse *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func dataProtectionPolicy(_ request: AWSSNSGetDataProtectionPolicyInput) async throws -> AWSSNSGetDataProtectionPolicyResponse

    Parameters

    request

    A container for the necessary parameters to execute the GetDataProtectionPolicy 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, AWSSNSErrorInvalidSecurity.

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

    See

    AWSSNSGetEndpointAttributesInput

    See

    AWSSNSGetEndpointAttributesResponse

    Declaration

    Objective-C

    - (id)getEndpointAttributes:(nonnull AWSSNSGetEndpointAttributesInput *)request;

    Swift

    func getEndpointAttributes(_ request: AWSSNSGetEndpointAttributesInput) -> Any!

    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.

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

    See

    AWSSNSGetEndpointAttributesInput

    See

    AWSSNSGetEndpointAttributesResponse

    Declaration

    Objective-C

    - (void)
    getEndpointAttributes:(nonnull AWSSNSGetEndpointAttributesInput *)request
        completionHandler:
            (void (^_Nullable)(AWSSNSGetEndpointAttributesResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func endpointAttributes(_ request: AWSSNSGetEndpointAttributesInput) async throws -> AWSSNSGetEndpointAttributesResponse

    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.

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

    See

    AWSSNSGetPlatformApplicationAttributesInput

    See

    AWSSNSGetPlatformApplicationAttributesResponse

    Declaration

    Objective-C

    - (id)getPlatformApplicationAttributes:
    (nonnull AWSSNSGetPlatformApplicationAttributesInput *)request;

    Swift

    func getPlatformApplicationAttributes(_ request: AWSSNSGetPlatformApplicationAttributesInput) -> Any!

    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.

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

    See

    AWSSNSGetPlatformApplicationAttributesInput

    See

    AWSSNSGetPlatformApplicationAttributesResponse

    Declaration

    Objective-C

    - (void)getPlatformApplicationAttributes:
            (nonnull AWSSNSGetPlatformApplicationAttributesInput *)request
                       completionHandler:
                           (void (^_Nullable)(
                               AWSSNSGetPlatformApplicationAttributesResponse
                                   *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func platformApplicationAttributes(_ request: AWSSNSGetPlatformApplicationAttributesInput) async throws -> AWSSNSGetPlatformApplicationAttributesResponse

    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.

  • Returns the settings for sending SMS messages from your Amazon Web Services account.

    These settings are set with the SetSMSAttributes action.

    See

    AWSSNSGetSMSAttributesInput

    See

    AWSSNSGetSMSAttributesResponse

    Declaration

    Objective-C

    - (id)getSMSAttributes:(nonnull AWSSNSGetSMSAttributesInput *)request;

    Swift

    func getSMSAttributes(_ request: AWSSNSGetSMSAttributesInput) -> Any!

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

  • Returns the settings for sending SMS messages from your Amazon Web Services account.

    These settings are set with the SetSMSAttributes action.

    See

    AWSSNSGetSMSAttributesInput

    See

    AWSSNSGetSMSAttributesResponse

    Declaration

    Objective-C

    - (void)getSMSAttributes:(nonnull AWSSNSGetSMSAttributesInput *)request
       completionHandler:
           (void (^_Nullable)(AWSSNSGetSMSAttributesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func smsAttributes(_ request: AWSSNSGetSMSAttributesInput) async throws -> AWSSNSGetSMSAttributesResponse

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

  • Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

    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.

    See

    AWSSNSGetSMSSandboxAccountStatusInput

    See

    AWSSNSGetSMSSandboxAccountStatusResult

    Declaration

    Objective-C

    - (id)getSMSSandboxAccountStatus:
    (nonnull AWSSNSGetSMSSandboxAccountStatusInput *)request;

    Swift

    func getSMSSandboxAccountStatus(_ request: AWSSNSGetSMSSandboxAccountStatusInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Retrieves the SMS sandbox status for the calling Amazon Web Services account in the target Amazon Web Services Region.

    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.

    See

    AWSSNSGetSMSSandboxAccountStatusInput

    See

    AWSSNSGetSMSSandboxAccountStatusResult

    Declaration

    Objective-C

    - (void)getSMSSandboxAccountStatus:
            (nonnull AWSSNSGetSMSSandboxAccountStatusInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSSNSGetSMSSandboxAccountStatusResult *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func smsSandboxAccountStatus(_ request: AWSSNSGetSMSSandboxAccountStatusInput) async throws -> AWSSNSGetSMSSandboxAccountStatusResult

    Parameters

    request

    A container for the necessary parameters to execute the GetSMSSandboxAccountStatus 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: AWSSNSErrorAuthorizationError, AWSSNSErrorInternalError, AWSSNSErrorThrottled.

  • Returns all of the properties of a subscription.

    See

    AWSSNSGetSubscriptionAttributesInput

    See

    AWSSNSGetSubscriptionAttributesResponse

    Declaration

    Objective-C

    - (id)getSubscriptionAttributes:
    (nonnull AWSSNSGetSubscriptionAttributesInput *)request;

    Swift

    func getSubscriptionAttributes(_ request: AWSSNSGetSubscriptionAttributesInput) -> Any!

    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.

  • Returns all of the properties of a subscription.

    See

    AWSSNSGetSubscriptionAttributesInput

    See

    AWSSNSGetSubscriptionAttributesResponse

    Declaration

    Objective-C

    - (void)getSubscriptionAttributes:
            (nonnull AWSSNSGetSubscriptionAttributesInput *)request
                completionHandler:
                    (void (^_Nullable)(
                        AWSSNSGetSubscriptionAttributesResponse *_Nullable,
                        NSError *_Nullable))completionHandler;

    Swift

    func subscriptionAttributes(_ request: AWSSNSGetSubscriptionAttributesInput) async throws -> AWSSNSGetSubscriptionAttributesResponse

    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.

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

    See

    AWSSNSGetTopicAttributesInput

    See

    AWSSNSGetTopicAttributesResponse

    Declaration

    Objective-C

    - (id)getTopicAttributes:(nonnull AWSSNSGetTopicAttributesInput *)request;

    Swift

    func getTopicAttributes(_ request: AWSSNSGetTopicAttributesInput) -> Any!

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

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

    See

    AWSSNSGetTopicAttributesInput

    See

    AWSSNSGetTopicAttributesResponse

    Declaration

    Objective-C

    - (void)getTopicAttributes:(nonnull AWSSNSGetTopicAttributesInput *)request
         completionHandler:
             (void (^_Nullable)(AWSSNSGetTopicAttributesResponse *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func topicAttributes(_ request: AWSSNSGetTopicAttributesInput) async throws -> AWSSNSGetTopicAttributesResponse

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

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListEndpointsByPlatformApplicationInput

    See

    AWSSNSListEndpointsByPlatformApplicationResponse

    Declaration

    Objective-C

    - (id)listEndpointsByPlatformApplication:
    (nonnull AWSSNSListEndpointsByPlatformApplicationInput *)request;

    Swift

    func listEndpoints(byPlatformApplication request: AWSSNSListEndpointsByPlatformApplicationInput) -> Any!

    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.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListEndpointsByPlatformApplicationInput

    See

    AWSSNSListEndpointsByPlatformApplicationResponse

    Declaration

    Objective-C

    - (void)
    listEndpointsByPlatformApplication:
        (nonnull AWSSNSListEndpointsByPlatformApplicationInput *)request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSSNSListEndpointsByPlatformApplicationResponse
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func listEndpoints(byPlatformApplication request: AWSSNSListEndpointsByPlatformApplicationInput) async throws -> AWSSNSListEndpointsByPlatformApplicationResponse

    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.

  • Lists the calling Amazon Web Services account’s dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

    See

    AWSSNSListOriginationNumbersRequest

    See

    AWSSNSListOriginationNumbersResult

    Declaration

    Objective-C

    - (id)listOriginationNumbers:
    (nonnull AWSSNSListOriginationNumbersRequest *)request;

    Swift

    func listOriginationNumbers(_ request: AWSSNSListOriginationNumbersRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the calling Amazon Web Services account’s dedicated origination numbers and their metadata. For more information about origination numbers, see Origination numbers in the Amazon SNS Developer Guide.

    See

    AWSSNSListOriginationNumbersRequest

    See

    AWSSNSListOriginationNumbersResult

    Declaration

    Objective-C

    - (void)
    listOriginationNumbers:
        (nonnull AWSSNSListOriginationNumbersRequest *)request
         completionHandler:
             (void (^_Nullable)(AWSSNSListOriginationNumbersResult *_Nullable,
                                NSError *_Nullable))completionHandler;

    Swift

    func listOriginationNumbers(_ request: AWSSNSListOriginationNumbersRequest) async throws -> AWSSNSListOriginationNumbersResult

    Parameters

    request

    A container for the necessary parameters to execute the ListOriginationNumbers 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: AWSSNSErrorInternalError, AWSSNSErrorAuthorizationError, AWSSNSErrorThrottled, AWSSNSErrorInvalidParameter, AWSSNSErrorValidation.

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

    See

    AWSSNSListPhoneNumbersOptedOutInput

    See

    AWSSNSListPhoneNumbersOptedOutResponse

    Declaration

    Objective-C

    - (id)listPhoneNumbersOptedOut:
    (nonnull AWSSNSListPhoneNumbersOptedOutInput *)request;

    Swift

    func listPhoneNumbersOptedOut(_ request: AWSSNSListPhoneNumbersOptedOutInput) -> Any!

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

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

    See

    AWSSNSListPhoneNumbersOptedOutInput

    See

    AWSSNSListPhoneNumbersOptedOutResponse

    Declaration

    Objective-C

    - (void)listPhoneNumbersOptedOut:
            (nonnull AWSSNSListPhoneNumbersOptedOutInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSSNSListPhoneNumbersOptedOutResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listPhoneNumbersOptedOut(_ request: AWSSNSListPhoneNumbersOptedOutInput) async throws -> AWSSNSListPhoneNumbersOptedOutResponse

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

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

    This action is throttled at 15 transactions per second (TPS).

    See

    AWSSNSListPlatformApplicationsInput

    See

    AWSSNSListPlatformApplicationsResponse

    Declaration

    Objective-C

    - (id)listPlatformApplications:
    (nonnull AWSSNSListPlatformApplicationsInput *)request;

    Swift

    func listPlatformApplications(_ request: AWSSNSListPlatformApplicationsInput) -> Any!

    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.

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

    This action is throttled at 15 transactions per second (TPS).

    See

    AWSSNSListPlatformApplicationsInput

    See

    AWSSNSListPlatformApplicationsResponse

    Declaration

    Objective-C

    - (void)listPlatformApplications:
            (nonnull AWSSNSListPlatformApplicationsInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSSNSListPlatformApplicationsResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listPlatformApplications(_ request: AWSSNSListPlatformApplicationsInput) async throws -> AWSSNSListPlatformApplicationsResponse

    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.

  • Lists the calling Amazon Web Services account’s current verified and pending destination phone numbers 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.

    See

    AWSSNSListSMSSandboxPhoneNumbersInput

    See

    AWSSNSListSMSSandboxPhoneNumbersResult

    Declaration

    Objective-C

    - (id)listSMSSandboxPhoneNumbers:
    (nonnull AWSSNSListSMSSandboxPhoneNumbersInput *)request;

    Swift

    func listSMSSandboxPhoneNumbers(_ request: AWSSNSListSMSSandboxPhoneNumbersInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Lists the calling Amazon Web Services account’s current verified and pending destination phone numbers 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.

    See

    AWSSNSListSMSSandboxPhoneNumbersInput

    See

    AWSSNSListSMSSandboxPhoneNumbersResult

    Declaration

    Objective-C

    - (void)listSMSSandboxPhoneNumbers:
            (nonnull AWSSNSListSMSSandboxPhoneNumbersInput *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSSNSListSMSSandboxPhoneNumbersResult *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func listSMSSandboxPhoneNumbers(_ request: AWSSNSListSMSSandboxPhoneNumbersInput) async throws -> AWSSNSListSMSSandboxPhoneNumbersResult

    Parameters

    request

    A container for the necessary parameters to execute the ListSMSSandboxPhoneNumbers 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: AWSSNSErrorAuthorizationError, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter, AWSSNSErrorResourceNotFound, AWSSNSErrorThrottled.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListSubscriptionsInput

    See

    AWSSNSListSubscriptionsResponse

    Declaration

    Objective-C

    - (id)listSubscriptions:(nonnull AWSSNSListSubscriptionsInput *)request;

    Swift

    func listSubscriptions(_ request: AWSSNSListSubscriptionsInput) -> Any!

    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.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListSubscriptionsInput

    See

    AWSSNSListSubscriptionsResponse

    Declaration

    Objective-C

    - (void)listSubscriptions:(nonnull AWSSNSListSubscriptionsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSSNSListSubscriptionsResponse *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func listSubscriptions(_ request: AWSSNSListSubscriptionsInput) async throws -> AWSSNSListSubscriptionsResponse

    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.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListSubscriptionsByTopicInput

    See

    AWSSNSListSubscriptionsByTopicResponse

    Declaration

    Objective-C

    - (id)listSubscriptionsByTopic:
    (nonnull AWSSNSListSubscriptionsByTopicInput *)request;

    Swift

    func listSubscriptions(byTopic request: AWSSNSListSubscriptionsByTopicInput) -> Any!

    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.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListSubscriptionsByTopicInput

    See

    AWSSNSListSubscriptionsByTopicResponse

    Declaration

    Objective-C

    - (void)listSubscriptionsByTopic:
            (nonnull AWSSNSListSubscriptionsByTopicInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSSNSListSubscriptionsByTopicResponse *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func listSubscriptions(byTopic request: AWSSNSListSubscriptionsByTopicInput) async throws -> AWSSNSListSubscriptionsByTopicResponse

    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.

  • List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

    See

    AWSSNSListTagsForResourceRequest

    See

    AWSSNSListTagsForResourceResponse

    Declaration

    Objective-C

    - (id)listTagsForResource:(nonnull AWSSNSListTagsForResourceRequest *)request;

    Swift

    func listTags(forResource request: AWSSNSListTagsForResourceRequest) -> Any!

    Parameters

    request

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

    Return Value

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

  • List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

    See

    AWSSNSListTagsForResourceRequest

    See

    AWSSNSListTagsForResourceResponse

    Declaration

    Objective-C

    - (void)listTagsForResource:(nonnull AWSSNSListTagsForResourceRequest *)request
          completionHandler:
              (void (^_Nullable)(AWSSNSListTagsForResourceResponse *_Nullable,
                                 NSError *_Nullable))completionHandler;

    Swift

    func listTags(forResource request: AWSSNSListTagsForResourceRequest) async throws -> AWSSNSListTagsForResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the ListTagsForResource 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: AWSSNSErrorResourceNotFound, AWSSNSErrorTagPolicy, AWSSNSErrorInvalidParameter, AWSSNSErrorAuthorizationError, AWSSNSErrorConcurrentAccess.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListTopicsInput

    See

    AWSSNSListTopicsResponse

    Declaration

    Objective-C

    - (id)listTopics:(nonnull AWSSNSListTopicsInput *)request;

    Swift

    func listTopics(_ request: AWSSNSListTopicsInput) -> Any!

    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.

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

    This action is throttled at 30 transactions per second (TPS).

    See

    AWSSNSListTopicsInput

    See

    AWSSNSListTopicsResponse

    Declaration

    Objective-C

    - (void)listTopics:(nonnull AWSSNSListTopicsInput *)request
    completionHandler:(void (^_Nullable)(AWSSNSListTopicsResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func listTopics(_ request: AWSSNSListTopicsInput) async throws -> AWSSNSListTopicsResponse

    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.

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

    See

    AWSSNSOptInPhoneNumberInput

    See

    AWSSNSOptInPhoneNumberResponse

    Declaration

    Objective-C

    - (id)optInPhoneNumber:(nonnull AWSSNSOptInPhoneNumberInput *)request;

    Swift

    func opt(inPhoneNumber request: AWSSNSOptInPhoneNumberInput) -> Any!

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

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

    See

    AWSSNSOptInPhoneNumberInput

    See

    AWSSNSOptInPhoneNumberResponse

    Declaration

    Objective-C

    - (void)optInPhoneNumber:(nonnull AWSSNSOptInPhoneNumberInput *)request
       completionHandler:
           (void (^_Nullable)(AWSSNSOptInPhoneNumberResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func opt(inPhoneNumber request: AWSSNSOptInPhoneNumberInput) async throws -> AWSSNSOptInPhoneNumberResponse

    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, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidParameter.

  • Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.

    To use the Publish action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

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

    You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

    See

    AWSSNSPublishInput

    See

    AWSSNSPublishResponse

    Declaration

    Objective-C

    - (id)publish:(nonnull AWSSNSPublishInput *)request;

    Swift

    func publish(_ request: AWSSNSPublishInput) -> Any!

    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, AWSSNSErrorKMSDisabled, AWSSNSErrorKMSInvalidState, AWSSNSErrorKMSNotFound, AWSSNSErrorKMSOptInRequired, AWSSNSErrorKMSThrottling, AWSSNSErrorKMSAccessDenied, AWSSNSErrorInvalidSecurity, AWSSNSErrorValidation.

  • Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the message is saved and Amazon SNS immediately delivers it to subscribers.

    To use the Publish action for publishing a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

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

    You can publish messages only to topics and endpoints in the same Amazon Web Services Region.

    See

    AWSSNSPublishInput

    See

    AWSSNSPublishResponse

    Declaration

    Objective-C

    - (void)publish:(nonnull AWSSNSPublishInput *)request
    completionHandler:(void (^_Nullable)(AWSSNSPublishResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func publish(_ request: AWSSNSPublishInput) async throws -> AWSSNSPublishResponse

    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, AWSSNSErrorKMSDisabled, AWSSNSErrorKMSInvalidState, AWSSNSErrorKMSNotFound, AWSSNSErrorKMSOptInRequired, AWSSNSErrorKMSThrottling, AWSSNSErrorKMSAccessDenied, AWSSNSErrorInvalidSecurity, AWSSNSErrorValidation.

  • Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

    The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

    See

    AWSSNSPublishBatchInput

    See

    AWSSNSPublishBatchResponse

    Declaration

    Objective-C

    - (id)publishBatch:(nonnull AWSSNSPublishBatchInput *)request;

    Swift

    func publishBatch(_ request: AWSSNSPublishBatchInput) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSPublishBatchResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorInvalidParameter, AWSSNSErrorInvalidParameterValue, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorEndpointDisabled, AWSSNSErrorPlatformApplicationDisabled, AWSSNSErrorAuthorizationError, AWSSNSErrorBatchEntryIdsNotDistinct, AWSSNSErrorBatchRequestTooLong, AWSSNSErrorEmptyBatchRequest, AWSSNSErrorInvalidBatchEntryId, AWSSNSErrorTooManyEntriesInBatchRequest, AWSSNSErrorKMSDisabled, AWSSNSErrorKMSInvalidState, AWSSNSErrorKMSNotFound, AWSSNSErrorKMSOptInRequired, AWSSNSErrorKMSThrottling, AWSSNSErrorKMSAccessDenied, AWSSNSErrorInvalidSecurity, AWSSNSErrorValidation.

  • Publishes up to ten messages to the specified topic. This is a batch version of Publish. For FIFO topics, multiple messages within a single batch are published in the order they are sent, and messages are deduplicated within the batch and across batches for 5 minutes.

    The result of publishing each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &AttributeName.1=first

    &AttributeName.2=second

    If you send a batch message to a topic, Amazon SNS publishes the batch message to each endpoint that is subscribed to the topic. The format of the batch message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the batch message is saved and Amazon SNS immediately delivers the message to subscribers.

    See

    AWSSNSPublishBatchInput

    See

    AWSSNSPublishBatchResponse

    Declaration

    Objective-C

    - (void)publishBatch:(nonnull AWSSNSPublishBatchInput *)request
    completionHandler:(void (^_Nullable)(AWSSNSPublishBatchResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func publishBatch(_ request: AWSSNSPublishBatchInput) async throws -> AWSSNSPublishBatchResponse

    Parameters

    request

    A container for the necessary parameters to execute the PublishBatch 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, AWSSNSErrorBatchEntryIdsNotDistinct, AWSSNSErrorBatchRequestTooLong, AWSSNSErrorEmptyBatchRequest, AWSSNSErrorInvalidBatchEntryId, AWSSNSErrorTooManyEntriesInBatchRequest, AWSSNSErrorKMSDisabled, AWSSNSErrorKMSInvalidState, AWSSNSErrorKMSNotFound, AWSSNSErrorKMSOptInRequired, AWSSNSErrorKMSThrottling, AWSSNSErrorKMSAccessDenied, AWSSNSErrorInvalidSecurity, AWSSNSErrorValidation.

  • Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

    See

    AWSSNSPutDataProtectionPolicyInput

    Declaration

    Objective-C

    - (id)putDataProtectionPolicy:
    (nonnull AWSSNSPutDataProtectionPolicyInput *)request;

    Swift

    func putDataProtectionPolicy(_ request: AWSSNSPutDataProtectionPolicyInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutDataProtectionPolicy 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, AWSSNSErrorInvalidSecurity.

  • Adds or updates an inline policy document that is stored in the specified Amazon SNS topic.

    See

    AWSSNSPutDataProtectionPolicyInput

    Declaration

    Objective-C

    - (void)putDataProtectionPolicy:
            (nonnull AWSSNSPutDataProtectionPolicyInput *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func putDataProtectionPolicy(_ request: AWSSNSPutDataProtectionPolicyInput) async throws

    Parameters

    request

    A container for the necessary parameters to execute the PutDataProtectionPolicy 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, AWSSNSErrorInvalidSecurity.

  • Removes a statement from a topic’s access control policy.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSRemovePermissionInput

    Declaration

    Objective-C

    - (id)removePermission:(nonnull AWSSNSRemovePermissionInput *)request;

    Swift

    func removePermission(_ request: AWSSNSRemovePermissionInput) -> Any!

    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.

  • Removes a statement from a topic’s access control policy.

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSRemovePermissionInput

    Declaration

    Objective-C

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

    Swift

    func removePermission(_ request: AWSSNSRemovePermissionInput) async throws

    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.

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

    See

    AWSSNSSetEndpointAttributesInput

    Declaration

    Objective-C

    - (id)setEndpointAttributes:(nonnull AWSSNSSetEndpointAttributesInput *)request;

    Swift

    func setEndpointAttributes(_ request: AWSSNSSetEndpointAttributesInput) -> Any!

    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.

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

    See

    AWSSNSSetEndpointAttributesInput

    Declaration

    Objective-C

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

    Swift

    func setEndpointAttributes(_ request: AWSSNSSetEndpointAttributesInput) async throws

    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.

  • Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.

    See

    AWSSNSSetPlatformApplicationAttributesInput

    Declaration

    Objective-C

    - (id)setPlatformApplicationAttributes:
    (nonnull AWSSNSSetPlatformApplicationAttributesInput *)request;

    Swift

    func setPlatformApplicationAttributes(_ request: AWSSNSSetPlatformApplicationAttributesInput) -> Any!

    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.

  • Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). 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.

    See

    AWSSNSSetPlatformApplicationAttributesInput

    Declaration

    Objective-C

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

    Swift

    func setPlatformApplicationAttributes(_ request: AWSSNSSetPlatformApplicationAttributesInput) async throws

    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.

  • 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 Publishing to a mobile phone in the Amazon SNS Developer Guide.

    To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

    See

    AWSSNSSetSMSAttributesInput

    See

    AWSSNSSetSMSAttributesResponse

    Declaration

    Objective-C

    - (id)setSMSAttributes:(nonnull AWSSNSSetSMSAttributesInput *)request;

    Swift

    func setSMSAttributes(_ request: AWSSNSSetSMSAttributesInput) -> Any!

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

  • 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 Publishing to a mobile phone in the Amazon SNS Developer Guide.

    To use this operation, you must grant the Amazon SNS service principal (sns.amazonaws.com) permission to perform the s3:ListBucket action.

    See

    AWSSNSSetSMSAttributesInput

    See

    AWSSNSSetSMSAttributesResponse

    Declaration

    Objective-C

    - (void)setSMSAttributes:(nonnull AWSSNSSetSMSAttributesInput *)request
       completionHandler:
           (void (^_Nullable)(AWSSNSSetSMSAttributesResponse *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func setSMSAttributes(_ request: AWSSNSSetSMSAttributesInput) async throws -> AWSSNSSetSMSAttributesResponse

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

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

    See

    AWSSNSSetSubscriptionAttributesInput

    Declaration

    Objective-C

    - (id)setSubscriptionAttributes:
    (nonnull AWSSNSSetSubscriptionAttributesInput *)request;

    Swift

    func setSubscriptionAttributes(_ request: AWSSNSSetSubscriptionAttributesInput) -> Any!

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

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

    See

    AWSSNSSetSubscriptionAttributesInput

    Declaration

    Objective-C

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

    Swift

    func setSubscriptionAttributes(_ request: AWSSNSSetSubscriptionAttributesInput) async throws

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError.

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

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSSetTopicAttributesInput

    Declaration

    Objective-C

    - (id)setTopicAttributes:(nonnull AWSSNSSetTopicAttributesInput *)request;

    Swift

    func setTopicAttributes(_ request: AWSSNSSetTopicAttributesInput) -> Any!

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

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

    To remove the ability to change topic permissions, you must deny permissions to the AddPermission, RemovePermission, and SetTopicAttributes actions in your IAM policy.

    See

    AWSSNSSetTopicAttributesInput

    Declaration

    Objective-C

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

    Swift

    func setTopicAttributes(_ request: AWSSNSSetTopicAttributesInput) async throws

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

  • Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

    You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for two days.

    This action is throttled at 100 transactions per second (TPS).

    See

    AWSSNSSubscribeInput

    See

    AWSSNSSubscribeResponse

    Declaration

    Objective-C

    - (id)subscribe:(nonnull AWSSNSSubscribeInput *)request;

    Swift

    func subscribe(_ request: AWSSNSSubscribeInput) -> Any!

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidSecurity.

  • Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same Amazon Web Services account, the endpoint owner must run the ConfirmSubscription action to confirm the subscription.

    You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for two days.

    This action is throttled at 100 transactions per second (TPS).

    See

    AWSSNSSubscribeInput

    See

    AWSSNSSubscribeResponse

    Declaration

    Objective-C

    - (void)subscribe:(nonnull AWSSNSSubscribeInput *)request
    completionHandler:(void (^_Nullable)(AWSSNSSubscribeResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func subscribe(_ request: AWSSNSSubscribeInput) async throws -> AWSSNSSubscribeResponse

    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, AWSSNSErrorFilterPolicyLimitExceeded, AWSSNSErrorReplayLimitExceeded, AWSSNSErrorInvalidParameter, AWSSNSErrorInternalError, AWSSNSErrorNotFound, AWSSNSErrorAuthorizationError, AWSSNSErrorInvalidSecurity.

  • Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    When you use topic tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a topic isn’t recommended.

    • Tags don’t have any semantic meaning. Amazon SNS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    • Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.

    See

    AWSSNSTagResourceRequest

    See

    AWSSNSTagResourceResponse

    Declaration

    Objective-C

    - (id)tagResource:(nonnull AWSSNSTagResourceRequest *)request;

    Swift

    func tagResource(_ request: AWSSNSTagResourceRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSTagResourceResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorResourceNotFound, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorInvalidParameter, AWSSNSErrorAuthorizationError, AWSSNSErrorConcurrentAccess.

  • Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    When you use topic tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a topic isn’t recommended.

    • Tags don’t have any semantic meaning. Amazon SNS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    • Tagging actions are limited to 10 TPS per Amazon Web Services account, per Amazon Web Services Region. If your application requires a higher throughput, file a technical support request.

    See

    AWSSNSTagResourceRequest

    See

    AWSSNSTagResourceResponse

    Declaration

    Objective-C

    - (void)tagResource:(nonnull AWSSNSTagResourceRequest *)request
    completionHandler:(void (^_Nullable)(AWSSNSTagResourceResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func tagResource(_ request: AWSSNSTagResourceRequest) async throws -> AWSSNSTagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the TagResource 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: AWSSNSErrorResourceNotFound, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorInvalidParameter, AWSSNSErrorAuthorizationError, AWSSNSErrorConcurrentAccess.

  • 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 Amazon Web Services 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.

    Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

    This action is throttled at 100 transactions per second (TPS).

    See

    AWSSNSUnsubscribeInput

    Declaration

    Objective-C

    - (id)unsubscribe:(nonnull AWSSNSUnsubscribeInput *)request;

    Swift

    func unsubscribe(_ request: AWSSNSUnsubscribeInput) -> Any!

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

  • 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 Amazon Web Services 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.

    Amazon SQS queue subscriptions require authentication for deletion. Only the owner of the subscription, or the owner of the topic can unsubscribe using the required Amazon Web Services signature.

    This action is throttled at 100 transactions per second (TPS).

    See

    AWSSNSUnsubscribeInput

    Declaration

    Objective-C

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

    Swift

    func unsubscribe(_ request: AWSSNSUnsubscribeInput) async throws

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

  • Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    See

    AWSSNSUntagResourceRequest

    See

    AWSSNSUntagResourceResponse

    Declaration

    Objective-C

    - (id)untagResource:(nonnull AWSSNSUntagResourceRequest *)request;

    Swift

    func untagResource(_ request: AWSSNSUntagResourceRequest) -> Any!

    Parameters

    request

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

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSSNSUntagResourceResponse. On failed execution, task.error may contain an NSError with AWSSNSErrorDomain domain and the following error code: AWSSNSErrorResourceNotFound, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorInvalidParameter, AWSSNSErrorAuthorizationError, AWSSNSErrorConcurrentAccess.

  • Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    See

    AWSSNSUntagResourceRequest

    See

    AWSSNSUntagResourceResponse

    Declaration

    Objective-C

    - (void)untagResource:(nonnull AWSSNSUntagResourceRequest *)request
    completionHandler:(void (^_Nullable)(AWSSNSUntagResourceResponse *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func untagResource(_ request: AWSSNSUntagResourceRequest) async throws -> AWSSNSUntagResourceResponse

    Parameters

    request

    A container for the necessary parameters to execute the UntagResource 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: AWSSNSErrorResourceNotFound, AWSSNSErrorTagLimitExceeded, AWSSNSErrorStaleTag, AWSSNSErrorTagPolicy, AWSSNSErrorInvalidParameter, AWSSNSErrorAuthorizationError, AWSSNSErrorConcurrentAccess.

  • Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.

    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.

    See

    AWSSNSVerifySMSSandboxPhoneNumberInput

    See

    AWSSNSVerifySMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (id)verifySMSSandboxPhoneNumber:
    (nonnull AWSSNSVerifySMSSandboxPhoneNumberInput *)request;

    Swift

    func verifySMSSandboxPhoneNumber(_ request: AWSSNSVerifySMSSandboxPhoneNumberInput) -> Any!

    Parameters

    request

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

    Return Value

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

  • Verifies a destination phone number with a one-time password (OTP) for the calling Amazon Web Services account.

    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.

    See

    AWSSNSVerifySMSSandboxPhoneNumberInput

    See

    AWSSNSVerifySMSSandboxPhoneNumberResult

    Declaration

    Objective-C

    - (void)verifySMSSandboxPhoneNumber:
            (nonnull AWSSNSVerifySMSSandboxPhoneNumberInput *)request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSSNSVerifySMSSandboxPhoneNumberResult *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func verifySMSSandboxPhoneNumber(_ request: AWSSNSVerifySMSSandboxPhoneNumberInput) async throws -> AWSSNSVerifySMSSandboxPhoneNumberResult

    Parameters

    request

    A container for the necessary parameters to execute the VerifySMSSandboxPhoneNumber 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: AWSSNSErrorAuthorizationError, AWSSNSErrorInternalError, AWSSNSErrorInvalidParameter, AWSSNSErrorResourceNotFound, AWSSNSErrorVerification, AWSSNSErrorThrottled.