[ aws . iotsitewise ]
обновление-модели-актива-составной-модели
Описание
Обновляет составную модель и все активы, созданные на основе этой модели. Каждый актив, созданный на основе модели, наследует обновлённые свойства и определения иерархии модели актива. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise в разделе Обновление активов и моделей.
Предупреждение
Если вы удаляете свойство из составной модели актива, IoT SiteWise удаляет все предыдущие данные для этого свойства. Вы не можете изменить тип или тип данных существующего свойства.
Чтобы заменить существующее свойство составной модели актива новым свойством с тем же name, выполните следующие действия:
- Отправьте запрос
UpdateAssetModelCompositeModelсо всем существующим свойством, удалённым. - Отправьте второй запрос
UpdateAssetModelCompositeModel, который включает новое свойство. Новое свойство актива будет иметь то жеname, что и предыдущее, и IoT SiteWise сгенерирует новый уникальныйid.
См. также: Документацию API AWS
Синтаксис
update-asset-model-composite-model
--asset-model-id <value>
--asset-model-composite-model-id <value>
[--asset-model-composite-model-external-id <value>]
[--asset-model-composite-model-description <value>]
--asset-model-composite-model-name <value>
[--client-token <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-id (строка)
--asset-model-composite-model-external-id (строка)
--asset-model-composite-model-description (строка)
--asset-model-composite-model-name (строка)
--client-token (строка)
--asset-model-composite-model-properties (список)
Определения свойств составной модели. Дополнительную информацию можно найти в разделе Встроенные пользовательские составные модели в руководстве пользователя IoT SiteWise.
Вы можете указать до 200 свойств на составную модель. Дополнительную информацию можно найти в разделе Квоты в руководстве пользователя IoT SiteWise.
(структура)
Содержит информацию о свойстве модели актива.
id -> (строка)
Идентификатор свойства модели актива.
- Если вы вызываете UpdateAssetModel для создания нового свойства: Вы можете указать его идентификатор здесь, если хотите. IoT SiteWise автоматически генерирует для вас уникальный идентификатор, поэтому этот параметр никогда не требуется. Однако, если вы предпочитаете указать свой собственный идентификатор, вы можете указать его здесь в формате UUID. Если вы указываете свой собственный идентификатор, он должен быть глобально уникальным.
- Если вы вызываете UpdateAssetModel для изменения существующего свойства: Это может быть либо фактический идентификатор в формате UUID, либо
externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию можно найти в руководстве пользователя IoT SiteWise в разделе Ссылка на объекты с внешними идентификаторами.
externalId -> (строка)
name -> (строка)
dataType -> (строка)
Тип данных свойства модели актива.
Если вы указываете STRUCT, вы также должны указать dataTypeSpec, чтобы определить тип структуры для этого свойства.
dataTypeSpec -> (строка)
STRUCT.unit -> (строка)
Newtons или RPM.type -> (структура)
Тип свойства (см. PropertyType).
attribute -> (структура)
Указывает свойство-атрибут актива. Атрибут, как правило, содержит статическую информацию, например, серийный номер ветряной турбины IIoT.
defaultValue -> (строка)
measurement -> (структура)
Указывает свойство-измерение актива. Измерение представляет поток исходных данных датчика устройства, например, временные метки значений температуры или временные метки значений мощности.
processingConfig -> (структура)
Конфигурация обработки для данного свойства измерения. Вы можете настроить измерения, чтобы они хранились на границе или передавались в облако Amazon Web Services. По умолчанию измерения передаются в облако.
forwardingConfig -> (структура)
Конфигурация пересылки для данного свойства измерения.
state -> (строка)
transform -> (структура)
Указывает свойство-преобразование актива. Преобразование содержит математическое выражение, которое отображает данные точек свойств из одной формы в другую, например, преобразование единиц из Цельсия в Фаренгейт.
expression -> (строка)
Математическое выражение, определяющее функцию преобразования. Вы можете указать до 10 переменных на выражение. Вы можете указать до 10 функций на выражение.
Дополнительная информация приведена в разделе Квоты в руководстве Пользовательское руководство по IoT SiteWise.
variables -> (список)
Список переменных, используемых в выражении.
(структура)
Содержит информацию о переменных выражения.
name -> (строка)
value -> (структура)
Переменная, определяющая свойство актива, значения которого необходимо использовать.
propertyId -> (строка)
name, если оно из той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительная информация приведена в разделе Использование внешних идентификаторов в руководстве Пользовательское руководство по IoT SiteWise.hierarchyId -> (строка)
Идентификатор иерархии для поиска идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если у иерархии есть внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительная информация приведена в разделе Использование внешних идентификаторов в руководстве Пользовательское руководство по 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 -> (строка)
name, если оно из той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительная информация приведена в разделе Использование внешних идентификаторов в руководстве Пользовательское руководство по IoT SiteWise.hierarchyId -> (строка)
Идентификатор иерархии для поиска идентификатора свойства. Вы можете использовать имя иерархии вместо идентификатора иерархии. Если у иерархии есть внешний идентификатор, вы можете указать externalId:, за которым следует внешний идентификатор. Дополнительная информация приведена в разделе Использование внешних идентификаторов в руководстве Пользовательское руководство по IoT SiteWise.
Используется идентификатор иерархии вместо идентификатора модели, так как у вас может быть несколько иерархий, использующих одну и ту же модель, и, следовательно, те же самые propertyId. Например, у вас могут быть отдельно сгруппированные активы, которые происходят из одной и той же модели актива. Дополнительная информация приведена в разделе Иерархии активов в руководстве Пользовательское руководство по IoT SiteWise.
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) на следующий день.
- Формат ISO 8601. Например, если вы указываете
PT18Hдляoffsetи1dдляinterval, IoT SiteWise агрегирует данные одним из следующих способов:- Если вы создаете метрику до или в 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) на следующий день.
processingConfig -> (структура)
Конфигурация обработки для данного свойства метрики. Вы можете настроить метрики, чтобы они вычислялись на границе или в облаке Amazon Web Services. По умолчанию метрики передаются в облако.
computeLocation -> (строка)
path -> (список)
Структурированный путь к свойству от корня модели актива.
(структура)
Представляет один уровень между свойством и корнем модели актива.
id -> (строка)
name -> (строка)
Синтаксис 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"
}
}
},
"path": [
{
"id": "string",
"name": "string"
}
...
]
}
...
]
--if-match (строка)
matchForVersionType). Запрос обновления отклоняется, если тег не соответствует текущему тегу сущности последней или активной версии. См. Оптимистическую блокировку для записи моделей активов в руководстве Пользовательское руководство по IoT SiteWise.--if-none-match (строка)
matchForVersionType как ACTIVE).--match-for-version-type (строка)
Указывает тип версии модели актива (LATEST или ACTIVE), используемой совместно с заголовками If-Match или If-None-Match для определения целевого ETag для операции обновления.
Возможные значения:
LATESTACTIVE
--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.
Вывод
assetModelCompositeModelPath -> (список)
Путь к списку составных моделей, перечисляющему родительские составные модели.
(структура)
Представляет один уровень между составной моделью и корнем модели актива.
id -> (строка)
name -> (строка)
assetModelStatus -> (структура)
Содержит текущую информацию о состоянии модели актива. Для получения дополнительной информации см. состояния актива и модели в руководстве пользователя IoT SiteWise.
state -> (строка)
error -> (структура)
Содержит связанную информацию об ошибке, если таковая имеется.
code -> (строка)
message -> (строка)
details -> (список)
Список подробных ошибок.
(структура)
Содержит подробную информацию об ошибке.
code -> (строка)
message -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.