アセットを更新するアセットモデルとコンポーネントモデルの更新カスタム複合モデル (コンポーネント) の更新

アセットとモデルの更新

でアセット、アセットモデル、コンポーネントモデルを更新 AWS IoT SiteWise して、名前と定義を変更できます。これらの更新オペレーションは非同期であり、を介して伝達されるまでに時間がかかります AWS IoT SiteWise。追加の変更を行う前に、アセットまたはモデルのステータスを確認してください。更新されたアセットまたはモデルを引き続き使用するには、変更が反映されるまで待機する必要があります。

トピック

アセットを更新する
アセットモデルとコンポーネントモデルの更新
カスタム複合モデル (コンポーネント) の更新

アセットを更新する

AWS IoT SiteWise コンソールまたは API を使用して、アセットの名前を更新できます。

アセットを更新すると、変更が反映されるまで、アセットの状態は UPDATING になります。詳細については、「アセットおよびモデルの状態」を参照してください。

アセットの更新 (コンソール)

AWS IoT SiteWise コンソールを使用してアセットの詳細を更新できます。

アセットを更新するには (コンソール)

AWS IoT SiteWise コンソールに移動します。
ナビゲーションペインで [Assets (アセット) ] を選択します。
更新するアセットを選択します。

ヒント
矢印アイコンを選択して、アセット階層を展開してアセットを検索できます。
[編集] を選択します。
アセットの [名前] を更新します。
(オプション) このページで、アセットのその他の情報を更新します。詳細については、次を参照してください。
[保存] を選択します。

アセットの更新 (AWS CLI）

AWS Command Line Interface （AWS CLI) を使用して、アセットの名前を更新できます。

UpdateAsset オペレーションを使用してアセットを更新します。以下のパラメータを指定します。

assetId – アセットの ID。これは UUID 形式の実際の ID であり、がある場合は externalId:myExternalId です。詳細については、AWS IoT SiteWise ユーザーガイドの外部 IDs参照を参照してください。
assetName - アセットの新しい名前。

