AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
 

Classes

NameDescription
Class AddPermissionRequest Container for the parameters to the AddPermission operation. Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.
Class AddPermissionResponse
Class AuthorizationErrorException SimpleNotificationService exception
Class ConfirmSubscriptionRequest Container for the parameters to the ConfirmSubscription operation. 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".
Class ConfirmSubscriptionResponse Configuration for accessing Amazon ConfirmSubscription service
Class ConfirmSubscriptionResult Response for ConfirmSubscriptions action.
Class CreatePlatformApplicationRequest Container for the parameters to the CreatePlatformApplication operation. Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is "SSL certificate". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is "client id". The PlatformCredential is also received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is "private key". For GCM, PlatformCredential is "API key". For ADM, PlatformCredential is "client secret". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications.
Class CreatePlatformApplicationResponse Configuration for accessing Amazon CreatePlatformApplication service
Class CreatePlatformApplicationResult Response from CreatePlatformApplication action.
Class CreatePlatformEndpointRequest Container for the parameters to the CreatePlatformEndpoint operation. Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

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

Class CreatePlatformEndpointResponse Configuration for accessing Amazon CreatePlatformEndpoint service
Class CreatePlatformEndpointResult Response from CreateEndpoint action.
Class CreateTopicRequest Container for the parameters to the CreateTopic operation. Creates a topic to which notifications can be published. Users can create at most 3000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.
Class CreateTopicResponse Configuration for accessing Amazon CreateTopic service
Class CreateTopicResult Response from CreateTopic action.
Class DeleteEndpointRequest Container for the parameters to the DeleteEndpoint operation. Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
Class DeleteEndpointResponse
Class DeletePlatformApplicationRequest Container for the parameters to the DeletePlatformApplication operation. Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Class DeletePlatformApplicationResponse
Class DeleteTopicRequest Container for the parameters to the DeleteTopic operation. 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.
Class DeleteTopicResponse
Class Endpoint Endpoint for mobile app and device.
Class EndpointDisabledException SimpleNotificationService exception
Class GetEndpointAttributesRequest Container for the parameters to the GetEndpointAttributes operation. Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
Class GetEndpointAttributesResponse Configuration for accessing Amazon GetEndpointAttributes service
Class GetEndpointAttributesResult Response from GetEndpointAttributes of the EndpointArn.
Class GetPlatformApplicationAttributesRequest Container for the parameters to the GetPlatformApplicationAttributes operation. Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Class GetPlatformApplicationAttributesResponse Configuration for accessing Amazon GetPlatformApplicationAttributes service
Class GetPlatformApplicationAttributesResult Response for GetPlatformApplicationAttributes action.
Class GetSubscriptionAttributesRequest Container for the parameters to the GetSubscriptionAttributes operation. Returns all of the properties of a subscription.
Class GetSubscriptionAttributesResponse Configuration for accessing Amazon GetSubscriptionAttributes service
Class GetSubscriptionAttributesResult Response for GetSubscriptionAttributes action.
Class GetTopicAttributesRequest Container for the parameters to the GetTopicAttributes operation. Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.
Class GetTopicAttributesResponse Configuration for accessing Amazon GetTopicAttributes service
Class GetTopicAttributesResult Response for GetTopicAttributes action.
Class InternalErrorException SimpleNotificationService exception
Class InvalidParameterException SimpleNotificationService exception
Class InvalidParameterValueException SimpleNotificationService exception
Class ListEndpointsByPlatformApplicationRequest Container for the parameters to the ListEndpointsByPlatformApplication operation. Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Class ListEndpointsByPlatformApplicationResponse Configuration for accessing Amazon ListEndpointsByPlatformApplication service
Class ListEndpointsByPlatformApplicationResult Response for ListEndpointsByPlatformApplication action.
Class ListPlatformApplicationsRequest Container for the parameters to the ListPlatformApplications operation. Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.
Class ListPlatformApplicationsResponse Configuration for accessing Amazon ListPlatformApplications service
Class ListPlatformApplicationsResult Response for ListPlatformApplications action.
Class ListSubscriptionsByTopicRequest Container for the parameters to the ListSubscriptionsByTopic operation. 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.
Class ListSubscriptionsByTopicResponse Configuration for accessing Amazon ListSubscriptionsByTopic service
Class ListSubscriptionsByTopicResult Response for ListSubscriptionsByTopic action.
Class ListSubscriptionsRequest Container for the parameters to the ListSubscriptions operation. 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.
Class ListSubscriptionsResponse Configuration for accessing Amazon ListSubscriptions service
Class ListSubscriptionsResult Response for ListSubscriptions action
Class ListTopicsRequest Container for the parameters to the ListTopics operation. 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.
Class ListTopicsResponse Configuration for accessing Amazon ListTopics service
Class ListTopicsResult Response for ListTopics action.
Class MessageAttributeValue The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes).

Class NotFoundException SimpleNotificationService exception
Class PlatformApplication Platform application object.
Class PlatformApplicationDisabledException SimpleNotificationService exception
Class PublishRequest Container for the parameters to the Publish operation. 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.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action. The second example below shows a request and response for publishing to a mobile endpoint.

Class PublishResponse Configuration for accessing Amazon Publish service
Class PublishResult Response for Publish action.
Class RemovePermissionRequest Container for the parameters to the RemovePermission operation. Removes a statement from a topic's access control policy.
Class RemovePermissionResponse
Class SetEndpointAttributesRequest Container for the parameters to the SetEndpointAttributes operation. Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.
Class SetEndpointAttributesResponse
Class SetPlatformApplicationAttributesRequest Container for the parameters to the SetPlatformApplicationAttributes operation. Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.
Class SetPlatformApplicationAttributesResponse
Class SetSubscriptionAttributesRequest Container for the parameters to the SetSubscriptionAttributes operation. Allows a subscription owner to set an attribute of the topic to a new value.
Class SetSubscriptionAttributesResponse
Class SetTopicAttributesRequest Container for the parameters to the SetTopicAttributes operation. Allows a topic owner to set an attribute of the topic to a new value.
Class SetTopicAttributesResponse
Class SubscribeRequest Container for the parameters to the Subscribe operation. Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.
Class SubscribeResponse Configuration for accessing Amazon Subscribe service
Class SubscribeResult Response for Subscribe action.
Class Subscription A wrapper type for the attributes of an Amazon SNS subscription.
Class SubscriptionLimitExceededException SimpleNotificationService exception
Class Topic A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.
Class TopicLimitExceededException SimpleNotificationService exception
Class UnsubscribeRequest Container for the parameters to the Unsubscribe operation. Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.
Class UnsubscribeResponse