Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

describe-job-template

Описание

Возвращает информацию о шаблоне задания.

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

Синтаксис

  describe-job-template
--job-template-id <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 (строка)

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

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

Вывод

jobTemplateArn -> (строка)

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

jobTemplateId -> (строка)

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

description -> (строка)

Описание шаблона задания.

documentSource -> (строка)

Ссылка S3 на документ задания.

document -> (строка)

Документ задания.

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

Время, в секундах с начала эпохи, когда был создан шаблон задания.

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

Настройка для предварительно подписанных URL S3.

roleArn -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

incrementFactor -> (двойное число)

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

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

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

Критерии для инициирования увеличения темпа развертывания задания.

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

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

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

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

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

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

criteriaList -> (список)

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

(структура)

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

failureType -> (строка)

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

action -> (строка)

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

thresholdPercentage -> (двойное число)

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

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

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

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

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

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

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

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

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

Настройка, которая определяет, сколько попыток повтора разрешается для каждого типа сбоев для задания.

criteriaList -> (список)

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

(структура)

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

failureType -> (строка)

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

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

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

maintenanceWindows -> (список)

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

(структура)

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

startTime -> (строка)

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

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

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

destinationPackageVersions -> (список)

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

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

(строка)

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

Spec-Zone.ru

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