Spec-Zone.ru › AWS CLI v2

[ aws . batch ]

describe-job-queues

Описание

Описывает одну или несколько очередей задач.

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

describe-job-queues является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответ на постраничный запрос, аргумент --query должен извлекать данные из результатов следующих выражений запроса: jobQueues

Синтаксис

  describe-job-queues
[--job-queues <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]

Параметры

--job-queues (список)

Список из до 100 имен очередей или полных записей Amazon Resource Name (ARN) очереди.

(строка)

Синтаксис:

"string" "string" ...

--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
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет интерпретироваться как двоичный и использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла необходимо правильно отформатировать для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

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

В этом примере описывается очередь задач HighPriority.

Команда:

aws batch describe-job-queues --job-queues HighPriority

Вывод:

{
    "jobQueues": [
        {
            "status": "VALID",
            "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
            "computeEnvironmentOrder": [
                {
                    "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
                    "order": 1
                }
            ],
            "statusReason": "JobQueue Healthy",
            "priority": 1,
            "state": "ENABLED",
            "jobQueueName": "HighPriority"
        }
    ]
}

Выходные данные

jobQueues -> (список)

Список очередей задач.

(структура)

Объект, представляющий детали очереди задач Batch.

jobQueueName -> (строка)

Имя очереди задач.

jobQueueArn -> (строка)

Amazon Resource Name (ARN) очереди задач.

state -> (строка)

Описывает возможность очереди принимать новые задачи. Если состояние очереди задач равно ENABLED, она может принимать задачи. Если состояние очереди задач равно DISABLED, новые задачи не могут быть добавлены в очередь, но задачи, уже находящиеся в очереди, могут завершиться.

schedulingPolicyArn -> (строка)

Amazon Resource Name (ARN) политики планирования. Формат — aws:*Partition* :batch:*Region* :*Account* :scheduling-policy/*Name* `` . For example, ``aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

status -> (строка)

Состояние очереди задач (например, CREATING или VALID).

statusReason -> (строка)

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

priority -> (целое число)

Приоритет очереди задач. Приоритет очереди задач определяет порядок, в котором оцениваются очереди задач при распределении задач в общей вычислительной среде. Более высокое значение для priority указывает более высокий приоритет. Очереди оцениваются циклически в порядке убывания приоритета. Например, очередь задач с приоритетом 10 оценивается раньше, чем очередь с приоритетом 1. Все вычислительные среды должны быть либо Amazon EC2 (EC2 или SPOT), либо Fargate (FARGATE или FARGATE_SPOT). Вычислительные среды Amazon EC2 и Fargate нельзя смешивать.

Примечание

Приоритет очереди задач не гарантирует, что конкретная задача выполнится раньше задачи из очереди с более низким приоритетом. Задачи, добавленные в очереди с более высоким приоритетом в течение цикла оценки очереди, могут не быть оценены до следующего цикла. Задача отправляется из очереди только в том случае, если ресурсы доступны при оценке очереди. Если в этот момент ресурсов недостаточно, цикл переходит к следующей очереди. Это означает, что задачи, добавленные в очереди с более высоким приоритетом, могут дождаться завершения задач в нескольких очередях с более низким приоритетом, прежде чем они будут отправлены. Вы можете использовать зависимости задач для управления порядком задач из очередей с различными приоритетами. Дополнительную информацию см. в разделе Зависимости задач в руководстве пользователя Batch.

computeEnvironmentOrder -> (список)

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

(структура)

Порядок, в котором вычислительные среды проверяются для размещения задач в очереди. Вычислительные среды проверяются в порядке возрастания. Например, если две вычислительные среды связаны с очередью задач, вычислительная среда с меньшим значением целого порядка будет проверена для размещения задач первой. Вычислительные среды должны находиться в состоянии VALID, прежде чем вы сможете связать их с очередью задач. Все вычислительные среды должны быть либо EC2 (EC2 или SPOT), либо Fargate (FARGATE или FARGATE_SPOT); вычислительные среды Amazon EC2 и Fargate нельзя смешивать.

Примечание

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

order -> (целое число)

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

computeEnvironment -> (строка)

Amazon Resource Name (ARN) вычислительной среды.

tags -> (отображение)

Теги, примененные к очереди задач. Дополнительную информацию см. в разделе Разметка ваших ресурсов Batch в Руководстве пользователя Batch.

key -> (строка)

value -> (строка)

jobStateTimeLimitActions -> (список)

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

(структура)

Определяет действие, которое Batch выполнит после того, как задача оставалась в начале очереди в указанном состоянии дольше, чем указанное время.

reason -> (строка)

Причина для логирования выполняемого действия.

state -> (строка)

Состояние задачи, необходимое для запуска действия. Единственное поддерживаемое значение — RUNNABLE.

maxTimeSeconds -> (целое число)

Приблизительное количество времени (в секундах), которое должно пройти с задачей в указанном состоянии, прежде чем будет выполнено действие. Минимальное значение — 600 (10 минут), максимальное — 86 400 (24 часа).

action -> (строка)

Действие, которое нужно выполнить, когда задача находится в начале очереди задач в указанном состоянии в течение указанного периода времени. Единственное поддерживаемое значение — CANCEL, что приведет к отмене задачи.

nextToken -> (строка)

Значение nextToken, которое необходимо включить в будущий запрос DescribeJobQueues. Когда результаты запроса DescribeJobQueues превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение равно null, если больше результатов для возврата нет.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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