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.

Container for the parameters to the GetQueueUrl operation. The GetQueueUrl API returns the URL of an existing Amazon SQS queue. This is useful when you know the queue's name but need to retrieve its URL for further operations.

To access a queue owned by another Amazon Web Services account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. Note that the queue owner must grant you the necessary permissions to access the queue. For more information about accessing shared queues, see the AddPermission API or Allow developers to write messages to a shared queue in the Amazon SQS Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SQS.AmazonSQSRequest
      Amazon.SQS.Model.GetQueueUrlRequest

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

Syntax

C# 
public class GetQueueUrlRequest : AmazonSQSRequest
         IAmazonWebServiceRequest

The GetQueueUrlRequest type exposes the following members

Constructors

NameDescription
Public Method GetQueueUrlRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method GetQueueUrlRequest(string)

Instantiates GetQueueUrlRequest with the parameterized properties

Properties

NameTypeDescription
Public Property QueueName System.String

Gets and sets the property QueueName.

(Required) The name of the queue for which you want to fetch the URL. The name can be up to 80 characters long and can include alphanumeric characters, hyphens (-), and underscores (_). Queue URLs and names are case-sensitive.

Public Property QueueOwnerAWSAccountId System.String

Gets and sets the property QueueOwnerAWSAccountId.

(Optional) The Amazon Web Services account ID of the account that created the queue. This is only required when you are attempting to access a queue owned by another Amazon Web Services account.

Examples

This example shows how to get a queue URL.

Get queue URL example

var client = new AmazonSQSClient();

var request = new GetQueueUrlRequest
{
  QueueName = "MyTestQueue",
  QueueOwnerAWSAccountId = "80398EXAMPLE"
};

var response = client.GetQueueUrl(request);

Console.WriteLine("Queue URL: " + response.QueueUrl);

The following example retrieves the queue ARN.

Retrieve queue attributes from an SQS queue


var client = new AmazonSQSClient();
var response = client.GetQueueUrl(new GetQueueUrlRequest 
{
    QueueName = "MyQueue",
    QueueOwnerAWSAccountId = "12345678910"
});

string queueUrl = response.QueueUrl;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5