Spec-Zone.ru › AWS CLI v2

[ aws . iotevents-данные ]

обновление-детектора-пакетно

Описание

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

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

Синтаксис

  batch-update-detector
--detectors <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]

Параметры

--detectors (список)

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

(структура)

Информация для обновления детектора (экземпляра).

messageId -> (строка)

Идентификатор, который необходимо присвоить обновлению детектора "message". Каждый "messageId" должен быть уникальным в каждой отправленной группе.

detectorModelName -> (строка)

Имя модели детектора, которая создала детекторов (экземпляры).

keyValue -> (строка)

Значение атрибута входного ключа (идентификатор устройства или системы), который вызвал создание этого детектора (экземпляра).

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

Новое состояние, значения переменных и настройки таймеров детектора (экземпляра).

stateName -> (строка)

Имя нового состояния детектора (экземпляра).

variables -> (список)

Новые значения переменных детектора. Любая переменная, значение которой не указано, очищается.

(структура)

Новое значение переменной.

name -> (строка)

Имя переменной.

value -> (строка)

Новое значение переменной.

timers -> (список)

Новые значения таймеров детектора. Любой таймер, значение которого не указано, очищается, и его событие таймаута не произойдёт.

(структура)

Новое значение таймера.

name -> (строка)

Имя таймера.

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

Новое значение таймера (количество секунд до истечения таймера).

Синтаксис JSON:

[
  {
    "messageId": "string",
    "detectorModelName": "string",
    "keyValue": "string",
    "state": {
      "stateName": "string",
      "variables": [
        {
          "name": "string",
          "value": "string"
        }
        ...
      ],
      "timers": [
        {
          "name": "string",
          "seconds": integer
        }
        ...
      ]
    }
  }
  ...
]

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

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

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. См. руководство по началу работы в руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. Использование кавычек со строками в руководстве пользователя AWS CLI .

Для обновления детектора (экземпляра)

Следующий batch-update-detector пример обновляет состояние, значения переменных и настройки таймеров одного или нескольких детекторов (экземпляров) указанной модели детектора.

aws iotevents-data batch-update-detector \
    --cli-input-json file://budFulton-A32.json

Содержимое budFulton-A32.json:

{
    "detectors": [
        {
            "messageId": "00001",
            "detectorModelName": "motorDetectorModel",
            "keyValue": "Fulton-A32",
            "state": {
                "stateName": "Normal",
                "variables": [
                    {
                        "name": "pressureThresholdBreached",
                        "value": "0"
                    }
                ],
                "timers": [
                ]
            }
        }
    ]
}

Вывод:

{
    "batchUpdateDetectorErrorEntries": []
}

Для получения дополнительной информации см. BatchUpdateDetector в руководстве разработчика AWS IoT Events.

Вывод

batchUpdateDetectorErrorEntries -> (список)

Список обновлений детекторов, которые привели к ошибкам. (Если ошибка указана здесь, конкретное обновление не произошло.)

(структура)

Информация об ошибке, возникшей при попытке обновления детектора.

messageId -> (строка)

Идентификатор запроса на обновление, который вызвал ошибку. (Значение "messageId" в запросе на обновление "Detector" объект.)

errorCode -> (строка)

Код ошибки.

errorMessage -> (строка)

Сообщение, описывающее ошибку.

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

Spec-Zone.ru

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