AWS IoT SiteWise esempi utilizzando AWS CLI - AWS Command Line Interface
Azioni

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

AWS IoT SiteWise esempi utilizzando AWS CLI

I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with AWS IoT SiteWise.

Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Azioni

Il seguente esempio di codice mostra come utilizzareassociate-assets.

AWS CLI

Come associare un asset secondario a un asset principale

L’esempio associate-assets seguente associa un asset turbina eolica a un asset parco eolico, dove il modello di asset turbina eolica è presente come gerarchia nel modello di asset parco eolico.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Associating assets nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarebatch-associate-project-assets.

AWS CLI

Come associare un asset a un progetto

L’esempio batch-associate-project-assets seguente associa un asset di tipo parco eolico a un progetto.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Aggiungere risorse ai progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarebatch-disassociate-project-assets.

AWS CLI

Come dissociare un asset da un progetto

L’esempio batch-disassociate-project-assets seguente disassocia un asset di tipo parco eolico da un progetto.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Aggiungere risorse ai progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarebatch-put-asset-property-value.

AWS CLI

Come inviare dati alle proprietà degli asset

L’esempio batch-put-asset-property-value seguente invia i dati di alimentazione e temperatura alle proprietà degli asset identificate dagli alias di proprietà.

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

Contenuto di 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
                    }
                }
            ]
        }
    ]
}

Output:

{
    "errorEntries": []
}

Per ulteriori informazioni, consulta Ingestione di dati utilizzando l' SiteWise API IoT nella AWSAWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarecreate-access-policy.

AWS CLI

Esempio 1: come concedere a un utente l’accesso amministrativo a un portale

L’esempio create-access-policy seguente crea una policy di accesso che concede a un utente l’accesso amministrativo a un portale web per una società che gestisce parchi eolici.

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

Contenuto di 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"
        }
    }
}

Output:

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

Per ulteriori informazioni, consulta Aggiungere o rimuovere amministratori del portale nella Guida per l' SiteWise utente AWS IoT.

Esempio 2: come concedere a un utente l’accesso in sola lettura a un progetto

L’esempio create-access-policy seguente crea una policy di accesso che concede a un utente l’accesso in sola lettura a un progetto di parco eolico.

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

Contenuto di 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"
        }
    }
}

Output:

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

Per ulteriori informazioni, consulta Assegnazione dei visualizzatori di progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarecreate-asset-model.

AWS CLI

Come creare un modello di asset

L’esempio create-asset-model seguente crea un modello di asset che definisce una turbina eolica con le seguenti proprietà:

Numero di serie - Il numero di serie di una turbina eolica Potenza generata - Il flusso di dati sulla potenza generata da una turbina eolica Temperatura C - Il flusso di dati della temperatura da una turbina eolica in CelsiusTemperature F - I dati di temperatura mappati da Celsius a Fahrenheit

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

Contenuto di 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"
                        }
                    }
                }
            }
        }
    ]
}

Output:

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

Per ulteriori informazioni, consulta Definizione dei modelli di asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarecreate-asset.

AWS CLI

Come creare un asset

L’esempio create-asset seguente crea un asset turbina eolica a partire da un modello di asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di risorse nella Guida per SiteWise l'utente AWS IoT.

Il seguente esempio di codice mostra come utilizzarecreate-dashboard.

AWS CLI

Come creare una dashboard

L’esempio create-dashboard seguente crea una dashboard con un grafico a linee che mostra la potenza totale generata per un parco eolico.

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

Contenuto di 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"
                }
            ]
        }
    ]
}

Output:

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

Per ulteriori informazioni, consulta Creazione di dashboard (CLI) nella Guida per l'utente AWS SiteWise IoT.

  • Per i dettagli sull'API, consulta AWS CLI Command CreateDashboardReference.

Il seguente esempio di codice mostra come utilizzarecreate-gateway.

AWS CLI

