Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

create-job-template

Описание

Создаёт шаблон задания.

Требуется разрешение на доступ к действию CreateJobTemplate.

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

Синтаксис

  create-job-template
--job-template-id <value>
[--job-arn <value>]
[--document-source <value>]
[--document <value>]
--description <value>
[--presigned-url-config <value>]
[--job-executions-rollout-config <value>]
[--abort-config <value>]
[--timeout-config <value>]
[--tags <value>]
[--job-executions-retry-config <value>]
[--maintenance-windows <value>]
[--destination-package-versions <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]

Параметры

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

Уникальный идентификатор шаблона задания. Рекомендуется использовать UUID. Допустимы буквенно-цифровые символы, «-» и «_».

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

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

--document-source (строка)

Ссылка на объект S3 или URL-адрес объекта S3 с документом задания. Ссылка — это URL-адрес объекта Amazon S3 и требуется, если вы не указали значение для document .

Например, --document-source https://s3.*region-code* .amazonaws.com/example-firmware/device-firmware.1.0

Дополнительную информацию см. в разделе Методы доступа к ведру.

--document (строка)

Документ задания. Требуется, если вы не указали значение для documentSource .

--description (строка)

Описание документа задания.

--presigned-url-config (структура)

Конфигурация для предварительно подписанных URL-адресов S3.

roleArn -> (строка)

ARN роли IAM, которая предоставляет разрешение на загрузку файлов из ведра S3, где хранятся данные/обновления задания. Роль также должна предоставить разрешение IoT на загрузку файлов.

Предупреждение

Дополнительную информацию об устранении проблемы с запутавшимся заместителем см. в разделе Предотвращение проблем с запутавшимся заместителем между службами в руководстве разработчика Amazon Web Services IoT Core.

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

Время действия предварительно подписанных URL-адресов в секундах. Допустимые значения — от 60 до 3600, по умолчанию — 3600 секунд. Предварительно подписанные URL-адреса генерируются, когда Jobs получает запрос MQTT для документа задания.

Краткая форма:

roleArn=string,expiresInSec=long

Формат JSON:

{
  "roleArn": "string",
  "expiresInSec": long
}

--job-executions-rollout-config (структура)

Позволяет создавать поэтапный ввод задания.

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

Максимальное количество устройств, которым будет сообщено о предстоящем задании в минуту. Этот параметр позволяет создавать поэтапный ввод задания.

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

Скорость наращивания ввода задания. Этот параметр позволяет определять экспоненциальную скорость наращивания ввода задания.

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

Минимальное количество устройств, которым будет сообщено о предстоящем задании в минуту в начале ввода задания. Этот параметр позволяет определить начальную скорость ввода задания.

incrementFactor -> (дробное число)

Экспоненциальный коэффициент увеличения скорости ввода задания.

Amazon Web Services IoT Core поддерживает не более одной цифры после запятой (например, 1,5, но не 1,55).

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

Критерии для начала увеличения скорости ввода задания.

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

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

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

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

Краткая форма:

maximumPerMinute=integer,exponentialRate={baseRatePerMinute=integer,incrementFactor=double,rateIncreaseCriteria={numberOfNotifiedThings=integer,numberOfSucceededThings=integer}}

Формат JSON:

{
  "maximumPerMinute": integer,
  "exponentialRate": {
    "baseRatePerMinute": integer,
    "incrementFactor": double,
    "rateIncreaseCriteria": {
      "numberOfNotifiedThings": integer,
      "numberOfSucceededThings": integer
    }
  }
}

--abort-config (структура)

Критерии, определяющие, когда и как происходит прерывание задания.

criteriaList -> (список)

Список критериев, определяющих, когда и как прервать выполнение задания.

(структура)

Критерии, определяющие, когда и как происходит прерывание задания.

failureType -> (строка)

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

action -> (строка)

Тип действия задания для инициирования прерывания задания.

thresholdPercentage -> (дробное число)

Минимальный процент сбоев при выполнении задания, которые должны произойти для инициирования прерывания задания.

Amazon Web Services IoT Core поддерживает не более двух цифр после запятой (например, 10,9 и 10,99, но не 10,999).

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

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

Краткая форма:

criteriaList=[{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer},{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer}]

Формат JSON:

{
  "criteriaList": [
    {
      "failureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
      "action": "CANCEL",
      "thresholdPercentage": double,
      "minNumberOfExecutedThings": integer
    }
    ...
  ]
}

--timeout-config (структура)

Указывает время, которое у каждого устройства есть на завершение выполнения задания. Таймер запускается, когда статус выполнения задания устанавливается в IN_PROGRESS . Если статус выполнения задания не устанавливается в другое конечное состояние до истечения таймера, он автоматически устанавливается в состояние TIMED_OUT .

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

Указывает время в минутах, которое у устройства есть на завершение выполнения задания. Интервал таймаута может составлять от 1 минуты до 7 дней (от 1 до 10080 минут). Интервал таймаута выполнения не может быть обновлён и будет применяться ко всем выполнениям задания для задания. Всякий раз, когда выполнение задания остаётся в состоянии IN_PROGRESS дольше этого интервала, выполнение задания завершается ошибкой и переключается в конечное состояние TIMED_OUT .

Краткая форма:

inProgressTimeoutInMinutes=long

Формат JSON:

{
  "inProgressTimeoutInMinutes": long
}

--tags (список)

Метаданные, которые можно использовать для управления шаблоном задания.

(структура)

Набор пар «ключ-значение», используемых для управления ресурсом.

Key -> (строка)

Ключ тега.

Value -> (строка)

Значение тега.

Краткая форма:

Key=string,Value=string ...

Формат JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--job-executions-retry-config (структура)

Позволяет создать критерии повторной попытки задания.

criteriaList -> (список)

Список критериев, определяющих, сколько попыток повтора допускается для каждого типа сбоя для задания.

(структура)

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

failureType -> (строка)

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

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

Количество попыток повтора, разрешенных для типа сбоя для задания.

Краткая форма:

criteriaList=[{failureType=string,numberOfRetries=integer},{failureType=string,numberOfRetries=integer}]

Формат JSON:

{
  "criteriaList": [
    {
      "failureType": "FAILED"|"TIMED_OUT"|"ALL",
      "numberOfRetries": integer
    }
    ...
  ]
}

--maintenance-windows (список)

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

(структура)

Необязательная конфигурация в SchedulingConfig для настройки повторяющегося окна технического обслуживания с предопределённым временем начала и продолжительностью для развертывания документа задания на все устройства в целевой группе для задания.

startTime -> (строка)

Время начала следующего окна технического обслуживания.

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

Продолжительность следующего окна технического обслуживания.

Краткая форма:

startTime=string,durationInMinutes=integer ...

Формат JSON:

[
  {
    "startTime": "string",
    "durationInMinutes": integer
  }
  ...
]

--destination-package-versions (список)

ARN (Amazon Resource Names) версий пакетов, которые устанавливаются на устройстве при успешном завершении задания. Версия пакета должна быть в состоянии «Опубликовано» или «Устарело», когда задание выполняется. Дополнительную информацию см. в разделе Жизненный цикл версии пакета.

Примечание: Следующие ограничения длины относятся к одному ARN. Допускается до 25 ARN версий пакетов.

(строка)

Синтаксис:

"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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить URL по умолчанию команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить вывод цвета.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. Формат по умолчанию — 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

jobTemplateArn -> (string)

ARN шаблона задачи.

jobTemplateId -> (string)

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

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

Spec-Zone.ru

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