Spec-Zone.ru › AWS CLI v2

[ aws . iotwireless ]

создать-беспроводной-шлюз

Описание

Создаёт беспроводной шлюз.

Примечание

При создании беспроводного шлюза могут возникнуть ошибки дублирования по следующим причинам.

  • Если вы указали значение GatewayEui, которое уже существует.
  • Если вы использовали ClientRequestToken с теми же параметрами в течение последних 10 минут.

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

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

Синтаксис

  create-wireless-gateway
[--name <value>]
[--description <value>]
[--tags <value>]
[--client-request-token <value>]
--lorawan <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]

Параметры

--name (строка)

Имя нового ресурса.

--description (строка)

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

--tags (список)

Теги, которые нужно прикрепить к новому беспроводному шлюзу. Теги — это метаданные, которые можно использовать для управления ресурсом.

(структура)

Простая метка, состоящая из пары ключ-значение, определённой пользователем

Ключ -> (строка)

Значение ключа тега.

Значение -> (строка)

Значение тега.

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-request-token (строка)

Каждый ресурс должен иметь уникальный маркер запроса клиента. Маркер запроса клиента используется для обеспечения идемпотентности. Он гарантирует, что запрос выполняется не более одного раза. Если вы повторите запрос с тем же маркером и теми же параметрами, запрос будет выполнен успешно. Однако если вы попытаетесь создать новый ресурс с тем же маркером, но другими параметрами, произойдёт конфликт HTTP 409. Если вы опустите это значение, AWS SDK автоматически сгенерирует уникальный маркер запроса. Дополнительную информацию об идемпотентности см. в статье Обеспечение идемпотентности в запросах API Amazon EC2.

--lorawan (структура)

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

GatewayEui -> (строка)

Значение EUI шлюза.

RfRegion -> (строка)

Значение полосы частот (RFRegion).

JoinEuiFilters -> (список)

Список JoinEuiRange, используемый шлюзами LoRa для фильтрации кадров LoRa.

(список)

Пара join EUI, описывающая диапазон [BegEui, EndEui], обе границы включительно.

(строка)

NetIdFilters -> (список)

Список значений NetId, используемых шлюзами LoRa для фильтрации восходящих кадров.

(строка)

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

SubBands -> (список)

Список целых чисел, указывающих, какие поддиапазоны поддерживает шлюз LoRa.

(целое число)

Подмножество поддерживаемых каналов частот в определённой полосе RFRegion.

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

Информация об объекте Beaconing, которая состоит из параметров скорости передачи данных и частоты.

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

Скорость передачи данных для шлюзов, которые отправляют маяки.

Frequencies -> (список)

Список частот, используемых шлюзами для отправки маяков.

(целое число)

MaxEirp -> (число с плавающей точкой)

Значение MaxEIRP.

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

GatewayEui=string,RfRegion=string,JoinEuiFilters=[[string,string],[string,string]],NetIdFilters=string,string,SubBands=integer,integer,Beaconing={DataRate=integer,Frequencies=[integer,integer]},MaxEirp=float

Синтаксис JSON:

{
  "GatewayEui": "string",
  "RfRegion": "string",
  "JoinEuiFilters": [
    ["string", ...]
    ...
  ],
  "NetIdFilters": ["string", ...],
  "SubBands": [integer, ...],
  "Beaconing": {
    "DataRate": integer,
    "Frequencies": [integer, ...]
  },
  "MaxEirp": float
}

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, 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.

Для создания беспроводного шлюза

В следующем create-wireless-gateway примере создаётся шлюз для устройства LoRaWAN.

aws iotwireless create-wireless-gateway \
    --lorawan GatewayEui="a1b2c3d4567890ab",RfRegion="US915" \
    --name "myFirstLoRaWANGateway" \
    --description "Using my first LoRaWAN gateway"

Вывод:

{
    "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/12345678-a1b2-3c45-67d8-e90fa1b2c34d",
    "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d"
}

Дополнительную информацию см. в разделе Подключение устройств и шлюзов к AWS IoT Core для LoRaWAN в Руководстве разработчика AWS IoT.

Вывод

Arn -> (строка)

Amazon Resource Name нового ресурса.

Id -> (строка)

Идентификатор нового беспроводного шлюза.

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

Spec-Zone.ru

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