Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

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

Описание

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

Примечание

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

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

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

Синтаксис

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

Имя вещи, которую нужно создать.

Вы не можете изменить имя вещи после её создания. Чтобы изменить имя вещи, необходимо создать новую вещь, присвоить ей новое имя и затем удалить старую вещь.

--thing-type-name (строка)

Имя типа вещи, связанного с новой вещью.

--attribute-payload (структура)

Загрузка атрибутов, которая состоит из до трёх пар имя/значение в документе JSON. Например:

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

attributes -> (массив)

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

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

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

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

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

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

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

Примечание

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

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

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

Синтаксис JSON:

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

--billing-group-name (строка)

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

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

Пример 1: Создание записи вещи в реестре

В следующем примере create-thing создаётся запись устройства в реестре вещей AWS IoT.

aws iot create-thing \
    --thing-name SampleIoTThing

Вывод:

{
    "thingName": "SampleIoTThing",
    "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing",
    "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE "
}

Пример 2: Определение вещи, связанной с типом вещи

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

aws iot create-thing \
    --thing-name "MyLightBulb" \
    --thing-type-name "LightBulb" \
    --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}"

Вывод:

{
    "thingName": "MyLightBulb",
    "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb",
    "thingId": "40da2e73-c6af-406e-b415-15acae538797"
}

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

Вывод

thingName -> (строка)

Имя новой вещи.

thingArn -> (строка)

ARN новой вещи.

thingId -> (строка)

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

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

Spec-Zone.ru

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