AWS SQS

Describe queue

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Get details about a queue.

Inputs

Champ

Type

Description

region [required]

enum

default: us-east-1

resourceId [required]

string

Outputs

Expand All

Champ

Type

Description

queue [required]

object

QueueUrl

string

URL of the source queue.

Arn

string

Amazon Resource Name (ARN) of the queue.

ContentBasedDeduplication

boolean

For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, Amazon SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message.

DeduplicationScope

string

Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue.

DelaySeconds

number

The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of 0 to 900 (15 minutes). The default value is 0.

FifoQueue

boolean

If set to true, creates a FIFO queue. If you don't specify this property, Amazon SQS creates a standard queue.

FifoThroughputLimit

string

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.

KmsDataKeyReusePeriodSeconds

number

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. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes).

KmsMasterKeyId

string

The ID of an AWS managed customer master key (CMK) for Amazon SQS or a custom CMK. To use the AWS managed CMK for Amazon SQS, specify the (default) alias alias/aws/sqs.

SqsManagedSseEnabled

boolean

Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS ).

MaximumMessageSize

number

The limit of how many bytes that a message can contain before Amazon SQS rejects it. You can specify an integer value from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default value is 262,144 (256 KiB).

MessageRetentionPeriod

number

The number of seconds that Amazon SQS retains a message. You can specify an integer value from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default value is 345,600 seconds (4 days).

QueueName

string

A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the .fifo suffix.

ReceiveMessageWaitTimeSeconds

number

Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property.

RedriveAllowPolicy

RedrivePolicy

Tags

[object]

The tags that you attach to this queue.

Key [required]

string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value [required]

string

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

VisibilityTimeout

number

The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds.

amzRequestId [required]

string