Spec-Zone.ru › AWS CLI v2

[ aws . m2 ]

start-batch-job

Описание

Запускает задачу пакетной обработки и возвращает уникальный идентификатор этого выполнения задачи пакетной обработки. Для запуска задачи пакетной обработки связанное приложение должно быть запущено.

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

Синтаксис

  start-batch-job
--application-id <value>
[--auth-secrets-manager-arn <value>]
--batch-job-identifier <value>
[--job-params <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]

Параметры

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

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

--auth-secrets-manager-arn (строка)

Услуга Amazon Web Services Secrets Manager, содержащая учетные данные пользователя для аутентификации и авторизации операции Start Batch Job.

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

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

Примечание

Это структура помеченного объединения. Можно задать только один из следующих верхних ключей: 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 -> (строка)

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

Укороченный синтаксис:

fileBatchJobIdentifier={fileName=string,folderPath=string},restartBatchJobIdentifier={executionId=string,jobStepRestartMarker={fromProcStep=string,fromStep=string,skip=boolean,stepCheckpoint=integer,toProcStep=string,toStep=string}},s3BatchJobIdentifier={bucket=string,identifier={fileName=string,scriptName=string},keyPrefix=string},scriptBatchJobIdentifier={scriptName=string}

Синтаксис JSON:

{
  "fileBatchJobIdentifier": {
    "fileName": "string",
    "folderPath": "string"
  },
  "restartBatchJobIdentifier": {
    "executionId": "string",
    "jobStepRestartMarker": {
      "fromProcStep": "string",
      "fromStep": "string",
      "skip": true|false,
      "stepCheckpoint": integer,
      "toProcStep": "string",
      "toStep": "string"
    }
  },
  "s3BatchJobIdentifier": {
    "bucket": "string",
    "identifier": {
      "fileName": "string",
      "scriptName": "string"
    },
    "keyPrefix": "string"
  },
  "scriptBatchJobIdentifier": {
    "scriptName": "string"
  }
}

--job-params (карта)

Коллекция параметров задачи пакетной обработки. Подробности о ограничениях для ключей и значений см. в разделе Кодирование переменных в JCL.

key -> (строка)

Подробности о ограничениях для ключей и значений см. в https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl . Для ключей (имен переменных) 8, для значений (значений переменных) 44. Кроме того, ключи будут содержать только буквенные символы и цифры без пробелов или специальных символов (дефис, подчеркивание и т. д.).

Для BluAge Engine: нет ограничений на длину ключей и значений. Дополнительная проверка может быть применена в коде в соответствии с движком.

Ключ параметра: первая буква должна быть буквенной. Может содержать до 32 буквенно-цифровых символов.

value -> (строка)

Значение параметра может содержать до 1024 буквенно-цифровых символов.

Укороченный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

executionId -> (строка)

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

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

Spec-Zone.ru

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