Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

создать-тип-вещи

Описание

Создаёт новый тип вещи. Если этот вызов выполняется несколько раз с тем же именем типа вещи и конфигурацией, вызов будет успешным. Если этот вызов выполняется с тем же именем типа вещи, но с другой конфигурацией, будет выброшено исключение ResourceAlreadyExistsException.

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

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

Синтаксис

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

Имя типа вещи.

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

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

thingTypeDescription -> (строка)

Описание типа вещи.

searchableAttributes -> (список)

Список имен атрибутов вещи, по которым можно искать.

(строка)

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

Конфигурация для добавления пользовательских свойств для обогащения сообщений MQTT 5.

propagatingAttributes -> (список)

Объект, представляющий передаваемые атрибуты вещи и атрибуты подключения.

(структура)

Объект, представляющий атрибут подключения, атрибут вещи и ключ пользовательского свойства.

userPropertyKey -> (строка)

Ключ пары ключ-значение пользовательского свойства.

thingAttribute -> (строка)

Пользовательский атрибут вещи, который передаётся для обогащения сообщений MQTT 5.

connectionAttribute -> (строка)

Атрибут, связанный с подключением устройства к Amazon Web Services IoT Core.

Синтаксис JSON:

{
  "thingTypeDescription": "string",
  "searchableAttributes": ["string", ...],
  "mqtt5Configuration": {
    "propagatingAttributes": [
      {
        "userPropertyKey": "string",
        "thingAttribute": "string",
        "connectionAttribute": "string"
      }
      ...
    ]
  }
}

--tags (список)

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

(структура)

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

Key -> (строка)

Ключ тега.

Value -> (строка)

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

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

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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для определения типа вещи

Следующий create-thing-type пример определяет тип вещи и связанные атрибуты.

aws iot create-thing-type \
    --thing-type-name "LightBulb" \
    --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model"

Вывод:

{
    "thingTypeName": "LightBulb",
    "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb",
    "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190"
}

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

Вывод

thingTypeName -> (строка)

Имя типа вещи.

thingTypeArn -> (строка)

Amazon Resource Name (ARN) типа вещи.

thingTypeId -> (строка)

Идентификатор типа вещи.

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

Spec-Zone.ru

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