AWS IoT SiteWise Beispiele mit AWS CLI

Um eine untergeordnete Anlage einer übergeordneten Anlage zuzuordnen

Im folgenden associate-assets Beispiel wird eine Windturbinenanlage einer Windparkanlage zugeordnet, wobei das Windturbinenanlagenmodell als Hierarchie im Windpark-Anlagenmodell existiert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Assets zuordnen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset einem Projekt zuzuordnen

Im folgenden batch-associate-project-assets Beispiel wird ein Windpark-Objekt einem Projekt zugeordnet.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Hinzufügen von Assets zu Projekten im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um ein Asset von einem Projekt zu trennen

Im folgenden batch-disassociate-project-assets Beispiel wird die Zuordnung einer Windpark-Anlage zu einem Projekt aufgehoben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Hinzufügen von Assets zu Projekten im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um Daten an Objekteigenschaften zu senden

Im folgenden batch-put-asset-property-value Beispiel werden Strom- und Temperaturdaten an die durch Eigenschaftsaliase identifizierten Eigenschaften der Anlage gesendet.

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

Inhalt von 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
                    }
                }
            ]
        }
    ]
}

Ausgabe:

{
    "errorEntries": []
}

Weitere Informationen finden Sie unter Daten mithilfe der AWS SiteWise IoT-API aufnehmen im AWS SiteWise IoT-Benutzerhandbuch.

Beispiel 1: Um einem Benutzer Administratorzugriff auf ein Portal zu gewähren

Im folgenden create-access-policy Beispiel wird eine Zugriffsrichtlinie erstellt, die einem Benutzer Administratorzugriff auf ein Webportal für ein Windparkunternehmen gewährt.

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

Inhalt von 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"
        }
    }
}

Ausgabe:

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

Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von Portaladministratoren im AWS SiteWise IoT-Benutzerhandbuch.

Beispiel 2: Um einem Benutzer nur Lesezugriff auf ein Projekt zu gewähren

Im folgenden create-access-policy Beispiel wird eine Zugriffsrichtlinie erstellt, die einem Benutzer nur Lesezugriff auf ein Windparkprojekt gewährt.

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

Inhalt von 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"
        }
    }
}

Ausgabe:

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

Weitere Informationen finden Sie unter Zuweisen von Projekt-Viewern im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um ein Asset-Modell zu erstellen

Im folgenden create-asset-model Beispiel wird ein Anlagenmodell erstellt, das eine Windturbine mit den folgenden Eigenschaften definiert:

Seriennummer — Die Seriennummer einer WindturbineErzeugter Strom — Der erzeugte Energiedatenstrom aus einer WindturbineTemperatur C — Der Temperaturdatenstrom einer Windturbine in CelsiusTemperature F — Die abgebildeten Temperaturdatenpunkte von Celsius bis Fahrenheit

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

Inhalt von 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"
                        }
                    }
                }
            }
        }
    ]
}

Ausgabe:

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

Weitere Informationen finden Sie unter Definieren von Asset-Modellen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset zu erstellen

Im folgenden create-asset Beispiel wird aus einem Anlagenmodell eine Windenergieanlage erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie im AWS SiteWise IoT-Benutzerhandbuch unter Assets erstellen.

Um ein Dashboard zu erstellen

Im folgenden create-dashboard Beispiel wird ein Dashboard mit einem Liniendiagramm erstellt, das die gesamte erzeugte Leistung für einen Windpark anzeigt.

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

Inhalt von 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"
                }
            ]
        }
    ]
}

Ausgabe:

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

Weitere Informationen finden Sie unter Erstellen von Dashboards (CLI) im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Gateway zu erstellen

Das folgende create-gateway Beispiel erstellt ein Gateway, das auf AWS IoT Greengrass läuft.

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}

Ausgabe:

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

Weitere Informationen finden Sie unter Konfiguration eines Gateways im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Portal zu erstellen

Im folgenden create-portal Beispiel wird ein Webportal für ein Windparkunternehmen erstellt. Sie können Portale nur in derselben Region erstellen, in der Sie AWS Single Sign-On aktiviert haben.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Erste Schritte mit AWS IoT SiteWise Monitor im AWS SiteWise IoT-Benutzerhandbuch und AWS SSO aktivieren im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Projekt zu erstellen

Im folgenden create-project Beispiel wird ein Windparkprojekt erstellt.

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."

Ausgabe:

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

Weitere Informationen finden Sie unter Projekte erstellen im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um einem Benutzer den Zugriff auf ein Projekt oder Portal zu entziehen

