Skip to main content

ISQSGetQueueAttributesRequest

Interface in AWS.SQS

Interface for GetQueueAttributes requests.

Ancestors​

Properties​

AttributeNames​

property AttributeNames: TList<string>

A collection of attribute names for which to retrieve information.

If you don't specify values for this parameter, the request returns empty results. Specify All to retrieve all available attributes, or specify individual attribute names. Standard queue attributes include:

  • ApproximateNumberOfMessages – Messages available for retrieval
  • ApproximateNumberOfMessagesNotVisible – Messages in flight
  • ApproximateNumberOfMessagesDelayed – Messages delayed and not available
  • DelaySeconds – Default delivery delay for messages
  • MaximumMessageSize – Maximum message size in bytes
  • MessageRetentionPeriod – Message retention time in seconds
  • ReceiveMessageWaitTimeSeconds – Long polling wait time
  • VisibilityTimeout – Message visibility timeout in seconds
  • QueueArn – Amazon Resource Name of the queue
  • Policy – Queue access policy as JSON FIFO queue specific attributes:
  • FifoQueue – Whether the queue is a FIFO queue
  • ContentBasedDeduplication – Whether content-based deduplication is enabled
  • DeduplicationScope – Message group or queue level deduplication
  • FifoThroughputLimit – Throughput quota scope (per queue or per message group) Dead letter queue attributes:
  • RedrivePolicy – Dead letter queue configuration as JSON
  • RedriveAllowPolicy – Controls which queues can use this as a dead letter queue Encryption attributes:
  • KmsMasterKeyId – AWS KMS key ID for server-side encryption
  • KmsDataKeyReusePeriodSeconds – Data key reuse period in seconds
  • SqsManagedSseEnabled – Whether SQS-managed server-side encryption is enabled Timestamp attributes:
  • CreatedTimestamp – Queue creation time in epoch seconds
  • LastModifiedTimestamp – Last modification time in epoch seconds The approximate message count attributes may not achieve consistency until at least 1 minute after producers stop sending messages due to eventual consistency requirements.

Methods​

AddAttributeName​

function AddAttributeName(const AAttributeName: string): NativeInt;

Adds an attribute name to AttributeNames.

Parameters

NameDescription
AAttributeNameSpecify an attribute name to add to AttributeNames.

Returns

Returns the index of the attribute name added to AttributeNames.