Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

создать-группу-вещей

Описание

Создать группу вещей.

Примечание

Это операция управления. Обратитесь к Разрешениям для получения информации о разрешении действий управления.

Если ThingGroup, которую вы создаёте, имеет точно такие же атрибуты, как существующая ThingGroup, вы получите ответ 200 об успехе.

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

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

Синтаксис

  create-thing-group
--thing-group-name <value>
[--parent-group-name <value>]
[--thing-group-properties <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 (строка)

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

--parent-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
  }
}

--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 (строка)

Переопределить 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.

Пример 1: Создание группы вещей

В следующем create-thing-group примере создаётся группа вещей с именем LightBulbs, описанием и двумя атрибутами.

aws iot create-thing-group \
    --thing-group-name LightBulbs \
    --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}"

Вывод:

{
    "thingGroupName": "LightBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs",
    "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331"
}

Пример 2: Создание группы вещей, входящей в состав родительской группы

В следующем create-thing-group примере создаётся группа вещей с именем HalogenBulbs, имеющая родительскую группу вещей с именем LightBulbs.

aws iot create-thing-group \
    --thing-group-name HalogenBulbs \
    --parent-group-name LightBulbs

Вывод:

{
    "thingGroupName": "HalogenBulbs",
    "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs",
    "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e"
}

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

Вывод

thingGroupName -> (строка)

Имя группы вещей.

thingGroupArn -> (строка)

ARN группы вещей.

thingGroupId -> (строка)

Идентификатор группы вещей.

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

Spec-Zone.ru

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