AWS IoT SiteWise exemples utilisant AWS CLI - AWS Command Line Interface
Actions

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

AWS IoT SiteWise exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du AWS Command Line Interface with AWS IoT SiteWise.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utiliserassociate-assets.

AWS CLI

Pour associer une ressource enfant à une ressource parent

L’exemple associate-assets suivant associe une ressource d’éolienne à une ressource de parc éolien, où le modèle de ressource d’éolienne existe sous forme de hiérarchie dans le modèle de ressource de parc éolien.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Associer des actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir AssociateAssetsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserbatch-associate-project-assets.

AWS CLI

Pour associer une ressource à un projet

L’exemple batch-associate-project-assets suivant associe une ressource de parc éolien à un projet.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Ajouter des actifs aux projets dans le guide de l'application AWS IoT SiteWise Monitor.

L'exemple de code suivant montre comment utiliserbatch-disassociate-project-assets.

AWS CLI

Pour dissocier une ressource d’un projet

L’exemple batch-disassociate-project-assets suivant dissocie une ressource de parc éolien d’un projet.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Ajouter des actifs aux projets dans le guide de l'application AWS IoT SiteWise Monitor.

L'exemple de code suivant montre comment utiliserbatch-put-asset-property-value.

AWS CLI

Pour envoyer des données aux propriétés de ressources

L’exemple batch-put-asset-property-value suivant envoie des données d’énergie et de température aux propriétés des ressources identifiées par des alias de propriété.

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

Contenu de 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
                    }
                }
            ]
        }
    ]
}

Sortie :

{
    "errorEntries": []
}

Pour plus d'informations, consultez la section Ingestion de données à l'aide de l' SiteWise API AWS IoT dans le guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utilisercreate-access-policy.

AWS CLI

Exemple 1 : pour accorder à un utilisateur l’accès administratif à un portail

L’exemple create-access-policy suivant crée une stratégie d’accès qui accorde à un utilisateur l’accès administratif à un portail Web pour une société de parc éolien.

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

Contenu de 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"
        }
    }
}

Sortie :

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

Pour plus d'informations, consultez la section Ajouter ou supprimer des administrateurs de portail dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

Exemple 2 : pour accorder à un utilisateur l’accès en lecture seule à un projet

L’exemple create-access-policy suivant crée une stratégie d’accès qui accorde à un utilisateur un accès en lecture seule à un projet de parc éolien.

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

Contenu de 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"
        }
    }
}

Sortie :

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

Pour plus d'informations, consultez la section Affectation de visualiseurs de projet dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir CreateAccessPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-asset-model.

AWS CLI

Pour créer un modèle de ressource

L’exemple create-asset-model suivant crée un modèle de ressource qui définit une éolienne avec les propriétés suivantes :

Numéro de série - Le numéro de série d'une éolienne L'énergie produite par une éolienne - Le flux de données de puissance généré par une éolienne Température C - Le flux de données de température d'une éolienne en CelsiusTemperature F - Les points de données de température cartographiés de Celsius à Fahrenheit

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

Contenu de 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"
                        }
                    }
                }
            }
        }
    ]
}

Sortie :

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

Pour plus d'informations, consultez la section Définition des modèles d'actifs dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir CreateAssetModella section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-asset.

AWS CLI

Pour créer une ressource

L’exemple create-asset suivant crée une ressource d’éolienne à partir d’un modèle de ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Création d'actifs dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir CreateAssetla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-dashboard.

AWS CLI

Pour créer un tableau de bord

L’exemple create-dashboard suivant crée un tableau de bord avec un graphique linéaire qui affiche l’énergie totale produite pour un parc éolien.

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

Contenu de 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"
                }
            ]
        }
    ]
}

Sortie :

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

Pour plus d'informations, consultez la section Création de tableaux de bord (CLI) dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir CreateDashboardla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-gateway.

AWS CLI

Pour créer une passerelle

L'create-gatewayexemple suivant crée une passerelle qui s'exécute sur 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}

Sortie :

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

Pour plus d'informations, consultez la section Configuration d'une passerelle dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir CreateGatewayla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-portal.

AWS CLI

Pour créer un portail

L’exemple create-portal suivant crée un portail Web pour une société de parc éolien. Vous ne pouvez créer des portails que dans la région où vous avez activé l'authentification AWS unique.

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

Sortie :

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

Pour plus d'informations, consultez Getting started with AWS IoT SiteWise Monitor dans le guide de l' SiteWise utilisateur de l'AWS IoT et Enabling AWS SSO dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir CreatePortalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-project.

AWS CLI