Come creare un gateway

L'create-gatewayesempio seguente crea un gateway che funziona su AWS IoT Greengrass.

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

Output:

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

Per ulteriori informazioni, consulta Configurazione di un gateway nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzarecreate-portal.

AWS CLI

Come creare un portale

L’esempio create-portal seguente crea un portale web per una società che gestisce parchi eolici. È possibile creare portali solo nella stessa regione in cui è stato abilitato il AWS Single Sign-On.

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

Output:

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

Per ulteriori informazioni, consulta la sezione Introduzione a AWS IoT SiteWise Monitor nella AWS IoT SiteWise User Guide e Enabling AWS SSO nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarecreate-project.

AWS CLI

Come creare un progetto

L’esempio create-project seguente crea un progetto di parco eolico.

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

Output:

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

Per ulteriori informazioni, consulta Creazione di progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzaredelete-access-policy.

AWS CLI

Come revocare l’accesso di un utente a un progetto o portale

L’esempio delete-access-policy seguente elimina una policy di accesso che concede a un utente l’accesso amministrativo a un portale.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Aggiungere o rimuovere amministratori del portale nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredelete-asset-model.

AWS CLI

Come eliminare un modello di asset

L’esempio delete-asset-model seguente elimina un modello di asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Eliminazione dei modelli di asset nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredelete-asset.

AWS CLI

Come eliminare un asset

L’esempio delete-asset seguente elimina un asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Eliminazione delle risorse nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredelete-dashboard.

AWS CLI

Come eliminare una dashboard

L’esempio delete-dashboard seguente elimina una dashboard di turbina eolica.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminazione dei dashboard nella Guida all'applicazione AWS IoT SiteWise Monitor.

  • Per i dettagli sull'API, consulta AWS CLI Command DeleteDashboardReference.

Il seguente esempio di codice mostra come utilizzaredelete-gateway.

AWS CLI

Come eliminare un gateway

L’esempio delete-gateway seguente elimina un gateway.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Ingestione di dati utilizzando un gateway nella AWS IoT SiteWise User Guide.

  • Per i dettagli sull'API, consulta AWS CLI Command DeleteGatewayReference.

Il seguente esempio di codice mostra come utilizzaredelete-portal.

AWS CLI

Come eliminare un portale

L’esempio delete-portal seguente elimina un portale web per una società che gestisce parchi eolici.

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

Output:

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

Per ulteriori informazioni, consulta Eliminazione di un portale nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredelete-project.

AWS CLI

Come eliminare un progetto

L’esempio delete-project seguente elimina un progetto di parco eolico.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Eliminazione di progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzaredescribe-access-policy.

AWS CLI

Come descrivere una policy di accesso

L’esempio describe-access-policy seguente descrive una policy di accesso che concede a un utente l’accesso amministrativo a un portale web per una società che gestisce parchi eolici.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere o rimuovere amministratori del portale nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredescribe-asset-model.

AWS CLI

Come descrivere un modello di asset

L’esempio describe-asset-model seguente descrive un modello di asset di tipo parco eolico.

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

Output:

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

Per ulteriori informazioni, consulta Descrivere un modello di asset specifico nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-asset-property.

AWS CLI

Come descrivere una proprietà di un asset

L’esempio describe-asset-property seguente descrive la proprietà della potenza totale generata da un impianto eolico.

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

Output:

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

Per ulteriori informazioni, consulta Descrivere una proprietà specifica dell'asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-asset.

AWS CLI

Come descrivere un asset

L’esempio describe-asset seguente descrive un asset di tipo parco eolico.

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

Output:

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

Per ulteriori informazioni, consulta Descrivere un asset specifico nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-dashboard.

AWS CLI

Come descrivere una dashboard

L’esempio describe-dashboard seguente descrive la dashboard di parco eolico specificata.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione dei dashboard nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzaredescribe-gateway-capability-configuration.

