IAmazonSQS.GetQueueUrl Method (GetQueueUrlRequest)

Returns the URL of an existing Amazon SQS queue.

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetQueueUrlAsync.

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

Syntax

public abstract GetQueueUrlResponse GetQueueUrl(
         GetQueueUrlRequest request
)

Parameters

request: Type: Amazon.SQS.Model.GetQueueUrlRequest

Container for the necessary parameters to execute the GetQueueUrl service method.

Return Value

Type: GetQueueUrlResponse

The response from the GetQueueUrl service method, as returned by SQS.

Exceptions

Exception	Condition
InvalidAddressException	The accountId is invalid.
InvalidSecurityException	When the request to a queue is not HTTPS and SigV4.
QueueDoesNotExistException	The specified queue doesn't exist.
RequestThrottledException	The request was denied due to request throttling. The rate of requests per second exceeds the Amazon Web Services KMS request quota for an account and Region. A burst or sustained high rate of requests to change the state of the same KMS key. This condition is often known as a "hot key." Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store might be throttled at a lower-than-expected rate when the Amazon Web Services CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
UnsupportedOperationException	Error code 400. Unsupported operation.

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 Framework:
Supported in: 4.5, 4.0, 3.5

IAmazonSQS.GetQueueUrl (GetQueueUrlRequest)

Method