Spec-Zone.ru › AWS CLI v2

[ aws . m2 ]

list-batch-job-executions

Описание

Выводит исторические, текущие и запланированные выполнения задач в очереди обработки для определенного приложения.

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

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

Синтаксис

  list-batch-job-executions
--application-id <value>
[--execution-ids <value>]
[--job-name <value>]
[--started-after <value>]
[--started-before <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]

Параметры

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

Уникальный идентификатор приложения.

--execution-ids (список)

Уникальный идентификатор каждого выполнения задачи в очереди обработки.

(строка)

Синтаксис:

"string" "string" ...

--job-name (строка)

Имя каждого выполнения задачи в очереди обработки.

--started-after (метка времени)

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

--started-before (метка времени)

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

--status (строка)

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

Возможные значения:

  • Submitting
  • Holding
  • Dispatching
  • Running
  • Cancelling
  • Cancelled
  • Succeeded
  • Failed
  • Purged
  • Succeeded With Warning

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

batchJobExecutions -> (список)

Возвращает список выполнений пакетных задач для приложения.

(структура)

Подмножество возможных атрибутов пакетной задачи. Используется в списке пакетных задач.

applicationId -> (строка)

Уникальный идентификатор приложения, в котором размещена эта пакетная задача.

batchJobIdentifier -> (структура помеченных союзов)

Уникальный идентификатор этой пакетной задачи.

Примечание

Это структура помеченных союзов. Только один из следующих верхнеуровневых ключей может быть задан: fileBatchJobIdentifier, restartBatchJobIdentifier, s3BatchJobIdentifier, scriptBatchJobIdentifier.

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

Определяет файл, связанный с конкретной пакетной задачей.

fileName -> (строка)

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

folderPath -> (строка)

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

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

Определяет необходимую информацию для перезапуска, включая executionId и JobStepRestartMarker.

executionId -> (строка)

executionId из ответа StartBatchJob, когда задача выполнялась впервые.

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

Информация о шаге/процедуре для операции перезапуска пакетной задачи.

fromProcStep -> (строка)

Имя шага процедуры, с которого была перезапущена пакетная задача.

fromStep -> (строка)

Имя шага, с которого была перезапущена пакетная задача.

skip -> (булево)

Отметка времени контрольной точки уровня шага (создание или последнее изменение) для пакетной задачи приложения Amazon Web Services Blu Age.

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

Пропустить выбранный шаг и выполнить перезапуск с непосредственного последующего шага для пакетной задачи приложения Amazon Web Services Blu Age.

toProcStep -> (строка)

Имя шага процедуры, до которого была перезапущена пакетная задача.

toStep -> (строка)

Имя шага, до которого была перезапущена пакетная задача.

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

Указывает расположение в Amazon S3, которое идентифицирует пакетные задачи, которые вы хотите запустить. Используйте этот идентификатор для запуска пакетных задач ad hoc.

bucket -> (строка)

Ведро Amazon S3, содержащее определения пакетных задач.

identifier -> (структура помеченных союзов)

Идентифицирует определение пакетной задачи. Этот идентификатор также может указывать на любое определение пакетной задачи, которое уже существует в приложении, или на одно из определений пакетных задач в каталоге, указанном в keyPrefix.

Примечание

Это структура помеченных союзов. Только один из следующих верхнеуровневых ключей может быть задан: fileName, scriptName.

fileName -> (строка)

Имя файла, содержащего определение пакетной задачи.

scriptName -> (строка)

Имя скрипта, содержащего определение пакетной задачи.

keyPrefix -> (строка)

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

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

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

scriptName -> (строка)

Имя скрипта, содержащего определение пакетной задачи.

endTime -> (метка времени)

Метка времени завершения выполнения этой пакетной задачи.

executionId -> (строка)

Уникальный идентификатор этого выполнения пакетной задачи.

jobId -> (строка)

Уникальный идентификатор конкретной пакетной задачи.

jobName -> (строка)

Имя конкретной пакетной задачи.

jobType -> (строка)

Тип конкретного выполнения пакетной задачи.

returnCode -> (строка)

Код возврата пакетной задачи от исполняющих модулей Blu Age или Micro Focus. Дополнительную информацию см. в разделе «Коды возврата пакетных задач» в документации по IBM WebSphere Application Server.

startTime -> (метка времени)

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

status -> (строка)

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

nextToken -> (строка)

Токен постраничной навигации, который возвращается, когда ответ не содержит всех выполнений пакетных задач.

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

Spec-Zone.ru

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