AWS IoT SiteWise examples using AWS CLI

次のコード例では、AWS IoT SiteWise で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

トピック

アクション

アクション

次の例は、associate-assets を使用する方法を説明しています。

AWS CLI

子アセットを親アセットに関連付けるには

次の associate-assets の例では、風力タービンアセットを風力発電所アセットに関連付けます。風力タービンアセットモデルは、風力発電所アセットモデルに階層として存在します。


aws iotsitewise associate-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \
    --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Associating assets」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「AssociateAssets」を参照してください。

次の例は、batch-associate-project-assets を使用する方法を説明しています。

AWS CLI

アセットをプロジェクトに関連付けるには

次の batch-associate-project-assets の例では、風力発電所アセットをプロジェクトに関連付けます。


aws iotsitewise batch-associate-project-assets \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「Adding assets to projects」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchAssociateProjectAssets」を参照してください。

次の例は、batch-disassociate-project-assets を使用する方法を説明しています。

AWS CLI

プロジェクトからアセットの関連付けを解除するには

次の batch-disassociate-project-assets の例では、プロジェクトから風力発電所アセットの関連付けを解除します。


aws iotsitewise batch-disassociate-project-assets \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「Adding assets to projects」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDisassociateProjectAssets」を参照してください。

次の例は、batch-put-asset-property-value を使用する方法を説明しています。

AWS CLI

アセットプロパティにデータを送信するには

次の batch-put-asset-property-value の例では、プロパティエイリアスによって識別されるアセットプロパティに電力と温度のデータを送信します。


aws iotsitewise batch-put-asset-property-value \
    --cli-input-json file://batch-put-asset-property-value.json

batch-put-asset-property-value.json の内容:


{
    "entries": [
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-power",
            "propertyAlias": "company-windfarm-3-turbine-7-power",
            "propertyValues": [
                {
                    "value": {
                        "doubleValue": 4.92
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    },
                    "quality": "GOOD"
                }
            ]
        },
        {
            "entryId": "1575691200-company-windfarm-3-turbine-7-temperature",
            "propertyAlias": "company-windfarm-3-turbine-7-temperature",
            "propertyValues": [
                {
                    "value": {
                        "integerValue": 38
                    },
                    "timestamp": {
                        "timeInSeconds": 1575691200
                    }
                }
            ]
        }
    ]
}

出力:


{
    "errorEntries": []
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Ingesting data using the AWS IoT SiteWise API」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「BatchPutAssetPropertyValue」を参照してください。

次の例は、create-access-policy を使用する方法を説明しています。

AWS CLI

例 1: ポータルへのユーザー管理アクセスを許可するには

次の create-access-policy の例では、風力発電所会社のウェブポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーを作成します。


aws iotsitewise create-access-policy \
    --cli-input-json file://create-portal-administrator-access-policy.json

create-portal-administrator-access-policy.json の内容:


{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyResource": {
        "portal": {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
        }
    }
}

出力:


