Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

batch-get-job-entity

Описание

Получение подробной информации о пакетных заданиях для рабочего узла.

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

batch-get-job-entity использует значения типов документов. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, логические значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая запись не поддерживает типы документов.

Синтаксис

  batch-get-job-entity
--farm-id <value>
--fleet-id <value>
--worker-id <value>
--identifiers <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 (строка)

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

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

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

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

Идентификатор рабочего узла, содержащего информацию о задании.

--identifiers (список)

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

(Структура помеченного объединения)

Подробная информация об идентификаторе задания.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: jobDetails, jobAttachmentDetails, stepDetails, environmentDetails.

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

Подробная информация о задании.

jobId -> (строка)

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

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

Подробная информация о прикреплении к заданию.

jobId -> (строка)

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

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

Подробная информация о шаге.

jobId -> (строка)

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

stepId -> (строка)

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

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

Подробная информация об окружении.

jobId -> (строка)

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

environmentId -> (строка)

Идентификатор окружения.

Краткая запись:

jobDetails={jobId=string},jobAttachmentDetails={jobId=string},stepDetails={jobId=string,stepId=string},environmentDetails={jobId=string,environmentId=string} ...

Синтаксис JSON:

[
  {
    "jobDetails": {
      "jobId": "string"
    },
    "jobAttachmentDetails": {
      "jobId": "string"
    },
    "stepDetails": {
      "jobId": "string",
      "stepId": "string"
    },
    "environmentDetails": {
      "jobId": "string",
      "environmentId": "string"
    }
  }
  ...
]

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

Вывод

entities -> (список)

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

(структура помеченного объединения)

Подробности сущности задачи.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: jobDetails, jobAttachmentDetails, stepDetails, environmentDetails.

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

Подробности задачи.

jobId -> (строка)

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

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

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

s3BucketName -> (строка)

Имя ведра Amazon S3.

rootPrefix -> (строка)

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

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

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

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

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

user -> (строка)

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

group -> (строка)

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

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

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

user -> (строка)

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

passwordArn -> (строка)

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

runAs -> (строка)

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

logGroupName -> (строка)

Имя группы журналов.

queueRoleArn -> (строка)

ARN роли очереди.

parameters -> (карта)

Параметры.

key -> (строка)

value -> (структура помеченного объединения)

Подробности параметров задачи.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: int, float, string, path.

int -> (строка)

Целое число со знаком, представленное как строка.

float -> (строка)

Число с плавающей запятой двойной точности IEEE-754, представленное как строка.

string -> (строка)

Строка UTF-8.

path -> (строка)

Путь файловой системы, представленный как строка.

schemaVersion -> (строка)

Версия схемы.

pathMappingRules -> (список)

Правила сопоставления путей.

(структура)

Подробности исходного и целевого пути.

sourcePathFormat -> (строка)

Формат исходного пути.

sourcePath -> (строка)

Исходный путь.

destinationPath -> (строка)

Целевой путь.

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

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

jobId -> (строка)

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

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

Прикрепления к задаче.

manifests -> (список)

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

(структура)

Подробности манифеста, связывающего исходную информацию задачи.

fileSystemLocationName -> (строка)

Имя расположения файловой системы.

rootPath -> (строка)

Корневой путь файла.

rootPathFormat -> (строка)

Формат корневого пути.

outputRelativeDirectories -> (список)

Путь к файлу относительно каталога.

(строка)

inputManifestPath -> (строка)

Путь к файлу.

inputManifestHash -> (строка)

Значение хэша файла.

fileSystem -> (строка)

Файловая система.

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

Подробности шага.

jobId -> (строка)

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

stepId -> (строка)

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

schemaVersion -> (строка)

Версия схемы для шаблонного шага.

template -> (документ)

Шаблон для шага.

dependencies -> (список)

Зависимости для шага.

(строка)

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

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

jobId -> (строка)

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

environmentId -> (строка)

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

schemaVersion -> (строка)

Версия схемы в среде.

template -> (документ)

Шаблон, используемый для среды.

errors -> (список)

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

(структура помеченного объединения)

Ошибка для сущности задачи.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть задан: jobDetails, jobAttachmentDetails, stepDetails, environmentDetails.

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

Подробности задачи для завершившейся ошибкой сущности.

jobId -> (строка)

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

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, описывающее причину ошибки.

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

Подробности прикрепления задачи для завершившейся с ошибкой сущности.

jobId -> (строка)

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

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, описывающее причину ошибки.

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

Подробности шага для завершившейся с ошибкой сущности задачи.

jobId -> (строка)

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

stepId -> (строка)

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

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, описывающее причину ошибки.

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

Подробности среды для завершившейся с ошибкой сущности задачи.

jobId -> (строка)

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

environmentId -> (строка)

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

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке, описывающее причину ошибки.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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