アセットまたはコンポーネントモデルの更新 (AWS CLI) - AWS IoT SiteWise

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アセットまたはコンポーネントモデルの更新 (AWS CLI)

AWS Command Line Interface (AWS CLI) を使用してアセットモデルまたはコンポーネントモデルを更新できます。

UpdateAssetModelAPI を使用して、アセットモデルまたはコンポーネントモデルの名前、説明、およびプロパティを更新します。アセットモデルのみ、階層を更新できます。以下のパラメータを指定します。

  • assetModelId – アセットの ID。これは UUID 形式の実際の ID、もしくは UUID 形式の ID です。externalId:myExternalId詳細については、AWS IoT SiteWise  ユーザーガイドの 外部 ID によるオブジェクトの参照を参照してください。

更新されたモデルをペイロードに指定します。アセットモデルまたはコンポーネントモデルの想定される形式については、を参照してくださいアセットモデルを作成する

警告

UpdateAssetModelAPI は、ペイロードに指定したモデルで既存のモデルを上書きします。モデルのプロパティや階層が削除されないようにするには、更新したモデルペイロードにそれらの ID と定義を含める必要があります。モデルの既存の構造をクエリする方法については、オペレーションを参照してください。DescribeAssetModel

注記

以下の手順ではタイプの複合モデルのみを更新できますAWS/ALARMCUSTOM複合モデルを更新する場合は、UpdateAssetModelCompositeModel代わりにを使用してください。詳細については、「カスタム複合モデル (コンポーネント) の更新」を参照してください。

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

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

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

    { "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" } }

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

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

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

    • assetModelId

    • assetModelArn

    • assetModelCompositeModelSummaries

    • assetModelCreationDate

    • assetModelLastUpdateDate

    • assetModelStatus

    • assetModelType

    UpdateAssetModelこのオペレーションでは、以下の構造のペイロードが必要です。

    { "assetModelName": "String", "assetModelDescription": "String", "assetModelProperties": Array of AssetModelProperty, "assetModelHierarchies": Array of AssetModelHierarchyDefinition, "assetModelCompositeModels": Array of AssetModelCompositeModel }
  4. update-asset-model.json で、次のいずれかを行ってください。

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

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

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

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

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

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

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