Spec-Zone.ru › AWS CLI v2

[ aws . iot-managed-integrations ]

create-ota-task-configuration

Описание

Создайте конфигурацию задачи обновления по воздуху (OTA).

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

Синтаксис

  create-ota-task-configuration
[--description <value>]
[--name <value>]
[--push-config <value>]
[--client-token <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]

Параметры

--description (строка)

Описание конфигурации задачи обновления по воздуху (OTA).

--name (строка)

Имя задачи обновления по воздуху (OTA).

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

Описание типа конфигурации, используемой для задачи обновления по воздуху (OTA).

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

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

AbortConfigCriteriaList -> (список)

Список критериев для конфигурации прерывания.

(структура)

Структура, представляющая один критерий прерывания.

Action -> (строка)

Действие, выполняемое конфигурацией прерывания.

FailureType -> (строка)

Тип ошибки критерия прерывания задачи обновления по воздуху (OTA).

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

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

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

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

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

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

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

Структура, представляющая экспоненциальную скорость развертывания для задачи обновления по воздуху (OTA).

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

Базовая скорость в минуту для развертывания задачи обновления по воздуху (OTA).

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

Коэффициент нарастания для увеличения скорости развертывания задачи обновления по воздуху (OTA).

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

Критерии для увеличения скорости развертывания задачи обновления по воздуху (OTA).

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

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

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

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

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

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

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

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

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

Указывает время, которое у устройства есть, чтобы завершить выполнение этой задачи. Интервал таймаута может составлять от 1 минуты до 7 дней.

JSON Синтаксис:

{
  "AbortConfig": {
    "AbortConfigCriteriaList": [
      {
        "Action": "CANCEL",
        "FailureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
        "MinNumberOfExecutedThings": integer,
        "ThresholdPercentage": double
      }
      ...
    ]
  },
  "RolloutConfig": {
    "ExponentialRolloutRate": {
      "BaseRatePerMinute": integer,
      "IncrementFactor": double,
      "RateIncreaseCriteria": {
        "numberOfNotifiedThings": integer,
        "numberOfSucceededThings": integer
      }
    },
    "MaximumPerMinute": integer
  },
  "TimeoutConfig": {
    "InProgressTimeoutInMinutes": long
  }
}

--client-token (строка)

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

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, 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.

Вывод

TaskConfigurationId -> (строка)

Идентификатор конфигурации задачи обновления по воздуху (OTA).

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

Spec-Zone.ru

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