AWS IoT SiteWise-Beispiele unter Verwendung der AWS CLI - AWS Command Line Interface
Aktionen

AWS IoT SiteWise-Beispiele unter Verwendung der AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie die AWS Command Line Interface mit AWS IoT SiteWise nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie associate-assets verwendet wird.

AWS CLI

So ordnen Sie eine untergeordnete Komponente einer übergeordneten zu

Im folgenden associate-assets-Beispiel wird eine Windturbinenkomponente einer Windparkkomponente zugeordnet, wobei das Windturbinen-Komponentenmodell als Hierarchie im Windpark-Komponentenmodell 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 Zuordnen von Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter AssociateAssets in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie batch-associate-project-assets verwendet wird.

AWS CLI

So ordnen Sie eine Komponente einem Projekt zu

Im folgenden batch-associate-project-assets-Beispiel wird eine Windpark-Komponente 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 Komponenten zu Projekten im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie batch-disassociate-project-assets verwendet wird.

AWS CLI

So heben Sie die Zuordnung einer Komponente zu einem Projekt auf

Im folgenden batch-disassociate-project-assets-Beispiel wird die Zuordnung einer Windpark-Komponente 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 Komponenten zu Projekten im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie batch-put-asset-property-value verwendet wird.

AWS CLI

So senden Sie Daten an Komponenteneigenschaften.

Im folgenden batch-put-asset-property-value-Beispiel werden Leistungs- und Temperaturdaten an die Eigenschaften der Komponente gesendet, die durch Eigenschaftsaliase identifiziert sind.

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 Erfassen von Daten über die API von AWS IoT SiteWise im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie create-access-policy verwendet wird.

AWS CLI

Beispiel 1: So gewähren Sie einem Benutzer Administratorzugriff auf ein Portal

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 Benutzerhandbuch zu AWS IoT SiteWise.

Beispiel 2: So gewähren Sie einem Benutzer schreibgeschützten Zugriff auf ein Projekt

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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie create-asset-model verwendet wird.

AWS CLI

So erstellen Sie ein Komponentenmodell

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

Seriennummer: Die Seriennummer einer WindturbineErzeugte Leistung: Der Datenstrom der erzeugten Leistung aus einer WindturbineTemperatur C: Der Temperatur-Datenstrom einer Windturbine in CelsiusTemperatur F: Die umgewandelten Temperatur-Datenpunkte von Celsius in 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 Komponentenmodellen im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter CreateAssetModel in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-asset verwendet wird.

AWS CLI

So erstellen Sie eine Komponente

Im folgenden create-asset-Beispiel wird aus dem Komponentenmodell einer Windturbine eine Windturbinenkomponente 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 unter Erstellen von Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter CreateAsset in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-dashboard verwendet wird.

AWS CLI

So erstellen Sie ein Dashboard

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 Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter CreateDashboard in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-gateway verwendet wird.

AWS CLI

So erstellen Sie ein Gateway

Im folgenden create-gateway-Beispiel wird ein Gateway erstellt, das auf AWS IoT Greengrass ausgeführt wird.

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 Konfigurieren eines Gateways im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter CreateGateway in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-portal verwendet wird.

AWS CLI

So erstellen Sie ein Portal

Im folgenden create-portal-Beispiel wird ein Webportal für ein Windparkunternehmen erstellt. Sie können Portale nur in der 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 Benutzerhandbuch zu AWS IoT SiteWise und Aktivieren von AWS SSO im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter CreatePortal in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie create-project verwendet wird.

AWS CLI

So erstellen Sie ein Projekt

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 Erstellen von Projekten im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter CreateProject in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-access-policy verwendet wird.

AWS CLI

So widerrufen Sie den Zugriff eines Benutzers auf ein Projekt oder Portal

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 Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie delete-asset-model verwendet wird.

AWS CLI

So löschen Sie ein Komponentenmodell

Im folgenden delete-asset-model-Beispiel wird ein Windturbinen-Komponentenmodell 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 Komponentenmodellen im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie delete-asset verwendet wird.

AWS CLI

So löschen Sie ein Asset

Im folgenden delete-asset-Beispiel wird eine Windturbinen-Komponente 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 Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DeleteAsset in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-dashboard verwendet wird.

AWS CLI

So löschen Sie ein Dashboard

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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter DeleteDashboard in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-gateway verwendet wird.

AWS CLI

So löschen Sie ein Gateway

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 Erfassen von Daten mit einem Gateway im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DeleteGateway in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-portal verwendet wird.

AWS CLI

So löschen Sie ein Portal

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 Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DeletePortal in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie delete-project verwendet wird.

AWS CLI

So löschen Sie ein Projekt

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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter DeleteProject in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-access-policy verwendet wird.

AWS CLI

So beschreiben Sie eine Zugriffsrichtlinie

Im folgenden describe-access-policy-Beispiel wird eine Zugriffsrichtlinie beschrieben, 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 Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie describe-asset-model verwendet wird.

AWS CLI

So beschreiben Sie ein Komponentenmodell

Im folgenden describe-asset-model-Beispiel wird das Windpark-Komponentenmodell beschrieben.

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 Beschreiben eines bestimmten Komponentenmodells im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie describe-asset-property verwendet wird.

AWS CLI

So beschreiben Sie eine Asset-Eigenschaft

Im folgenden describe-asset-property-Beispiel wird die gesamte erzeugte Leistung einer Windparkkomponente beschrieben.

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 Beschreiben einer bestimmten Komponenteneigenschaft im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie describe-asset verwendet wird.

AWS CLI

So beschreiben Sie ein Asset

Das folgende describe-asset-Beispiel beschreibt eine Windpark-Komponente.

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 Beschreiben einer bestimmten Komponente im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DescribeAsset in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-dashboard verwendet wird.

AWS CLI

So beschreiben Sie ein Dashboard

Im folgenden describe-dashboard-Beispiel wird das angegebene Windpark-Dashboard beschrieben.

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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie describe-gateway-capability-configuration verwendet wird.

AWS CLI

So beschreiben Sie eine Gateway-Kapazität

Im folgenden describe-gateway-capability-configuration-Beispiel wird eine OPC-UA-Quellfunktion beschrieben.

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 Konfigurieren von Datenquellen im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie describe-gateway verwendet wird.

AWS CLI

So beschreiben Sie ein Gateway

Im folgenden describe-gateway-Beispiel wird ein Gateway beschrieben.

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 Erfassen von Daten mit einem Gateway im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DescribeGateway in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-logging-options verwendet wird.

AWS CLI

So rufen Sie die aktuellen Protokollierungsoptionen von AWS IoT SiteWise ab

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

aws iotsitewise describe-logging-options

Ausgabe:

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

Weitere Informationen finden Sie unter Überwachen von AWS IoT SiteWise mit Amazon CloudWatch Logs im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie describe-portal verwendet wird.

AWS CLI

So beschreiben Sie ein Portal

Im folgenden describe-portal-Beispiel wird ein Webportal für ein Windparkunternehmen beschrieben.

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 Verwalten Ihres Portals im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter DescribePortal in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie describe-project verwendet wird.

AWS CLI

So beschreiben Sie ein Projekt

Im folgenden describe-project-Beispiel wird ein Windparkprojekt beschrieben.

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 Anzeigen von Projektdetails im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter DescribeProject in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie disassociate-assets verwendet wird.

AWS CLI

So heben Sie die Zuordnung einer untergeordneten Komponente zu einer übergeordneten Komponente auf

Im folgenden disassociate-assets-Beispiel wird die Zuordnung einer Windturbinen-Komponente zu einer Windpark-Komponente aufgehoben.

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 Zuordnen von Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie get-asset-property-aggregates verwendet wird.

AWS CLI

So rufen Sie die aggregierten Werte für Durchschnitt und Anzahl einer Komponenteneigenschaft ab

