create-queue

Описание

Создаёт новую стандартную или FIFO-очередь. Вы можете передать один или несколько атрибутов в запросе. Имейте в виду следующее:

Если вы не указываете атрибут FifoQueue, Amazon SQS создаст стандартную очередь.

Примечание

Вы не можете изменить тип очереди после её создания, и вы не можете преобразовать существующую стандартную очередь в FIFO-очередь. Вы должны либо создать новую FIFO-очередь для своего приложения, либо удалить существующую стандартную очередь и воссоздать её как FIFO-очередь. Дополнительную информацию см. в разделе Переход от стандартной очереди к FIFO-очереди в Руководстве разработчика Amazon SQS.

Если вы не предоставите значение для атрибута, очередь будет создана с предполагаемым значением атрибута.
Если вы удаляете очередь, вы должны подождать не менее 60 секунд, прежде чем создавать очередь с тем же именем.

Чтобы успешно создать новую очередь, вы должны указать имя очереди, которое соответствует ограничениям, связанным с очередями, и является уникальным в рамках вашей очереди.

Примечание

После создания очереди необходимо подождать не менее одной секунды после создания очереди, чтобы иметь возможность использовать её.

Чтобы получить URL очереди, используйте действие ` GetQueueUrl https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html`__. Это действие требует только параметра ` QueueName https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax`__.

При создании очередей имейте в виду следующие моменты:

Если вы укажете имя существующей очереди и предоставите точно такие же имена и значения для всех её атрибутов, действие ` CreateQueue https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html`__ вернёт URL существующей очереди вместо создания новой.
Если вы попытаетесь создать очередь с именем, которое уже существует, но с другими именами или значениями атрибутов, действие CreateQueue вернёт ошибку. Это гарантирует, что существующие очереди не будут случайно изменены.

Примечание

Разрешения между учётными записями не применяются к этому действию. Дополнительную информацию см. в разделе Предоставление разрешений между учётными записями роли и имени пользователя в Руководстве разработчика Amazon SQS.

См. также: Документация API AWS

Синтаксис

  create-queue