Pour créer un projet

L’exemple create-project suivant crée un projet de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Création de projets dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir CreateProjectla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-access-policy.

AWS CLI

Pour révoquer l’accès d’un utilisateur à un projet ou à un portail

L’exemple delete-access-policy suivant supprime une stratégie d’accès qui accorde à un utilisateur l’accès administratif à un portail.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Ajouter ou supprimer des administrateurs de portail dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DeleteAccessPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-asset-model.

AWS CLI

Pour supprimer un modèle de ressource

L’exemple delete-asset-model suivant supprime un modèle de ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Suppression de modèles d'actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DeleteAssetModella section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-asset.

AWS CLI

Pour supprimer un actif

L’exemple delete-asset suivant supprime une ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Suppression d'actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DeleteAssetla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-dashboard.

AWS CLI

Pour supprimer un tableau de bord

L’exemple delete-dashboard suivant supprime un tableau de bord d’éolienne.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Suppression de tableaux de bord dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir DeleteDashboardla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-gateway.

AWS CLI

Pour supprimer une passerelle

L’exemple delete-gateway suivant supprime une passerelle.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Ingestion de données à l'aide d'une passerelle dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DeleteGatewayla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-portal.

AWS CLI

Pour supprimer un portail

L’exemple delete-portal suivant supprime un portail Web pour une société de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Suppression d'un portail dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DeletePortalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-project.

AWS CLI

Pour supprimer un projet

L’exemple delete-project suivant supprime un projet de parc éolien.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Suppression de projets dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir DeleteProjectla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-access-policy.

AWS CLI

Pour décrire une stratégie d’accès

L’exemple describe-access-policy suivant décrit une stratégie d’accès qui accorde à un utilisateur l’accès administratif à un portail Web pour une société de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Ajouter ou supprimer des administrateurs de portail dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribeAccessPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-asset-model.

AWS CLI

Pour décrire un modèle de ressource

L’exemple describe-asset-model suivant décrit un modèle de ressource de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Décrire un modèle d'actif spécifique dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribeAssetModella section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-asset-property.

AWS CLI

Pour décrire la propriété de ressource

L’exemple describe-asset-property suivant décrit la propriété d’énergie produite totale d’une ressource de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Décrire une propriété d'actif spécifique dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribeAssetPropertyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-asset.

AWS CLI

Pour décrire une ressource

L’exemple describe-asset suivant décrit une ressource de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Décrire un actif spécifique dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribeAssetla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-dashboard.

AWS CLI

Pour décrire un tableau de bord

L’exemple describe-dashboard suivant décrit le tableau de bord du parc éolien spécifié.

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

Sortie :

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

Pour plus d'informations, consultez la section Affichage des tableaux de bord dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir DescribeDashboardla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-gateway-capability-configuration.

AWS CLI

Pour décrire une fonctionnalité de passerelle

L’exemple describe-gateway-capability-configuration suivant décrit une fonctionnalité de source OPC-UA.

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

Sortie :

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

Pour plus d'informations, consultez la section Configuration des sources de données dans le guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utiliserdescribe-gateway.

AWS CLI

Pour décrire une passerelle

L’exemple describe-gateway suivant décrit une passerelle.

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

Sortie :

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

Pour plus d'informations, consultez la section Ingestion de données à l'aide d'une passerelle dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribeGatewayla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-logging-options.

AWS CLI

Pour récupérer les options de SiteWise journalisation actuelles de AWS l'IoT

L'describe-logging-optionsexemple suivant permet de récupérer les options de SiteWise journalisation AWS IoT actuelles pour votre AWS compte dans la région actuelle.

aws iotsitewise describe-logging-options

Sortie :

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

Pour plus d'informations, consultez la section Surveillance de AWS l'IoT SiteWise avec Amazon CloudWatch Logs dans le guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utiliserdescribe-portal.

AWS CLI

Pour décrire un portail

L’exemple describe-portal suivant décrit un portail Web pour une société de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Administration de vos portails dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DescribePortalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdescribe-project.

AWS CLI

Pour décrire un projet

L’exemple describe-project suivant décrit un projet de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Affichage des détails du projet dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir DescribeProjectla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdisassociate-assets.

AWS CLI

Pour dissocier une ressource enfant d’une ressource parent

L’exemple disassociate-assets suivant dissocie une ressource d’éolienne d’une ressource de parc éolien.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Associer des actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir DisassociateAssetsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-asset-property-aggregates.

AWS CLI

Pour extraire les valeurs moyennes et de compte agrégées d’une propriété de ressource

