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 operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Mentre le azioni mostrano come richiamare le singole funzioni di servizio, è possibile visualizzare le azioni nel loro contesto negli scenari correlati.
Ogni esempio include un collegamento al codice sorgente completo, in cui è possibile trovare istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come utilizzareassociate-assets
.
- AWS CLI
-
Per associare una risorsa secondaria a una risorsa principale
L'
associate-assets
esempio seguente associa una turbina eolica a una risorsa di un parco eolico, dove il modello degli asset delle turbine eoliche esiste come gerarchia nel modello degli asset del parco eolico.aws iotsitewise associate-assets \ --asset-id
a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
\ --hierarchy-ida1b2c3d4-5678-90ab-cdef-77777EXAMPLE
\ --child-asset-ida1b2c3d4-5678-90ab-cdef-33333EXAMPLE
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Associating assets nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta AssociateAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarebatch-associate-project-assets
.
- AWS CLI
-
Associare una risorsa a un progetto
L'
batch-associate-project-assets
esempio seguente associa un asset di un parco eolico a un progetto.aws iotsitewise batch-associate-project-assets \ --project-id
a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
\ --asset-idsa1b2c3d4-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.
-
Per API i dettagli, consulta BatchAssociateProjectAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarebatch-disassociate-project-assets
.
- AWS CLI
-
Dissociare una risorsa da un progetto
L'
batch-disassociate-project-assets
esempio seguente dissocia un asset di un parco eolico da un progetto.aws iotsitewise batch-disassociate-project-assets \ --project-id
a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE
\ --asset-idsa1b2c3d4-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.
-
Per API i dettagli, consulta BatchDisassociateProjectAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarebatch-put-asset-property-value
.
- AWS CLI
-
Per inviare dati alle proprietà degli asset
L'
batch-put-asset-property-value
esempio seguente invia i dati di alimentazione e temperatura alle proprietà dell'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'IoT SiteWise API nella AWSAWS IoT SiteWise User Guide.
-
Per API i dettagli, vedere BatchPutAssetPropertyValue
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-access-policy
.
- AWS CLI
-
Esempio 1: concedere a un utente l'accesso amministrativo a un portale
L'
create-access-policy
esempio seguente crea una politica di accesso che concede a un utente l'accesso amministrativo a un portale Web per un'azienda di 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: concedere a un utente l'accesso in sola lettura a un progetto
L'
create-access-policy
esempio seguente crea una politica 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.
-
Per API i dettagli, consulta AWS CLI Command CreateAccessPolicy
Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-asset-model
.
- AWS CLI
-
Per creare un modello di asset
L'
create-asset-model
esempio seguente crea un modello di asset che definisce una turbina eolica con le seguenti proprietà:Numero di serie - Il numero di serie di un' turbineGenerated energia eolica - Il flusso di dati sull'energia generata da un vento turbineTemperature C - Il flusso di dati sulla temperatura di una turbina eolica in CelsiusTemperature F - I dati di temperatura mappati vanno 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.
-
Per API i dettagli, vedere CreateAssetModel
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-asset
.
- AWS CLI
-
Per creare una risorsa
L'
create-asset
esempio seguente crea un asset di turbine eoliche a partire da un modello di asset di turbine eoliche.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.
-
Per API i dettagli, consulta CreateAsset AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-dashboard
.
- AWS CLI
-
Per creare una dashboard
L'
create-dashboard
esempio 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-definitionfile://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 Creating dashboards (CLI) nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta CreateDashboard AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-gateway
.
- AWS CLI
-
Per creare un gateway
L'
create-gateway
esempio seguente crea un gateway che funziona su AWS IoT Greengrass.aws iotsitewise create-gateway \ --gateway-name
ExampleCorpGateway
\ --gateway-platformgreengrass={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.
-
Per API i dettagli, vedere CreateGateway
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-portal
.
- AWS CLI
-
Per creare un portale
L'
create-portal
esempio seguente crea un portale web per un'azienda di 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-emailsupport@example.com
\ --role-arnarn: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 Guida introduttiva a AWS IoT SiteWise Monitor nella AWS IoT SiteWise User Guide e Enabling AWS SSO in the AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta CreatePortal AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-project
.
- AWS CLI
-
Per creare un progetto
L'
create-project
esempio 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.
-
Per API i dettagli, consulta CreateProject AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-access-policy
.
- AWS CLI
-
Per revocare l'accesso di un utente a un progetto o portale
L'
delete-access-policy
esempio seguente elimina una politica 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.
-
Per API i dettagli, vedere DeleteAccessPolicy
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-asset-model
.
- AWS CLI
-
Per eliminare un modello di asset
L'
delete-asset-model
esempio seguente elimina un modello di asset per turbine eoliche.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.
-
Per API i dettagli, consulta DeleteAssetModel AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-asset
.
- AWS CLI
-
Per eliminare una risorsa
L'
delete-asset
esempio seguente elimina un asset di una 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.
-
Per API i dettagli, consulta DeleteAsset AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-dashboard
.
- AWS CLI
-
Per eliminare un pannello di controllo
L'
delete-dashboard
esempio seguente elimina il cruscotto di una 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 API i dettagli, consulta AWS CLI Command DeleteDashboard
Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-gateway
.
- AWS CLI
-
Per eliminare un gateway
L'
delete-gateway
esempio 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 API i dettagli, vedere DeleteGateway
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-portal
.
- AWS CLI
-
Per eliminare un portale
L'
delete-portal
esempio seguente elimina un portale Web per una società di 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.
-
Per API i dettagli, vedere DeletePortal
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-project
.
- AWS CLI
-
Per eliminare un progetto
L'
delete-project
esempio 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.
-
Per API i dettagli, consulta DeleteProject AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-access-policy
.
- AWS CLI
-
Per descrivere una politica di accesso
L'
describe-access-policy
esempio seguente descrive una politica di accesso che concede a un utente l'accesso amministrativo a un portale Web per un'azienda di 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.
-
Per API i dettagli, vedere DescribeAccessPolicy
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-asset-model
.
- AWS CLI
-
Per descrivere un modello di asset
L'
describe-asset-model
esempio seguente descrive un modello di asset per un 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.
-
Per API i dettagli, consulta DescribeAssetModel AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-asset-property
.
- AWS CLI
-
Per descrivere la proprietà di un asset
L'
describe-asset-property
esempio seguente descrive la proprietà della potenza totale generata di un impianto eolico.aws iotsitewise describe-asset-property \ --asset-id
a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
\ --property-ida1b2c3d4-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.
-
Per API i dettagli, consulta DescribeAssetProperty AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-asset
.
- AWS CLI
-
Per descrivere una risorsa
L'
describe-asset
esempio seguente descrive un asset di un 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.
-
Per API i dettagli, consulta DescribeAsset AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-dashboard
.
- AWS CLI
-
Per descrivere una dashboard
L'
describe-dashboard
esempio seguente descrive il pannello di controllo del parco eolico specificato.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.
-
Per API i dettagli, consulta DescribeDashboard AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-gateway-capability-configuration
.
- AWS CLI
-
Per descrivere una funzionalità gateway
L'
describe-gateway-capability-configuration
esempio 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.
-
Per API i dettagli, vedere DescribeGatewayCapabilityConfiguration
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-gateway
.
- AWS CLI
-
Per descrivere un gateway
L'
describe-gateway
esempio 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 API i dettagli, vedere DescribeGateway
in AWS CLI Command Reference.
-
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-options
esempio 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.
-
Per API i dettagli, consulta DescribeLoggingOptions AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-portal
.
- AWS CLI
-
Per descrivere un portale
L'
describe-portal
esempio seguente descrive un portale web per un'azienda di 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 API i dettagli, vedere DescribePortal
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-project
.
- AWS CLI
-
Per descrivere un progetto
L'
describe-project
esempio 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.
-
Per API i dettagli, vedere DescribeProject
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredisassociate-assets
.
- AWS CLI
-
Per dissociare una risorsa figlia da una risorsa principale
L'
disassociate-assets
esempio seguente dissocia una turbina eolica da una risorsa di un parco eolico.aws iotsitewise disassociate-assets \ --asset-id
a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
\ --hierarchy-ida1b2c3d4-5678-90ab-cdef-77777EXAMPLE
\ --child-asset-ida1b2c3d4-5678-90ab-cdef-33333EXAMPLE
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Associating assets nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta DisassociateAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-asset-property-aggregates
.
- AWS CLI
-
Per recuperare la media aggregata e i valori di conteggio di una proprietà di asset
L'
get-asset-property-aggregates
esempio seguente recupera la potenza totale media di una turbina eolica e il conteggio dei punti dati sulla potenza totale per un periodo di 1 ora.aws iotsitewise get-asset-property-aggregates \ --asset-id
a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --property-ida1b2c3d4-5678-90ab-cdef-66666EXAMPLE
\ --start-date1580849400
\ --end-date1580853000
\ --aggregate-typesAVERAGE
COUNT
\ --resolution1h
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.
-
Per API i dettagli, consulta AWS CLI Command GetAssetPropertyAggregates
Reference.
-
Il seguente esempio di codice mostra come utilizzareget-asset-property-value-history
.
- AWS CLI
-
Per recuperare i valori storici di una proprietà di asset
L'
get-asset-property-value-history
esempio seguente recupera i valori di potenza totale di una turbina eolica per un periodo di 20 minuti.aws iotsitewise get-asset-property-value-history \ --asset-id
a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --property-ida1b2c3d4-5678-90ab-cdef-66666EXAMPLE
\ --start-date1580851800
\ --end-date1580853000
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.
-
Per API i dettagli, consulta GetAssetPropertyValueHistory AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-asset-property-value
.
- AWS CLI
-
Per recuperare il valore corrente di una proprietà dell'asset
L'
get-asset-property-value
esempio seguente recupera la potenza totale corrente di una turbina eolica.aws iotsitewise get-asset-property-value \ --asset-id
a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --property-ida1b2c3d4-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.
-
Per API i dettagli, consulta GetAssetPropertyValue AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-access-policies
.
- AWS CLI
-
Per elencare tutte le politiche di accesso
L'
list-access-policies
esempio seguente elenca tutte le politiche di accesso per un utente che è amministratore del portale.aws iotsitewise list-access-policies \ --identity-type
USER
\ --identity-ida1b2c3d4e5-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.
-
Per API i dettagli, vedere ListAccessPolicies
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-asset-models
.
- AWS CLI
-
Per elencare tutti i modelli di asset
L'
list-asset-models
esempio 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.
-
Per API i dettagli, consulta ListAssetModels AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-assets
.
- AWS CLI
-
Esempio 1: per elencare tutte le risorse di primo livello
L'
list-assets
esempio seguente elenca tutti gli asset che sono di primo livello nell'albero della gerarchia degli asset e definiti 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: per elencare tutti gli asset in base a un modello di asset
L'
list-assets
esempio seguente elenca tutti gli asset basati su 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.
-
Per API i dettagli, consulta ListAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-associated-assets
.
- AWS CLI
-
Per elencare tutte le risorse associate a una risorsa in una gerarchia specifica
L'
list-associated-assets
esempio seguente elenca tutti gli asset delle turbine eoliche associati all'asset del parco eolico specificato.aws iotsitewise list-associated-assets \ --asset-id
a1b2c3d4-5678-90ab-cdef-44444EXAMPLE
\ --hierarchy-ida1b2c3d4-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.
-
Per API i dettagli, consulta ListAssociatedAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-dashboards
.
- AWS CLI
-
Per elencare tutte le dashboard di un progetto
L'
list-dashboards
esempio 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.
-
Per API i dettagli, consulta ListDashboards AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-gateways
.
- AWS CLI
-
Per elencare tutti i gateway
L'
list-gateways
esempio 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 API i dettagli, vedere ListGateways
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-portals
.
- AWS CLI
-
Per elencare tutti i portali
L'
list-portals
esempio 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 API i dettagli, vedere ListPortals
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-project-assets
.
- AWS CLI
-
Per elencare tutte le risorse associate a un progetto
L'
list-project-assets
esempio 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.
-
Per API i dettagli, consulta ListProjectAssets AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-projects
.
- AWS CLI
-
Per elencare tutti i progetti in un portale
L'
list-projects
esempio 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.
-
Per API i dettagli, vedere ListProjects
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource
.
- AWS CLI
-
Per elencare tutti i tag di una risorsa
L'
list-tags-for-resource
esempio seguente elenca tutti i tag relativi a una 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.
-
Per API i dettagli, consulta ListTagsForResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareput-logging-options
.
- AWS CLI
-
Per specificare il livello di registrazione
L'
put-logging-options
esempio seguente abilita la registrazione deiINFO
livelli in AWS IoT SiteWise. Gli altri livelli includonoDEBUG
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.
-
Per API i dettagli, consulta PutLoggingOptions AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaretag-resource
.
- AWS CLI
-
Per aggiungere un tag a una risorsa
L'
tag-resource
esempio seguente aggiunge un tag proprietario a una turbina eolica. Ciò consente di controllare l'accesso alla risorsa in base a chi la possiede.aws iotsitewise tag-resource \ --resource-arn
arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --tagsOwner=richard-roe
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging your resources nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta TagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareuntag-resource
.
- AWS CLI
-
Per rimuovere un tag da una risorsa
L'
untag-resource
esempio seguente rimuove un tag proprietario da una risorsa di una turbina eolica.aws iotsitewise untag-resource \ --resource-arn
arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --tag-keysOwner
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Tagging your resources nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta UntagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-access-policy
.
- AWS CLI
-
Per concedere a un visualizzatore del progetto la proprietà di un progetto
L'
update-access-policy
esempio seguente aggiorna una politica di accesso che concede a un visualizzatore del progetto la proprietà di un progetto.aws iotsitewise update-access-policy \ --access-policy-id
a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE
\ --cli-input-jsonfile://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.
-
Per API i dettagli, consulta UpdateAccessPolicy AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-asset-model
.
- AWS CLI
-
Per aggiornare un modello di asset
L'
update-asset-model
esempio seguente aggiorna la descrizione del modello di impianto di un 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.
-
Per API i dettagli, consulta UpdateAssetModel AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-asset-property
.
- AWS CLI
-
Esempio 1: per aggiornare l'alias di una proprietà di asset
L'
update-asset-property
esempio seguente aggiorna l'alias della proprietà di alimentazione di un asset di una turbina eolica.aws iotsitewise update-asset-property \ --asset-id
a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --property-ida1b2c3d4-5678-90ab-cdef-55555EXAMPLE
\ --property-alias"/examplecorp/windfarm/1/turbine/1/power"
\ --property-notification-stateDISABLED
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: per abilitare le notifiche sulle proprietà degli asset
L'
update-asset-property
esempio seguente abilita le notifiche di aggiornamento delle proprietà energetiche di una turbina eolica. Gli aggiornamenti dei valori delle proprietà vengono pubblicati nell'MQTTargomento$aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>
, dove ogni ID viene sostituito dalla proprietà, dalla risorsa e dall'ID del modello della proprietà dell'asset.aws iotsitewise update-asset-property \ --asset-id
a1b2c3d4-5678-90ab-cdef-33333EXAMPLE
\ --property-ida1b2c3d4-5678-90ab-cdef-66666EXAMPLE
\ --property-notification-stateENABLED
\ --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.
-
Per API i dettagli, vedere UpdateAssetProperty
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-asset
.
- AWS CLI
-
Per aggiornare il nome di una risorsa
L'
update-asset
esempio seguente aggiorna il nome di una 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.
-
Per API i dettagli, consulta UpdateAsset AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-dashboard
.
- AWS CLI
-
Per aggiornare un pannello di controllo
L'
update-dashboard
esempio seguente modifica il titolo del grafico a linee di un pannello di controllo 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-definitionfile://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 Creating dashboards (CLI) nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, consulta UpdateDashboard AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-gateway-capability-configuration
.
- AWS CLI
-
Per aggiornare la funzionalità di un gateway
L'
update-gateway-capability-configuration
esempio seguente configura una sorgente 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-configurationfile://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.
-
Per API i dettagli, vedere UpdateGatewayCapabilityConfiguration
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-gateway
.
- AWS CLI
-
Per aggiornare il nome di un gateway
L'
update-gateway
esempio seguente aggiorna il nome di un gateway.aws iotsitewise update-gateway \ --gateway-id
a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE
\ --gateway-nameExampleCorpGateway1
Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Ingestione di dati utilizzando un gateway nella AWS IoT SiteWise User Guide.
-
Per API i dettagli, vedere UpdateGateway
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-portal
.
- AWS CLI
-
Per aggiornare i dettagli di un portale
L'
update-portal
esempio seguente aggiorna un portale web per un'azienda di parchi eolici.aws iotsitewise update-portal \ --portal-id
a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE
\ --portal-nameWindFarmPortal
\ --portal-description"A portal that contains wind farm projects for Example Corp."
\ --portal-contact-emailsupport@example.com
\ --role-arnarn: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 API i dettagli, vedere UpdatePortal
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-project
.
- AWS CLI
-
Per aggiornare i dettagli di un progetto
L'
update-project
esempio 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.
-
Per API i dettagli, consulta UpdateProject AWS CLI
Command Reference.
-