Spec-Zone.ru › AWS CLI v2

[ aws . iotwireless ]

получить-группу-многоадресной-рассылки

Описание

Получает информацию о группе многоадресной рассылки.

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

Синтаксис

  get-multicast-group
--id <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]

Параметры

--id (строка)

Идентификатор группы многоадресной рассылки.

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

Вывод

Arn -> (строка)

Arn группы многоадресной рассылки.

Id -> (строка)

Идентификатор группы многоадресной рассылки.

Name -> (строка)

Название группы многоадресной рассылки.

Description -> (строка)

Описание нового ресурса.

Status -> (строка)

Состояние группы многоадресной рассылки.

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

Информация LoRaWAN, которая должна быть возвращена при получении информации о группе многоадресной рассылки.

RfRegion -> (строка)

Поддерживаемые RfRegions

DlClass -> (строка)

DlClass для LoRaWAM, допустимые значения — ClassB и ClassC.

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

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

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

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

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

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

GatewayList -> (список)

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

(строка)

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

Длительность времени в миллисекундах, в течение которой AWS IoT Core для LoRaWAN будет ждать перед передачей полезной нагрузки многоадресной рассылки следующему шлюзу в списке.

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

Отметка времени создания ресурса.

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

Spec-Zone.ru

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