Im folgenden get-asset-property-aggregates-Beispiel werden die durchschnittliche Gesamtleistung und die Anzahl der Gesamtleistungs-Datenpunkte einer Windturbinen-Komponente 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 Komponenteneigenschafts-Aggregaten im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie get-asset-property-value-history verwendet wird.

AWS CLI

So rufen Sie die historischen Werte einer Komponenteneigenschaft ab

Im folgenden get-asset-property-value-history-Beispiel werden die Gesamtleistungswerte einer Windturbinen-Komponente 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 von historischen Komponenteneigenschaftswerten im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie get-asset-property-value verwendet wird.

AWS CLI

So rufen Sie den aktuellen Wert einer Komponenteneigenschaft ab

Im folgenden get-asset-property-value-Beispiel wird die aktuelle Gesamtleistung einer Windturbinen-Komponente 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 von aktuellen Komponenteneigenschaftswerten im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie list-access-policies verwendet wird.

AWS CLI

So listen Sie alle Zugriffsrichtlinien auf

Im folgenden list-access-policies-Beispiel werden alle Zugriffsrichtlinien für einen Benutzer aufgelistet, 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 Verwalten Ihres Portals im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie list-asset-models verwendet wird.

AWS CLI

So listen Sie alle Komponentenmodelle auf

Im folgenden list-asset-models-Beispiel werden alle Komponentenmodelle aufgelistet, 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 Komponentenmodelle im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter ListAssetModels in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-assets verwendet wird.

AWS CLI

Beispiel 1: So listen Sie alle Komponenten der obersten Ebene auf

Im folgenden list-assets-Beispiel werden alle Komponenten aufgelistet, die sich in der Hierarchiestruktur der Komponente 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 Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

Beispiel 2: So listen Sie alle Komponenten auf Basis eines Komponentenmodells auf

Im folgenden list-assets-Beispiel werden alle Komponenten aufgelistet, die auf einem Komponentenmodell 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 Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter ListAssets in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-associated-assets verwendet wird.

AWS CLI

So listen Sie alle Komponenten auf, die einer Komponente in einer bestimmten Hierarchie zugeordnet sind

Im folgenden list-associated-assets-Beispiel werden alle Windturbinen-Komponenten aufgeführt, die der angegebenen Windpark-Komponente 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 unter Auflisten von Komponenten, die einer bestimmten Komponente zugeordnet sind im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie list-dashboards verwendet wird.

AWS CLI

So listen Sie alle Dashboards in einem Projekt auf

Im folgenden list-dashboards-Beispiel werden alle Dashboards aufgelistet, 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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter ListDashboards in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-gateways verwendet wird.

AWS CLI

So listen Sie alle Gateways auf

Im folgenden list-gateways-Beispiel werden alle Gateways aufgelistet, 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 Erfassen von Daten mit einem Gateway im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter ListGateways in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-portals verwendet wird.

AWS CLI

So listen Sie alle Portale auf

Im folgenden list-portals-Beispiel werden alle Portale aufgelistet, 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 Verwalten Ihres Portals im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter ListPortals in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-project-assets verwendet wird.

AWS CLI

So listen Sie alle Komponenten auf, die einem Projekt zugeordnet sind

Im folgenden list-project-assets-Beispiel werden alle Komponenten aufgelistet, 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 Komponenten zu Projekten im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie list-projects verwendet wird.

AWS CLI

So listen Sie alle Projekte in einem Portal auf

Im folgenden list-projects-Beispiel werden alle Projekte aufgelistet, 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 Anzeigen von Projektdetails im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter ListProjects in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie list-tags-for-resource verwendet wird.

AWS CLI

So listen Sie alle Tags für eine Ressource auf

Im folgenden list-tags-for-resource-Beispiel werden alle Tags für eine Windturbinen-Komponente aufgelistet.

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 Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie put-logging-options verwendet wird.

AWS CLI

So legen Sie den Grad der Protokollierung fest

Im folgenden put-logging-options-Beispiel wird die INFO-Level-Protokollierung in AWS IoT SiteWise aktiviert. Andere Level umfassen DEBUG und OFF.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Überwachen von AWS IoT SiteWise mit Amazon CloudWatch Logs im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie tag-resource verwendet wird.

