создание-модели-актива-составной-модели

Описание

Создает пользовательскую составную модель из указанных определений свойств и иерархии. Существует два типа пользовательских составных моделей, inline и component-model-based .

Используйте пользовательские составные модели на основе моделей компонентов для определения стандартных, многократно используемых компонентов. Пользовательская составная модель на основе модели компонента состоит из имени, описания и идентификатора модели компонента, на которую она ссылается. Пользовательская составная модель на основе модели компонента не имеет собственных свойств; её ссылка на модель компонента предоставляет свои связанные свойства для всех созданных активов. Для получения дополнительной информации см. Пользовательские составные модели (компоненты) в Руководстве пользователя IoT SiteWise .

Используйте встроенные пользовательские составные модели для организации свойств модели актива. Свойства встроенных пользовательских составных моделей локальны для модели актива, где они включены, и не могут использоваться для создания нескольких активов.

Для создания модели на основе модели компонента укажите composedAssetModelId существующей модели актива с assetModelType COMPONENT_MODEL .

Для создания встроенной модели укажите assetModelCompositeModelProperties и не включайте composedAssetModelId .

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

Синтаксис

  create-asset-model-composite-model
--asset-model-id <value>
[--asset-model-composite-model-external-id <value>]
[--parent-asset-model-composite-model-id <value>]
[--asset-model-composite-model-id <value>]
[--asset-model-composite-model-description <value>]
--asset-model-composite-model-name <value>
--asset-model-composite-model-type <value>
[--client-token <value>]
[--composed-asset-model-id <value>]
[--asset-model-composite-model-properties <value>]
[--if-match <value>]
[--if-none-match <value>]
[--match-for-version-type <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-model-id (строка)

Идентификатор модели актива, частью которой является эта составная модель.

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

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

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

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

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

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

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

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

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

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

Уникальное имя составной модели.

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

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

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

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

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

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

--asset-model-composite-model-properties (список)

Определения свойств составной модели. Для получения дополнительной информации см. Встроенные пользовательские составные модели в Руководстве пользователя IoT SiteWise .

Вы можете указать до 200 свойств на одну составную модель. Для получения дополнительной информации см. Квоты в Руководстве пользователя IoT SiteWise .

(структура)

Содержит определение свойства модели актива. Это определение свойства применяется ко всем активам, созданным из модели актива.

id -> (строка)

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

externalId -> (строка)

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

name -> (строка)

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

dataType -> (строка)

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

Если вы указываете STRUCT, вы также должны указать dataTypeSpec, чтобы определить тип структуры для этого свойства.

dataTypeSpec -> (строка)

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

Варианты этого параметра зависят от типа составной модели, в которой вы определяете это свойство. Используйте AWS/ALARM_STATE для состояния тревоги в моделях составных тревог.

unit -> (строка)

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

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

Тип определения свойства (см. PropertyType). Вы можете указать только один тип в определении свойства.

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

Определяет свойство атрибута актива. Атрибут обычно содержит статическую информацию, например, серийный номер ветряной турбины IIoT.

defaultValue -> (строка)

Значение по умолчанию атрибута свойства модели актива. Все активы, которые вы создаете из модели актива, содержат это значение атрибута. Вы можете обновить значение атрибута после создания актива. Дополнительную информацию см. в разделе Обновление значений атрибутов в Руководстве пользователя IoT SiteWise.

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

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

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

Настройка обработки для данного свойства измерения. Вы можете настроить измерения, чтобы они хранились на границе или передавались в облако Amazon Web Services. По умолчанию измерения передаются в облако.

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

Настройка передачи для данного свойства измерения.

state -> (строка)

Состояние передачи для данного свойства.

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

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

expression -> (строка)

Математическое выражение, определяющее функцию преобразования. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.

Дополнительную информацию см. в разделе Квоты в Руководстве пользователя IoT SiteWise.

variables -> (список)

Список переменных, используемых в выражении.

(структура)

Содержит информацию о переменной выражения.

name -> (строка)

Наименование переменной для использования в выражении.

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

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

propertyId -> (строка)

Идентификатор свойства, используемого в качестве переменной. Вы можете использовать свойство name, если оно из той же модели актива. Если свойство имеет внешний ID, вы можете указать externalId:, за которым следует внешний ID. Дополнительную информацию см. в разделе Использование внешних идентификаторов в Руководстве пользователя IoT SiteWise.

hierarchyId -> (строка)

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

Используется идентификатор иерархии вместо идентификатора модели, потому что вы можете иметь несколько иерархий, использующих одну и ту же модель, и, следовательно, тот же propertyId. Например, вы можете иметь отдельно сгруппированные активы, которые происходят из одной и той же модели актива. Дополнительную информацию см. в разделе Иерархии активов в Руководстве пользователя IoT SiteWise.

propertyPath -> (список)

Путь к свойству.

(структура)

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

id -> (строка)

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

name -> (строка)

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

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

Настройка обработки для данного свойства преобразования. Вы можете настроить преобразования, чтобы они хранились на границе или передавались в облако Amazon Web Services. Вы также можете настроить преобразования, чтобы они вычислялись на границе или в облаке.

computeLocation -> (строка)

Место вычисления для данного свойства преобразования.

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

Настройка передачи для данного свойства.

state -> (строка)

Состояние передачи для данного свойства.

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

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

expression -> (строка)

Математическое выражение, определяющее функцию агрегирования метрики. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.

Дополнительную информацию см. в разделе Квоты в Руководстве пользователя IoT SiteWise.

variables -> (список)

Список переменных, используемых в выражении.

(структура)

Содержит информацию о переменной выражения.

name -> (строка)

Наименование переменной для использования в выражении.

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

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

propertyId -> (строка)

hierarchyId -> (строка)

propertyPath -> (список)

Путь к свойству.

(структура)

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

id -> (строка)

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

name -> (строка)

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

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

Окно (интервал времени), в течение которого IoT SiteWise вычисляет выражение агрегирования метрики. IoT SiteWise вычисляет одну точку данных за window.

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

Окно интервала времени с накатыванием.

interval -> (строка)

Интервал времени для окна с накатыванием. Время интервала должно быть от 1 минуты до 1 недели.

IoT SiteWise вычисляет 1w интервал в конце воскресенья в полночь каждую неделю (UTC), 1d интервал в конце каждого дня в полночь (UTC), 1h интервал в конце каждого часа и так далее.

При агрегации точек данных для вычислений метрики, начало каждого интервала исключается, а конец каждого интервала включается. IoT SiteWise помещает вычисленную точку данных в конце интервала.

offset -> (строка)

Смещение для окна с накатыванием. Параметр offset принимает следующие значения:

Время смещения. Например, если вы укажете 18h для offset и 1d для interval, IoT SiteWise агрегирует данные следующим образом:
- Если вы создаете метрику до 18:00 (UTC) или в 18:00 (UTC), вы получите первый результат агрегации в 18:00 (UTC) в день создания метрики.
- Если вы создаете метрику после 18:00 (UTC), вы получите первый результат агрегации в 18:00 (UTC) на следующий день.
Формат ISO 8601. Например, если вы укажете PT18H для offset и 1d для interval, IoT SiteWise агрегирует данные следующим образом:
- Если вы создаете метрику до 18:00 (UTC) или в 18:00 (UTC), вы получите первый результат агрегации в 18:00 (UTC) в день создания метрики.
- Если вы создаете метрику после 18:00 (UTC), вы получите первый результат агрегации в 18:00 (UTC) на следующий день.
24-часовой формат. Например, если вы укажете 00:03:00 для offset, 5m для interval, и вы создаете метрику в 14:00 (UTC), вы получите первый результат агрегации в 14:03 (UTC). Вы получите второй результат агрегации в 14:08 (UTC).
Временная зона смещения. Например, если вы укажете 2021-07-23T18:00-08 для offset и 1d для interval, IoT SiteWise агрегирует данные следующим образом:
- Если вы создаете метрику до 18:00 (PST) или в 18:00 (PST), вы получите первый результат агрегации в 18:00 (PST) в день создания метрики.
- Если вы создаете метрику после 18:00 (PST), вы получите первый результат агрегации в 18:00 (PST) на следующий день.

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

Настройка обработки для данного свойства метрики. Вы можете настроить метрики, чтобы они вычислялись на границе или в облаке Amazon Web Services. По умолчанию метрики передаются в облако.

computeLocation -> (строка)

Место вычисления для данного свойства метрики.

Синтаксис JSON:

[
  {
    "id": "string",
    "externalId": "string",
    "name": "string",
    "dataType": "STRING"|"INTEGER"|"DOUBLE"|"BOOLEAN"|"STRUCT",
    "dataTypeSpec": "string",
    "unit": "string",
    "type": {
      "attribute": {
        "defaultValue": "string"
      },
      "measurement": {
        "processingConfig": {
          "forwardingConfig": {
            "state": "DISABLED"|"ENABLED"
          }
        }
      },
      "transform": {
        "expression": "string",
        "variables": [
          {
            "name": "string",
            "value": {
              "propertyId": "string",
              "hierarchyId": "string",
              "propertyPath": [
                {
                  "id": "string",
                  "name": "string"
                }
                ...
              ]
            }
          }
          ...
        ],
        "processingConfig": {
          "computeLocation": "EDGE"|"CLOUD",
          "forwardingConfig": {
            "state": "DISABLED"|"ENABLED"
          }
        }
      },
      "metric": {
        "expression": "string",
        "variables": [
          {
            "name": "string",
            "value": {
              "propertyId": "string",
              "hierarchyId": "string",
              "propertyPath": [
                {
                  "id": "string",
                  "name": "string"
                }
                ...
              ]
            }
          }
          ...
        ],
        "window": {
          "tumbling": {
            "interval": "string",
            "offset": "string"
          }
        },
        "processingConfig": {
          "computeLocation": "EDGE"|"CLOUD"
        }
      }
    }
  }
  ...
]

--if-match (строка)

Ожидаемый текущий тег сущности (ETag) для последней или активной версии модели актива (указанной с помощью matchForVersionType ). Запрос на создание отклоняется, если тег не соответствует текущему тегу сущности последней или активной версии. См. Оптимистическую блокировку для записи моделей активов в Руководстве пользователя IoT SiteWise.

--if-none-match (строка)

Принимает *, чтобы отклонить запрос на создание, если для модели актива уже существует активная версия (указанная с помощью matchForVersionType как ACTIVE ).

--match-for-version-type (строка)

Указывает тип версии модели актива (LATEST или ACTIVE ), используемый совместно с заголовками If-Match или If-None-Match для определения целевого ETag для операции создания.

Возможные значения:

LATEST
ACTIVE

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

Вывод

assetModelCompositeModelId -> (строка)

ID составленной модели актива. Вы можете использовать этот ID при вызове других API IoT SiteWise.

assetModelCompositeModelPath -> (список)

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

(структура)

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

id -> (строка)

ID сегмента пути.

name -> (строка)

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

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

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

state -> (строка)

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

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

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

code -> (строка)

Код ошибки.

message -> (строка)

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

details -> (список)

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

(структура)

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

code -> (строка)

Код ошибки.

message -> (строка)

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