AWS SDK Version 3 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.

Implementation for accessing SimpleNotificationService Amazon Simple Notification Service

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

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.SimpleNotificationService.AmazonSimpleNotificationServiceClient

Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.SimpleNotificationService.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonSimpleNotificationServiceClient : AmazonServiceClient
         IAmazonService, IAmazonSimpleNotificationService, IDisposable

The AmazonSimpleNotificationServiceClient type exposes the following members

Constructors

NameDescription
Public Method AmazonSimpleNotificationServiceClient()

Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonSimpleNotificationServiceClient(RegionEndpoint)

Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonSimpleNotificationServiceClient(AmazonSimpleNotificationServiceConfig)

Constructs AmazonSimpleNotificationServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonSimpleNotificationServiceClient(AWSCredentials)

Constructs AmazonSimpleNotificationServiceClient with AWS Credentials

Public Method AmazonSimpleNotificationServiceClient(AWSCredentials, RegionEndpoint)

Constructs AmazonSimpleNotificationServiceClient with AWS Credentials

Public Method AmazonSimpleNotificationServiceClient(AWSCredentials, AmazonSimpleNotificationServiceConfig)

Constructs AmazonSimpleNotificationServiceClient with AWS Credentials and an AmazonSimpleNotificationServiceClient Configuration object.

Public Method AmazonSimpleNotificationServiceClient(string, string)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleNotificationServiceClient(string, string, RegionEndpoint)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleNotificationServiceClient(string, string, AmazonSimpleNotificationServiceConfig)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object.

Public Method AmazonSimpleNotificationServiceClient(string, string, string)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleNotificationServiceClient(string, string, string, RegionEndpoint)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonSimpleNotificationServiceClient(string, string, string, AmazonSimpleNotificationServiceConfig)

Constructs AmazonSimpleNotificationServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSimpleNotificationServiceClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddPermission(string, string, List<String>, List<String>)

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

Public Method AddPermission(AddPermissionRequest)

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

Public Method AddPermissionAsync(string, string, List<String>, List<String>, CancellationToken)

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

Public Method AddPermissionAsync(AddPermissionRequest, CancellationToken)

Initiates the asynchronous execution of the AddPermission operation.

Public Method AuthorizeS3ToPublish(string, string)

This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it.

Public Method AuthorizeS3ToPublishAsync(string, string)

This is a utility method which updates the policy of a topic to allow the S3 bucket to publish events to it.

Public Method CheckIfPhoneNumberIsOptedOut(CheckIfPhoneNumberIsOptedOutRequest)

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

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

Public Method CheckIfPhoneNumberIsOptedOutAsync(CheckIfPhoneNumberIsOptedOutRequest, CancellationToken)

Initiates the asynchronous execution of the CheckIfPhoneNumberIsOptedOut operation.

Public Method ConfirmSubscription(string, string, string)

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

Public Method ConfirmSubscription(string, string)

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

Public Method ConfirmSubscription(ConfirmSubscriptionRequest)

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

Public Method ConfirmSubscriptionAsync(string, string, string, CancellationToken)

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

Public Method ConfirmSubscriptionAsync(string, string, CancellationToken)

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

Public Method ConfirmSubscriptionAsync(ConfirmSubscriptionRequest, CancellationToken)

Initiates the asynchronous execution of the ConfirmSubscription operation.

Public Method CreatePlatformApplication(CreatePlatformApplicationRequest)

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

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

