AWS IoT SiteWise exemples utilisant AWS CLI - AWS Exemples de code SDK
Actions

D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples GitHub .

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 façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

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

AWS CLI

Pour associer un actif enfant à un actif parent

L'associate-assetsexemple suivant associe un actif d'éolienne à un actif de parc éolien, où le modèle d'actif d'éolienne existe sous forme de hiérarchie dans le modèle d'actif 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 aucun résultat.

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, reportez-vous AssociateAssetsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour associer un actif à un projet

L'batch-associate-project-assetsexemple suivant associe un actif 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 aucun résultat.

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 un actif d'un projet

L'batch-disassociate-project-assetsexemple suivant dissocie un actif d'un 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 aucun résultat.

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 des actifs

L'batch-put-asset-property-valueexemple suivant envoie des données de puissance et de température aux propriétés des actifs 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 : accorder à un utilisateur un accès administratif à un portail

L'create-access-policyexemple suivant crée une politique d'accès qui accorde à un utilisateur un 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 un accès en lecture seule à un projet

L'create-access-policyexemple suivant crée une politique 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, reportez-vous CreateAccessPolicyà la 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 d'actifs

L'create-asset-modelexemple suivant crée un modèle d'actif 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, reportez-vous CreateAssetModelà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour créer un actif

L'create-assetexemple suivant crée un actif d'éolienne à partir d'un modèle d'actif 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, reportez-vous CreateAssetà la 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'create-dashboardexemple suivant crée un tableau de bord avec un graphique linéaire qui affiche la puissance 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, reportez-vous CreateDashboardà la 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, reportez-vous CreateGatewayà la 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'create-portalexemple 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, reportez-vous CreatePortalà la 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'create-projectexemple 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, reportez-vous CreateProjectà la 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'delete-access-policyexemple suivant supprime une politique d'accès qui accorde à un utilisateur un accès administratif à un portail.

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

Cette commande ne produit aucun résultat.

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, reportez-vous DeleteAccessPolicyà la 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'delete-asset-modelexemple suivant supprime un modèle d'actif 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, reportez-vous DeleteAssetModelà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour supprimer un actif

L'delete-assetexemple suivant supprime un actif 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, reportez-vous DeleteAssetà la 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'delete-dashboardexemple suivant supprime un tableau de bord d'éolienne.

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

Cette commande ne produit aucun résultat.

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, reportez-vous DeleteDashboardà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour supprimer une passerelle

L'delete-gatewayexemple suivant supprime une passerelle.

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

Cette commande ne produit aucun résultat.

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, reportez-vous DeleteGatewayà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour supprimer un portail

L'delete-portalexemple suivant supprime le portail Web d'une société de parcs éoliens.

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, reportez-vous DeletePortalà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour supprimer un projet

L'delete-projectexemple suivant supprime un projet de parc éolien.

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

Cette commande ne produit aucun résultat.

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, reportez-vous DeleteProjectà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour décrire une politique d'accès

L'describe-access-policyexemple suivant décrit une politique d'accès qui accorde à un utilisateur un 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, reportez-vous DescribeAccessPolicyà la 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 d'actifs

L'describe-asset-modelexemple suivant décrit un modèle d'actifs 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, reportez-vous DescribeAssetModelà la 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é d'un actif

L'describe-asset-propertyexemple suivant décrit la propriété énergétique totale d'un actif 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, reportez-vous DescribeAssetPropertyà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour décrire un actif

L'describe-assetexemple suivant décrit un actif 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, reportez-vous DescribeAssetà la 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'describe-dashboardexemple 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, reportez-vous DescribeDashboardà la 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'describe-gateway-capability-configurationexemple 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'describe-gatewayexemple 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, reportez-vous DescribeGatewayà la 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 AWS IoT actuelles

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.

  • Pour plus de détails sur l'API, reportez-vous DescribeLoggingOptionsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour décrire un portail

L'describe-portalexemple 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, reportez-vous DescribePortalà la 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'describe-projectexemple 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, reportez-vous DescribeProjectà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour dissocier un actif enfant d'un actif parent

