Mettre à jour un modèle d'actif ou de composant (AWS CLI)

Vous pouvez utiliser le AWS Command Line Interface (AWS CLI) pour mettre à jour un modèle d'actif ou un modèle de composant.

Utilisez l'UpdateAssetModelAPI pour mettre à jour le nom, la description et les propriétés d'un modèle d'actif ou d'un modèle de composant. Pour les modèles d'actifs uniquement, vous pouvez mettre à jour les hiérarchies. Spécifiez les paramètres suivants :

• assetModelId— L'ID de l'actif. Il s'agit de l'identifiant réel au format UUID, ou du externalId:myExternalId s'il en possède un. Pour plus d’informations, consultez Référencement d'objets avec des identifiants externes dans le Guide de l’utilisateur AWS IoT SiteWise .

Spécifiez le modèle mis à jour dans la charge utile. Pour en savoir plus sur le format attendu d'un modèle d'actif ou d'un modèle de composant, voirCréation de modèles de ressources.

Avertissement

L'UpdateAssetModelAPI remplace le modèle existant par le modèle que vous fournissez dans la charge utile. Pour éviter de supprimer les propriétés ou les hiérarchies de votre modèle, vous devez inclure leurs identifiants et leurs définitions dans la charge utile du modèle mise à jour. Pour savoir comment interroger la structure existante de votre modèle, consultez l'DescribeAssetModelopération.

Note

La procédure suivante ne permet de mettre à jour que les modèles composites de typeAWS/ALARM. Si vous souhaitez mettre à jour des modèles CUSTOM composites, utilisez UpdateAssetModelCompositeModelplutôt. Pour plus d’informations, consultez Mise à jour de modèles composites personnalisés (composants).

Pour mettre à jour un modèle d'actif ou un modèle de composant (AWS CLI)

1. Exécutez la commande suivante pour récupérer la définition du modèle existant. asset-model-idRemplacez-le par l'ID ou l'ID externe du modèle d'actif ou du modèle de composant à mettre à jour.

   aws iotsitewise describe-asset-model --asset-model-id asset-model-id

   L'opération renvoie une réponse contenant les détails du modèle. La réponse présente la structure suivante.

   {
     "assetModelId": "String",
     "assetModelArn": "String",
     "assetModelName": "String",
     "assetModelDescription": "String",
     "assetModelProperties": Array of AssetModelProperty,
     "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
     "assetModelCompositeModels": Array of AssetModelCompositeModel,
     "assetModelCompositeModelSummaries": Array of AssetModelCompositeModelSummary,
     "assetModelCreationDate": "String",
     "assetModelLastUpdateDate": "String",
     "assetModelStatus": {
       "state": "String",
       "error": {
         "code": "String",
         "message": "String"
       },
     "assetModelType": "String"
     }
   }

   Pour plus d'informations, consultez l'DescribeAssetModelopération.

2. Créez un fichier appelé update-asset-model.json et copiez la réponse de la commande précédente dans le fichier.

3. Supprimez les paires clé-valeur suivantes de l'objet JSON dans update-asset-model.json :

   • assetModelId

   • assetModelArn

   • assetModelCompositeModelSummaries

   • assetModelCreationDate

   • assetModelLastUpdateDate

   • assetModelStatus

   • assetModelType

   L'UpdateAssetModelopération attend une charge utile dont la structure est la suivante :

   {
     "assetModelName": "String",
     "assetModelDescription": "String",
     "assetModelProperties": Array of AssetModelProperty,
     "assetModelHierarchies": Array of AssetModelHierarchyDefinition,
     "assetModelCompositeModels": Array of AssetModelCompositeModel
   }

4. Dans update-asset-model.json, effectuez l’une des actions suivantes :

   • Modifiez le nom du modèle de ressource (assetModelName).

   • Modifiez, ajoutez ou supprimez la description du modèle de ressource (assetModelDescription).

   • Modifiez, ajoutez ou supprimez les propriétés du modèle de ressource (assetModelProperties). Vous ne pouvez pas modifier le dataType des propriétés existantes ou le window des métriques existantes. Pour plus d’informations, consultez Définition des propriétés des données.

   • Modifiez, ajoutez ou supprimez les hiérarchies du modèle de ressource (assetModelHierarchies). Vous ne pouvez pas modifier le childAssetModelId des hiérarchies existantes. Pour plus d’informations, consultez Définition de hiérarchies de modèles d'actifs.

   • Modifiez, ajoutez ou supprimez l'un des modèles composites de type AWS/ALARM (assetModelCompositeModels) du modèle d'actifs. Les alarmes surveillent d'autres propriétés afin que vous puissiez identifier les équipements ou les processus nécessitant une attention particulière. Chaque définition d'alarme est un modèle composite qui normalise l'ensemble de propriétés utilisées par l'alarme. Pour plus d’informations, consultez Surveillance des données à l'aide d'alarmes et Définition des alarmes sur les modèles d'actifs.

5. Exécutez la commande suivante pour mettre à jour le modèle de ressource avec la définition stockée dans update-asset-model.json. Remplacez asset-model-idpar l'ID du modèle d'actif :

   aws iotsitewise update-asset-model \
     --asset-model-id asset-model-id \
     --cli-input-json file://model-payload.json