обновление-модели-актива

Описание

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

Предупреждение

Если вы удалите свойство из модели актива, IoT SiteWise удалит все предыдущие данные для этого свойства. Вы не можете изменить тип или тип данных существующего свойства.

Чтобы заменить существующее свойство модели актива новым свойством с тем же name, выполните следующие действия:

Отправьте запрос UpdateAssetModel с удалением всего существующего свойства.
Отправьте второй запрос UpdateAssetModel, который включает новое свойство. Новое свойство актива будет иметь то же name, что и предыдущее, и IoT SiteWise сгенерирует новый уникальный id.

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

Синтаксис

  update-asset-model
--asset-model-id <value>
[--asset-model-external-id <value>]
--asset-model-name <value>
[--asset-model-description <value>]
[--asset-model-properties <value>]
[--asset-model-hierarchies <value>]
[--asset-model-composite-models <value>]
[--client-token <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 (строка)

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

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

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

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

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

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

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

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

Обновленные определения свойств модели актива. Дополнительную информацию см. в разделе «Свойства актива» в руководстве пользователя IoT SiteWise.

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

(структура)

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

id -> (строка)

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

Если вы вызываете UpdateAssetModel для создания нового свойства: вы можете указать его идентификатор здесь, если хотите. IoT SiteWise автоматически генерирует уникальный идентификатор для вас, поэтому этот параметр никогда не требуется. Однако, если вы предпочитаете указать свой собственный идентификатор, вы можете указать его здесь в формате UUID. Если вы указываете свой собственный идентификатор, он должен быть глобально уникальным.
Если вы вызываете UpdateAssetModel для изменения существующего свойства: это может быть фактический идентификатор в формате UUID или же externalId:, за которым следует внешний идентификатор, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними идентификаторами» в руководстве пользователя IoT SiteWise.

externalId -> (строка)

Внешний идентификатор (если есть), предоставленный в операции CreateAssetModel или UpdateAssetModel. Вы можете назначить внешний идентификатор, указав это значение в рамках вызова UpdateAssetModel. Однако вы не можете изменить внешний идентификатор, если он уже назначен. Дополнительную информацию см. в разделе «Использование внешних идентификаторов» в руководстве пользователя IoT SiteWise.

name -> (строка)

Имя свойства модели актива.

dataType -> (строка)

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

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

dataTypeSpec -> (строка)

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

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, если оно относится к той же модели актива. Если свойство имеет внешний идентификатор, вы можете указать 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 -> (строка)

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) на следующий день.
Формат 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"
      }
      ...
    ]
  }
  ...
]

--asset-model-hierarchies (список)

Обновленные определения иерархии модели актива. Каждая иерархия определяет модель актива, чьи активы могут быть дочерними для любых других активов, созданных из этой модели актива. Дополнительную информацию см. в разделе «Иерархии активов» в руководстве пользователя IoT SiteWise.

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

(структура)

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

id -> (строка)

ID иерархии модели актива. Этот ID является hierarchyId.

Если вы вызываете UpdateAssetModel для создания новой иерархии: Вы можете указать ее ID здесь, если хотите. IoT SiteWise автоматически генерирует уникальный ID для вас, поэтому этот параметр никогда не требуется. Однако, если вы предпочитаете указать свой собственный ID, вы можете указать его здесь в формате UUID. Если вы указываете свой собственный ID, он должен быть глобально уникальным.
Если вы вызываете UpdateAssetModel для изменения существующей иерархии: Это может быть либо фактический ID в формате UUID, либо externalId:, за которым следует внешний ID, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними ID» в руководстве пользователя IoT SiteWise.

externalId -> (строка)

Внешний ID (если есть), предоставленный в операции CreateAssetModel или UpdateAssetModel. Вы можете назначить внешний ID, указав это значение в рамках вызова UpdateAssetModel. Однако вы не можете изменить внешний ID, если он уже назначен. Дополнительную информацию см. в разделе «Использование внешних ID» в руководстве пользователя IoT SiteWise.

name -> (строка)

Имя иерархии модели актива, которое вы указываете с помощью API-операции CreateAssetModel или UpdateAssetModel.

childAssetModelId -> (строка)

ID модели актива в формате UUID. Все активы в этой иерархии должны быть экземплярами модели актива childAssetModelId. IoT SiteWise всегда вернет фактический ID модели актива для этого значения. Однако, когда вы указываете это значение в рамках вызова UpdateAssetModel, вы можете указать либо ID модели актива, либо externalId:, за которым следует внешний ID модели актива. Дополнительную информацию см. в разделе «Использование внешних ID» в руководстве пользователя IoT SiteWise.

