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
 
Container for the parameters to the GetQueueAttributes operation. Gets attributes for the specified queue. The following attributes are supported: Going forward, new attributes might be added. If you are writing code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.Some API actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

Inheritance Hierarchy

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

Namespace: Amazon.SQS.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class GetQueueAttributesRequest : AmazonSQSRequest
         IRequestEvents

The GetQueueAttributesRequest type exposes the following members

Constructors

NameDescription
Public Method GetQueueAttributesRequest() Empty constructor used to set properties independently even when a simple constructor is available
Public Method GetQueueAttributesRequest(string, List<String>)

Properties

NameTypeDescription
Public Property AttributeNames System.Collections.Generic.List<System.String> Gets and sets the property AttributeNames.

A list of attributes to retrieve information for.

Public Property QueueUrl System.String Gets and sets the property QueueUrl.

The URL of the Amazon SQS queue to take action on.

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

.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