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.
**Topics**
+ [Actions](#actions)
## Actions
### `associate-assets`
L'exemple de code suivant montre comment utiliser`associate-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [AssociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/associate-assets.html)la section *Référence des AWS CLI commandes*.
### `batch-associate-project-assets`
L'exemple de code suivant montre comment utiliser`batch-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [BatchAssociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-associate-project-assets.html)la section *Référence des AWS CLI commandes*.
### `batch-disassociate-project-assets`
L'exemple de code suivant montre comment utiliser`batch-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [BatchDisassociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-disassociate-project-assets.html)la section *Référence des AWS CLI commandes*.
### `batch-put-asset-property-value`
L'exemple de code suivant montre comment utiliser`batch-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html)la section *Référence des AWS CLI commandes*.
### `create-access-policy`
L'exemple de code suivant montre comment utiliser`create-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) 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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-viewers.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [CreateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-access-policy.html)la section *Référence des AWS CLI commandes*.
### `create-asset-model`
L'exemple de code suivant montre comment utiliser`create-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html)la section *Référence des AWS CLI commandes*.
### `create-asset`
L'exemple de code suivant montre comment utiliser`create-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html)la section *Référence des AWS CLI commandes*.
### `create-dashboard`
L'exemple de code suivant montre comment utiliser`create-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)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [CreateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-dashboard.html)la section *Référence des AWS CLI commandes*.
### `create-gateway`
L'exemple de code suivant montre comment utiliser`create-gateway`.
**AWS CLI**
**Pour créer une passerelle**
L'`create-gateway`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html)la section *Référence des AWS CLI commandes*.
### `create-portal`
L'exemple de code suivant montre comment utiliser`create-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html) dans le guide de l'* SiteWise utilisateur de l'AWS IoT et [Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html#monitor-enable-sso) dans le guide* de l'* SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [CreatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-portal.html)la section *Référence des AWS CLI commandes*.
### `create-project`
L'exemple de code suivant montre comment utiliser`create-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/create-projects.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-project.html)la section *Référence des AWS CLI commandes*.
### `delete-access-policy`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DeleteAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-access-policy.html)la section *Référence des AWS CLI commandes*.
### `delete-asset-model`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html)la section *Référence des AWS CLI commandes*.
### `delete-asset`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html)la section *Référence des AWS CLI commandes*.
### `delete-dashboard`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html) de bord dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [DeleteDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-dashboard.html)la section *Référence des AWS CLI commandes*.
### `delete-gateway`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html)la section *Référence des AWS CLI commandes*.
### `delete-portal`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-delete-portal) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DeletePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-portal.html)la section *Référence des AWS CLI commandes*.
### `delete-project`
L'exemple de code suivant montre comment utiliser`delete-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-project.html)la section *Référence des AWS CLI commandes*.
### `describe-access-policy`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-access-policy.html)la section *Référence des AWS CLI commandes*.
### `describe-asset-model`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html)la section *Référence des AWS CLI commandes*.
### `describe-asset-property`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-property) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-property.html)la section *Référence des AWS CLI commandes*.
### `describe-asset`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset.html)la section *Référence des AWS CLI commandes*.
### `describe-dashboard`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) de bord dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [DescribeDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-dashboard.html)la section *Référence des AWS CLI commandes*.
### `describe-gateway-capability-configuration`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway-capability-configuration.html)la section *Référence des AWS CLI commandes*.
### `describe-gateway`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)la section *Référence des AWS CLI commandes*.
### `describe-logging-options`
L'exemple de code suivant montre comment utiliser`describe-logging-options`.
**AWS CLI**
**Pour récupérer les options de SiteWise journalisation actuelles de AWS l'IoT**
L'`describe-logging-options`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-logging-options.html)la section *Référence des AWS CLI commandes*.
### `describe-portal`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DescribePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-portal.html)la section *Référence des AWS CLI commandes*.
### `describe-project`
L'exemple de code suivant montre comment utiliser`describe-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [DescribeProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-project.html)la section *Référence des AWS CLI commandes*.
### `disassociate-assets`
L'exemple de code suivant montre comment utiliser`disassociate-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [DisassociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/disassociate-assets.html)la section *Référence des AWS CLI commandes*.
### `get-asset-property-aggregates`
L'exemple de code suivant montre comment utiliser`get-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates) de l'* SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [GetAssetPropertyAggregates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-aggregates.html)la section *Référence des AWS CLI commandes*.
### `get-asset-property-value-history`
L'exemple de code suivant montre comment utiliser`get-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [GetAssetPropertyValueHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value-history.html)la section *Référence des AWS CLI commandes*.
### `get-asset-property-value`
L'exemple de code suivant montre comment utiliser`get-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html)la section *Référence des AWS CLI commandes*.
### `list-access-policies`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-access-policies.html)la section *Référence des AWS CLI commandes*.
### `list-asset-models`
L'exemple de code suivant montre comment utiliser`list-asset-models`.
**AWS CLI**
**Pour répertorier tous les modèles de ressource**
L'`list-asset-models`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html)la section *Référence des AWS CLI commandes*.
### `list-assets`
L'exemple de code suivant montre comment utiliser`list-assets`.
**AWS CLI**
**Exemple 1 : pour répertorier toutes les ressources de premier niveau**
L'`list-assets`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) 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-assets`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-assets.html)la section *Référence des AWS CLI commandes*.
### `list-associated-assets`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-associated-assets) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListAssociatedAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-associated-assets.html)la section *Référence des AWS CLI commandes*.
### `list-dashboards`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html) de bord dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-dashboards.html)la section *Référence des AWS CLI commandes*.
### `list-gateways`
L'exemple de code suivant montre comment utiliser`list-gateways`.
**AWS CLI**
**Pour répertorier toutes les passerelles**
L'`list-gateways`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-gateways.html)la section *Référence des AWS CLI commandes*.
### `list-portals`
L'exemple de code suivant montre comment utiliser`list-portals`.
**AWS CLI**
**Pour répertorier tous les portails**
L'`list-portals`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListPortals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-portals.html)la section *Référence des AWS CLI commandes*.
### `list-project-assets`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [ListProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-project-assets.html)la section *Référence des AWS CLI commandes*.
### `list-projects`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-projects.html)la section *Référence des AWS CLI commandes*.
### `list-tags-for-resource`
L'exemple de code suivant montre comment utiliser`list-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-tags-for-resource.html)la section *Référence des AWS CLI commandes*.
### `put-logging-options`
L'exemple de code suivant montre comment utiliser`put-logging-options`.
**AWS CLI**
**Pour spécifier le niveau de journalisation**
L'`put-logging-options`exemple 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/put-logging-options.html)la section *Référence des AWS CLI commandes*.
### `tag-resource`
L'exemple de code suivant montre comment utiliser`tag-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/tag-resource.html)la section *Référence des AWS CLI commandes*.
### `untag-resource`
L'exemple de code suivant montre comment utiliser`untag-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/untag-resource.html)la section *Référence des AWS CLI commandes*.
### `update-access-policy`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-owners.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [UpdateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-access-policy.html)la section *Référence des AWS CLI commandes*.
### `update-asset-model`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-asset-models) dans le *Guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-model.html)la section *Référence des AWS CLI commandes*.
### `update-asset-property`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html) 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//assets//properties/`, 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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-property.html)la section *Référence des AWS CLI commandes*.
### `update-asset`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-assets) dans le *guide de SiteWise l'utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset.html)la section *Référence des AWS CLI commandes*.
### `update-dashboard`
L'exemple de code suivant montre comment utiliser`update-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)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-dashboard.html)la section *Référence des AWS CLI commandes*.
### `update-gateway-capability-configuration`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway-capability-configuration.html)la section *Référence des AWS CLI commandes*.
### `update-gateway`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html) dans le *guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway.html)la section *Référence des AWS CLI commandes*.
### `update-portal`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html) dans le *Guide de l' SiteWise utilisateur de l'AWS IoT*.
+ Pour plus de détails sur l'API, voir [UpdatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-portal.html)la section *Référence des AWS CLI commandes*.
### `update-project`
L'exemple de code suivant montre comment utiliser`update-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](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/edit-project-details.html) dans le *guide de l'application AWS IoT SiteWise Monitor*.
+ Pour plus de détails sur l'API, voir [UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-project.html)la section *Référence des AWS CLI commandes*.