Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

create-asset

Описание

Создаёт ресурс "актив" на основе существующей модели актива. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise.

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

Синтаксис

  create-asset
--asset-name <value>
--asset-model-id <value>
[--client-token <value>]
[--tags <value>]
[--asset-description <value>]
[--asset-id <value>]
[--asset-external-id <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]

Параметры

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

Дружественное имя для актива.

--asset-model-id (строка)

Идентификатор модели актива, на основе которой создаётся актив. Это может быть либо фактический ID в формате UUID, либо externalId:, за которым следует внешний ID, если он есть. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise, раздел "Ссылка на объекты с внешними идентификаторами".

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

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

--tags (массив)

Список пар ключ-значение, содержащих метаданные для актива. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise, раздел "Маркировка ресурсов IoT SiteWise".

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--asset-description (строка)

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

--asset-id (строка)

ID, который нужно назначить активу (по желанию). IoT SiteWise автоматически генерирует уникальный ID, поэтому этот параметр никогда не является обязательным. Однако, если вы предпочитаете указать свой собственный ID, вы можете указать его здесь в формате UUID. Если вы указываете свой собственный ID, он должен быть глобально уникальным.

--asset-external-id (строка)

Внешний ID, который нужно назначить активу. Внешний ID должен быть уникальным в пределах вашей учётной записи Amazon Web Services. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise, раздел "Использование внешних идентификаторов".

--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, в разделе "Использование кавычек со строками".

Создание актива

Следующий пример создаёт актив ветряной турбины на основе модели актива ветряной турбины.

aws iotsitewise create-asset \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --asset-name "Wind Turbine 1"

Вывод:

{
    "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetStatus": {
        "state": "CREATING"
    }
}

Дополнительную информацию можно найти в руководстве пользователя AWS IoT SiteWise, в разделе "Создание активов".

Вывод

assetId -> (строка)

ID актива в формате UUID. Этот ID однозначно идентифицирует актив в IoT SiteWise и может быть использован в других операциях API IoT SiteWise.

assetArn -> (строка)

ARN актива, имеющий следующий формат.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

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

Статус актива, который содержит состояние (CREATING после успешного выполнения этой операции) и любые сообщения об ошибках.

state -> (строка)

Текущий статус актива.

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

Содержит связанную информацию об ошибках, если таковые имеются.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

details -> (список)

Список подробных ошибок.

(структура)

Содержит подробную информацию об ошибках.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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