describe-asset-composite-model

Описание

Получает информацию об агрегированной модели актива (также известной как компонент актива). AssetCompositeModel — это экземпляр AssetModelCompositeModel. Если вы хотите увидеть информацию о модели, на которой она основана, вызовите DescribeAssetModelCompositeModel.

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

Синтаксис

  describe-asset-composite-model
--asset-id <value>
--asset-composite-model-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-id (строка)

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

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

Идентификатор агрегированной модели на этом активе. Это может быть фактический идентификатор в формате UUID или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе Ссылка на объекты с внешними идентификаторами в Руководстве пользователя 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
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

on
off
auto

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

Вывод

assetId -> (строка)

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

assetCompositeModelId -> (строка)

Идентификатор агрегированной модели на этом активе.

assetCompositeModelExternalId -> (строка)

Внешний идентификатор, назначаемый модели актива.

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

assetCompositeModelPath -> (список)

Путь к агрегированной модели, отображающий родительские агрегированные модели.

(структура)

Представляет один уровень между агрегированной моделью и корнем актива.

id -> (строка)

Идентификатор сегмента пути.

name -> (строка)

Имя сегмента пути.

assetCompositeModelName -> (строка)

Уникальное, понятное имя для агрегированной модели.

assetCompositeModelDescription -> (строка)

Описание агрегированной модели.

assetCompositeModelType -> (строка)

Тип агрегированной модели. Допустимые значения — AWS/ALARM, CUSTOM или AWS/L4E_ANOMALY.

assetCompositeModelProperties -> (список)

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

(структура)

Содержит информацию об активе.

id -> (строка)

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

name -> (строка)

Имя свойства.

alias -> (строка)

Псевдоним, определяющий свойство, например, путь потока данных сервера OPC-UA (например, /company/windfarm/3/turbine/7/temperature). Дополнительную информацию см. в разделе Сопоставление промышленных потоков данных со свойствами актива в Руководстве пользователя IoT SiteWise.

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

Тема и состояние уведомления свойства актива. Дополнительную информацию см. в UpdateAssetProperty.

topic -> (строка)

MQTT-тема, в которую IoT SiteWise публикует уведомления об обновлениях значения свойства.

state -> (строка)

Текущее состояние уведомления.

dataType -> (строка)

Тип данных свойства актива.

dataTypeSpec -> (строка)

Тип данных структуры для этого свойства. Этот параметр существует для свойств, имеющих тип данных STRUCT.

unit -> (строка)

Единица измерения свойства актива (например, Newtons или RPM).

path -> (список)

Структурированный путь к свойству от корня актива.

(структура)

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

id -> (строка)

Идентификатор сегмента пути.

name -> (строка)

Имя сегмента пути.

externalId -> (строка)

Внешний идентификатор свойства актива. Дополнительную информацию см. в разделе Использование внешних идентификаторов в Руководстве пользователя IoT SiteWise.

assetCompositeModelSummaries -> (список)

Список сводок агрегированной модели.

(структура)

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

id -> (строка)

Идентификатор агрегированной модели, описываемой этой сводкой.

externalId -> (строка)

Внешний идентификатор, назначаемый модели актива.

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

name -> (строка)

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

type -> (строка)

Тип модели актива.

ASSET_MODEL – (по умолчанию) Модель актива, которую можно использовать для создания активов. Не может быть включена в качестве компонента в другой модели актива.
COMPONENT_MODEL – Многоразовой компонент, который можно включить в агрегированные модели других моделей актива. Нельзя напрямую создавать активы из этого типа модели актива.

description -> (строка)

Описание агрегированной модели, описываемой этой сводкой.

path -> (список)

Путь, включающий все компоненты модели актива для актива.

(структура)

Представляет один уровень между агрегированной моделью и корнем актива.

id -> (строка)

Идентификатор сегмента пути.

name -> (строка)

Имя сегмента пути.

actionDefinitions -> (список)

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

(структура)

Содержит определение действия.

actionDefinitionId -> (строка)

Идентификатор определения действия.

actionName -> (строка)

Имя определения действия.

actionType -> (строка)

Тип определения действия.