AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

GetQueueAttributesInput

import "github.com/aws/aws-sdk-go/service/sqs"

type GetQueueAttributesInput struct { AttributeNames []*string `locationNameList:"AttributeName" type:"list" flattened:"true"` QueueUrl *string `type:"string" required:"true"` }

AttributeNames

Type: []*string

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

  • All - Returns all values.

  • ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.

  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.

  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.

  • CreatedTimestamp - Returns the time when the queue was created in seconds

(epoch time (http://en.wikipedia.org/wiki/Unix_time)).
  • DelaySeconds - Returns the default delay on the queue in seconds.

  • MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.

  • Policy - Returns the policy of the queue.

  • QueueArn - Returns the Amazon resource name (ARN) of the queue.

  • ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue

to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

maxReceiveCount - The number of times a message is delivered to the source

queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout

(http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the Amazon Simple Queue Service Developer Guide.

The following attributes apply only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):

  • KmsMasterKeyId - Returns the ID of an AWS-managed customer master key

(CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).

The following attributes apply only to FIFO (first-in-first-out) queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html):

To determine whether a queue is FIFO (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html),

you can check whether QueueName ends with the .fifo suffix.
  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing

(http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing) in the Amazon Simple Queue Service Developer Guide.
QueueUrl

Type: *string

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs and names are case-sensitive.

QueueUrl is a required field

Method

GoString

func (s GetQueueAttributesInput) GoString() string

GoString returns the string representation

SetAttributeNames

func (s *GetQueueAttributesInput) SetAttributeNames(v []*string) *GetQueueAttributesInput

SetAttributeNames sets the AttributeNames field's value.

SetQueueUrl

func (s *GetQueueAttributesInput) SetQueueUrl(v string) *GetQueueAttributesInput

SetQueueUrl sets the QueueUrl field's value.

String

func (s GetQueueAttributesInput) String() string

String returns the string representation

Validate

func (s *GetQueueAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: