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 3.5
 
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.dll
Version: (assembly version)

Syntax

C#
public class AmazonSimpleNotificationServiceClient : AmazonServiceClient
         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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             
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.

Methods

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 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 BeginAddPermission(AddPermissionRequest, AsyncCallback, object) Initiates the asynchronous execution of the AddPermission operation.
Public Method BeginConfirmSubscription(ConfirmSubscriptionRequest, AsyncCallback, object) Initiates the asynchronous execution of the ConfirmSubscription operation.
Public Method BeginCreatePlatformApplication(CreatePlatformApplicationRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreatePlatformApplication operation.
Public Method BeginCreatePlatformEndpoint(CreatePlatformEndpointRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreatePlatformEndpoint operation.
Public Method BeginCreateTopic(CreateTopicRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateTopic operation.
Public Method BeginDeleteEndpoint(DeleteEndpointRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteEndpoint operation.
Public Method BeginDeletePlatformApplication(DeletePlatformApplicationRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeletePlatformApplication operation.
Public Method BeginDeleteTopic(DeleteTopicRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteTopic operation.
Public Method BeginGetEndpointAttributes(GetEndpointAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetEndpointAttributes operation.
Public Method BeginGetPlatformApplicationAttributes(GetPlatformApplicationAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetPlatformApplicationAttributes operation.
Public Method BeginGetSubscriptionAttributes(GetSubscriptionAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetSubscriptionAttributes operation.
Public Method BeginGetTopicAttributes(GetTopicAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetTopicAttributes operation.
Public Method BeginListEndpointsByPlatformApplication(ListEndpointsByPlatformApplicationRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListEndpointsByPlatformApplication operation.
Public Method BeginListPlatformApplications(ListPlatformApplicationsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListPlatformApplications operation.
Public Method BeginListSubscriptions(ListSubscriptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListSubscriptions operation.
Public Method BeginListSubscriptionsByTopic(ListSubscriptionsByTopicRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListSubscriptionsByTopic operation.
Public Method BeginListTopics(ListTopicsRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListTopics operation.
Public Method BeginPublish(PublishRequest, AsyncCallback, object) Initiates the asynchronous execution of the Publish operation.
Public Method BeginRemovePermission(RemovePermissionRequest, AsyncCallback, object) Initiates the asynchronous execution of the RemovePermission operation.
Public Method BeginSetEndpointAttributes(SetEndpointAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetEndpointAttributes operation.
Public Method BeginSetPlatformApplicationAttributes(SetPlatformApplicationAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetPlatformApplicationAttributes operation.
Public Method BeginSetSubscriptionAttributes(SetSubscriptionAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetSubscriptionAttributes operation.
Public Method BeginSetTopicAttributes(SetTopicAttributesRequest, AsyncCallback, object) Initiates the asynchronous execution of the SetTopicAttributes operation.
Public Method BeginSubscribe(SubscribeRequest, AsyncCallback, object) Initiates the asynchronous execution of the Subscribe operation.
Public Method BeginUnsubscribe(UnsubscribeRequest, AsyncCallback, object) Initiates the asynchronous execution of the Unsubscribe 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 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 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.
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 CreateTopic(string) 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.
Public Method CreateTopic(CreateTopicRequest) 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.
Public Method DeleteEndpoint(DeleteEndpointRequest) Deletes the endpoint from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.
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 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 Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EndAddPermission(IAsyncResult) Finishes the asynchronous execution of the AddPermission operation.
Public Method EndConfirmSubscription(IAsyncResult) Finishes the asynchronous execution of the ConfirmSubscription operation.
Public Method EndCreatePlatformApplication(IAsyncResult) Finishes the asynchronous execution of the CreatePlatformApplication operation.
Public Method EndCreatePlatformEndpoint(IAsyncResult) Finishes the asynchronous execution of the CreatePlatformEndpoint operation.
Public Method EndCreateTopic(IAsyncResult) Finishes the asynchronous execution of the CreateTopic operation.
Public Method EndDeleteEndpoint(IAsyncResult) Finishes the asynchronous execution of the DeleteEndpoint operation.
Public Method EndDeletePlatformApplication(IAsyncResult) Finishes the asynchronous execution of the DeletePlatformApplication operation.
Public Method EndDeleteTopic(IAsyncResult) Finishes the asynchronous execution of the DeleteTopic operation.
Public Method EndGetEndpointAttributes(IAsyncResult) Finishes the asynchronous execution of the GetEndpointAttributes operation.
Public Method EndGetPlatformApplicationAttributes(IAsyncResult) Finishes the asynchronous execution of the GetPlatformApplicationAttributes operation.
Public Method EndGetSubscriptionAttributes(IAsyncResult) Finishes the asynchronous execution of the GetSubscriptionAttributes operation.
Public Method EndGetTopicAttributes(IAsyncResult) Finishes the asynchronous execution of the GetTopicAttributes operation.
Public Method EndListEndpointsByPlatformApplication(IAsyncResult) Finishes the asynchronous execution of the ListEndpointsByPlatformApplication operation.
Public Method EndListPlatformApplications(IAsyncResult) Finishes the asynchronous execution of the ListPlatformApplications operation.
Public Method EndListSubscriptions(IAsyncResult) Finishes the asynchronous execution of the ListSubscriptions operation.
Public Method EndListSubscriptionsByTopic(IAsyncResult) Finishes the asynchronous execution of the ListSubscriptionsByTopic operation.
Public Method EndListTopics(IAsyncResult) Finishes the asynchronous execution of the ListTopics operation.
Public Method EndPublish(IAsyncResult) Finishes the asynchronous execution of the Publish operation.
Public Method EndRemovePermission(IAsyncResult) Finishes the asynchronous execution of the RemovePermission operation.
Public Method EndSetEndpointAttributes(IAsyncResult) Finishes the asynchronous execution of the SetEndpointAttributes operation.
Public Method EndSetPlatformApplicationAttributes(IAsyncResult) Finishes the asynchronous execution of the SetPlatformApplicationAttributes operation.
Public Method EndSetSubscriptionAttributes(IAsyncResult) Finishes the asynchronous execution of the SetSubscriptionAttributes operation.
Public Method EndSetTopicAttributes(IAsyncResult) Finishes the asynchronous execution of the SetTopicAttributes operation.
Public Method EndSubscribe(IAsyncResult) Finishes the asynchronous execution of the Subscribe operation.
Public Method EndUnsubscribe(IAsyncResult) Finishes the asynchronous execution of the Unsubscribe operation.
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 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 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 GetSubscriptionAttributes(string) Returns all of the properties of a subscription.
Public Method GetSubscriptionAttributes(GetSubscriptionAttributesRequest) Returns all of the properties of a subscription.
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 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 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 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 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 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 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 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.

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

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

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 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 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.
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 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 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 SubscribeQueue(string, IAmazonSQS, 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 SubscribeQueueToTopics(IList<String>, IAmazonSQS, 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 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.

Events

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

Examples

This example shows how to create, subscribe to, and publish a topic.

Create, subscribe to, and publish topic example

var snsClient = new AmazonSimpleNotificationServiceClient();

var topicRequest = new CreateTopicRequest
{
  Name = "CodingTestResults"
};

var topicResponse = snsClient.CreateTopic(topicRequest);

var topicAttrRequest = new SetTopicAttributesRequest
{
  TopicArn = topicResponse.TopicArn,
  AttributeName = "DisplayName",
  AttributeValue = "Coding Test Results"
};

snsClient.SetTopicAttributes(topicAttrRequest);

snsClient.Subscribe(new SubscribeRequest
{
  Endpoint = "johndoe@example.com",
  Protocol = "email",
  TopicArn = topicResponse.TopicArn
});

// Wait for up to 2 minutes for the user to confirm the subscription.
DateTime latest = DateTime.Now + TimeSpan.FromMinutes(2);

while (DateTime.Now < latest)
{
  var subsRequest = new ListSubscriptionsByTopicRequest
  {
    TopicArn = topicResponse.TopicArn
  };

  var subs = snsClient.ListSubscriptionsByTopic(subsRequest).Subscriptions;

  var sub = subs[0];

  if (!string.Equals(sub.SubscriptionArn,
    "PendingConfirmation", StringComparison.Ordinal))
  {
    break;
  }

  // Wait 15 seconds before trying again.
  System.Threading.Thread.Sleep(TimeSpan.FromSeconds(15));
}

snsClient.Publish(new PublishRequest
{
  Subject = "Coding Test Results for " +
    DateTime.Today.ToShortDateString(),
  Message = "All of today's coding tests passed.",
  TopicArn = topicResponse.TopicArn
});
      

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8