Interface DescribeQueueCommandOutputProtected

The output of DescribeQueueCommand.

Hierarchy

Properties

approximateNumberOfMessages: undefined | number

The approximate number of messages available for retrieval from the queue.

approximateNumberOfMessagesDelayed: undefined | number

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: undefined | number

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.

delaySeconds?: number

The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.

fifo?: boolean

Designates a queue as FIFO. If you don't specify the FifoQueue attribute, the queue will be treated as a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

maximumMessageSize?: number

The limit of how many bytes a message can contain. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

messageRetentionPeriod?: number

The length of time, in seconds, for which to retain a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes and will impact existing messages in the queue potentially causing them to be expired and deleted if the MessageRetentionPeriod is reduced below the age of existing messages.

queueName: undefined | string

The name of the new queue. A queue name can have up to 80 alphanumeric characters, hyphens, or underscores. A FIFO queue name must end with the .fifo suffix. Queue URLs and names are case-sensitive.

queueUrl: undefined | string

The URL of the queue.

resourceDetail: undefined | DescribeResourceDetail
visibilityTimeout?: number

Visibility timeout, specified in seconds. Valid values: An integer from 0 to 43,200 (12 hours).