get-queue-attributes

Описание

Получает атрибуты указанной очереди.

Примечание

Чтобы определить, является ли очередь FIFO, можно проверить, заканчивается ли QueueName на суффикс .fifo.

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

Синтаксис

  get-queue-attributes
--queue-url <value>
[--attribute-names <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-url (строка)

URL очереди Amazon SQS, информация об атрибутах которой извлекается.

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

--attribute-names (список)

Список атрибутов, для которых необходимо получить информацию.

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

Примечание

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

Поддерживаются следующие атрибуты:

Предупреждение

Метрики ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible и ApproximateNumberOfMessages могут не достичь согласованности в течение как минимум 1 минуты после того, как производители перестанут отправлять сообщения. Этот период необходим для достижения конечной согласованности метаданных очереди.

All – Возвращает все значения.
ApproximateNumberOfMessages – Возвращает приблизительное количество сообщений, доступных для извлечения из очереди.
ApproximateNumberOfMessagesDelayed – Возвращает приблизительное количество сообщений в очереди, которые отложены и не доступны для немедленного чтения. Это может произойти, когда очередь настроена как очередь с задержкой или когда сообщение было отправлено с параметром задержки.
ApproximateNumberOfMessagesNotVisible – Возвращает приблизительное количество сообщений в процессе. Сообщения считаются находящимися в процессе, если они были отправлены клиенту, но ещё не были удалены или не достигли конца своего окна видимости.
CreatedTimestamp – Возвращает время создания очереди в секундах (эпохальное время).
DelaySeconds – Возвращает значение по умолчанию для задержки очереди в секундах.
LastModifiedTimestamp – Возвращает время последнего изменения очереди в секундах (эпохальное время).
MaximumMessageSize – Возвращает предел размера сообщения в байтах, превышение которого приводит к отклонению сообщения Amazon SQS.
MessageRetentionPeriod – Возвращает время хранения сообщения в секундах. При изменении атрибутов очереди изменение может занять до 60 секунд для распространения по всей системе Amazon SQS. Изменения, внесённые в атрибут MessageRetentionPeriod, могут занять до 15 минут и повлияют на существующие сообщения в очереди, потенциально вызывая их истечение срока действия и удаление, если MessageRetentionPeriod будет уменьшен ниже возраста существующих сообщений.
Policy – Возвращает политику очереди.
QueueArn – Возвращает Amazon Resource Name (ARN) очереди.
ReceiveMessageWaitTimeSeconds – Возвращает время ожидания в секундах для прибытия сообщения действием ReceiveMessage.
VisibilityTimeout – Возвращает тайм-аут видимости для очереди. Дополнительную информацию о тайм-ауте видимости см. в разделе Тайм-аут видимости в руководстве разработчика 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. Для получения дополнительной информации см. Определения ключевых терминов.
KmsDataKeyReusePeriodSeconds – Возвращает время в секундах, в течение которого Amazon SQS может повторно использовать ключ данных для шифрования или расшифровки сообщений перед обращением к KMS. Для получения дополнительной информации см. Как работает период повторного использования ключа данных?
SqsManagedSseEnabled – Возвращает информацию о том, использует ли очередь шифрование SSE-SQS с использованием ключей шифрования Amazon SQS. Поддерживается только один вариант шифрования на стороне сервера на очередь (например, SSE-KMS или SSE-SQS).

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

FifoQueue – Возвращает информацию о том, является ли очередь FIFO. Для получения дополнительной информации см. Логика очереди FIFO в руководстве разработчика Amazon SQS.

Примечание

Чтобы определить, является ли очередь FIFO, можно проверить, заканчивается ли QueueName на суффикс .fifo.

ContentBasedDeduplication – Возвращает информацию о том, включена ли дедупликация на основе содержимого для очереди. Дополнительную информацию см. в разделе Обработка сообщений с гарантией «ровно один раз» в руководстве разработчика Amazon SQS.

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

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

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

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

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

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

(строка)

Синтаксис:

"string" "string" ...

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

--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 (boolean)

Включить отладочную запись в журнал.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат 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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Получение атрибутов очереди

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

Команда:

aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names All

Вывод:

{
  "Attributes": {
    "ApproximateNumberOfMessagesNotVisible": "0",
    "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":1000}",
    "MessageRetentionPeriod": "345600",
    "ApproximateNumberOfMessagesDelayed": "0",
    "MaximumMessageSize": "262144",
    "CreatedTimestamp": "1442426968",
    "ApproximateNumberOfMessages": "0",
    "ReceiveMessageWaitTimeSeconds": "0",
    "DelaySeconds": "0",
    "VisibilityTimeout": "30",
    "LastModifiedTimestamp": "1442426968",
    "QueueArn": "arn:aws:sqs:us-east-1:80398EXAMPLE:MyNewQueue"
  }
}

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

Команда:

aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue --attribute-names MaximumMessageSize VisibilityTimeout

Вывод:

{
  "Attributes": {
    "VisibilityTimeout": "30",
    "MaximumMessageSize": "262144"
  }
}

Вывод

Атрибуты -> (массив)

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

ключ -> (строка)

значение -> (строка)