Interface for accessing AmazonSNS.
More...
#import <AmazonSNSClient.h>
List of all members.
Detailed Description
Interface for accessing AmazonSNS.
Amazon Simple Notification Service
Member Function Documentation
The AddPermission action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
- Parameters:
-
| addPermissionRequest | Container for the necessary parameters to execute the AddPermission service method on AmazonSNS. |
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The ConfirmSubscription action 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".
- Parameters:
-
| confirmSubscriptionRequest | Container for the necessary parameters to execute the ConfirmSubscription service method on AmazonSNS. |
- Returns:
- The response from the ConfirmSubscription service method, as returned by AmazonSNS.
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| SubscriptionLimitExceededException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The CreateTopic action creates a topic to which notifications can be published. Users can create at most 25 topics. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN will be returned without creating a new topic.
- Parameters:
-
| createTopicRequest | Container for the necessary parameters to execute the CreateTopic service method on AmazonSNS. |
- Returns:
- The response from the CreateTopic service method, as returned by AmazonSNS.
- Exceptions:
-
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| TopicLimitExceededException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The DeleteTopic action 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 will not result in an error.
- Parameters:
-
| deleteTopicRequest | Container for the necessary parameters to execute the DeleteTopic service method on AmazonSNS. |
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The GetTopicAttribtues action returns all of the properties of a topic customers have created. Topic properties returned might differ based on the authorization of the user.
- Parameters:
-
| getTopicAttributesRequest | Container for the necessary parameters to execute the GetTopicAttributes service method on AmazonSNS. |
- Returns:
- The response from the GetTopicAttributes service method, as returned by AmazonSNS.
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
+ (void AmazonSNSClient.)initializeResponseObjects |
|
|
|
|
Ensure that all respsonse objects have been loaded by the runtime.
The ListSubscriptions action returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.
- Parameters:
-
| listSubscriptionsRequest | Container for the necessary parameters to execute the ListSubscriptions service method on AmazonSNS. |
- Returns:
- The response from the ListSubscriptions service method, as returned by AmazonSNS.
- Exceptions:
-
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The ListSubscriptionsByTopic action returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.
- Parameters:
-
| listSubscriptionsByTopicRequest | Container for the necessary parameters to execute the ListSubscriptionsByTopic service method on AmazonSNS. |
- Returns:
- The response from the ListSubscriptionsByTopic service method, as returned by AmazonSNS.
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The ListTopics action returns a list of the requester's topics. Each call returns a limited list of topics. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.
- Parameters:
-
| listTopicsRequest | Container for the necessary parameters to execute the ListTopics service method on AmazonSNS. |
- Returns:
- The response from the ListTopics service method, as returned by AmazonSNS.
- Exceptions:
-
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The Publish action sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol selected.
- Parameters:
-
| publishRequest | Container for the necessary parameters to execute the Publish service method on AmazonSNS. |
- Returns:
- The response from the Publish service method, as returned by AmazonSNS.
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The RemovePermission action removes a statement from a topic's access control policy.
- Parameters:
-
| removePermissionRequest | Container for the necessary parameters to execute the RemovePermission service method on AmazonSNS. |
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The SetTopicAttributes action allows a topic owner to set an attribute of the topic to a new value.
- Parameters:
-
| setTopicAttributesRequest | Container for the necessary parameters to execute the SetTopicAttributes service method on AmazonSNS. |
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The Subscribe action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for twenty-four hours.
- Parameters:
-
| subscribeRequest | Container for the necessary parameters to execute the Subscribe service method on AmazonSNS. |
- Returns:
- The response from the Subscribe service method, as returned by AmazonSNS.
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| SubscriptionLimitExceededException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The Unsubscribe action deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the its topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
- Parameters:
-
| unsubscribeRequest | Container for the necessary parameters to execute the Unsubscribe service method on AmazonSNS. |
- Exceptions:
-
| NotFoundException | |
| AuthorizationErrorException | |
| InternalErrorException | |
| InvalidParameterException | |
| AmazonClientException | If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available. |
| AmazonServiceException | If an error response is returned by AmazonSNS indicating either a problem with the data in the request, or a server side issue. |
The documentation for this class was generated from the following file: