Spec-Zone.ru › AWS CLI v2

[ aws . greengrassv2 ]

обновить-сведения-о-соединении

Описание

Обновляет сведения о соединении для устройства ядра Greengrass.

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

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

Синтаксис

  update-connectivity-info
--thing-name <value>
--connectivity-info <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]

Параметры

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

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

--connectivity-info (список)

Сведения о соединении для устройства ядра.

(структура)

Содержит сведения об конечной точке и порте, через которые клиентские устройства могут подключаться к MQTT-посреднику на устройстве ядра Greengrass.

id -> (строка)

Идентификатор сведений о соединении.

hostAddress -> (строка)

IP-адрес или DNS-адрес, через который клиентские устройства могут подключиться к MQTT-посреднику на устройстве ядра Greengrass.

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

Порт, на котором работает MQTT-посредник на устройстве ядра. Этот порт обычно равен 8883, что является стандартным портом для компонента MQTT-посредника, работающего на устройствах ядра.

metadata -> (строка)

Дополнительные метаданные для предоставления клиентским устройствам, подключающимся к этому устройству ядра.

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

id=string,hostAddress=string,portNumber=integer,metadata=string ...

Синтаксис JSON:

[
  {
    "id": "string",
    "hostAddress": "string",
    "portNumber": integer,
    "metadata": "string"
  }
  ...
]

--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
  • text
  • таблица
  • 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.

Для обновления сведений о соединении для устройства ядра Greengrass

Следующий пример update-connectivity-info получает сведения о соединении для устройства ядра Greengrass. Клиентские устройства используют эти сведения для подключения к MQTT-посреднику, работающему на этом устройстве ядра.

aws greengrassv2 update-connectivity-info \
    --thing-name MyGreengrassCore \
    --cli-input-json file://core-device-connectivity-info.json

Содержимое core-device-connectivity-info.json:

{
    "connectivityInfo": [
        {
            "hostAddress": "192.0.2.0",
            "portNumber": 8883,
            "id": "localIP_192.0.2.0"
        }
    ]
}

Вывод:

{
    "version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

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

Вывод

version -> (строка)

Новая версия сведений о соединении для устройства ядра.

message -> (строка)

Сообщение об обновлении запроса сведений о соединении.

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

Spec-Zone.ru

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