L’exemple get-asset-property-aggregates suivant extrait l’énergie totale moyenne d’une éolienne et le nombre de points de données d’énergie totale sur une période d’une heure.

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

Sortie :

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

Pour plus d'informations, consultez la section Interrogation des agrégats de propriétés des actifs dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utiliserget-asset-property-value-history.

AWS CLI

Pour extraire les valeurs historiques d’une propriété de ressource

L’exemple get-asset-property-value-history suivant extrait les valeurs d’énergie totale d’une éolienne sur une période de 20 minutes.

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

Sortie :

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

Pour plus d'informations, consultez la section Interrogation des valeurs historiques des propriétés des actifs dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utiliserget-asset-property-value.

AWS CLI

Pour extraire la valeur actuelle d’une propriété de ressource

L’exemple get-asset-property-value suivant extrait l’énergie totale actuelle d’une ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Interrogation des valeurs actuelles des propriétés des actifs dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir GetAssetPropertyValuela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-access-policies.

AWS CLI

Pour répertorier toutes les stratégies d’accès

L’exemple list-access-policies suivant répertorie toutes les stratégies d’accès pour un utilisateur administrateur du portail.

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

Sortie :

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

Pour plus d'informations, consultez la section Administration de vos portails dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListAccessPoliciesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-asset-models.

AWS CLI

Pour répertorier tous les modèles de ressource

L'list-asset-modelsexemple suivant répertorie tous les modèles d'actifs définis dans votre AWS compte dans la région actuelle.

aws iotsitewise list-asset-models

Sortie :

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

Pour plus d'informations, consultez la section Liste de tous les modèles d'actifs dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListAssetModelsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-assets.

AWS CLI

Exemple 1 : pour répertorier toutes les ressources de premier niveau

L'list-assetsexemple suivant répertorie tous les actifs situés au niveau supérieur de l'arborescence hiérarchique des actifs et définis dans votre AWS compte dans la région actuelle.

aws iotsitewise list-assets \
    --filter TOP_LEVEL

Sortie :

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

Pour plus d'informations, consultez la section Répertorier les actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

Exemple 2 : pour répertorier toutes les ressources basées sur un modèle de ressource

L'list-assetsexemple suivant répertorie tous les actifs basés sur un modèle d'actif défini dans votre AWS compte dans la région actuelle.

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

Sortie :

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

Pour plus d'informations, consultez la section Répertorier les actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListAssetsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-associated-assets.

AWS CLI

Pour répertorier toutes les ressources associées à une ressource au sein d’une hiérarchie spécifique

L’exemple list-associated-assets suivant répertorie toutes les ressources d’éoliennes associées à la ressource de parc éolien spécifiée.

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

Sortie :

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

Pour plus d'informations, consultez la section Répertorier les actifs associés à un actif spécifique dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListAssociatedAssetsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-dashboards.

AWS CLI

Pour répertorier tous les tableaux de bord d’un projet

L’exemple list-dashboards suivant répertorie tous les tableaux de bord définis dans un projet.

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

Sortie :

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

Pour plus d'informations, consultez la section Affichage des tableaux de bord dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir ListDashboardsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-gateways.

AWS CLI

Pour répertorier toutes les passerelles

L'list-gatewaysexemple suivant répertorie toutes les passerelles définies dans votre AWS compte dans la région actuelle.

aws iotsitewise list-gateways

Sortie :

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

Pour plus d'informations, consultez la section Ingestion de données à l'aide d'une passerelle dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListGatewaysla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-portals.

AWS CLI

Pour répertorier tous les portails

L'list-portalsexemple suivant répertorie tous les portails définis dans votre AWS compte dans la région actuelle.

aws iotsitewise list-portals

Sortie :

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

Pour plus d'informations, consultez la section Administration de vos portails dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListPortalsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-project-assets.

AWS CLI

Pour répertorier toutes les ressources associées à un projet

L’exemple list-project-assets suivant répertorie toutes les ressources associées un projet de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Ajouter des actifs aux projets dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir ListProjectAssetsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-projects.

AWS CLI

Pour répertorier tous les projets d’un portail

L’exemple list-projects suivant répertorie tous les projets définis dans un portail.

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

Sortie :

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

Pour plus d'informations, consultez la section Affichage des détails du projet dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir ListProjectsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour répertorier toutes les balises d’une ressource

L’exemple list-tags-for-resource suivant répertorie toutes les balises d’une ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Marquage de vos ressources dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-logging-options.

AWS CLI

Pour spécifier le niveau de journalisation