アセットの名前を更新するには (AWS CLI）

アセットの名前を更新するには、次のコマンドを実行します。asset-id をアセットの ID または外部 ID に置き換えます。asset-name をアセットの新しい名前で更新します。
```
aws iotsitewise update-asset \
  --asset-id asset-id \
  --asset-name asset-name
```

アセットモデルとコンポーネントモデルの更新

AWS IoT SiteWise コンソールまたは API を使用して、アセットモデルまたはコンポーネントモデルを更新できます。

既存のプロパティの型やデータ型、または既存のメトリクスのウィンドウを変更することはできません。また、モデルのタイプをアセットモデルからコンポーネントモデル、またはその逆に変更することもできません。

重要

アセットモデルまたはコンポーネントモデルからプロパティを削除すると、はそのプロパティの以前のデータをすべて AWS IoT SiteWise 削除します。コンポーネントモデルの場合、これはそのコンポーネントモデルを使用するすべてのアセットモデルに影響するため、特に変更が適用される範囲を理解するように注意してください。
アセットモデルから階層定義を削除すると、はその階層内のすべてのアセットの関連付け AWS IoT SiteWise を解除します。

アセットモデルを更新すると、基になるモデルに加えた変更がそのモデルに基づくすべてのアセットに反映されます。変更が反映されるまで、各アセットには UPDATING 状態になります。それらのアセットを操作する前に、それらが ACTIVE 状態に戻るまで待機する必要があります。この間、更新されたアセットモデルのステータスは PROPAGATING になります。

コンポーネントモデルを更新すると、そのコンポーネントモデルを組み込むすべてのアセットモデルに変更が反映されます。コンポーネントモデルが変更されるまで、影響を受ける各アセットモデルには UPDATING状態PROPAGATINGがあり、その後、前の段落で説明したように、関連するアセットが更新されます。これらのアセットモデルが ACTIVE状態に戻るまで待ってから、操作する必要があります。この間、更新されたコンポーネントモデルのステータスはになりますPROPAGATING。

詳細については、「アセットおよびモデルの状態」を参照してください。

トピック

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

アセットモデルまたはコンポーネントモデルの更新 (コンソール）

AWS IoT SiteWise コンソールを使用して、アセットモデルまたはコンポーネントモデルを更新できます。

アセットモデルまたはコンポーネントモデルを更新するには (コンソール）

AWS IoT SiteWise コンソールに移動します。
ナビゲーションペインで、[モデル] を選択します。
更新するアセットモデルまたはコンポーネントモデルを選択します。
[編集] を選択します。
[モデルの編集] ページで、次のいずれかの操作を行います。
- [モデルの詳細] で、モデルの [名前] を変更します。
- 任意の [属性定義] を変更します。既存の属性の [データ型] は変更できません。詳細については、「静的データ (属性) の定義」を参照してください。
- [測定の定義] を変更します。既存の測定値の [データ型] は変更できません。詳細については、「機器からのデータストリームの定義 (測定値) 」を参照してください。
- 任意の [定義を変換する] を変更します。詳細については、「データの変換 (変換) 」を参照してください。
- [メトリクスの定義] を変更します。既存のメトリクスの [時間間隔] は変更できません。詳細については、「プロパティおよびその他のアセットのデータ (指標) の集計」を参照してください。
- （アセットモデルのみ) 階層定義 を変更します。既存の階層の [階層モデル] を変更することはできません。詳細については、「アセットモデル階層の定義」を参照してください
保存を選択します。

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

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

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

assetModelId – アセットの ID。これは UUID 形式の実際の ID であり、がある場合は externalId:myExternalId です。詳細については、AWS IoT SiteWise ユーザーガイドの外部 IDs参照を参照してください。

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

警告

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

注記

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

アセットモデルまたはコンポーネントモデルを更新するには (AWS CLI）

次のコマンドを実行して、既存のモデル定義を取得します。を更新するアセットモデルまたはコンポーネントモデルの 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 オペレーションを参照してください。

update-asset-model.json という名前のファイルを作成し、前のコマンドのレスポンスをファイルにコピーします。
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
}
```
update-asset-model.json で、次のいずれかを行ってください。
- アセットモデルの名前を変更します (assetModelName)。
- アセットモデルの説明を変更、追加、または削除します (assetModelDescription)。
- アセットモデルのプロパティを変更、追加、または削除します (assetModelProperties)。既存のプロパティの dataType、または既存のメトリクスの window を変更することはできません。詳細については、「データのプロパティを定義する。」を参照してください。
- アセットモデルの階層を変更、追加、または削除します (assetModelHierarchies)。既存の階層の childAssetModelId は変更できません。詳細については、「アセットモデル階層の定義」を参照してください。
- アセットモデルの複合モデルタイプ AWS/ALARM () を変更、追加、または削除しますassetModelCompositeModels。アラームは、他のプロパティをモニタリングし、機器やプロセスに注意が必要な時期を特定することができます。各アラーム定義は、アラームが使用する一連のプロパティを標準化した複合モデルです。詳細については、アラームによるデータのモニタリング。およびアセットモデルにおけるアラームの定義を参照してください。
次のコマンドを実行して、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
```

カスタム複合モデル (コンポーネント) の更新

AWS IoT SiteWise API を使用してカスタム複合モデルを更新するか、 AWS IoT SiteWise コンソールを使用してコンポーネントを更新できます。

トピック

コンポーネントの更新 (コンソール）
カスタム複合モデルの更新 (AWS CLI）

コンポーネントの更新 (コンソール）

AWS IoT SiteWise コンソールを使用してコンポーネントを更新できます。

コンポーネントを更新するには (コンソール）

AWS IoT SiteWise コンソールに移動します。
ナビゲーションペインで、[モデル] を選択します。
コンポーネントがあるアセットモデルを選択します。
プロパティ タブで、コンポーネント を選択します。
更新するコンポーネントを選択します。
[編集] を選択します。
コンポーネントの編集ページで、次のいずれかの操作を行います。
- [モデルの詳細] で、モデルの [名前] を変更します。
- 任意の [属性定義] を変更します。既存の属性の [データ型] は変更できません。詳細については、「静的データ (属性) の定義」を参照してください。
- [測定の定義] を変更します。既存の測定値の [データ型] は変更できません。詳細については、「機器からのデータストリームの定義 (測定値) 」を参照してください。
- 任意の [定義を変換する] を変更します。詳細については、「データの変換 (変換) 」を参照してください。
- [メトリクスの定義] を変更します。既存のメトリクスの [時間間隔] は変更できません。詳細については、「プロパティおよびその他のアセットのデータ (指標) の集計」を参照してください
保存を選択します。

カスタム複合モデルの更新 (AWS CLI）

AWS Command Line Interface （AWS CLI) を使用して、カスタム複合モデルを更新できます。

名前または説明を更新するには、 UpdateAssetModelCompositeModelオペレーションを使用します。インラインカスタム複合モデルのみの場合、プロパティを更新することもできます。 component-model-based カスタム複合モデルのプロパティを更新することはできません。参照されるコンポーネントモデルが関連するプロパティを提供するためです。

重要

カスタム複合モデルからプロパティを削除すると、はそのプロパティの以前のデータをすべて AWS IoT SiteWise 削除します。既存のプロパティの型またはデータ型を変更することはできません。

既存の複合モデルプロパティを、同じを持つ新しい複合モデルプロパティに置き換えるにはname、次の手順を実行します。

既存のプロパティ全体を削除して UpdateAssetModelCompositeModelリクエストを送信します。
新しいプロパティを含む 2 番目のUpdateAssetModelCompositeModelリクエストを送信します。新しいアセットプロパティは、前のアセットプロパティnameと同じを持ち AWS IoT SiteWise 、新しい一意のを生成しますid。

カスタム複合モデルを更新するには (AWS CLI）

既存の複合モデル定義を取得するには、次のコマンドを実行します。を更新するカスタム複合モデルの ID または外部 ID composite-model-idに、をカスタム複合モデルが関連付けられているアセットモデルasset-model-idに置き換えます。詳細については、「ユーザーガイド」のAWS IoT SiteWise 「」を参照してください。
```
aws iotsitewise describe-asset-model-composite-model \
--asset-model-composite-model-id composite-model-id \
--asset-model-id asset-model-id
```
詳細については、DescribeAssetModelCompositeModel オペレーションを参照してください。
という名前のファイルを作成しupdate-custom-composite-model.json、前のコマンドのレスポンスをファイルにコピーします。
以下のフィールドupdate-custom-composite-model.jsonを除き、の JSON オブジェクトからすべてのキーと値のペアを削除します。
- assetModelCompositeModelName
- assetModelCompositeModelDescription (存在する場合）
- assetModelCompositeModelProperties (存在する場合）
update-custom-composite-model.json で、次のいずれかを行ってください。
- の値を変更しますassetModelCompositeModelName。
- を追加または削除するかassetModelCompositeModelDescription、その値を変更します。
- インラインカスタム複合モデルのみ: でアセットモデルのプロパティを変更、追加、または削除しますassetModelCompositeModelProperties。
このファイルに必要な形式の詳細については、「」のリクエスト構文を参照してくださいUpdateAssetModelCompositeModel。
次のコマンドを実行して、に保存されている定義でカスタム複合モデルを更新しますupdate-custom-composite-model.json。を複合モデルの ID composite-model-idに置き換え、をその中にあるアセットモデルの ID asset-model-idに置き換えます。
```
aws iotsitewise update-asset-model-composite-model \
--asset-model-composite-model-id composite-model-id \
--asset-model-id asset-model-id \
--cli-input-json file://update-custom-composite-model.json
```

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

アセットの関連付けと関連付け解除

アセットとモデルの削除

アセットとモデルの更新

トピック

アセットを更新する

トピック

アセットの更新 (コンソール)

アセットを更新するには (コンソール)

ヒント

アセットの更新 (AWS CLI）

アセットの名前を更新するには (AWS CLI）

アセットモデルとコンポーネントモデルの更新

重要

トピック

アセットモデルまたはコンポーネントモデルの更新 (コンソール）

アセットモデルまたはコンポーネントモデルを更新するには (コンソール）

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

警告

注記

アセットモデルまたはコンポーネントモデルを更新するには (AWS CLI）

カスタム複合モデル (コンポーネント) の更新

トピック

コンポーネントの更新 (コンソール）

コンポーネントを更新するには (コンソール）

カスタム複合モデルの更新 (AWS CLI）

重要

カスタム複合モデルを更新するには (AWS CLI）