list-jobs-by-consumable-resource
Описание
Возвращает список заданий Batch, требующих определенного ресурса потребления.
См. также: Документацию API AWS
list-jobs-by-consumable-resource является постраничной операцией. Для получения всего набора результатов могут быть выпущены несколько запросов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлечь данные из результатов следующих выражений запроса: jobs
Синтаксис
list-jobs-by-consumable-resource
--consumable-resource <value>
[--filters <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]
Параметры
--consumable-resource (строка)
--filters (список)
Фильтры для применения к запросу списка заданий. Если используется, отображаются только те задания, которые требуют указанного ресурса потребления (consumableResource ) и соответствуют значениям фильтров. Имена и значения фильтров могут быть:
- name:
JOB_STATUSvalues:SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED - name:
JOB_NAMEЗначения являются регистронезависимыми совпадениями для имени задания. Если значение фильтра заканчивается звездочкой (*), оно соответствует любому имени задания, начинающемуся со строки перед ‘*’.
(структура)
Пара имя-значение фильтра, используемая для возврата более конкретного списка результатов из операции API ListJobs или ListJobsByConsumableResource.
name -> (строка)
values -> (список)
Значения фильтра.
(строка)
Сокращенная синтаксическая форма:
name=string,values=string,string ...
Синтаксис JSON:
[
{
"name": "string",
"values": ["string", ...]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные через JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного через JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания точки начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS .
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньшее количество элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS .
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS .
--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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.
Вывод
jobs -> (список)
Список заданий, требующих указанных ресурсов потребления.
(структура)
Текущая информация о ресурсе потребления, необходимом для задания.
jobArn -> (строка)
jobQueueArn -> (строка)
jobName -> (строка)
jobDefinitionArn -> (строка)
shareIdentifier -> (строка)
jobStatus -> (строка)
Статус задания. Может быть одним из следующих:
SUBMITTEDPENDINGRUNNABLESTARTINGRUNNINGSUCCEEDEDFAILED
quantity -> (длинное целое число)
statusReason -> (строка)
startedAt -> (длинное целое число)
STARTING в состояние RUNNING.createdAt -> (длинное целое число)
consumableResourceProperties -> (структура)
Содержит список ресурсов потребления, необходимых заданию.
consumableResourceList -> (список)
Список ресурсов потребления, необходимых заданию.
(структура)
Информация о ресурсе потребления, необходимом для выполнения задания.
consumableResource -> (строка)
quantity -> (длинное целое число)
nextToken -> (строка)
nextToken для включения в последующий запрос ListJobsByConsumableResource. Когда результаты запроса ListJobsByConsumableResource превышают maxResults, это значение можно использовать для получения следующей страницы результатов. Это значение null, когда больше результатов для возврата нет.
© Copyright 2025, Amazon Web Services. Created using Sphinx.