メタデータのエクスポート例

Amazon S3 への AWS IoT SiteWise コンテンツの一括エクスポートを実行するときに、エクスポートする特定のアセットモデルとアセットを制限するフィルターを指定できます。

フィルターは、リクエスト本文の iotSiteWiseConfigurationセクション内の sourcesセクションで指定します。

注記

複数のフィルターを含めることができます。一括オペレーションでは、いずれかのフィルターに一致するアセットモデルまたはアセットがエクスポートされます。

フィルターを指定しない場合、オペレーションはすべてのアセットモデルとアセットをエクスポートします。

{
    "metadataTransferJobId": "your-transfer-job-id",
    "sources": [{
        "type": "iotsitewise",
        "iotSiteWiseConfiguration": {
            "filters": [{
                list of filters
            }]
        }
    }],
    "destination": {
        "type": "s3",
        "s3Configuration": {
            "location": "arn:aws:s3:::amzn-s3-demo-bucket"
        }
    }
}

アセットモデルでフィルタリングする

特定のアセットモデルをフィルタリングできます。そのモデルを使用するすべてのアセット、または階層内のすべてのアセットモデルを含めることもできます。アセットと階層の両方を含めることはできません。

階層の詳細については、「アセットモデル階層の定義」を参照してください。

Asset model

このフィルターには、指定されたアセットモデルが含まれます。

"filterByAssetModel": {
    "assetModelId": "asset model ID"
}

Asset model and its assets

このフィルターには、指定されたアセットモデルとそのアセットモデルを使用するすべてのアセットが含まれます。

"filterByAssetModel": {
    "assetModelId": "asset model ID",
    "includeAssets": true
}

Asset model and its hierarchy

このフィルターには、指定されたアセットモデルと、その階層内のすべての関連するアセットモデルが含まれます。

"filterByAssetModel": {
    "assetModelId": "asset model ID",
    "includeOffspring": true
}

アセットによるフィルタリング

特定のアセットをフィルタリングできます。そのアセットモデル、または関連するすべてのアセットを階層に含めることもできます。アセットモデルと階層の両方を含めることはできません。

階層の詳細については、「アセットモデル階層の定義」を参照してください。

Asset

このフィルターには、指定されたアセットが含まれます。

"filterByAsset": {
    "assetId": "asset ID"
}

Asset and its asset model

このフィルターには、指定したアセットと、使用するアセットモデルが含まれます。

"filterByAsset": {
    "assetId": "asset ID",
    "includeAssetModel": true
}

Asset and its hierarchy

このフィルターには、指定されたアセットとその階層内のすべての関連アセットが含まれます。

"filterByAsset": {
    "assetId": "asset ID",
    "includeOffspring": true
}