list-queues
Описание
Выводит список очередей.
См. также: Документация API AWS
list-queues является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: queues
Синтаксис
list-queues
--farm-id <value>
[--principal-id <value>]
[--status <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Параметры
--farm-id (строка)
--principal-id (строка)
--status (строка)
Статус перечисленных очередей.
-
ACTIVE–Очереди активны. -
SCHEDULING–Очереди планируются. -
SCHEDULING_BLOCKED–Планирование очереди заблокировано для этих очередей.
Возможные значения:
IDLESCHEDULINGSCHEDULING_BLOCKED
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания, где начать постраничную обработку. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Чтобы продолжить постраничную обработку, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.
--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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из вашего файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/окружения.
--version (строка)
Вывод версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--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.
Вывод
queues -> (список)
Очереди в списке.
(структура)
Подробности сводной информации об очереди.
farmId -> (строка)
queueId -> (строка)
displayName -> (строка)
Отображаемое имя сводной информации об очереди для обновления.
Предупреждение
Это поле может хранить любое содержимое. Перед отображением этого содержимого на веб-странице или любой другой системе, которая может интерпретировать содержимое этого поля, необходимо экранировать или закодировать это содержимое.status -> (строка)
defaultBudgetAction -> (строка)
blockedReason -> (строка)
createdAt -> (временная метка)
createdBy -> (строка)
updatedAt -> (временная метка)
updatedBy -> (строка)
nextToken -> (строка)
nextToken , то есть больше результатов. Значение nextToken — уникальный маркер постраничной обработки для каждой страницы. Для получения следующей страницы вызовите операцию снова с возвращенным маркером. Не изменяйте другие аргументы. Если результатов больше нет, то nextToken устанавливается в значение null. Каждый маркер постраничной обработки истекает через 24 часа. Если вы предоставите недействительный маркер, то получите ошибку HTTP 400 ValidationException.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|