AWS CLI

Come descrivere una funzionalità gateway

L’esempio describe-gateway-capability-configuration seguente descrive una funzionalità di origine OPC-UA.

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

Output:

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

Per ulteriori informazioni, consulta Configurazione delle fonti di dati nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzaredescribe-gateway.

AWS CLI

Come descrivere un gateway

L’esempio describe-gateway seguente descrive un gateway.

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

Output:

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

Per ulteriori informazioni, consulta Ingestione di dati utilizzando un gateway nella AWS IoT SiteWise User Guide.

  • Per i dettagli sull'API, consulta AWS CLI Command DescribeGatewayReference.

Il seguente esempio di codice mostra come utilizzaredescribe-logging-options.

AWS CLI

Per recuperare le opzioni di SiteWise registrazione AWS IoT correnti

L'describe-logging-optionsesempio seguente recupera le opzioni di SiteWise registrazione AWS IoT correnti per il tuo AWS account nella regione corrente.

aws iotsitewise describe-logging-options

Output:

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

Per ulteriori informazioni, consulta Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzaredescribe-portal.

AWS CLI

Come descrivere un portale

L’esempio describe-portal seguente descrive un portale web per una società che gestisce parchi eolici.

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

Output:

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

Per ulteriori informazioni, consulta Amministrare i portali nella Guida per SiteWise l'utente AWS IoT.

  • Per i dettagli sull'API, consulta AWS CLI Command DescribePortalReference.

Il seguente esempio di codice mostra come utilizzaredescribe-project.

AWS CLI

Come descrivere un progetto

L’esempio describe-project seguente descrive un progetto di parco eolico.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione dei dettagli del progetto nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzaredisassociate-assets.

AWS CLI

Come dissociare un asset secondario da un asset principale

L’esempio disassociate-assets seguente disassocia un asset turbina eolica da un asset di tipo parco eolico.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Associating assets nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareget-asset-property-aggregates.

AWS CLI

Come recuperare la media aggregata e i valori di conteggio di una proprietà di un asset

L’esempio get-asset-property-aggregates seguente recupera la potenza totale media di un asset turbina eolica e il conteggio dei punti dati della potenza totale per un periodo di 1 ora.

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

Output:

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

Per ulteriori informazioni, consulta Interrogazione degli aggregati di proprietà degli asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareget-asset-property-value-history.

AWS CLI

Come recuperare i valori storici di una proprietà di un asset

L’esempio get-asset-property-value-history seguente recupera i valori di potenza totale di un asset turbina eolica per un periodo di 20 minuti.

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

Output:

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

Per ulteriori informazioni, consulta Interrogazione dei valori storici delle proprietà degli asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareget-asset-property-value.

AWS CLI

Come recuperare il valore corrente di una proprietà di asset

L’esempio get-asset-property-value seguente recupera la potenza totale corrente di un asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Interrogazione dei valori delle proprietà degli asset correnti nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarelist-access-policies.

AWS CLI

Come elencare tutte le policy di accesso

L’esempio list-access-policies seguente elenca tutte le policy di accesso per un utente che è amministratore del portale.

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

Output:

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

Per ulteriori informazioni, consulta Amministrare i portali nella Guida per SiteWise l'utente AWS IoT.

Il seguente esempio di codice mostra come utilizzarelist-asset-models.

AWS CLI

Come elencare tutti i modelli di asset

L'list-asset-modelsesempio seguente elenca tutti i modelli di asset definiti nel vostro AWS account nella regione corrente.

aws iotsitewise list-asset-models

Output:

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

Per ulteriori informazioni, consulta Elenco di tutti i modelli di asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarelist-assets.

AWS CLI

Esempio 1: come elencare tutti gli asset di primo livello

L'list-assetsesempio seguente elenca tutte le risorse che sono di primo livello nell'albero della gerarchia delle risorse e definite nel tuo AWS account nella regione corrente.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

