Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

создание динамической группы устройств

Описание

Создаёт динамическую группу устройств.

Требуется разрешение на доступ к действию CreateDynamicThingGroup.

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

Синтаксис

  create-dynamic-thing-group
--thing-group-name <value>
[--thing-group-properties <value>]
[--index-name <value>]
--query-string <value>
[--query-version <value>]
[--tags <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-group-name (строка)

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

--thing-group-properties (структура)

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

thingGroupDescription -> (строка)

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

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

Атрибуты группы устройств в формате JSON.

attributes -> (массив)

Строка JSON, содержащая до трёх пар «ключ-значение» в формате JSON. Например:

{\"attributes\":{\"string1\":\"string2\"}}

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

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

merge -> (логическое значение)

Указывает, сливаются ли предоставленные в AttributePayload атрибуты сохранёнными в реестре, или же заменяют их.

Чтобы удалить атрибут, вызовите UpdateThing со значением атрибута пустым.

Примечание

Атрибут merge действителен только при вызове UpdateThing или UpdateThingGroup.

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

thingGroupDescription=string,attributePayload={attributes={KeyName1=string,KeyName2=string},merge=boolean}

Синтаксис JSON:

{
  "thingGroupDescription": "string",
  "attributePayload": {
    "attributes": {"string": "string"
      ...},
    "merge": true|false
  }
}

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

Имя индекса динамической группы устройств.

Примечание

В настоящее время поддерживается один индекс: AWS_Things.

--query-string (строка)

Строка запроса поиска динамической группы устройств.

См. Синтаксис запроса для получения информации о синтаксисе строки запроса.

--query-version (строка)

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

Примечание

В настоящее время поддерживается одна версия запроса: «2017-09-30». Если не указано, версия запроса по умолчанию имеет это значение.

--tags (список)

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

(структура)

Набор пар «ключ-значение», используемых для управления ресурсом.

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

Ключ тега.

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 (строка)

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

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

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

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

Следующий create-dynamic-thing-group пример создаёт динамическую группу устройств, содержащую любое устройство с атрибутом температуры, превышающим 60 градусов. Вам необходимо включить индексирование флота AWS IoT, прежде чем вы сможете использовать динамические группы устройств.

aws iot create-dynamic-thing-group \
    --thing-group-name "RoomTooWarm" \
    --query-string "attributes.temperature>60"

Вывод:

{
    "thingGroupName": "RoomTooWarm",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm",
    "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1",
    "indexName": "AWS_Things",
    "queryString": "attributes.temperature>60",
    "queryVersion": "2017-09-30"
}

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

Вывод

thingGroupName -> (строка)

Имя динамической группы устройств.

thingGroupArn -> (строка)

ARN динамической группы устройств.

thingGroupId -> (строка)

ID динамической группы устройств.

indexName -> (строка)

Имя индекса динамической группы устройств.

queryString -> (строка)

Строка запроса поиска динамической группы устройств.

queryVersion -> (строка)

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

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

Spec-Zone.ru

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