--queue-name <value>
[--attributes <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--queue-name (строка)

Имя новой очереди. На следующие ограничения имени накладываются следующие ограничения:

Имя очереди может содержать до 80 символов.
Допустимые значения: буквенно-цифровые символы, дефисы (- ), и символы подчеркивания (_ ).
Имя очереди FIFO должно заканчиваться суффиксом .fifo.

Имена и URL-адреса очереди чувствительны к регистру.

--attributes (массив)

Массив атрибутов и их соответствующих значений.

Ниже приведен список имен, описаний и значений специальных параметров запроса, используемых действием CreateQueue:

DelaySeconds – Длительность в секундах задержки доставки всех сообщений в очереди. Допустимые значения: целое число от 0 до 900 секунд (15 минут). По умолчанию: 0.
MaximumMessageSize – Максимальное количество байтов в сообщении перед отклонением Amazon SQS. Допустимые значения: целое число от 1024 байтов (1 Кбайт) до 262 144 байтов (256 Кбайт). По умолчанию: 262 144 (256 Кбайт).
MessageRetentionPeriod – Время в секундах, в течение которого Amazon SQS сохраняет сообщение. Допустимые значения: целое число от 60 секунд (1 минута) до 1 209 600 секунд (14 дней). По умолчанию: 345 600 (4 дня). При изменении атрибутов очереди изменения могут распространиться по всей системе Amazon SQS в течение 60 секунд для большинства атрибутов. Изменения, внесенные в атрибут MessageRetentionPeriod, могут занимать до 15 минут и повлиять на существующие сообщения в очереди, потенциально вызвав их истечение срока действия и удаление, если значение MessageRetentionPeriod будет уменьшено ниже возраста существующих сообщений.
Policy – Политика очереди. Действительная политика Amazon Web Services. Дополнительную информацию о структуре политики см. в разделе Обзор политик IAM Amazon Web Services в Руководстве пользователя IAM .
ReceiveMessageWaitTimeSeconds – Время в секундах, в течение которого действие `` ReceiveMessage `` ожидает прибытия сообщения. Допустимые значения: целое число от 0 до 20 (секунд). По умолчанию: 0.
VisibilityTimeout – Тайм-аут видимости очереди в секундах. Допустимые значения: целое число от 0 до 43 200 (12 часов). По умолчанию: 30. Дополнительную информацию о тайм-ауте видимости см. в разделе Тайм-аут видимости в Руководстве разработчика Amazon SQS .

Следующие атрибуты применяются только к очередям с перенаправлением:

RedrivePolicy – Строка, содержащая параметры функциональности очереди перенаправления для исходной очереди в формате JSON. Параметры следующие:
- deadLetterTargetArn – Amazon Resource Name (ARN) очереди перенаправления, в которую Amazon SQS переместит сообщения после превышения значения maxReceiveCount.
- maxReceiveCount – Количество попыток доставки сообщения в исходную очередь перед перемещением в очередь перенаправления. По умолчанию: 10. Когда ReceiveCount сообщения превышает maxReceiveCount очереди, Amazon SQS перемещает сообщение в очередь перенаправления.
RedriveAllowPolicy – Строка, содержащая параметры разрешений для разрешения перенаправления очереди перенаправления и указания исходных очередей, которые могут задать очереди перенаправления в формате JSON. Параметры следующие:
- redrivePermission – Тип разрешения, определяющий, какие исходные очереди могут указать текущую очередь как очередь перенаправления. Допустимые значения:
  - allowAll – (По умолчанию) Любые исходные очереди в этой учетной записи Amazon Web Services в том же регионе могут указать эту очередь как очередь перенаправления.
  - denyAll – Никакие исходные очереди не могут указать эту очередь как очередь перенаправления.
  - byQueue – Только очереди, указанные параметром sourceQueueArns, могут указать эту очередь как очередь перенаправления.
- sourceQueueArns – Amazon Resource Names (ARN) исходных очередей, которые могут указать эту очередь как очередь перенаправления и перенаправить сообщения. Этот параметр можно указать только в том случае, если параметр redrivePermission установлен в byQueue. Можно указать до 10 ARN исходных очередей. Чтобы разрешить указание более 10 исходных очередей в качестве очередей перенаправления, установите параметр redrivePermission в значение allowAll.

Примечание

Очередь перенаправления очереди FIFO также должна быть очередью FIFO. Аналогично, очередь перенаправления стандартной очереди также должна быть стандартной очередью.

Следующие атрибуты применяются только к шифрованию на стороне сервера:

KmsMasterKeyId – Идентификатор управляемого Amazon Web Services ключа шифрования (CMK) для Amazon SQS или пользовательского CMK. Дополнительная информация см. в разделе Термины . Хотя псевдоним управляемого Amazon Web Services CMK для Amazon SQS всегда равен alias/aws/sqs, псевдоним пользовательского CMK может, например, быть ``alias/MyAlias `` . Для получения дополнительных примеров см. KeyId в Справочнике по API службы управления ключами .
KmsDataKeyReusePeriodSeconds – Время в секундах, в течение которого Amazon SQS может повторно использовать ключ данных для шифрования или расшифровки сообщений перед повторным обращением к KMS. Целое число, представляющее секунды, между 60 секундами (1 минутой) и 86 400 секундами (24 часами). По умолчанию: 300 (5 минут). Более короткий интервал повышает безопасность, но приводит к большему количеству обращений к KMS, что может повлечь за собой расходы после бесплатного периода. Дополнительная информация см. в разделе Как работает период повторного использования ключа данных?
SqsManagedSseEnabled – Включает шифрование очереди на стороне сервера с использованием ключей шифрования, принадлежащих SQS. Только один вариант шифрования на стороне сервера поддерживается на одну очередь (например, SSE-KMS или SSE-SQS).

Следующие атрибуты применяются только к очередям FIFO (первым вошел — первым вышел):

FifoQueue – Определяет очередь как FIFO. Допустимые значения — true и false. Если вы не укажете атрибут FifoQueue, Amazon SQS создаст стандартную очередь. Вы можете указать этот атрибут только при создании очереди. Изменить его для существующей очереди нельзя. При установке этого атрибута вы также должны явно указать MessageGroupId для своих сообщений. Дополнительная информация см. в разделе Логика очереди FIFO в Руководстве разработчика Amazon SQS .
ContentBasedDeduplication – Включает дублирование по содержимому. Допустимые значения — true и false. Дополнительная информация см. в разделе Обработка «ровно один раз» в Руководстве разработчика Amazon SQS . Обратите внимание на следующее:
- Каждое сообщение должно иметь уникальное MessageDeduplicationId.
  - Вы можете явно указать MessageDeduplicationId.
  - Если вы не можете указать MessageDeduplicationId и включите ContentBasedDeduplication для вашей очереди, Amazon SQS использует хэш SHA-256 для генерации MessageDeduplicationId, используя тело сообщения (но не атрибуты сообщения).
  - Если вы не указываете MessageDeduplicationId, а в очереди не задано ContentBasedDeduplication, действие завершается с ошибкой.
  - Если в очереди задано ContentBasedDeduplication, ваше MessageDeduplicationId переопределяет сгенерированное.
- Когда ContentBasedDeduplication включено, сообщения с одинаковым содержимым, отправленные в течение интервала дублирования, считаются дубликатами, и доставляется только один экземпляр сообщения.
- Если вы отправите одно сообщение с ContentBasedDeduplication включенным, а затем другое сообщение с MessageDeduplicationId, равным сгенерированному для первого MessageDeduplicationId, оба сообщения считаются дубликатами, и доставляется только один экземпляр сообщения.

Следующие атрибуты применяются только к высокой пропускной способности для очередей FIFO:

DeduplicationScope – Указывает, происходит ли дублирование сообщений на уровне группы сообщений или очереди. Допустимые значения — messageGroup и queue.
FifoThroughputLimit – Указывает, относится ли квота пропускной способности очереди FIFO ко всей очереди или к каждой группе сообщений. Допустимые значения — perQueue и perMessageGroupId. Значение perMessageGroupId разрешено только при значении DeduplicationScope равном messageGroup.

Для включения высокой пропускной способности для очередей FIFO выполните следующие действия:

Установите DeduplicationScope в значение messageGroup.
Установите FifoThroughputLimit в значение perMessageGroupId.

Если эти атрибуты установлены не в указанные значения для включения высокой пропускной способности, действует обычная пропускная способность, и дублирование происходит согласно указанным параметрам.

Информация о квотах пропускной способности содержится в разделе Квоты, связанные с сообщениями в Руководстве разработчика Amazon SQS .

key -> (строка)

value -> (строка)

Сокращенная синтаксис:

  KeyName1=string,KeyName2=string

Where valid key names are:
  All
  Policy
  VisibilityTimeout
  MaximumMessageSize
  MessageRetentionPeriod
  ApproximateNumberOfMessages
  ApproximateNumberOfMessagesNotVisible
  CreatedTimestamp
  LastModifiedTimestamp
  QueueArn
  ApproximateNumberOfMessagesDelayed
  DelaySeconds
  ReceiveMessageWaitTimeSeconds
  RedrivePolicy
  FifoQueue
  ContentBasedDeduplication
  KmsMasterKeyId
  KmsDataKeyReusePeriodSeconds
  DeduplicationScope
  FifoThroughputLimit
  RedriveAllowPolicy
  SqsManagedSseEnabled

Синтаксис JSON:

{"All"|"Policy"|"VisibilityTimeout"|"MaximumMessageSize"|"MessageRetentionPeriod"|"ApproximateNumberOfMessages"|"ApproximateNumberOfMessagesNotVisible"|"CreatedTimestamp"|"LastModifiedTimestamp"|"QueueArn"|"ApproximateNumberOfMessagesDelayed"|"DelaySeconds"|"ReceiveMessageWaitTimeSeconds"|"RedrivePolicy"|"FifoQueue"|"ContentBasedDeduplication"|"KmsMasterKeyId"|"KmsDataKeyReusePeriodSeconds"|"DeduplicationScope"|"FifoThroughputLimit"|"RedriveAllowPolicy"|"SqsManagedSseEnabled": "string"
  ...}

--tags (массив)

Добавление тегов распределения затрат к указанной очереди Amazon SQS. Обзор см. в разделе Добавление тегов к очередям Amazon SQS в Руководстве разработчика Amazon SQS .

При работе с тегами очереди следует придерживаться следующих рекомендаций:

Не рекомендуется добавлять более 50 тегов в очередь.
Теги не имеют семантического значения. Amazon SQS интерпретирует теги как строки символов.
Теги чувствительны к регистру.
Новый тег с ключом, идентичным ключу существующего тега, перезаписывает существующий тег.

Полный список ограничений по тегам см. в разделе Квоты, связанные с очередями, в Руководстве разработчика Amazon SQS .

Примечание

Для возможности добавления тегов к очереди при создании необходимо иметь разрешения sqs:CreateQueue и sqs:TagQueue.

Разрешения между учетными записями не применяются к этому действию. Дополнительную информацию см. в разделе Предоставление разрешений между учетными записями роли и имени пользователя в Руководстве разработчика Amazon SQS .

key -> (строка)

value -> (строка)

Сокращенная синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределяют значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретироваться буквально. Это может не указываться вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, оно выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (логическое значение)

Включить отладочную регистрацию.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

json
текст
таблица
yaml
yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

включить
выключить
автоматически

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить пейджер cli для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запрошение параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки терминала. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для создания очереди

В этом примере создается очередь с указанным именем, устанавливается период хранения сообщений в 3 дня (3 дня * 24 часа * 60 минут * 60 секунд) и устанавливается очередь для сообщений с ошибкой (dead letter queue) в указанную очередь с максимальным количеством сообщений для приема 1000.

Команда:

aws sqs create-queue --queue-name MyQueue --attributes file://create-queue.json

Входной файл (create-queue.json):

{
  "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":\"1000\"}",
  "MessageRetentionPeriod": "259200"
}

Вывод:

{
  "QueueUrl": "https://queue.amazonaws.com/80398EXAMPLE/MyQueue"
}

Вывод

QueueUrl -> (строка)

URL созданной Amazon SQS очереди.