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.

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.

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

Syntax

C#
public virtual String SubscribeQueue(
         String topicArn,
         ICoreAmazonSQS sqsClient,
         String sqsQueueUrl
)
Parameters
topicArn
Type: System.String

The topic to subscribe to

sqsClient
Type: Amazon.Runtime.SharedInterfaces.ICoreAmazonSQS

The SQS client used to get attributes and set the policy on the SQS queue.

sqsQueueUrl
Type: System.String

The queue to add a subscription to.

Return Value
Type: String
The subscription ARN as returned by Amazon SNS when the queue is successfully subscribed to the topic.

Version Information

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