Spec-Zone.ru › AWS CLI v2

[ aws . greengrassv2 ]

batch-associate-client-device-with-core-device

Описание

Связывает список клиентских устройств с устройством ядра. Используйте эту операцию API, чтобы указать, какие клиентские устройства могут обнаружить устройство ядра с помощью облачного обнаружения. При облачном обнаружении клиентские устройства подключаются к IoT Greengrass, чтобы получить информацию о подключении и сертификаты связанных устройств ядра. Дополнительную информацию см. в разделе Настройка облачного обнаружения в руководстве разработчика IoT Greengrass V2.

Примечание

Клиентские устройства — это локальные устройства IoT, которые подключаются к устройству ядра IoT Greengrass и взаимодействуют с ним через MQTT. Вы можете подключить клиентские устройства к устройству ядра, чтобы синхронизировать сообщения MQTT и данные с Amazon Web Services IoT Core и взаимодействовать с клиентскими устройствами в компонентах Greengrass. Дополнительную информацию см. в разделе Взаимодействие с локальными устройствами IoT в руководстве разработчика IoT Greengrass V2.

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

Синтаксис

  batch-associate-client-device-with-core-device
[--entries <value>]
--core-device-thing-name <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]

Параметры

--entries (список)

Список клиентских устройств для связывания.

(структура)

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

thingName -> (строка)

Имя IoT-вещи, представляющей клиентское устройство для связывания.

Сокращенный синтаксис:

thingName=string ...

Синтаксис JSON:

[
  {
    "thingName": "string"
  }
  ...
]

--core-device-thing-name (строка)

Имя устройства ядра. Это также имя IoT-вещи.

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

Примеры

Примечание

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

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

Связывание клиентских устройств с устройством ядра

Следующий batch-associate-client-device-with-core-device пример связывает два клиентских устройства с устройством ядра.

aws greengrassv2 batch-associate-client-device-with-core-device \
  --core-device-thing-name MyGreengrassCore \
  --entries thingName=MyClientDevice1 thingName=MyClientDevice2

Вывод:

{
    "errorEntries": []
}

Дополнительную информацию см. в разделе Взаимодействие с локальными устройствами IoT в руководстве разработчика AWS IoT Greengrass V2.

Вывод

errorEntries -> (список)

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

(структура)

Содержит ошибку, возникшую при попытке связать клиентское устройство с устройством ядра. Операция BatchAssociateClientDeviceWithCoreDevice возвращает список таких ошибок.

thingName -> (строка)

Имя IoT-вещи, запрос на связывание которой не удался.

code -> (строка)

Код ошибки запроса.

message -> (строка)

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

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

Spec-Zone.ru

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