Output:

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

Per ulteriori informazioni, consulta Elencare gli asset nella AWS IoT SiteWise User Guide.

Esempio 2: come elencare tutti gli asset in base a un modello di asset

L'list-assetsesempio seguente elenca tutti gli asset in base a un modello di asset e definiti nel tuo AWS account nella regione corrente.

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

Output:

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

Per ulteriori informazioni, consulta Elencare gli asset nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarelist-associated-assets.

AWS CLI

Come elencare tutti gli asset associati a un asset in una gerarchia specifica

L’esempio list-associated-assets seguente elenca tutti gli asset turbina eolica associati all’asset parco eolico specificato.

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

Output:

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

Per ulteriori informazioni, consulta Elencare gli asset associati a un asset specifico nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzarelist-dashboards.

AWS CLI

Come elencare tutte le dashboard di un progetto

L’esempio list-dashboards seguente elenca tutte le dashboard definite in un progetto.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione dei dashboard nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarelist-gateways.

AWS CLI

Come elencare tutti i gateway

L'list-gatewaysesempio seguente elenca tutti i gateway definiti nell' AWS account nella regione corrente.

aws iotsitewise list-gateways

Output:

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

Per ulteriori informazioni, consulta Ingestione di dati utilizzando un gateway nella AWS IoT SiteWise User Guide.

  • Per i dettagli sull'API, consulta AWS CLI Command ListGatewaysReference.

Il seguente esempio di codice mostra come utilizzarelist-portals.

AWS CLI

Come elencare tutti i portali

L'list-portalsesempio seguente elenca tutti i portali definiti nel tuo AWS account nella regione corrente.

aws iotsitewise list-portals

Output:

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

Per ulteriori informazioni, consulta Amministrare i portali nella Guida per SiteWise l'utente AWS IoT.

  • Per i dettagli sull'API, consulta AWS CLI Command ListPortalsReference.

Il seguente esempio di codice mostra come utilizzarelist-project-assets.

AWS CLI

Come elencare tutti gli asset associati a un progetto

L’esempio list-project-assets seguente elenca tutti gli asset associati a un progetto di parco eolico.

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

Output:

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

Per ulteriori informazioni, consulta Aggiungere risorse ai progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarelist-projects.

AWS CLI

Come elencare tutti i progetti in un portale

L’esempio list-projects seguente elenca tutti i progetti definiti in un portale.

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

Output:

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

Per ulteriori informazioni, consulta Visualizzazione dei dettagli del progetto nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.

AWS CLI

Come elencare tutti i tag per una risorsa

L’esempio list-tags-for-resource seguente elenca tutti i tag relativi a un asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Tagging your resources nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareput-logging-options.

AWS CLI

Come specificare il livello di registrazione di log

L'put-logging-optionsesempio seguente abilita la registrazione dei INFO livelli in AWS IoT SiteWise. Altri livelli includono DEBUG e OFF.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzaretag-resource.

AWS CLI

Come aggiungere un tag a una risorsa

L’esempio tag-resource seguente aggiunge un tag owner a un asset turbina eolica. Ciò consente di controllare l’accesso all’asset in base al proprietario.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging your resources nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareuntag-resource.

AWS CLI

Come rimuovere un tag da una risorsa

L’esempio untag-resource seguente rimuove un tag owner da un asset turbina eolica.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tagging your resources nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareupdate-access-policy.

AWS CLI

Come concedere a un visualizzatore di un progetto la proprietà del progetto

L’esempio update-access-policy seguente aggiorna una policy di accesso che concede a un visualizzatore di un progetto la proprietà del progetto.

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

Contenuto di 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"
        }
    }
}

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Assegnazione dei proprietari dei progetti nella Guida all'applicazione AWS IoT SiteWise Monitor.

Il seguente esempio di codice mostra come utilizzareupdate-asset-model.

AWS CLI