Im folgenden delete-access-policy Beispiel wird eine Zugriffsrichtlinie gelöscht, die einem Benutzer Administratorzugriff auf ein Portal gewährt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von Portaladministratoren im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset-Modell zu löschen

Im folgenden delete-asset-model Beispiel wird ein Anlagenmodell einer Windkraftanlage gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Löschen von Asset-Modellen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset zu löschen

Im folgenden delete-asset Beispiel wird ein Windturbinen-Asset gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Löschen von Assets im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Dashboard zu löschen

Im folgenden delete-dashboard Beispiel wird ein Windturbinen-Dashboard gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen von Dashboards im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um ein Gateway zu löschen

Im folgenden delete-gateway Beispiel wird ein Gateway gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Daten mithilfe eines Gateways aufnehmen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Portal zu löschen

Im folgenden delete-portal Beispiel wird ein Webportal für ein Windparkunternehmen gelöscht.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Löschen eines Portals im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Projekt zu löschen

Im folgenden delete-project Beispiel wird ein Windparkprojekt gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Löschen von Projekten im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um eine Zugriffsrichtlinie zu beschreiben

Das folgende describe-access-policy Beispiel beschreibt eine Zugriffsrichtlinie, die einem Benutzer Administratorzugriff auf ein Webportal für ein Windparkunternehmen gewährt.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Hinzufügen oder Entfernen von Portaladministratoren im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset-Modell zu beschreiben

Das folgende describe-asset-model Beispiel beschreibt ein Anlagenmodell für Windparks.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Beschreibung eines bestimmten Asset-Modells im AWS SiteWise IoT-Benutzerhandbuch.

Um eine Immobilie zu beschreiben

Das folgende describe-asset-property Beispiel beschreibt die gesamte Stromerzeugungskapazität einer Windparkanlage.

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

Ausgabe:

{
    "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"
                    }
                }
            }
        }
    }
}

Weitere Informationen finden Sie unter Beschreibung einer bestimmten Anlageneigenschaft im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Asset zu beschreiben

Das folgende describe-asset Beispiel beschreibt ein Windpark-Asset.

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

Ausgabe:

{
    "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"
    }
}

Weitere Informationen finden Sie unter Beschreibung eines bestimmten Assets im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Dashboard zu beschreiben

Das folgende describe-dashboard Beispiel beschreibt das angegebene Windpark-Dashboard.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Anzeigen von Dashboards im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um eine Gateway-Fähigkeit zu beschreiben

Das folgende describe-gateway-capability-configuration Beispiel beschreibt eine OPC-UA-Quellfunktion.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Konfiguration von Datenquellen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Gateway zu beschreiben

Das folgende describe-gateway Beispiel beschreibt ein Gateway.

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

Ausgabe:

{
    "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
}

Weitere Informationen finden Sie unter Daten mithilfe eines Gateways aufnehmen im AWS SiteWise IoT-Benutzerhandbuch.

Um die aktuellen AWS SiteWise IoT-Protokollierungsoptionen abzurufen

Im folgenden describe-logging-options Beispiel werden die aktuellen AWS SiteWise IoT-Protokollierungsoptionen für Ihr AWS Konto in der aktuellen Region abgerufen.

aws iotsitewise describe-logging-options

Ausgabe:

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

Weitere Informationen finden Sie unter Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Portal zu beschreiben

Das folgende describe-portal Beispiel beschreibt ein Webportal für ein Windparkunternehmen.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Verwaltung Ihrer Portale im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Projekt zu beschreiben

Das folgende describe-project Beispiel beschreibt ein Windparkprojekt.

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

Ausgabe:

{
    "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"
}

Weitere Informationen finden Sie unter Projektdetails anzeigen im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um eine untergeordnete Anlage von einer übergeordneten Anlage zu trennen

Im folgenden disassociate-assets Beispiel wird die Zuordnung einer Windturbinenanlage von einer Windparkanlage getrennt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Assets zuordnen im AWS SiteWise IoT-Benutzerhandbuch.

Um die aggregierten Durchschnitts- und Zählwerte einer Anlageeigenschaft abzurufen

Im folgenden get-asset-property-aggregates Beispiel werden die durchschnittliche Gesamtleistung und die Anzahl der Gesamtleistungsdatenpunkte einer Windenergieanlage für einen Zeitraum von 1 Stunde abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Abfragen von Aggregaten für Asset-Eigenschaften im AWS SiteWise IoT-Benutzerhandbuch.

Um die historischen Werte einer Anlageeigenschaft abzurufen

Im folgenden get-asset-property-value-history Beispiel werden die Gesamtleistungswerte einer Windenergieanlage für einen Zeitraum von 20 Minuten abgerufen.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Abfragen historischer Immobilienwerte im AWS SiteWise IoT-Benutzerhandbuch.

