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.

Gets attributes for the specified queue.

To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

Note:

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

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

Syntax

C#
public virtual GetQueueAttributesResponse GetQueueAttributes(
         GetQueueAttributesRequest request
)
Parameters
request
Type: Amazon.SQS.Model.GetQueueAttributesRequest

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

Return Value
The response from the GetQueueAttributes service method, as returned by SQS.

Exceptions

ExceptionCondition
InvalidAttributeNameException The specified attribute doesn't exist.

Examples

This example shows how to get queue attributes.

Get queue attributes example

var client = new AmazonSQSClient();

var request = new GetQueueAttributesRequest
{
  QueueUrl = "https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyTestQueue",
  AttributeNames = new List<string>() { "All" }
};

var response = client.GetQueueAttributes(request);

Console.WriteLine("Attributes for queue ARN '" + response.QueueARN + "':");
Console.WriteLine("  Approximate number of messages:" +
  response.ApproximateNumberOfMessages);
Console.WriteLine("  Approximate number of messages delayed: " +
  response.ApproximateNumberOfMessagesDelayed);
Console.WriteLine("  Approximate number of messages not visible: " +
  response.ApproximateNumberOfMessagesNotVisible);
Console.WriteLine("  Queue created on: " + response.CreatedTimestamp);
Console.WriteLine("  Delay seconds: " + response.DelaySeconds);
Console.WriteLine("  Queue last modified on: " +
  response.LastModifiedTimestamp);
Console.WriteLine("  Maximum message size: " +
  response.MaximumMessageSize);
Console.WriteLine("  Message retention period: " +
  response.MessageRetentionPeriod);
Console.WriteLine("  Visibility timeout: " + response.VisibilityTimeout);
Console.WriteLine("  Policy: " + response.Policy);
Console.WriteLine("  Attributes:");

foreach (var attr in response.Attributes)
{
  Console.WriteLine("    " + attr.Key + ": " + attr.Value);
}
      

Version Information

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

See Also