L'disassociate-assetsexemple suivant dissocie un actif d'éolienne d'un actif 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 aucun résultat.

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, reportez-vous DisassociateAssetsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour récupérer les valeurs moyennes et dénombrées agrégées d'une propriété d'actif

L'get-asset-property-aggregatesexemple suivant permet de récupérer la puissance totale moyenne d'une éolienne et le nombre de points de données de puissance 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 récupérer les valeurs historiques d'une propriété d'actif

L'get-asset-property-value-historyexemple suivant permet de récupérer les valeurs de puissance 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 récupérer la valeur actuelle d'une propriété d'actif

L'get-asset-property-valueexemple suivant permet de récupérer la puissance totale actuelle d'une é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, reportez-vous GetAssetPropertyValueà la 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 politiques d'accès

L'list-access-policiesexemple suivant répertorie toutes les politiques 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, reportez-vous ListAccessPoliciesà la 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 d'actifs

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, reportez-vous ListAssetModelsà la section Référence des AWS CLI commandes.

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

AWS CLI

Exemple 1 : pour répertorier tous les actifs 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 tous les actifs en fonction d'un modèle d'actifs

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, reportez-vous ListAssetsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour répertorier tous les actifs associés à un actif dans une hiérarchie spécifique

L'list-associated-assetsexemple suivant répertorie tous les actifs d'éoliennes associés à l'actif de parc éolien spécifié.

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, reportez-vous ListAssociatedAssetsà la 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'list-dashboardsexemple 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, reportez-vous ListDashboardsà la 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, reportez-vous ListGatewaysà la 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, reportez-vous ListPortalsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour répertorier tous les actifs associés à un projet

L'list-project-assetsexemple suivant répertorie tous les actifs associés à 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, reportez-vous ListProjectAssetsà la 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 dans un portail

L'list-projectsexemple 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, reportez-vous ListProjectsà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour répertorier tous les tags d'une ressource

L'list-tags-for-resourceexemple suivant répertorie toutes les balises d'un actif 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, reportez-vous ListTagsForResourceà la 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 etOFF.

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

Cette commande ne produit aucun résultat.

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, reportez-vous PutLoggingOptionsà la section Référence des AWS CLI commandes.

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

AWS CLI

Ajout d’une balise à une ressource

L'tag-resourceexemple suivant ajoute une étiquette de propriétaire à un actif d'éolienne. Cela vous permet de contrôler l'accès à l'actif 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 aucun résultat.

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, reportez-vous TagResourceà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour supprimer un tag d'une ressource

L'untag-resourceexemple suivant supprime une étiquette de propriétaire d'un actif 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 aucun résultat.

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, reportez-vous UntagResourceà la 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'update-access-policyexemple suivant met à jour une politique 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 aucun résultat.

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, reportez-vous UpdateAccessPolicyà la 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 d'actifs

L'update-asset-modelexemple suivant met à jour la description d'un modèle d'actifs 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, reportez-vous UpdateAssetModelà la 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é d'actif

L'update-asset-propertyexemple suivant met à jour l'alias de propriété énergétique d'un actif 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 aucun résultat.

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 des actifs

L'update-asset-propertyexemple suivant active les notifications de mise à jour des propriétés d'un actif pour la propriété électrique 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é, d'actif et de modèle de la propriété de l'actif.

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 aucun résultat.

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, reportez-vous UpdateAssetPropertyà la 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'un actif

L'update-assetexemple suivant met à jour le nom d'un actif 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, reportez-vous UpdateAssetà la 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'update-dashboardexemple suivant modifie le titre du graphique linéaire d'un tableau de bord qui affiche la puissance totale produite 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 aucun résultat.

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, reportez-vous UpdateDashboardà la 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'update-gateway-capability-configurationexemple 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'update-gatewayexemple 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 aucun résultat.

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, reportez-vous UpdateGatewayà la 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'update-portalexemple 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, reportez-vous UpdatePortalà la section Référence des AWS CLI commandes.

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

AWS CLI

Pour mettre à jour les détails d'un projet

L'update-projectexemple 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 aucun résultat.

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, reportez-vous UpdateProjectà la section Référence des AWS CLI commandes.