Um den aktuellen Wert einer Anlageeigenschaft abzurufen

Im folgenden get-asset-property-value Beispiel wird die aktuelle Gesamtleistung einer Windenergieanlage abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Abfragen aktueller Objekteigenschaftswerte im AWS SiteWise IoT-Benutzerhandbuch.

Um alle Zugriffsrichtlinien aufzulisten

Das folgende list-access-policies Beispiel listet alle Zugriffsrichtlinien für einen Benutzer auf, der Portaladministrator ist.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Verwaltung Ihrer Portale im AWS SiteWise IoT-Benutzerhandbuch.

Um alle Asset-Modelle aufzulisten

Das folgende list-asset-models Beispiel listet alle Vermögensmodelle auf, die in Ihrem AWS Konto in der aktuellen Region definiert sind.

aws iotsitewise list-asset-models

Ausgabe:

{
    "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"
            }
        }
    ]
}

Weitere Informationen finden Sie unter Auflisten aller Asset-Modelle im AWS SiteWise IoT-Benutzerhandbuch.

Beispiel 1: Um alle Vermögenswerte der obersten Ebene aufzulisten

Das folgende list-assets Beispiel listet alle Vermögenswerte auf, die sich in der Asset-Hierarchiestruktur auf oberster Ebene befinden und in Ihrem AWS Konto in der aktuellen Region definiert sind.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

Ausgabe:

{
    "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"
                }
            ]
        }
    ]
}

Weitere Informationen finden Sie unter Auflisten von Assets im AWS SiteWise IoT-Benutzerhandbuch.

Beispiel 2: Um alle Anlagen aufzulisten, die auf einem Asset-Modell basieren

Im folgenden list-assets Beispiel werden alle Vermögenswerte aufgeführt, die auf einem Vermögensmodell basieren und in Ihrem AWS Konto in der aktuellen Region definiert sind.

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

Ausgabe:

{
    "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": []
        }
    ]
}

Weitere Informationen finden Sie unter Auflisten von Assets im AWS SiteWise IoT-Benutzerhandbuch.

Um alle mit einem Asset verknüpften Assets in einer bestimmten Hierarchie aufzulisten

Das folgende list-associated-assets Beispiel listet alle Windturbinenanlagen auf, die dem angegebenen Windpark-Asset zugeordnet sind.

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

Ausgabe:

{
    "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": []
        }
    ]
}

Weitere Informationen finden Sie im AWS SiteWise IoT-Benutzerhandbuch unter Auflisten von Assets, die einem bestimmten Asset zugeordnet sind.

Um alle Dashboards in einem Projekt aufzulisten

Das folgende list-dashboards Beispiel listet alle Dashboards auf, die in einem Projekt definiert sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Anzeigen von Dashboards im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um alle Gateways aufzulisten

Das folgende list-gateways Beispiel listet alle Gateways auf, die in Ihrem AWS Konto in der aktuellen Region definiert sind.

aws iotsitewise list-gateways

Ausgabe:

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

Weitere Informationen finden Sie unter Daten mithilfe eines Gateways aufnehmen im AWS SiteWise IoT-Benutzerhandbuch.

Um alle Portale aufzulisten

Das folgende list-portals Beispiel listet alle Portale auf, die in Ihrem AWS Konto in der aktuellen Region definiert sind.

aws iotsitewise list-portals

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Verwaltung Ihrer Portale im AWS SiteWise IoT-Benutzerhandbuch.

Um alle mit einem Projekt verknüpften Assets aufzulisten

Im folgenden list-project-assets Beispiel werden alle Anlagen aufgeführt, die einem Windparkprojekt zugeordnet sind.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Hinzufügen von Assets zu Projekten im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um alle Projekte in einem Portal aufzulisten

Das folgende list-projects Beispiel listet alle Projekte auf, die in einem Portal definiert sind.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Projektdetails anzeigen im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um alle Tags für eine Ressource aufzulisten

Das folgende list-tags-for-resource Beispiel listet alle Tags für eine Windturbinenanlage auf.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Taggen Ihrer Ressourcen im AWS SiteWise IoT-Benutzerhandbuch.

Um die Protokollierungsebene anzugeben

Das folgende put-logging-options Beispiel aktiviert die INFO Level-Protokollierung in AWS IoT SiteWise. Andere Ebenen umfassen DEBUG undOFF.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs im AWS SiteWise IoT-Benutzerhandbuch.

So fügen Sie einer Ressource einen Tag hinzu