Public Method CreatePlatformApplicationAsync(CreatePlatformApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePlatformApplication operation.

Public Method CreatePlatformEndpoint(CreatePlatformEndpointRequest)

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.

Public Method CreatePlatformEndpointAsync(CreatePlatformEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePlatformEndpoint operation.

Public Method CreateTopic(string)

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

Public Method CreateTopic(CreateTopicRequest)

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

Public Method CreateTopicAsync(string, CancellationToken)

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

Public Method CreateTopicAsync(CreateTopicRequest, CancellationToken)

Initiates the asynchronous execution of the CreateTopic operation.

Public Method DeleteEndpoint(DeleteEndpointRequest)

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.

Public Method DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEndpoint operation.

Public Method DeletePlatformApplication(DeletePlatformApplicationRequest)

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.

Public Method DeletePlatformApplicationAsync(DeletePlatformApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePlatformApplication operation.

Public Method DeleteTopic(string)

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.

Public Method DeleteTopic(DeleteTopicRequest)

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.

Public Method DeleteTopicAsync(string, CancellationToken)

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.

Public Method DeleteTopicAsync(DeleteTopicRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteTopic operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method FindTopic(string)

Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found.

The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches topicName is found.

Public Method FindTopicAsync(string)

Finds an existing Amazon SNS topic by iterating all SNS topics until a match is found asynchronously.

The ListTopics method is used to fetch upto 100 SNS topics at a time until a SNS topic with an TopicArn that matches topicName is found.

Public Method GetEndpointAttributes(GetEndpointAttributesRequest)

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.

Public Method GetEndpointAttributesAsync(GetEndpointAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetEndpointAttributes operation.

Public Method GetPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest)

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.

Public Method GetPlatformApplicationAttributesAsync(GetPlatformApplicationAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation.

Public Method GetSMSAttributes(GetSMSAttributesRequest)

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

Public Method GetSMSAttributesAsync(GetSMSAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetSMSAttributes operation.

Public Method GetSubscriptionAttributes(string)

Returns all of the properties of a subscription.

Public Method GetSubscriptionAttributes(GetSubscriptionAttributesRequest)

Returns all of the properties of a subscription.

Public Method GetSubscriptionAttributesAsync(string, CancellationToken)

Returns all of the properties of a subscription.

Public Method GetSubscriptionAttributesAsync(GetSubscriptionAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetSubscriptionAttributes operation.

Public Method GetTopicAttributes(string)

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

Public Method GetTopicAttributes(GetTopicAttributesRequest)

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

Public Method GetTopicAttributesAsync(string, CancellationToken)

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

Public Method GetTopicAttributesAsync(GetTopicAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the GetTopicAttributes operation.

Public Method ListEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest)

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.

Public Method ListEndpointsByPlatformApplicationAsync(ListEndpointsByPlatformApplicationRequest, CancellationToken)

Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation.

Public Method ListPhoneNumbersOptedOut(ListPhoneNumbersOptedOutRequest)

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.

Public Method ListPhoneNumbersOptedOutAsync(ListPhoneNumbersOptedOutRequest, CancellationToken)

Initiates the asynchronous execution of the ListPhoneNumbersOptedOut operation.

Public Method ListPlatformApplications()

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

Public Method ListPlatformApplications(ListPlatformApplicationsRequest)

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.

Public Method ListPlatformApplicationsAsync(CancellationToken)

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.

Public Method ListPlatformApplicationsAsync(ListPlatformApplicationsRequest, CancellationToken)

Initiates the asynchronous execution of the ListPlatformApplications operation.

Public Method ListSubscriptions()

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

Public Method ListSubscriptions(string)

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.

Public Method ListSubscriptions(ListSubscriptionsRequest)

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.

Public Method ListSubscriptionsAsync(CancellationToken)

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.

Public Method ListSubscriptionsAsync(string, CancellationToken)

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.

Public Method ListSubscriptionsAsync(ListSubscriptionsRequest, CancellationToken)

Initiates the asynchronous execution of the ListSubscriptions operation.

Public Method ListSubscriptionsByTopic(string, string)

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.

Public Method ListSubscriptionsByTopic(string)

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.

Public Method ListSubscriptionsByTopic(ListSubscriptionsByTopicRequest)

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.

Public Method ListSubscriptionsByTopicAsync(string, string, CancellationToken)

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.

Public Method ListSubscriptionsByTopicAsync(string, CancellationToken)

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.

Public Method ListSubscriptionsByTopicAsync(ListSubscriptionsByTopicRequest, CancellationToken)

Initiates the asynchronous execution of the ListSubscriptionsByTopic operation.

Public Method ListTopics()

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

Public Method ListTopics(string)

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.

Public Method ListTopics(ListTopicsRequest)

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.

Public Method ListTopicsAsync(CancellationToken)

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.

Public Method ListTopicsAsync(string, CancellationToken)

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.

Public Method ListTopicsAsync(ListTopicsRequest, CancellationToken)

Initiates the asynchronous execution of the ListTopics operation.

Public Method OptInPhoneNumber(OptInPhoneNumberRequest)

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.

Public Method OptInPhoneNumberAsync(OptInPhoneNumberRequest, CancellationToken)

Initiates the asynchronous execution of the OptInPhoneNumber operation.

Public Method Publish(string, string)

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

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

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

Public Method Publish(string, string, string)

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

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

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

Public Method Publish(PublishRequest)

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

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

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

Public Method PublishAsync(string, string, CancellationToken)

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

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

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

Public Method PublishAsync(string, string, string, CancellationToken)

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

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

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

Public Method PublishAsync(PublishRequest, CancellationToken)

Initiates the asynchronous execution of the Publish operation.

Public Method RemovePermission(string, string)

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

Public Method RemovePermission(RemovePermissionRequest)

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

Public Method RemovePermissionAsync(string, string, CancellationToken)

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

Public Method RemovePermissionAsync(RemovePermissionRequest, CancellationToken)

Initiates the asynchronous execution of the RemovePermission operation.

Public Method SetEndpointAttributes(SetEndpointAttributesRequest)

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.

Public Method SetEndpointAttributesAsync(SetEndpointAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the SetEndpointAttributes operation.

Public Method SetPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest)

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

Public Method SetPlatformApplicationAttributesAsync(SetPlatformApplicationAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation.

Public Method SetSMSAttributes(SetSMSAttributesRequest)

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

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

Public Method SetSMSAttributesAsync(SetSMSAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the SetSMSAttributes operation.

Public Method SetSubscriptionAttributes(string, string, string)

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

Public Method SetSubscriptionAttributes(SetSubscriptionAttributesRequest)

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

Public Method SetSubscriptionAttributesAsync(string, string, string, CancellationToken)

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

Public Method SetSubscriptionAttributesAsync(SetSubscriptionAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the SetSubscriptionAttributes operation.

Public Method SetTopicAttributes(string, string, string)

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

Public Method SetTopicAttributes(SetTopicAttributesRequest)

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

Public Method SetTopicAttributesAsync(string, string, string, CancellationToken)

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

Public Method SetTopicAttributesAsync(SetTopicAttributesRequest, CancellationToken)

Initiates the asynchronous execution of the SetTopicAttributes operation.

Public Method Subscribe(string, string, string)

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.

Public Method Subscribe(SubscribeRequest)

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.

Public Method SubscribeAsync(string, string, string, CancellationToken)

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.

Public Method SubscribeAsync(SubscribeRequest, CancellationToken)

Initiates the asynchronous execution of the Subscribe operation.

Public Method SubscribeQueue(string, ICoreAmazonSQS, string)

Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic.

The policy applied to the SQS queue is similar to this:

{
    "Version" : "2008-10-17",
    "Statement" : [{
        "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic",
        "Effect" : "Allow",
        "Principal" : "*",
        "Action" : ["sqs:SendMessage"],
        "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"],
        "Condition" : {
            "ArnLike":{
                "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"]
            }
        }
    }]
}
            

There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue.

Public Method SubscribeQueueAsync(string, ICoreAmazonSQS, string)

Subscribes an existing Amazon SQS queue to an existing Amazon SNS topic asynchronously.

The policy applied to the SQS queue is similar to this:

{
    "Version" : "2008-10-17",
    "Statement" : [{
        "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic",
        "Effect" : "Allow",
        "Principal" : "*",
        "Action" : ["sqs:SendMessage"],
        "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"],
        "Condition" : {
            "ArnLike":{
                "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"]
            }
        }
    }]
}
            

There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue.

Public Method SubscribeQueueToTopics(IList<String>, ICoreAmazonSQS, string)

Subscribes an existing Amazon SQS queue to existing Amazon SNS topics.

The policy applied to the SQS queue is similar to this:

{
    "Version" : "2008-10-17",
    "Statement" : [{
        "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic",
        "Effect" : "Allow",
        "Principal" : "*",
        "Action" : ["sqs:SendMessage"],
        "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"],
        "Condition" : {
            "ArnLike":{
                "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"]
            }
        }
    }]
}
            

There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue.

Public Method SubscribeQueueToTopicsAsync(IList<String>, ICoreAmazonSQS, string)

Subscribes an existing Amazon SQS queue to existing Amazon SNS topics asynchronously.

The policy applied to the SQS queue is similar to this:

{
    "Version" : "2008-10-17",
    "Statement" : [{
        "Sid" : "topic-subscription-arn:aws:sns:us-west-2:599109622955:myTopic",
        "Effect" : "Allow",
        "Principal" : "*",
        "Action" : ["sqs:SendMessage"],
        "Resource":["arn:aws:sqs:us-west-2:599109622955:myQueue"],
        "Condition" : {
            "ArnLike":{
                "aws:SourceArn":["arn:aws:sns:us-west-2:599109622955:myTopic"]
            }
        }
    }]
}
            

There might be a small time period immediately after subscribing the SQS queue to the SNS topic and updating the SQS queue's policy, where messages are not able to be delivered to the queue. After a moment, the new queue policy will propagate and the queue will be able to receive messages. This delay only occurs immediately after initially subscribing the queue.

Public Method Unsubscribe(string)

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.

Public Method Unsubscribe(UnsubscribeRequest)

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.

Public Method UnsubscribeAsync(string, CancellationToken)

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.

Public Method UnsubscribeAsync(UnsubscribeRequest, CancellationToken)

Initiates the asynchronous execution of the Unsubscribe operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone