Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following in mind:
If you don't specify the FifoQueue
attribute, Amazon SQS creates a
standard queue.
You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.
If you don't provide a value for an attribute, the queue is created with the default value for the attribute.
If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
After you create a queue, you must wait at least one second after the queue is created to be able to use the queue.
To get the queue URL, use the get_queue_url
action. get_queue_url
requires only the
QueueName
parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact
names and values of all the queue's attributes,
create_queue
returns the queue URL for the
existing queue.
If the queue name, attribute names, or attribute values don't match
an existing queue, create_queue
returns an
error.
Some actions take lists of parameters. These lists are specified using
the param.n
notation. Values of n
are integers starting from 1. For
example, a parameter list with two elements looks like this:
&AttributeName.1=first
&AttributeName.2=second
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.
sqs_create_queue(QueueName, Attributes, tags)
[required] The name of the new queue. The following limits apply to this name:
A queue name can have up to 80 characters.
Valid values: alphanumeric characters, hyphens (-
), and
underscores (_
).
A FIFO queue name must end with the .fifo
suffix.
Queue URLs and names are case-sensitive.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special
request parameters that the create_queue
action
uses:
DelaySeconds
<U+2013> 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.
MaximumMessageSize
<U+2013> The limit of how many bytes a message can
contain before Amazon SQS rejects it. Valid values: An integer from
1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
(256 KiB).
MessageRetentionPeriod
<U+2013> The length of time, in seconds, for which
Amazon SQS retains a message. Valid values: An integer from 60
seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
(4 days).
Policy
<U+2013> The queue's policy. A valid AWS policy. For more
information about policy structure, see Overview of AWS IAM Policies
in the Amazon IAM User Guide.
ReceiveMessageWaitTimeSeconds
<U+2013> The length of time, in seconds,
for which a receive_message
action waits
for a message to arrive. Valid values: An integer from 0 to 20
(seconds). Default: 0.
RedrivePolicy
<U+2013> 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
<U+2013> The Amazon Resource Name (ARN) of the
dead-letter queue to which Amazon SQS moves messages after the
value of maxReceiveCount
is exceeded.
maxReceiveCount
<U+2013> 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.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
VisibilityTimeout
<U+2013> The visibility timeout for the queue, in
seconds. Valid values: An integer from 0 to 43,200 (12 hours).
Default: 30. For more information about the visibility timeout, see
Visibility Timeout
in the Amazon Simple Queue Service Developer Guide.
The following attributes apply only to server-side-encryption:
KmsMasterKeyId
<U+2013> The ID of an AWS-managed customer master key
(CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
While the alias of the AWS-managed CMK for Amazon SQS is always
alias/aws/sqs
, the alias of a custom CMK can, for example, be
alias/MyAlias
. For more examples, see
KeyId
in the AWS Key Management Service API Reference.
KmsDataKeyReusePeriodSeconds
<U+2013> 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. An
integer representing seconds, between 60 seconds (1 minute) and
86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time
period provides better security but results in more calls to KMS
which might incur charges after Free Tier. For more information, see
How Does the Data Key Reuse Period Work?.
The following attributes apply only to FIFO (first-in-first-out) queues:
FifoQueue
<U+2013> Designates a queue as FIFO. Valid values are true
and false
. If you don't specify the FifoQueue
attribute, Amazon
SQS creates 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.
For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.
ContentBasedDeduplication
<U+2013> Enables content-based deduplication.
Valid values are true
and false
. For more information, see
Exactly-Once Processing
in the Amazon Simple Queue Service Developer Guide. Note the
following:
Every message must have a unique MessageDeduplicationId
.
You may provide a MessageDeduplicationId
explicitly.
If you aren't able to provide a MessageDeduplicationId
and
you enable ContentBasedDeduplication
for your queue,
Amazon SQS uses a SHA-256 hash to generate the
MessageDeduplicationId
using the body of the message (but
not the attributes of the message).
If you don't provide a MessageDeduplicationId
and the
queue doesn't have ContentBasedDeduplication
set, the
action fails with an error.
If the queue has ContentBasedDeduplication
set, your
MessageDeduplicationId
overrides the generated one.
When ContentBasedDeduplication
is in effect, messages with
identical content sent within the deduplication interval are
treated as duplicates and only one copy of the message is
delivered.
If you send one message with ContentBasedDeduplication
enabled
and then another message with a MessageDeduplicationId
that is
the same as the one generated for the first
MessageDeduplicationId
, the two messages are treated as
duplicates and only one copy of the message is delivered.
Preview: High throughput for FIFO queues
High throughput for Amazon SQS FIFO queues is in preview release and is subject to change. This feature provides a high number of transactions per second (TPS) for messages in FIFO queues. For information on throughput quotas, see Quotas related to messages in the Amazon Simple Queue Service Developer Guide.
This preview includes two new attributes:
DeduplicationScope
<U+2013> Specifies whether message deduplication
occurs at the message group or queue level. Valid values are
messageGroup
and queue
.
FifoThroughputLimit
<U+2013> 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
.
To enable high throughput for FIFO queues, do the following:
Set DeduplicationScope
to messageGroup
.
Set FifoThroughputLimit
to perMessageGroupId
.
If you set these attributes to anything other than the values shown for enabling high throughput, standard throughput is in effect and deduplication occurs as specified.
This preview is available in the following AWS Regions:
US East (Ohio); us-east-2
US East (N. Virginia); us-east-1
US West (Oregon); us-west-2
Europe (Ireland); eu-west-1
For more information about high throughput for FIFO queues, see Preview: High throughput for FIFO queues in the Amazon Simple Queue Service Developer Guide.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.
When you use queue tags, keep the following guidelines in mind:
Adding more than 50 tags to a queue isn't recommended.
Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
Tags are case-sensitive.
A new tag with a key identical to that of an existing tag overwrites the existing tag.
For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.
To be able to tag a queue on creation, you must have the
sqs:CreateQueue
and sqs:TagQueue
permissions.
Cross-account permissions don't apply to this action. For more information, see Grant cross-account permissions to a role and a user name in the Amazon Simple Queue Service Developer Guide.
A list with the following syntax:
list( QueueUrl = "string" )
svc$create_queue( QueueName = "string", Attributes = list( "string" ), tags = list( "string" ) )