Im folgenden tag-resource Beispiel wird einer Windturbinenanlage ein Besitzer-Tag hinzugefügt. Auf diese Weise können Sie den Zugriff auf das Asset anhand dessen steuern, wem es gehört.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Taggen Ihrer Ressourcen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Tag aus einer Ressource zu entfernen

Im folgenden untag-resource Beispiel wird ein Besitzer-Tag aus einer Windturbinenanlage entfernt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Taggen Ihrer Ressourcen im AWS SiteWise IoT-Benutzerhandbuch.

Um einem Projektbetrachter das Eigentum an einem Projekt zu gewähren

Im folgenden update-access-policy Beispiel wird eine Zugriffsrichtlinie aktualisiert, die einem Projektbetrachter die Inhaberschaft an einem Projekt gewährt.

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

Inhalt von 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"
        }
    }
}

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Zuweisen von Projekteigentümern im AWS IoT SiteWise Monitor-Anwendungshandbuch.

Um ein Asset-Modell zu aktualisieren

Im folgenden update-asset-model Beispiel wird die Beschreibung eines Windpark-Assetmodells aktualisiert. In diesem Beispiel werden die vorhandenen IDs und die Definitionen des Modells berücksichtigt, da das bestehende Modell durch das neue Modell update-asset-model überschrieben wird.

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

Inhalt von 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"
        }
    ]
}

Ausgabe:

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

Weitere Informationen finden Sie unter Aktualisieren von Asset-Modellen im AWS SiteWise IoT-Benutzerhandbuch.

Beispiel 1: Um den Alias einer Asset-Eigenschaft zu aktualisieren

Im folgenden update-asset-property Beispiel wird der Alias für die Energieeigenschaft einer Windenergieanlage aktualisiert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie im AWS SiteWise IoT-Benutzerhandbuch unter Zuordnung von industriellen Datenströmen zu Anlageneigenschaften.

Beispiel 2: Um Benachrichtigungen über Anlageneigenschaften zu aktivieren

Im folgenden update-asset-property Beispiel werden Benachrichtigungen zur Aktualisierung von Anlageneigenschaften für die Energieeigenschaften einer Windenergieanlage aktiviert. Aktualisierungen von Eigenschaftswerten werden im MQTT-Thema veröffentlicht$aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, wobei jede ID durch die Eigenschafts-, Anlagen- und Modell-ID der Anlageneigenschaft ersetzt wird.

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"

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Interaktion mit anderen Diensten im AWS SiteWise IoT-Benutzerhandbuch.

Um den Namen eines Assets zu aktualisieren

Im folgenden update-asset Beispiel wird der Name einer Windenergieanlage aktualisiert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktualisieren von Ressourcen im AWS SiteWise IoT-Benutzerhandbuch.

Um ein Dashboard zu aktualisieren

Im folgenden update-dashboard Beispiel wird der Titel des Liniendiagramms eines Dashboards geändert, in dem die gesamte erzeugte Leistung für einen Windpark angezeigt wird.

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

Inhalt von 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"
                }
            ]
        }
    ]
}

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Erstellen von Dashboards (CLI) im AWS SiteWise IoT-Benutzerhandbuch.

Um eine Gateway-Funktion zu aktualisieren

Im folgenden update-gateway-capability-configuration Beispiel wird eine OPC-UA-Quelle mit den folgenden Eigenschaften konfiguriert:

Vertraut jedem Zertifikat. Verwendet den Basic256-Algorithmus, um Nachrichten zu sichern. Verwendet den SignAndEncrypt Modus, um Verbindungen zu sichern. Verwendet Authentifizierungsdaten, die in einem Secrets Manager-Geheimnis gespeichert sind. AWS

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

Inhalt von 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": ""
        }
    ]
}

Ausgabe:

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

Weitere Informationen finden Sie unter Konfiguration von Datenquellen im AWS SiteWise IoT-Benutzerhandbuch.

Um den Namen eines Gateways zu aktualisieren

Im folgenden update-gateway Beispiel wird der Name eines Gateways aktualisiert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Daten mithilfe eines Gateways aufnehmen im AWS SiteWise IoT-Benutzerhandbuch.

Um die Details eines Portals zu aktualisieren

Im folgenden update-portal Beispiel wird ein Webportal für ein Windparkunternehmen aktualisiert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwaltung Ihrer Portale im AWS SiteWise IoT-Benutzerhandbuch.

Um die Details eines Projekts zu aktualisieren

Im folgenden update-project Beispiel wird ein Windparkprojekt aktualisiert.

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."

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Projektdetails ändern im AWS IoT SiteWise Monitor-Anwendungshandbuch.