AWS CLI

So fügen Sie einer Ressource einen Tag hinzu

Im folgenden tag-resource-Beispiel wird einer Windturbinen-Komponente ein Eigentümer-Tag hinzugefügt. Auf diese Weise können Sie den Zugriff auf die Komponente auf Basis dessen steuern, wem sie 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 Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter TagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie untag-resource verwendet wird.

AWS CLI

So entfernen Sie ein Tag von einer Ressource

Im folgenden untag-resource-Beispiel wird ein Eigentümer-Tag von einer Windturbinen-Komponente 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 Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter UntagResource in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-access-policy verwendet wird.

AWS CLI

So gewähren Sie einem Projekt-Viewer die Eigentümerschaft an einem Projekt

Im folgenden update-access-policy-Beispiel wird eine Zugriffsrichtlinie aktualisiert, die einem Projekt-Viewer die Eigentümerschaft 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 Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

Das folgende Codebeispiel zeigt, wie update-asset-model verwendet wird.

AWS CLI

So aktualisieren Sie ein Komponentenmodell

Im folgenden update-asset-model-Beispiel wird die Beschreibung des Komponentenmodells eines Windparks aktualisiert. In diesem Beispiel werden die vorhandenen IDs und Definitionen des Modells berücksichtigt, da update-asset-model das vorhandene Modell mit dem neuen Modell überschreibt.

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 Komponentenmodellen im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie update-asset-property verwendet wird.

AWS CLI

Beispiel 1: So aktualisieren Sie den Alias einer Komponenteneigenschaft

Im folgenden update-asset-property-Beispiel wird der Leistungs-Alias einer Windturbinen-Komponente 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 unter Zuordnen von industriellen Datenströmen zu Komponenteneigenschaften im Benutzerhandbuch zu AWS IoT SiteWise.

Beispiel 2: So aktivieren Sie Benachrichtigungen zu Komponenteneigenschaften

Im folgenden update-asset-property-Beispiel werden Benachrichtigungen zur Aktualisierung von Komponenteneigenschaften für die Leistung einer Windturbinen-Komponente aktiviert. Aktualisierungen von Eigenschaftswerten werden im MQTT-Thema $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId> veröffentlicht, wobei jede ID durch die Eigenschafts-, Komponenten- und Modell-ID der Komponenteneigenschaft 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 Services im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie update-asset verwendet wird.

AWS CLI

So aktualisieren Sie den Namen einer Komponente

Im folgenden update-asset-Beispiel wird der Name einer Windturbinen-Komponente 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 Komponenten im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter UpdateAsset in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-dashboard verwendet wird.

AWS CLI

So aktualisieren Sie ein Dashboard

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 Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter UpdateDashboard in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-gateway-capability-configuration verwendet wird.

AWS CLI

So aktualisieren Sie eine Gateway-Kapazität

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 Authentifizierungs-Anmeldeinformationen, die in einem Geheimnis von AWS Secrets Manager gespeichert sind.

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 Konfigurieren von Datenquellen im Benutzerhandbuch zu AWS IoT SiteWise.

Das folgende Codebeispiel zeigt, wie update-gateway verwendet wird.

AWS CLI

So aktualisieren Sie den Namen eines Gateways

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 Erfassen von Daten mit einem Gateway im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter UpdateGateway in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-portal verwendet wird.

AWS CLI

So aktualisieren Sie die Details eines Portals

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 Verwalten Ihres Portals im Benutzerhandbuch zu AWS IoT SiteWise.

  • API-Details finden Sie unter UpdatePortal in der AWS CLI-Befehlsreferenz.

Das folgende Codebeispiel zeigt, wie update-project verwendet wird.

AWS CLI

So aktualisieren Sie die Details eines Projekts

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 Ändern von Projektdetails im Anwendungsleitfaden zu AWS IoT SiteWise Monitor.

  • API-Details finden Sie unter UpdateProject in der AWS CLI-Befehlsreferenz.