使用 AWS CLI 的 AWS IoT SiteWise 示例 - AWS Command Line Interface
操作

使用 AWS CLI 的 AWS IoT SiteWise 示例

以下代码示例演示了如何通过将 AWS Command Line Interface与 AWS IoT SiteWise 结合使用，来执行操作和实现常见场景。

操作 是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示了如何使用 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 用户指南》中的关联资产。

  • 有关 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 应用指南》中的向项目添加资产。

以下代码示例演示了如何使用 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 应用指南》中的向项目添加资产。

以下代码示例演示了如何使用 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 用户指南》中的使用 AWS IoT SiteWise API 接收数据。

以下代码示例演示了如何使用 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 用户指南》中的添加或删除门户管理员。

示例 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 IoT SiteWise Monitor 应用指南》中的分配项目查看者。

  • 有关 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 用户指南》中的定义资产模型。

  • 有关 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 用户指南》中的创建资产。

  • 有关 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 用户指南》中的创建仪表板（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 用户指南》中的配置网关。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateGateway。

以下代码示例演示了如何使用 create-portal。

AWS CLI

创建门户

以下 create-portal 示例为一家风电场公司创建一个门户网站。您只能在启用了 AWS 单点登录的同一区域创建门户。

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 用户指南》中的 AWS IoT SiteWise Monitor 入门和《AWS IoT SiteWise 用户指南》中的启用 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 应用指南》中的创建项目。

  • 有关 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 用户指南》中的添加或删除门户管理员。

  • 有关 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 用户指南》中的删除资产模型。

  • 有关 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 用户指南》中的删除资产。

  • 有关 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 用户指南》中的使用网关提取数据。

  • 有关 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 用户指南》中的删除门户。

  • 有关 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 应用指南》中的删除项目。

  • 有关 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 用户指南》中的添加或删除门户管理员。

以下代码示例演示了如何使用 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 用户指南》中的描述特定资产模型。

  • 有关 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 用户指南》中的描述特定资产属性。

以下代码示例演示了如何使用 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 用户指南》中的描述特定资产。

  • 有关 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 用户指南》中的配置数据源。

以下代码示例演示了如何使用 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 用户指南》中的使用网关提取数据。

  • 有关 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 用户指南》中的使用 Amazon CloudWatch Logs 监控 AWS IoT SiteWise。

以下代码示例演示了如何使用 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 用户指南》中的管理您的门户。

  • 有关 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 用户指南》中的关联资产。

  • 有关 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 用户指南》中的查询资产属性聚合值。

以下代码示例演示了如何使用 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 用户指南》中的查询历史资产属性值。

以下代码示例演示了如何使用 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 用户指南》中的查询当前资产属性值。

以下代码示例演示了如何使用 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 用户指南》中的管理您的门户。

  • 有关 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 用户指南》中的列出与特定资产关联的资产。

以下代码示例演示了如何使用 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 用户指南》中的使用网关提取数据。

  • 有关 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 用户指南》中的管理您的门户。

  • 有关 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 应用指南》中的向项目添加资产。

  • 有关 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 用户指南》中的标记资源。

以下代码示例演示了如何使用 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 用户指南》中的使用 Amazon CloudWatch Logs 监控 AWS IoT SiteWise。

  • 有关 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 IoT SiteWise Monitor 应用指南》中的分配项目所有者。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UpdateAccessPolicy。

以下代码示例演示了如何使用 update-asset-model。

AWS CLI

更新资产模型

以下 update-asset-model 示例更新一个风电场资产模型的描述。此示例包括模型的现有 ID 和定义，因为 update-asset-model 用新模型覆盖了现有模型。

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 用户指南》中的与其他服务交互。

以下代码示例演示了如何使用 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 用户指南》中的创建仪表板（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 用户指南》中的配置数据源。

以下代码示例演示了如何使用 update-gateway。

AWS CLI

更新网关的名称

以下 update-gateway 示例更新网关的名称。

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

此命令不生成任何输出。

有关更多信息，请参阅《AWS IoT SiteWise 用户指南》中的使用网关提取数据。

  • 有关 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 用户指南》中的管理您的门户。

  • 有关 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。