Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

get-queue

Описание

Получает очередь.

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

Синтаксис

  get-queue
--farm-id <value>
--queue-id <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]

Параметры

--farm-id (строка)

Идентификатор фермы, в которой находится очередь.

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

Идентификатор очереди для получения.

--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
  • 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.

Вывод

queueId -> (строка)

Идентификатор очереди.

displayName -> (строка)

Имя очереди для отображения.

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

Это поле может содержать любой контент. Перед отображением на веб-странице или в любой другой системе, которая может интерпретировать содержимое этого поля, необходимо выполнить экранирование или кодирование этого контента.

description -> (строка)

Описание очереди.

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

Это поле может содержать любой контент. Перед отображением на веб-странице или в любой другой системе, которая может интерпретировать содержимое этого поля, необходимо выполнить экранирование или кодирование этого контента.

farmId -> (строка)

Идентификатор фермы для очереди.

status -> (строка)

Статус очереди.

  • ACTIVE –Очередь активна.
  • SCHEDULING –Очередь планируется.
  • SCHEDULING_BLOCKED –Планирование очереди заблокировано. См. указанную причину.

defaultBudgetAction -> (строка)

Действие по умолчанию, выполняемое в очереди, если бюджет не был настроен.

blockedReason -> (строка)

Причина блокировки очереди.

jobAttachmentSettings -> (структура)

Настройки прикрепления задач к очереди.

s3BucketName -> (строка)

Имя ведра Amazon S3.

rootPrefix -> (строка)

Корневой префикс.

roleArn -> (строка)

ARN роли IAM.

requiredFileSystemLocationNames -> (список)

Список требуемых имен расположений файловой системы в очереди.

(строка)

allowedStorageProfileIds -> (список)

Идентификаторы профилей хранилища для очереди.

(строка)

jobRunAsUser -> (структура)

Задачи в очереди выполнялись от имени указанного пользователя POSIX.

posix -> (структура)

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

user -> (строка)

Имя пользователя POSIX.

group -> (строка)

Имя группы пользователя POSIX.

windows -> (структура)

Идентификация пользователя Microsoft Windows.

user -> (строка)

Пользователь.

passwordArn -> (строка)

ARN пароля для пользователя Windows.

runAs -> (строка)

Указывает, должен ли процесс выполняться от имени системного пользователя очереди или от имени системного пользователя агента исполнителя.

createdAt -> (временная метка)

Дата и время создания ресурса.

createdBy -> (строка)

Пользователь или система, создавшая этот ресурс.

updatedAt -> (временная метка)

Дата и время обновления ресурса.

updatedBy -> (строка)

Пользователь или система, обновившая этот ресурс.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API