Сокращенная синтаксическая запись:

id=string,externalId=string,name=string,childAssetModelId=string ...

Синтаксис JSON:

[
  {
    "id": "string",
    "externalId": "string",
    "name": "string",
    "childAssetModelId": "string"
  }
  ...
]

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

Составные модели, которые являются частью этой модели актива. Она группирует свойства (такие как атрибуты, измерения, преобразования и метрики) и дочерние составные модели, которые моделируют части вашего промышленного оборудования. Каждая составная модель имеет тип, который определяет свойства, поддерживаемые составной моделью. Используйте составные модели для определения тревог на этой модели актива.

Примечание

При создании пользовательских составных моделей необходимо использовать CreateAssetModelCompositeModel. Дополнительную информацию см. в разделе «Создание пользовательских составных моделей (компоненты)» в руководстве пользователя IoT SiteWise.

(структура)

Содержит информацию о составной модели в модели актива. Этот объект содержит определения свойств актива, которые вы определяете в составной модели.

name -> (строка)

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

description -> (строка)

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

type -> (строка)

Тип составной модели. Для составных моделей тревог этот тип является AWS/ALARM.

properties -> (список)

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

(структура)

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

id -> (строка)

ID свойства модели актива.

Если вы вызываете UpdateAssetModel для создания нового свойства: Вы можете указать его ID здесь, если хотите. IoT SiteWise автоматически генерирует уникальный ID для вас, поэтому этот параметр никогда не требуется. Однако, если вы предпочитаете указать свой собственный ID, вы можете указать его здесь в формате UUID. Если вы указываете свой собственный ID, он должен быть глобально уникальным.
Если вы вызываете UpdateAssetModel для изменения существующего свойства: Это может быть либо фактический ID в формате UUID, либо externalId:, за которым следует внешний ID, если он есть. Дополнительную информацию см. в разделе «Ссылка на объекты с внешними ID» в руководстве пользователя IoT SiteWise.

externalId -> (строка)

name -> (строка)

Имя свойства модели актива.

dataType -> (строка)

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

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

dataTypeSpec -> (строка)

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

unit -> (строка)

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

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

Тип свойства (см. PropertyType).

атрибут -> (структура)

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

defaultValue -> (строка)

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

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

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

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

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

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

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

state -> (строка)

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

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

expression -> (строка)

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

variables -> (список)

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

(структура)

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

name -> (строка)

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

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

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

propertyId -> (строка)

hierarchyId -> (строка)

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

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

propertyPath -> (список)

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

(структура)

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

id -> (строка)

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

name -> (строка)

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

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

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

computeLocation -> (строка)

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

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

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

state -> (строка)

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

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

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

expression -> (строка)

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

variables -> (список)

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

(структура)

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

name -> (строка)

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

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

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

propertyId -> (строка)

hierarchyId -> (строка)

propertyPath -> (список)

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

(структура)

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

id -> (строка)

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

name -> (строка)

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

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

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

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

interval -> (строка)

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

При агрегировании точек данных для вычислений метрики начальная точка каждого интервала исключается, а конечная точка каждого интервала включается. 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 -> (строка)

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

id -> (строка)

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

externalId -> (строка)

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

JSON Синтаксис:

[
  {
    "name": "string",
    "description": "string",
    "type": "string",
    "properties": [
      {
        "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"
          }
          ...
        ]
      }
      ...
    ],
    "id": "string",
    "externalId": "string"
  }
  ...
]

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

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

--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-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

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

Если не указано иное, все примеры используют правила цитирования, подобные правилам UNIX. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Для обновления модели актива

Следующий update-asset-model пример обновляет описание модели актива ветряной электростанции. В этом примере включены существующие идентификаторы и определения модели, поскольку update-asset-model перезаписывает существующую модель новой моделью.

aws iotsitewise update-asset-model \
    --cli-input-json file://update-wind-farm-model.json

Содержимое update-wind-farm-model.json:

{
    "assetModelName": "Wind Farm Model",
    "assetModelDescription": "Represents a wind farm that comprises many wind turbines",
    "assetModelProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
                                "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ],
    "assetModelHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines",
            "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
        }
    ]
}

Вывод:

{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

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

Вывод

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

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

state -> (строка)

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

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

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

code -> (строка)

Код ошибки.

message -> (строка)

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

details -> (список)

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

(структура)

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

code -> (строка)

Код ошибки.

message -> (строка)

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