プロパティエイリアスの設定 (AWS CLI) - AWS IoT SiteWise

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

プロパティエイリアスの設定 (AWS CLI)

AWS Command Line Interface (AWS CLI) を使用して、アセットプロパティのエイリアスを設定します。

この手順を完了するには、アセットの assetId とプロパティの propertyId を知っている必要があります。外部 ID を使用することもできます。アセットを作成し、その がわからない場合はassetIdListAssets API を使用して特定のモデルのすべてのアセットを一覧表示します。DescribeAsset オペレーションを使用して、プロパティ IDs を含むアセットのプロパティを表示します。

UpdateAssetProperty オペレーションを使用して、データストリームをアセットの プロパティにマッピングします。以下のパラメータを指定します。

  • assetId – アセットの ID または外部 ID。詳細については、AWS IoT SiteWise  ユーザーガイドの 外部 IDs を持つオブジェクトの参照を参照してください。

  • propertyId – アセットプロパティの ID または外部 ID。

  • propertyAlias - プロパティへのエイリアスへのデータストリームのパス。

  • propertyNotificationState - プロパティ値の通知状態: ENABLED または DISABLED。プロパティのエイリアスを更新するときに、プロパティの既存の通知状態を指定します。DescribeAssetProperty オペレーションを使用して、既存の通知状態を取得できます。

    このパラメータを省略すると、新しい通知状態が DISABLED になります。プロパティ通知の詳細については、「AWS 他のサービスとのやり取り」を参照してください。

プロパティエイリアスを設定するには (AWS CLI)
  1. 次のコマンドを実行して、プロパティの現在の通知状態を取得します。asset-idproperty-id をアセットプロパティの ID に置き換えます。

    aws iotsitewise describe-asset-property \ --asset-id asset-id \ --property-id property-id

    このオペレーションは、アセットプロパティの詳細を含むレスポンスを次の形式で返します。プロパティ通知の状態は JSON オブジェクトの assetProperty.notification.state にあります。

    { "assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetName": "Wind Turbine 7", "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetProperty": { "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "name": "Wind Speed", "notification": { "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "state": "ENABLED" }, "dataType": "DOUBLE", "unit": "m/s", "type": { "measurement": {} } } }
  2. 次のコマンドを実行して、アセットプロパティのエイリアスを設定します。property-alias をプロパティエイリアス、notification-state を通知状態に置き換えるか、--property-notification-state を省略して通知を無効にします。オプションで新しい単位--property-unit を使用して、アセットの単位を更新することもできます。

    aws iotsitewise update-asset-property \ --asset-id asset-id \ --property-id property-id \ --property-alias property-alias \ --property-notification-state notification-state \ --property-unit unit
  3. エイリアスが設定されていることを確認するには、以下のコマンドを実行してプロパティの詳細を取得します。asset-idproperty-id をアセットプロパティの ID に置き換えます。

    aws iotsitewise describe-asset-property \ --asset-id asset-id \ --property-id property-id

    このオペレーションは、アセットプロパティの詳細を含むレスポンスを次の形式で返します。プロパティエイリアスは JSON オブジェクトの assetProperty.alias であり、この例では myAlias に設定されています。

    { "assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetName": "Wind Turbine 7", "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetProperty": { "alias": "myAlias", "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "name": "Wind Speed", "notification": { "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "state": "ENABLED" }, "dataType": "DOUBLE", "unit": "m/s", "type": { "measurement": {} } } }