Come aggiornare un modello di asset

L’esempio update-asset-model seguente descrive un modello di asset di tipo parco eolico. Questo esempio include il modello esistente IDs e le definizioni, poiché update-asset-model sovrascrive il modello esistente con il nuovo modello.

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

Contenuto di 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"
        }
    ]
}

Output:

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

Per ulteriori informazioni, consulta Updating asset models nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareupdate-asset-property.

AWS CLI

Esempio 1: come aggiornare l’alias di una proprietà di asset

L’esempio update-asset-property seguente aggiorna l’alias della proprietà di alimentazione di un asset turbina eolica.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Mappatura dei flussi di dati industriali alle proprietà degli asset nella AWS IoT SiteWise User Guide.

Esempio 2: come abilitare le notifiche delle proprietà di asset

L’esempio update-asset-property seguente abilita le notifiche di aggiornamento delle proprietà di alimentazione di un asset turbina eolica. Gli aggiornamenti dei valori delle proprietà vengono pubblicati nell’argomento MQTT $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, dove ogni ID viene sostituito dalla proprietà, dall’asset e dall’ID del modello della proprietà dell’asset.

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"

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Interagire con altri servizi nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzareupdate-asset.

AWS CLI

Come aggiornare il nome di un asset

L’esempio update-asset seguente aggiorna il nome dell’asset turbina eolica.

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

Output:

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

Per ulteriori informazioni, consulta Updating assets nella AWS IoT SiteWise User Guide.

Il seguente esempio di codice mostra come utilizzareupdate-dashboard.

AWS CLI

Come aggiornare una dashboard

L’esempio update-dashboard seguente modifica il titolo di un grafico a linee di una dashboard che mostra la potenza totale generata per un parco eolico.

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

Contenuto di 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"
                }
            ]
        }
    ]
}

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Creazione di dashboard (CLI) nella Guida per l'utente AWS SiteWise IoT.

  • Per i dettagli sull'API, consulta AWS CLI Command UpdateDashboardReference.

Il seguente esempio di codice mostra come utilizzareupdate-gateway-capability-configuration.

AWS CLI

Come aggiornare la funzionalità di un gateway

L’esempio update-gateway-capability-configuration seguente configura un’origine OPC-UA con le seguenti proprietà:

Considera attendibile qualsiasi certificato.Utilizza l'algoritmo Basic256 per proteggere i messaggi.Utilizza la SignAndEncrypt modalità per proteggere le connessioni.Utilizza le credenziali di autenticazione memorizzate in un segreto di Secrets Manager. 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

Contenuto di 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": ""
        }
    ]
}

Output:

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

Per ulteriori informazioni, consulta Configurazione delle fonti di dati nella Guida per l' SiteWise utente AWS IoT.

Il seguente esempio di codice mostra come utilizzareupdate-gateway.

AWS CLI

Come aggiornare il nome di un gateway

L’esempio update-gateway seguente aggiorna il nome di un gateway.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Ingestione di dati utilizzando un gateway nella AWS IoT SiteWise User Guide.

  • Per i dettagli sull'API, consulta AWS CLI Command UpdateGatewayReference.

Il seguente esempio di codice mostra come utilizzareupdate-portal.

AWS CLI

Come aggiornare i dettagli di un portale

L’esempio update-portal seguente aggiorna un portale web per una società che gestisce parchi eolici.

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

Output:

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

Per ulteriori informazioni, consulta Amministrare i portali nella Guida per SiteWise l'utente AWS IoT.

  • Per i dettagli sull'API, consulta AWS CLI Command UpdatePortalReference.

Il seguente esempio di codice mostra come utilizzareupdate-project.

AWS CLI

Come aggiornare i dettagli di un progetto

L’esempio update-project seguente aggiorna un progetto di parco eolico.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Modifica dei dettagli del progetto nella Guida all'applicazione AWS IoT SiteWise Monitor.