{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Adding or removing portal administrators」を参照してください。

例 2: プロジェクトへの読み取り専用アクセス権をユーザーに付与するには

次の create-access-policy の例では、風力発電所プロジェクトへの読み取り専用アクセス権をユーザーに付与するアクセスポリシーを作成します。


aws iotsitewise create-access-policy \
    --cli-input-json file://create-project-viewer-access-policy.json

create-project-viewer-access-policy.json の内容:


{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "VIEWER",
    "accessPolicyResource": {
        "project": {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
        }
    }
}

出力:


{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE"
}

詳細については、「AWS SiteWise Monitor アプリケーションガイド」の「Assigning project viewers」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateAccessPolicy」を参照してください。

次の例は、create-asset-model を使用する方法を説明しています。

AWS CLI

アセットモデルを作成するには

次の create-asset-model の例では、次のプロパティを使用して風力タービンを定義するアセットモデルを作成します。

シリアル番号 - 風力タービンのシリアル番号発電電力 - 風力タービンからの発電電力のデータストリーム温度 C - 風力タービンからの温度のデータストリーム (摂氏) 温度 F - 摂氏から華氏にマップされた温度のデータポイント


aws iotsitewise create-asset-model \
    --cli-input-json file://create-wind-turbine-model.json

create-wind-turbine-model.json の内容:


{
    "assetModelName": "Wind Turbine Model",
    "assetModelDescription": "Represents a wind turbine",
    "assetModelProperties": [
        {
            "name": "Serial Number",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "name": "Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature C",
            "dataType": "DOUBLE",
            "unit": "Celsius",
            "type": {
                "measurement": {}
            }
        },
        {
            "name": "Temperature F",
            "dataType": "DOUBLE",
            "unit": "Fahrenheit",
            "type": {
                "transform": {
                    "expression": "temp_c * 9 / 5 + 32",
                    "variables": [
                        {
                            "name": "temp_c",
                            "value": {
                                "propertyId": "Temperature C"
                            }
                        }
                    ]
                }
            }
        },
        {
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "Generated Power"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ]
}

出力:


{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Defining asset models」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateAssetModel」を参照してください。

次の例は、create-asset を使用する方法を説明しています。

AWS CLI

アセットを作成するには

次の create-asset の例では、風力タービンアセットモデルから風力タービンアセットを作成します。


aws iotsitewise create-asset \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --asset-name "Wind Turbine 1"

出力:


{
    "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
    "assetStatus": {
        "state": "CREATING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Creating assets」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateAsset」を参照してください。

次の例は、create-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードを作成するには

次の create-dashboard の例では、風力発電所の総発電電力が表示される折れ線グラフを含むダッシュボードを作成します。


aws iotsitewise create-dashboard \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --dashboard-name "Wind Farm" \
    --dashboard-definition file://create-wind-farm-dashboard.json

create-wind-farm-dashboard.json の内容:


{
    "widgets": [
        {
            "type": "monitor-line-chart",
            "title": "Generated Power",
            "x": 0,
            "y": 0,
            "height": 3,
            "width": 3,
            "metrics": [
                {
                    "label": "Power",
                    "type": "iotsitewise",
                    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"
                }
            ]
        }
    ]
}

出力:


{
    "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Creating dashboards (CLI)」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateDashboard」を参照してください。

次の例は、create-gateway を使用する方法を説明しています。

AWS CLI

ゲートウェイを作成するには

次の create-gateway の例では、AWS IoT Greengrass で実行されるゲートウェイを作成します。


aws iotsitewise create-gateway \
    --gateway-name ExampleCorpGateway \
    --gateway-platform greengrass={groupArn=arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE}

出力:


{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Configuring a gateway」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreateGateway」を参照してください。

次の例は、create-portal を使用する方法を説明しています。

AWS CLI

ポータルを作成するには

次の create-portal の例では、風力発電所会社のウェブポータルを作成します。ポータルは、AWS Single Sign-On が有効になっている同じリージョンにのみ作成できます。


aws iotsitewise create-portal \
    --portal-name WindFarmPortal \
    --portal-description "A portal that contains wind farm projects for Example Corp." \
    --portal-contact-email support@example.com \
    --role-arn arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole

出力:


{
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
    "portalStatus": {
        "state": "CREATING"
    },
    "ssoApplicationId": "ins-a1b2c3d4-EXAMPLE"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Getting started with AWS IoT SiteWise Monitor」および「AWS SiteWise ユーザーガイド」の「Enabling AWS SSO」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「CreatePortal」を参照してください。

次の例は、create-project を使用する方法を説明しています。

AWS CLI

プロジェクトを作成するには

次の create-project の例では、風力発電所プロジェクトを作成します。


aws iotsitewise create-project \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \
    --project-name "Wind Farm 1" \
    --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp."

出力:


{
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「Creating projects」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「CreateProject」を参照してください。

次の例は、delete-access-policy を使用する方法を説明しています。

AWS CLI

プロジェクトまたはポータルへのユーザーのアクセス権を取り消すには

次の delete-access-policy の例では、ポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーを削除します。


aws iotsitewise delete-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Adding or removing portal administrators」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAccessPolicy」を参照してください。

次の例は、delete-asset-model を使用する方法を説明しています。

AWS CLI

アセットモデルを削除するには

次の delete-asset-model の例では、風力タービンアセットモデルを削除します。


aws iotsitewise delete-asset-model \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

出力:


{
    "assetModelStatus": {
        "state": "DELETING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Deleting asset models」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAssetModel」を参照してください。

次の例は、delete-asset を使用する方法を説明しています。

AWS CLI

アセットを削除するには

次の delete-asset の例では、風力タービンアセットを削除します。


aws iotsitewise delete-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

出力:


{
    "assetStatus": {
        "state": "DELETING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Deleting assets」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAsset」を参照してください。

次の例は、delete-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードを削除するには

次の delete-dashboard の例では、風力タービンダッシュボードを削除します。


aws iotsitewise delete-dashboard \
    --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「ダッシュボードの削除を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteDashboard」を参照してください。

次の例は、delete-gateway を使用する方法を説明しています。

AWS CLI

ゲートウェイを削除するには

次の delete-gateway の例では、ゲートウェイを削除します。


aws iotsitewise delete-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Ingesting data using a gateway」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteGateway」を参照してください。

次の例は、delete-portal を使用する方法を説明しています。

AWS CLI

ポータルを削除するには

次の delete-portal の例では、風力発電所会社のウェブポータルを削除します。


aws iotsitewise delete-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

出力:


{
    "portalStatus": {
        "state": "DELETING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Deleting a portal」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeletePortal」を参照してください。

次の例は、delete-project を使用する方法を説明しています。

AWS CLI

プロジェクトを削除するには

次の delete-project の例では、風力発電所プロジェクトを削除します。


aws iotsitewise delete-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「Deleting projects」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteProject」を参照してください。

次の例は、describe-access-policy を使用する方法を説明しています。

AWS CLI

アクセスポリシーの説明を表示するには

次の describe-access-policy の例では、風力発電所会社のウェブポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーの説明を表示します。


aws iotsitewise describe-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE

出力:


{
    "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyResource": {
        "portal": {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyCreationDate": "2020-02-20T22:35:15.552880124Z",
    "accessPolicyLastUpdateDate": "2020-02-20T22:35:15.552880124Z"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Adding or removing portal administrators」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAccessPolicy」を参照してください。

次の例は、describe-asset-model を使用する方法を説明しています。

AWS CLI

アセットモデルの説明を表示するには

次の describe-asset-model の例では、風力発電所アセットモデルの説明を表示します。


aws iotsitewise describe-asset-model \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

出力:


{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelName": "Wind Farm Model",
    "assetModelDescription": "Represents a wind farm that comprises many wind turbines",
    "assetModelProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE",
                                "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING",
            "type": {
                "attribute": {
                    "defaultValue": " "
                }
            }
        }
    ],
    "assetModelHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines",
            "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
        }
    ],
    "assetModelCreationDate": 1575671284.0,
    "assetModelLastUpdateDate": 1575671988.0,
    "assetModelStatus": {
        "state": "ACTIVE"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Describing a specific asset model」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAssetModel」を参照してください。

次の例は、describe-asset-property を使用する方法を説明しています。

AWS CLI

アセットプロパティの説明を表示するには

次の describe-asset-property の例では、風力発電所アセットの総発電電力プロパティの説明を表示します。


aws iotsitewise describe-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE

出力:


{
    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetName": "Wind Farm 1",
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetProperty": {
        "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
        "name": "Total Generated Power",
        "notification": {
            "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "state": "DISABLED"
        },
        "dataType": "DOUBLE",
        "unit": "kW",
        "type": {
            "metric": {
                "expression": "sum(power)",
                "variables": [
                    {
                        "name": "power",
                        "value": {
                            "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE",
                            "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE"
                        }
                    }
                ],
                "window": {
                    "tumbling": {
                        "interval": "1h"
                    }
                }
            }
        }
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Describing a specific asset property」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAssetProperty」を参照してください。

次の例は、describe-asset を使用する方法を説明しています。

AWS CLI

アセットの説明を表示するには

次の describe-asset の例では、風力発電所アセットの説明を表示します。


aws iotsitewise describe-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

出力:


{
    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetName": "Wind Farm 1",
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING"
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW"
        }
    ],
    "assetHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines"
        }
    ],
    "assetCreationDate": 1575672453.0,
    "assetLastUpdateDate": 1575672453.0,
    "assetStatus": {
        "state": "ACTIVE"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Describing a specific asset」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeAsset」を参照してください。

次の例は、describe-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードの説明を表示するには

次の describe-dashboard の例では、指定された風力発電所ダッシュボードの説明を表示します。


aws iotsitewise describe-dashboard \
    --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE

出力:


{
    "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
    "dashboardName": "Wind Farm",
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "dashboardDefinition": "{\"widgets\":[{\"type\":\"monitor-line-chart\",\"title\":\"Generated Power\",\"x\":0,\"y\":0,\"height\":3,\"width\":3,\"metrics\":[{\"label\":\"Power\",\"type\":\"iotsitewise\",\"assetId\":\"a1b2c3d4-5678-90ab-cdef-44444EXAMPLE\",\"propertyId\":\"a1b2c3d4-5678-90ab-cdef-99999EXAMPLE\"}]}]}",
    "dashboardCreationDate": "2020-05-01T20:32:12.228476348Z",
    "dashboardLastUpdateDate": "2020-05-01T20:32:12.228476348Z"
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「ダッシュボードの表示を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeDashboard」を参照してください。

次の例は、describe-gateway-capability-configuration を使用する方法を説明しています。

AWS CLI

ゲートウェイ機能の説明を表示するには

次の describe-gateway-capability-configuration の例では、OPC-UA ソース機能の説明を表示します。


aws iotsitewise describe-gateway-capability-configuration \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --capability-namespace "iotsitewise:opcuacollector:1"

出力:


{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "capabilityNamespace": "iotsitewise:opcuacollector:1",
    "capabilityConfiguration": "{\"sources\":[{\"name\":\"Wind Farm #1\",\"endpoint\":{\"certificateTrust\":{\"type\":\"TrustAny\"},\"endpointUri\":\"opc.tcp://203.0.113.0:49320\",\"securityPolicy\":\"BASIC256\",\"messageSecurityMode\":\"SIGN_AND_ENCRYPT\",\"identityProvider\":{\"type\":\"Username\",\"usernameSecretArn\":\"arn:aws:secretsmanager:us-east-1:123456789012:secret:greengrass-factory1-auth-3QNDmM\"},\"nodeFilterRules\":[]},\"measurementDataStreamPrefix\":\"\"}]}",
    "capabilitySyncStatus": "IN_SYNC"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Configuring data sources」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeGatewayCapabilityConfiguration」を参照してください。

次の例は、describe-gateway を使用する方法を説明しています。

AWS CLI

ゲートウェイの説明を表示するには

次の describe-gateway の例では、ゲートウェイの説明を表示します。


aws iotsitewise describe-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE

出力:


{
    "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayName": "ExampleCorpGateway",
    "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
    "gatewayPlatform": {
        "greengrass": {
            "groupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/a1b2c3d4-5678-90ab-cdef-1b1b1EXAMPLE"
        }
    },
    "gatewayCapabilitySummaries": [
        {
            "capabilityNamespace": "iotsitewise:opcuacollector:1",
            "capabilitySyncStatus": "IN_SYNC"
        }
    ],
    "creationDate": 1588369971.457,
    "lastUpdateDate": 1588369971.457
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Ingesting data using a gateway」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeGateway」を参照してください。

次の例は、describe-logging-options を使用する方法を説明しています。

AWS CLI

現在の AWS IoT SiteWise ログ記録オプションを取得するには

次の describe-logging-options の例では、現在のリージョンにおける AWS アカウントの現在の AWS IoT SiteWise ログ記録オプションを取得します。


aws iotsitewise describe-logging-options

出力:


{
    "loggingOptions": {
        "level": "INFO"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeLoggingOptions」を参照してください。

次の例は、describe-portal を使用する方法を説明しています。

AWS CLI

ポータルの説明を表示するには

次の describe-portal の例では、風力発電所会社のウェブポータルの説明を表示します。


aws iotsitewise describe-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

出力:


{
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalArn": "arn:aws:iotsitewise:us-west-2:123456789012:portal/a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "portalName": "WindFarmPortal",
    "portalDescription": "A portal that contains wind farm projects for Example Corp.",
    "portalClientId": "E-a1b2c3d4e5f6_a1b2c3d4e5f6EXAMPLE",
    "portalStartUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
    "portalContactEmail": "support@example.com",
    "portalStatus": {
        "state": "ACTIVE"
    },
    "portalCreationDate": "2020-02-04T23:01:52.90248068Z",
    "portalLastUpdateDate": "2020-02-04T23:01:52.90248078Z",
    "roleArn": "arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Administering your portals」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribePortal」を参照してください。

次の例は、describe-project を使用する方法を説明しています。

AWS CLI

プロジェクトの説明を表示するには

次の describe-project の例では、風力発電所プロジェクトの説明を表示します。


aws iotsitewise describe-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

出力:


{
    "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
    "projectName": "Wind Farm 1",
    "portalId": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
    "projectDescription": "Contains asset visualizations for Wind Farm #1 for Example Corp.",
    "projectCreationDate": "2020-02-20T21:58:43.362246001Z",
    "projectLastUpdateDate": "2020-02-20T21:58:43.362246095Z"
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「プロジェクト詳細の表示を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DescribeProject」を参照してください。

次の例は、disassociate-assets を使用する方法を説明しています。

AWS CLI

親アセットから子アセットの関連付けを解除するには

次の disassociate-assets の例では、風力発電所アセットから風力タービンアセットの関連付けを解除します。


aws iotsitewise disassociate-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE \
    --child-asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Associating assets」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「DisassociateAssets」を参照してください。

次の例は、get-asset-property-aggregates を使用する方法を説明しています。

AWS CLI

アセットプロパティの集計された平均とカウントの値を取得するには

次の get-asset-property-aggregates の例では、風力タービンアセットの 1 時間の平均総電力と総電力データポイント数を取得します。


aws iotsitewise get-asset-property-aggregates \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --start-date 1580849400 \
    --end-date 1580853000 \
    --aggregate-types AVERAGE COUNT \
    --resolution 1h

出力:


{
    "aggregatedValues": [
        {
            "timestamp": 1580850000.0,
            "quality": "GOOD",
            "value": {
                "average": 8723.46538886233,
                "count": 12.0
            }
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Querying asset property aggregates」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetAssetPropertyAggregates」を参照してください。

次の例は、get-asset-property-value-history を使用する方法を説明しています。

AWS CLI

アセットプロパティの過去の値を取得するには

次の get-asset-property-value-history の例では、風力タービンアセットの 20 分間の総電力値を取得します。


aws iotsitewise get-asset-property-value-history \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --start-date 1580851800 \
    --end-date 1580853000

出力:


{
    "assetPropertyValueHistory": [
        {
            "value": {
                "doubleValue": 7217.787046814844
            },
            "timestamp": {
                "timeInSeconds": 1580852100,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6941.242811875451
            },
            "timestamp": {
                "timeInSeconds": 1580852400,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6976.797662266717
            },
            "timestamp": {
                "timeInSeconds": 1580852700,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        },
        {
            "value": {
                "doubleValue": 6890.8677520453875
            },
            "timestamp": {
                "timeInSeconds": 1580853000,
                "offsetInNanos": 0
            },
            "quality": "GOOD"
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「履歴アセットプロパティ値をクエリする」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetAssetPropertyValueHistory」を参照してください。

次の例は、get-asset-property-value を使用する方法を説明しています。

AWS CLI

アセットプロパティの現在の値を取得するには

次の get-asset-property-value の例では、風力タービンアセットの現在の総電力を取得します。


aws iotsitewise get-asset-property-value \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE

出力:


{
    "propertyValue": {
        "value": {
            "doubleValue": 6890.8677520453875
        },
        "timestamp": {
            "timeInSeconds": 1580853000,
            "offsetInNanos": 0
        },
        "quality": "GOOD"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「現在のアセットプロパティ値をクエリする」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「GetAssetPropertyValue」を参照してください。

次の例は、list-access-policies を使用する方法を説明しています。

AWS CLI

すべてのアクセスポリシーを一覧表示するには

次の list-access-policies の例では、ポータル管理者であるユーザーのすべてのアクセスポリシーを一覧表示します。


aws iotsitewise list-access-policies \
    --identity-type USER \
    --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE

出力:


{
    "accessPolicySummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE",
            "identity": {
                "user": {
                    "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
                }
            },
            "resource": {
                "portal": {
                    "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE"
                }
            },
            "permission": "ADMINISTRATOR"
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Administering your portals」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListAccessPolicies」を参照してください。

次の例は、list-asset-models を使用する方法を説明しています。

AWS CLI

すべてのアセットモデルを一覧表示するには

次の list-asset-models の例では、現在のリージョンの AWS アカウントで定義されているすべてのアセットモデルを一覧表示します。


aws iotsitewise list-asset-models

出力:


{
    "assetModelSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "name": "Wind Farm Model",
            "description": "Represents a wind farm that comprises many wind turbines",
            "creationDate": 1575671284.0,
            "lastUpdateDate": 1575671988.0,
            "status": {
                "state": "ACTIVE"
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "name": "Wind Turbine Model",
            "description": "Represents a wind turbine manufactured by Example Corp",
            "creationDate": 1575671207.0,
            "lastUpdateDate": 1575686273.0,
            "status": {
                "state": "ACTIVE"
            }
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「すべてのアセットモデルのリスト表示」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListAssetModels」を参照してください。

次の例は、list-assets を使用する方法を説明しています。

AWS CLI

例 1: すべての最上位アセットを一覧表示するには

次の list-assets の例では、アセット階層ツリーの最上位にあり、現在のリージョンの AWS アカウントで定義されているすべてのアセットを一覧表示します。


aws iotsitewise list-assets \
    --filter TOP_LEVEL

出力:


{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
            "name": "Wind Farm 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
            "creationDate": 1575672453.0,
            "lastUpdateDate": 1575672453.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": [
                {
                    "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
                    "name": "Wind Turbines"
                }
            ]
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「アセットのリスト表示」を参照してください。

例 2: アセットモデルに基づくすべてのアセットを一覧表示するには

次の list-assets の例では、アセットモデルに基づき、現在のリージョンの AWS アカウントで定義されているすべてのアセットを一覧表示します。


aws iotsitewise list-assets \
    --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE

出力:


{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "name": "Wind Turbine 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "creationDate": 1575671550.0,
            "lastUpdateDate": 1575686308.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": []
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「アセットのリスト表示」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListAssets」を参照してください。

次の例は、list-associated-assets を使用する方法を説明しています。

AWS CLI

特定のアセットに関連付けられているすべてのアセットを一覧表示するには

次の list-associated-assets の例では、指定された風力発電所アセットに関連付けられているすべての風力タービンアセットを一覧表示します。


aws iotsitewise list-associated-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE

出力:


{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
            "name": "Wind Turbine 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
            "creationDate": 1575671550.0,
            "lastUpdateDate": 1575686308.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": []
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「特定のアセットに関連付けられているアセットのリスト表示」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListAssociatedAssets」を参照してください。

次の例は、list-dashboards を使用する方法を説明しています。

AWS CLI

プロジェクト内のすべてのダッシュボードを一覧表示するには

次の list-dashboards の例では、プロジェクトで定義されているすべてのダッシュボードを一覧表示します。


aws iotsitewise list-dashboards \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

出力:


{
    "dashboardSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE",
            "name": "Wind Farm",
            "creationDate": "2020-05-01T20:32:12.228476348Z",
            "lastUpdateDate": "2020-05-01T20:32:12.228476348Z"
        }
    ]
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「ダッシュボードの表示を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListDashboards」を参照してください。

次の例は、list-gateways を使用する方法を説明しています。

AWS CLI

すべてのゲートウェイを一覧表示するには

次の list-gateways の例では、現在のリージョンの AWS アカウントで定義されているすべてのゲートウェイを一覧表示します。


aws iotsitewise list-gateways

出力:


{
    "gatewaySummaries": [
        {
            "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE",
            "gatewayName": "ExampleCorpGateway",
            "gatewayCapabilitySummaries": [
                {
                    "capabilityNamespace": "iotsitewise:opcuacollector:1",
                    "capabilitySyncStatus": "IN_SYNC"
                }
            ],
            "creationDate": 1588369971.457,
            "lastUpdateDate": 1588369971.457
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Ingesting data using a gateway」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListGateways」を参照してください。

次の例は、list-portals を使用する方法を説明しています。

AWS CLI

すべてのポータルを一覧表示するには

次の list-portals の例では、現在のリージョンの AWS アカウントで定義されているすべてのポータルを一覧表示します。


aws iotsitewise list-portals

出力:


{
    "portalSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE",
            "name": "WindFarmPortal",
            "description": "A portal that contains wind farm projects for Example Corp.",
            "startUrl": "https://a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE.app.iotsitewise.aws",
            "creationDate": "2020-02-04T23:01:52.90248068Z",
            "lastUpdateDate": "2020-02-04T23:01:52.90248078Z",
            "roleArn": "arn:aws:iam::123456789012:role/service-role/MySiteWiseMonitorServiceRole"
        }
    ]
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Administering your portals」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListPortals」を参照してください。

次の例は、list-project-assets を使用する方法を説明しています。

AWS CLI

プロジェクトに関連付けられているすべてのアセットを一覧表示するには

次の list-project-assets の例では、風力発電所プロジェクトに関連付けられているすべてのアセットを一覧表示します。


aws iotsitewise list-projects \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE

出力:


{
    "assetIds": [
        "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE"
    ]
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「Adding assets to projects」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListProjectAssets」を参照してください。

次の例は、list-projects を使用する方法を説明しています。

AWS CLI

ポータル内のすべてのプロジェクトを一覧表示するには

次の list-projects の例では、ポータルで定義されているすべてのプロジェクトを一覧表示します。


aws iotsitewise list-projects \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE

出力:


{
    "projectSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE",
            "name": "Wind Farm 1",
            "description": "Contains asset visualizations for Wind Farm #1 for Example Corp.",
            "creationDate": "2020-02-20T21:58:43.362246001Z",
            "lastUpdateDate": "2020-02-20T21:58:43.362246095Z"
        }
    ]
}

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「プロジェクト詳細の表示を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListProjects」を参照してください。

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

リソースのすべてのタグを一覧表示するには

次の list-tags-for-resource の例では、風力タービンアセットのすべてのタグを一覧表示します。


aws iotsitewise list-tags-for-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE

出力:


{
    "tags": {
        "Owner": "richard-roe"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「リソースへのタグ付け」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource」を参照してください。

次の例は、put-logging-options を使用する方法を説明しています。

AWS CLI

ログ記録のレベルを指定するには

次の put-logging-options の例では、AWS IoT SiteWise で INFO レベルのログ記録を有効にします。その他のレベルには、DEBUG と OFF があります。


aws iotsitewise put-logging-options \
    --logging-options level=INFO

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「PutLoggingOptions」を参照してください。

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

リソースにタグを追加

次の tag-resource の例では、風力タービンアセットに所有者タグを追加します。これにより、アセットの所有者に基づいてアセットへのアクセスを制御できます。


aws iotsitewise tag-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --tags Owner=richard-roe

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「リソースへのタグ付け」を参照してください。

API の詳細については、AWS CLI コマンドリファレンスの「TagResource」を参照してください。

次の例では、untag-resource を使用する方法を説明しています。

AWS CLI

リソースからタグを削除するには

次の untag-resource の例では、風力タービンアセットから所有者タグを削除します。


aws iotsitewise untag-resource \
    --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --tag-keys Owner

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「リソースへのタグ付け」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource」を参照してください。

次の例は、update-access-policy を使用する方法を説明しています。

AWS CLI

プロジェクトビューワーにプロジェクトの所有権を付与するには

次の update-access-policy の例では、プロジェクトビューワーにプロジェクトの所有権を付与するアクセスポリシーを更新します。


aws iotsitewise update-access-policy \
    --access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \
    --cli-input-json file://update-project-viewer-access-policy.json

update-project-viewer-access-policy.json の内容:


{
    "accessPolicyIdentity": {
        "user": {
            "id": "a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE"
        }
    },
    "accessPolicyPermission": "ADMINISTRATOR",
    "accessPolicyResource": {
        "project": {
            "id": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE"
        }
    }
}

このコマンドでは何も出力されません。

詳細については、「AWS SiteWise Monitor アプリケーションガイド」の「プロジェクトの所有者を割り当てる」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAccessPolicy」を参照してください。

次の例は、update-asset-model を使用する方法を説明しています。

AWS CLI

アセットモデルを更新するには

次の update-asset-model の例では、風力発電所アセットモデルの説明を更新します。update-asset-model は既存のモデルを新しいモデルで上書きするため、この例にはモデルの既存の ID と定義が含まれています。


aws iotsitewise update-asset-model \
    --cli-input-json file://update-wind-farm-model.json

update-wind-farm-model.json の内容:


{
    "assetModelName": "Wind Farm Model",
    "assetModelDescription": "Represents a wind farm that comprises many wind turbines",
    "assetModelProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING",
            "type": {
                "attribute": {}
            }
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW",
            "type": {
                "metric": {
                    "expression": "sum(power)",
                    "variables": [
                        {
                            "name": "power",
                            "value": {
                                "hierarchyId": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
                                "propertyId": "a1b2c3d4-5678-90ab-cdef-66666EXAMPLE"
                            }
                        }
                    ],
                    "window": {
                        "tumbling": {
                            "interval": "1h"
                        }
                    }
                }
            }
        }
    ],
    "assetModelHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines",
            "childAssetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE"
        }
    ]
}

出力:


{
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetModelStatus": {
        "state": "CREATING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「アセットモデルの更新」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAssetModel」を参照してください。

次の例は、update-asset-property を使用する方法を説明しています。

AWS CLI

例 1: アセットプロパティのエイリアスを更新するには

次の update-asset-property の例では、風力タービンアセットの電力プロパティエイリアスを更新します。


aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power" \
    --property-notification-state DISABLED

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「アセットプロパティへの産業データストリームのマッピング」を参照してください。

例 2: アセットプロパティの通知を有効にするには

次の update-asset-property の例では、風力タービンアセットの電力プロパティのアセットプロパティ更新通知を有効にします。プロパティ値の更新は MQTT トピック $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId> に発行されます。各 ID はアセットプロパティのプロパティ、アセット、モデル ID に置き換えられます。


aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --property-notification-state ENABLED \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power"

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「その他のサービスの操作」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAssetProperty」を参照してください。

次の例は、update-asset を使用する方法を説明しています。

AWS CLI

アセットの名前を更新するには

次の update-asset の例では、風力タービンアセットの名前を更新します。


aws iotsitewise update-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --asset-name "Wind Turbine 2"

出力:


{
    "assetStatus": {
        "state": "UPDATING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「アセットの更新」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAsset」を参照してください。

次の例は、update-dashboard を使用する方法を説明しています。

AWS CLI

ダッシュボードを更新するには

次の update-dashboard の例では、風力発電所の総発電電力が表示されるダッシュボードの折れ線グラフのタイトルを変更します。


aws iotsitewise update-dashboard \
    --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \
    --dashboard-name "Wind Farm" \
    --dashboard-definition file://update-wind-farm-dashboard.json

update-wind-farm-dashboard.json の内容:


{
    "widgets": [
        {
            "type": "monitor-line-chart",
            "title": "Total Generated Power",
            "x": 0,
            "y": 0,
            "height": 3,
            "width": 3,
            "metrics": [
                {
                    "label": "Power",
                    "type": "iotsitewise",
                    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"
                }
            ]
        }
    ]
}

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Creating dashboards (CLI)」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateDashboard」を参照してください。

次の例は、update-gateway-capability-configuration を使用する方法を説明しています。

AWS CLI

ゲートウェイ機能を更新するには

次の update-gateway-capability-configuration の例では、次のプロパティを使用して OPC-UA ソースを設定します。

すべての証明書を信頼する。Basic256 アルゴリズムを使用してメッセージを保護する。SignAndEncrypt モードを使用して接続を保護する。AWS Secrets Manager シークレットに保存されている認証情報を使用する。


aws iotsitewise update-gateway-capability-configuration \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --capability-namespace "iotsitewise:opcuacollector:1" \
    --capability-configuration file://opc-ua-capability-configuration.json

opc-ua-capability-configuration.json の内容:


{
    "sources": [
        {
            "name": "Wind Farm #1",
            "endpoint": {
                "certificateTrust": {
                    "type": "TrustAny"
                },
                "endpointUri": "opc.tcp://203.0.113.0:49320",
                "securityPolicy": "BASIC256",
                "messageSecurityMode": "SIGN_AND_ENCRYPT",
                "identityProvider": {
                    "type": "Username",
                    "usernameSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-windfarm1-auth-1ABCDE"
                },
                "nodeFilterRules": []
            },
            "measurementDataStreamPrefix": ""
        }
    ]
}

出力:


{
    "capabilityNamespace": "iotsitewise:opcuacollector:1",
    "capabilitySyncStatus": "OUT_OF_SYNC"
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Configuring data sources」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateGatewayCapabilityConfiguration」を参照してください。

次の例は、update-gateway を使用する方法を説明しています。

AWS CLI

ゲートウェイの名前を更新するには

次の update-gateway の例では、ゲートウェイの名前を更新します。


aws iotsitewise update-gateway \
    --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \
    --gateway-name ExampleCorpGateway1

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Ingesting data using a gateway」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateGateway」を参照してください。

次の例は、update-portal を使用する方法を説明しています。

AWS CLI

ポータルの詳細を更新するには

次の update-portal の例では、風力発電所会社のウェブポータルを更新します。


aws iotsitewise update-portal \
    --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE \
    --portal-name WindFarmPortal \
    --portal-description "A portal that contains wind farm projects for Example Corp." \
    --portal-contact-email support@example.com \
    --role-arn arn:aws:iam::123456789012:role/MySiteWiseMonitorServiceRole

出力:


{
    "portalStatus": {
        "state": "UPDATING"
    }
}

詳細については、「AWS IoT SiteWise ユーザーガイド」の「Administering your portals」を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdatePortal」を参照してください。

次の例は、update-project を使用する方法を説明しています。

AWS CLI

プロジェクトの詳細を更新するには

次の update-project の例では、風力発電所プロジェクトを更新します。


aws iotsitewise update-project \
    --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \
    --project-name "Wind Farm 1" \
    --project-description "Contains asset visualizations for Wind Farm #1 for Example Corp."

このコマンドでは何も出力されません。

詳細については、「AWS IoT SiteWise Monitor アプリケーションガイド」の「プロジェクト詳細の変更を参照してください。

API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateProject」を参照してください。

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

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

ドキュメントの表記規則

AWS IoT Jobs SDK release

AWS IoT Things Graph