Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

list-jobs

Описание

Выводит список задач.

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

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

Синтаксис

  list-jobs
--farm-id <value>
[--principal-id <value>]
--queue-id <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 (строка)

ID фермы для задач.

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

ID принципала для членов задач.

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

ID очереди для задачи.

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

--starting-token (строка)

Токен для указания места начала постраничного вывода. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в руководстве пользователя AWS CLI.

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

Вывод

jobs -> (список)

Список задач.

(структура)

Краткая информация о деталях задачи.

jobId -> (строка)

ID задачи.

name -> (строка)

Имя задачи.

lifecycleStatus -> (строка)

Статус жизненного цикла.

lifecycleStatusMessage -> (строка)

Сообщение о статусе жизненного цикла.

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

Приоритет задачи.

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

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

createdBy -> (строка)

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

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

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

updatedBy -> (строка)

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

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

Дата и время запуска ресурса.

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

Дата и время завершения работы ресурса.

taskRunStatus -> (строка)

Статус выполнения задачи для задачи.

  • PENDING — ожидается и ждёт ресурсов.
  • READY — готов к обработке.
  • ASSIGNED — назначен и будет запущен следующим на узле.
  • SCHEDULED — запланировано для выполнения на узле.
  • INTERRUPTING — прерывается.
  • RUNNING — выполняется на узле.
  • SUSPENDED — задача приостановлена.
  • CANCELED — задача отменена.
  • FAILED — задача завершилась неудачно.
  • SUCCEEDED — задача завершилась успешно.

targetTaskRunStatus -> (строка)

Статус задачи для начала работы над задачей.

taskRunStatusCounts -> (карта)

Количество задач, выполняемых над задачей.

key -> (строка)

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

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

Количество сбоев задач до того, как задача прекратит работу и помечается как FAILED.

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

Максимальное количество попыток для задачи.

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

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

Вы не можете установить maxWorkerCount в 0. Если установить его в -1, то максимального количества рабочих нет.

Если вы не укажете maxWorkerCount, по умолчанию будет -1.

sourceJobId -> (строка)

ID задачи для исходной задачи.

nextToken -> (строка)

Если Deadline Cloud возвращает nextToken, то доступны дополнительные результаты. Значение nextToken — уникальный токен постраничного вывода для каждой страницы. Для получения следующей страницы снова вызовите операцию, используя возвращённый токен. Сохраните все остальные аргументы неизменными. Если больше результатов нет, то nextToken устанавливается в null. Каждый токен постраничного вывода истекает через 24 часа. Если вы предоставите недействительный токен, то получите ошибку HTTP 400 ValidationException.

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

Spec-Zone.ru

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