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.
Get-SQSQueueAttribute-QueueUrl <String>-AttributeName <String[]>-Select <String>-PassThru <SwitchParameter>
QueueName
ends with the .fifo
suffix. ApproximateNumberOfMessagesDelayed
, ApproximateNumberOfMessagesNotVisible
, and ApproximateNumberOfMessagesVisible
metrics may not achieve consistency until at least 1 minute after the producers stop sending messages. This period is required for the queue metadata to reach eventual consistency. 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).DelaySeconds
– Returns the default delay on the queue in seconds.LastModifiedTimestamp
– Returns the time when the queue was last changed in seconds (epoch time).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. RedrivePolicy
– The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.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 in the Amazon Simple Queue Service Developer Guide. 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. KmsDataKeyReusePeriodSeconds
– Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?. FifoQueue
– Returns information about whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.To determine whether a queue is FIFO, 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 in the Amazon Simple Queue Service Developer Guide. DeduplicationScope
– Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup
and queue
.FifoThroughputLimit
– Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue
and perMessageGroupId
. The perMessageGroupId
value is allowed only when the value for DeduplicationScope
is messageGroup
.DeduplicationScope
to messageGroup
.FifoThroughputLimit
to perMessageGroupId
.Required? | False |
Position? | 2 |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AttributeNames |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
Get-SQSQueueAttribute -AttributeName All -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2008-10-17","Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[QueueArn, arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue], [ApproximateNumberOfMessages, 0],
[ApproximateNumberOfMessagesNotVisible, 0], [ApproximateNumberOfMessagesDelayed, 0]...}This example lists all attributes for the specified queue.
Get-SQSQueueAttribute -AttributeName MaximumMessageSize, VisibilityTimeout -QueueUrl https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue
VisibilityTimeout : 30
DelaySeconds : 0
MaximumMessageSize : 262144
MessageRetentionPeriod : 345600
ApproximateNumberOfMessages : 0
ApproximateNumberOfMessagesNotVisible : 0
ApproximateNumberOfMessagesDelayed : 0
CreatedTimestamp : 2/11/2015 5:53:35 PM
LastModifiedTimestamp : 12/29/2015 2:23:17 PM
QueueARN : arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue
Policy : {"Version":"2008-10-17","Id":"arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue/SQSDefaultPolicy","Statement":[{"Sid":"Sid14
495134224EX","Effect":"Allow","Principal":{"AWS":"*"},"Action":"SQS:SendMessage","Resource":"arn:aws:sqs:us-east-1:80
398EXAMPLE:MyQueue","Condition":{"ArnEquals":{"aws:SourceArn":"arn:aws:sns:us-east-1:80398EXAMPLE:MyTopic"}}},{"Sid":
"SendMessagesFromMyQueue","Effect":"Allow","Principal":{"AWS":"80398EXAMPLE"},"Action":"SQS:SendMessage","Resource":"
arn:aws:sqs:us-east-1:80398EXAMPLE:MyQueue"}]}
Attributes : {[MaximumMessageSize, 262144], [VisibilityTimeout, 30]}This example lists separately only the specified attributes for the specified queue.
AWS Tools for PowerShell: 2.x.y.z