Spec-Zone.ru › AWS CLI v2

[ aws . amplify ]

start-job

Описание

Запускает новую задачу для ветки приложения Amplify.

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

Синтаксис

  start-job
--app-id <value>
--branch-name <value>
[--job-id <value>]
--job-type <value>
[--job-reason <value>]
[--commit-id <value>]
[--commit-message <value>]
[--commit-time <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]

Параметры

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

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

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

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

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

Уникальный идентификатор существующей задачи. Требуется, если значение jobType равно RETRY .

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

Определяет тип задачи. Тип задачи RELEASE запускает новую задачу с последним изменением из указанной ветки. Это значение доступно только для приложений, подключенных к репозиторию.

Тип задачи RETRY повторно запускает существующую задачу. Если значение типа задачи равно RETRY , также требуется jobId.

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

  • RELEASE
  • RETRY
  • MANUAL
  • WEB_HOOK

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

Подробное описание причины запуска задачи.

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

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

--commit-message (строка)

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

--commit-time (временная метка)

Дата и время коммита для задачи.

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

Вывод

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

Резюме задачи.

jobArn -> (строка)

Amazon Resource Name (ARN) для задачи.

jobId -> (строка)

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

commitId -> (строка)

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

commitMessage -> (строка)

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

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

Дата и время коммита для задачи.

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

Дата и время начала задачи.

status -> (строка)

Текущий статус задачи.

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

Дата и время окончания задачи.

jobType -> (строка)

Тип задачи. Если значение равно RELEASE , задача была вручную освобождена от исходного кода с помощью API StartJob. Это значение доступно только для приложений, подключенных к репозиторию.

Если значение равно RETRY , задача была вручную повторно запущена с помощью API StartJob. Если значение равно WEB_HOOK , задача была автоматически запущена веб-хуками. Если значение равно MANUAL , задача предназначена для приложения, развернутого вручную. Приложения, развернутые вручную, не подключены к Git-репозиторию.

sourceUrl -> (строка)

URL исходного файла для развертывания. URL исходного файла может быть публичным URL HTTP GET, который загружает один .zip-файл, или бакетом Amazon S3 и префиксом.

sourceUrlType -> (строка)

Тип источника, указанный в sourceURL. Если значение равно ZIP , источник — .zip-файл. Если значение равно BUCKET_PREFIX , источник — бакет Amazon S3 и префикс. Если значение не указано, по умолчанию используется ZIP.

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

Spec-Zone.ru

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