アセットモデルとコンポーネントモデルを更新する

AWS IoT SiteWise コンソールに移動します。

ナビゲーションペインで、[モデル] を選択します。

更新するアセットモデルまたはコンポーネントモデルを選択します。

[編集] を選択します。

[モデルの編集] ページで、次のいずれかの操作を行います。

• [モデルの詳細] で、モデルの [名前] を変更します。

• 任意の [属性定義] を変更します。既存の属性の [データ型] は変更できません。詳細については、「静的データ (属性) を定義する」を参照してください。

• [測定の定義] を変更します。既存の測定値の [データ型] は変更できません。詳細については、「機器からのデータストリームを定義する (測定値) 」を参照してください。

• 任意の [定義を変換する] を変更します。詳細については、「データを変換する (変換) 」を参照してください。

• [メトリクスの定義] を変更します。既存のメトリクスの [時間間隔] は変更できません。詳細については、「プロパティおよびその他のアセットからのデータを集計する (メトリクス)」を参照してください。

• (アセットモデルのみ) 任意の [階層の定義] を変更します。既存の階層の [階層モデル] を変更することはできません。詳細については、「アセットモデルの階層を定義する」を参照してください。

[Save] を選択します。

次のコマンドを実行して、既存のアセットモデル定義を取得します。asset-model-id を、更新するアセットモデルまたはコンポーネントモデルの ID または外部 ID に置き換えます。

aws iotsitewise describe-asset-model --asset-model-id asset-model-id

上記のコマンドは、モデルの最新バージョンに対応するモデル定義を返します。

アセットモデルが FAILED 状態にあるユースケースでは、アクティブなバージョンに対応する有効なモデル定義を取得して、更新リクエストを構築します。詳細については、「アセットモデルのバージョン」を参照してください。次のコマンドを実行して、アクティブなモデル定義を取得します。

aws iotsitewise describe-asset-model --asset-model-id asset-model-id --asset-model-version ACTIVE 

このオペレーションは、モデルの詳細を含むレスポンスを返します。このレスポンスには以下の構造が含まれます。

{
    "assetModelId": "String",
    "assetModelArn": "String",
    "assetModelName": "String",
    "assetModelDescription": "String",
    "assetModelProperties": Array of AssetModelProperty,
    "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
    "assetModelCompositeModels": Array of AssetModelCompositeModel,
    "assetModelCompositeModelSummaries": Array of AssetModelCompositeModelSummary,
    "assetModelCreationDate": "String",
    "assetModelLastUpdateDate": "String",
    "assetModelStatus": {
      "state": "String",
      "error": {
        "code": "String",
        "message": "String"
      },
    "assetModelType": "String"
    },
    "assetModelVersion": "String",
    "eTag": "String"
}

詳細については、「DescribeAssetModel オペレーション」を参照してください。

update-asset-model.json という名前のファイルを作成し、前のコマンドのレスポンスをファイルにコピーします。

update-asset-model.json の JSON オブジェクトから次のキーと値のペアを削除します。

UpdateAssetModel オペレーションでは、次の構造を持つペイロードが必要です。

{
  "assetModelName": "String",
  "assetModelDescription": "String",
  "assetModelProperties": Array of AssetModelProperty,
  "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
  "assetModelCompositeModels": Array of AssetModelCompositeModel
}

update-asset-model.json で、次のいずれかを行ってください。

• アセットモデルの名前を変更します (assetModelName)。

• アセットモデルの説明を変更、追加、または削除します (assetModelDescription)。

• アセットモデルのプロパティを変更、追加、または削除します (assetModelProperties)。既存のプロパティの dataType、または既存のメトリクスの window を変更することはできません。詳細については、「データのプロパティを定義する」を参照してください。

• アセットモデルの階層を変更、追加、または削除します (assetModelHierarchies)。既存の階層の childAssetModelId は変更できません。詳細については、「アセットモデルの階層を定義する」を参照してください。

• アセットモデルのタイプ AWS/ALARM (assetModelCompositeModels) の複合モデルを変更、追加、または削除します。アラームは、他のプロパティをモニタリングし、機器やプロセスに注意が必要な時期を特定することができます。各アラーム定義は、アラームが使用する一連のプロパティを標準化した複合モデルです。詳細については、でアラームを使用してデータをモニタリングする AWS IoT SiteWiseおよびでアセットモデルにアラームを定義する AWS IoT SiteWiseを参照してください。

次のコマンドを実行して、update-asset-model.json に保存されている定義でアセットモデルを更新します。asset-model-id をアセットモデルの ID に置き換えます。

aws iotsitewise update-asset-model \
  --asset-model-id asset-model-id \
  --cli-input-json file://model-payload.json