L'put-logging-optionsexemple suivant active la journalisation des INFO niveaux dans AWS l'IoT SiteWise. Les autres niveaux incluent DEBUG et OFF.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Surveillance de AWS l'IoT SiteWise avec Amazon CloudWatch Logs dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir PutLoggingOptionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour ajouter une balise à une ressource

L’exemple tag-resource suivant ajoute une balise de propriétaire à une ressource d’éolienne. Cela vous permet de contrôler l’accès à la ressource en fonction de son propriétaire.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Marquage de vos ressources dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer une balise d’une ressource

L’exemple untag-resource suivant supprime une balise de propriétaire d’une ressource d’éolienne.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Marquage de vos ressources dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UntagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-access-policy.

AWS CLI

Pour octroyer à un observateur de projet la propriété d’un projet

L’exemple update-access-policy suivant met à jour une stratégie d’accès qui accorde à un observateur de projet la propriété d’un projet.

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

Contenu de 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"
        }
    }
}

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Affectation des responsables de projet dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir UpdateAccessPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-asset-model.

AWS CLI

Pour mettre à jour un modèle de ressource

L’exemple update-asset-model suivant met à jour une description d’un modèle de ressource de parc éolien. Cet exemple inclut l'existant IDs et les définitions du modèle, car il update-asset-model remplace le modèle existant par le nouveau modèle.

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

Contenu de 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"
        }
    ]
}

Sortie :

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

Pour plus d'informations, consultez la section Mise à jour des modèles d'actifs dans le Guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdateAssetModella section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-asset-property.

AWS CLI

Exemple 1 : pour mettre à jour l’alias d’une propriété de ressource

L’exemple update-asset-property suivant met à jour l’alias de propriété énergétique d’une ressource d’éolienne.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Mappage des flux de données industriels aux propriétés des actifs dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

Exemple 2 : pour activer les notifications relatives aux propriétés de la ressource

L’exemple update-asset-property suivant active les notifications de mise à jour des propriétés d’une ressource pour la propriété énergétique d’une éolienne. Les mises à jour de la valeur des propriétés sont publiées dans la rubrique MQTT $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, où chaque ID est remplacé par l’ID de propriété, de ressource et de modèle de la propriété de la ressource.

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"

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Interaction avec d'autres services dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdateAssetPropertyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-asset.

AWS CLI

Pour mettre à jour le nom d’une ressource

L’exemple update-asset suivant met à jour le nom d’une ressource d’éolienne.

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

Sortie :

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

Pour plus d'informations, consultez la section Mise à jour des actifs dans le guide de SiteWise l'utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdateAssetla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-dashboard.

AWS CLI

Pour mettre à jour un tableau de bord

L’exemple update-dashboard suivant modifie le titre du graphique linéaire d’un tableau de bord qui affiche l’énergie produite totale pour un parc éolien.

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

Contenu de 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"
                }
            ]
        }
    ]
}

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Création de tableaux de bord (CLI) dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdateDashboardla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-gateway-capability-configuration.

AWS CLI

Pour mettre à jour les fonctionnalités d’une passerelle

L’exemple update-gateway-capability-configuration suivant configure une source OPC-UA avec les propriétés suivantes :

Fait confiance à n'importe quel certificat. Utilise l'algorithme Basic256 pour sécuriser les messages.Utilise le SignAndEncrypt mode pour sécuriser les connexions. Utilise les informations d'authentification stockées dans un secret de 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

Contenu de 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": ""
        }
    ]
}

Sortie :

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

Pour plus d'informations, consultez la section Configuration des sources de données dans le guide de l' SiteWise utilisateur de l'AWS IoT.

L'exemple de code suivant montre comment utiliserupdate-gateway.

AWS CLI

Pour mettre à jour le nom d’une passerelle

L’exemple update-gateway suivant met à jour le nom d’une passerelle.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Ingestion de données à l'aide d'une passerelle dans le guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdateGatewayla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-portal.

AWS CLI

Pour mettre à jour les informations d’un portail

L’exemple update-portal suivant met à jour un portail Web pour une société de parc éolien.

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

Sortie :

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

Pour plus d'informations, consultez la section Administration de vos portails dans le Guide de l' SiteWise utilisateur de l'AWS IoT.

  • Pour plus de détails sur l'API, voir UpdatePortalla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-project.

AWS CLI

Pour mettre à jour les informations d’un projet

L’exemple update-project suivant met à jour un projet de parc éolien.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Modification des détails du projet dans le guide de l'application AWS IoT SiteWise Monitor.

  • Pour plus de détails sur l'API, voir UpdateProjectla section Référence des AWS CLI commandes.