Spec-Zone.ru › AWS CLI v2

[ aws . iot-managed-integrations ]

get-ota-task

Описание

Получить задачу обновления по воздуху (OTA).

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

Синтаксис

  get-ota-task
--identifier <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]

Параметры

--identifier (строка)

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

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

Вывод

TaskId -> (строка)

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

TaskArn -> (строка)

Amazon Resource Name (ARN) задачи обновления по воздуху (OTA).

Description -> (строка)

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

S3Url -> (строка)

URL хранилища Amazon S3, где хранится задача обновления по воздуху (OTA).

Protocol -> (строка)

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

OtaType -> (строка)

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

OtaTargetQueryString -> (строка)

Строка запроса для добавления элементов в группу устройств.

OtaMechanism -> (строка)

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

Target -> (список)

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

(строка)

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

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

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

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

TaskConfigurationId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

processingTargets -> (список)

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

(строка)

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

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

EndBehavior -> (строка)

Указывает поведение по завершению всех выполнений задачи после того, как задача достигает выбранного endTime. Если endTime не выбрана при создании задачи, то endBehavior не применяется.

EndTime -> (строка)

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

MaintenanceWindows -> (список)

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

(структура)

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

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

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

StartTime -> (строка)

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

StartTime -> (строка)

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

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

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

RetryConfigCriteria -> (список)

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

(структура)

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

FailureType -> (строка)

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

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

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

Status -> (строка)

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

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

Spec-Zone.ru

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