Définissez AWS IoT Events alarmes pour AWS IoT SiteWise

Pour définir un AWS IoT Events alarme sur un modèle d'actif

1. Accédez à la console AWS IoT SiteWise.

2. Dans le panneau de navigation, choisissez Models (Modèles).

3. Choisissez le modèle d'actif pour lequel définir une alarme.

4. Choisissez l'onglet Alarme.

5. Choisissez Ajouter une alarme.

6. Dans la section Options du type d'alarme, choisissez AWS IoT Events alarme.

7. Dans la section Détails de l'alarme, procédez comme suit :

   1. Saisissez un nom pour votre alarme.

   2. (Facultatif) Entrez la description de votre alarme.

8. Dans la section Définitions des seuils, vous définissez le moment où l'alarme est détectée et la gravité de l'alarme. Procédez comme suit :

   1. Sélectionnez la propriété sur laquelle l'alarme est détectée. Chaque fois que cette propriété reçoit une nouvelle valeur, AWS IoT SiteWise envoie la valeur AWS IoT Events à pour évaluer l'état de l'alarme.

   2. Sélectionnez l'opérateur à utiliser pour comparer la propriété à la valeur de seuil. Sélectionnez l’une des options suivantes :

      • < inférieur à

      • <= inférieur ou égal

      • == égal

      • ! = pas égal

      • >= supérieur ou égal

      • > supérieur à

   3. Dans Valeur, sélectionnez la propriété d'attribut à utiliser comme valeur de seuil. AWS IoT Events compare la valeur de la propriété à la valeur de cet attribut.

   4. Entrez la gravité de l'alarme. Utilisez un chiffre que votre équipe comprend pour refléter la gravité de cette alarme.

9. (Facultatif) Dans la section Paramètres de notification - facultatif, procédez comme suit :

   1. Choisissez Active.

      Note

      Si vous choisissez Inactif, vous et votre équipe ne recevrez aucune notification d'alarme.

   2. Dans Destinataire, choisissez le destinataire.

      Important

      Vous pouvez envoyer des notifications d'alarme aux AWS IAM Identity Center utilisateurs. Pour utiliser cette fonctionnalité, vous devez activer IAM Identity Center. Vous ne pouvez activer IAM Identity Center que dans une seule AWS région à la fois. Cela signifie que vous ne pouvez définir des notifications d'alarme que dans la région où vous activez IAM Identity Center. Pour plus d'informations, consultez Démarrer dans le Guide de l'utilisateur AWS IAM Identity Center .

   3. Pour Protocole, choisissez l'une des options suivantes :

      • E-mail et SMS  : l'alarme avertit les utilisateurs d'IAM Identity Center par un SMS et un e-mail.

      • E-mail  : l'alarme envoie un e-mail aux utilisateurs d'IAM Identity Center.

      • Texte  : l'alarme envoie un message SMS aux utilisateurs d'IAM Identity Center.

   4. Pour Expéditeur, choisissez l'expéditeur.

      Important

      Vous devez vérifier l'adresse e-mail de l'expéditeur dans Amazon Simple Email Service (Amazon SES). Pour plus d'informations, consultez la section Vérification de l'identité d'une adresse e-mail dans le manuel Amazon Simple Email Service Developer Guide.

10. Dans la section État par défaut de l'actif, vous pouvez définir l'état par défaut des alarmes créées à partir de ce modèle d'actif.

    Note

    Vous activez ou désactivez cette alarme pour les actifs que vous créez à partir de ce modèle d'actif lors d'une étape ultérieure.

11. Dans la section Paramètres avancés, vous pouvez configurer les autorisations, les paramètres de notification supplémentaires, les actions relatives à l'état de l'alarme, le modèle d'alarme dans SiteWise Monitor et le flux d'accusé de réception.

    Note

    AWS IoT Events les alarmes nécessitent les rôles de service suivants :

    • Un rôle qui AWS IoT Events suppose d'envoyer les valeurs d'état d'alarme à AWS IoT SiteWise.

    • Rôle qui AWS IoT Events suppose d'envoyer des données à Lambda. Vous n'avez besoin de ce rôle que si votre alarme envoie des notifications.

    Dans la section Autorisations, procédez comme suit :

    1. Pour AWS IoT Events le rôle, utilisez un rôle existant ou créez-en un avec les autorisations requises. Ce rôle nécessite l'iotsitewise:BatchPutAssetPropertyValueautorisation et une relation de confiance qui permettent à iotevents.amazonaws.com d'assumer le rôle.

    2. Pour le rôle AWS IoT Events Lambda, utilisez un rôle existant ou créez-en un avec les autorisations requises. Ce rôle nécessite les sso-directory:DescribeUser autorisations lambda:InvokeFunction et une relation de confiance qui permet iotevents.amazonaws.com d'assumer le rôle.

12. (Facultatif) Dans la section Paramètres de notification supplémentaires, procédez comme suit :

    1. Pour Attribut du destinataire, vous définissez un attribut dont la valeur indique le destinataire de la notification. Vous pouvez choisir les utilisateurs d'IAM Identity Center comme destinataires.

       Vous pouvez créer un attribut ou utiliser un attribut existant dans le modèle d'actif.

       • Si vous choisissez Créer un nouvel attribut de destinataire, spécifiez le nom de l'attribut du destinataire et la valeur par défaut du destinataire, facultative pour l'attribut.

       • Si vous choisissez Utiliser un attribut de destinataire existant, choisissez l'attribut dans Nom de l'attribut du destinataire. L'alarme utilise la valeur par défaut de l'attribut que vous choisissez.

       Vous pouvez modifier la valeur par défaut de chaque actif que vous créez à partir de ce modèle d'actif.

    2. Pour Attribut de message personnalisé, vous définissez un attribut dont la valeur indique le message personnalisé à envoyer en plus du message de changement d'état par défaut. Par exemple, vous pouvez spécifier un message qui aidera votre équipe à comprendre comment traiter cette alarme.

       Vous pouvez choisir de créer un attribut ou d'utiliser un attribut existant dans le modèle d'actif.

       • Si vous choisissez de créer un nouvel attribut de message personnalisé, spécifiez le nom de l'attribut de message personnalisé et la valeur par défaut du message personnalisé, facultative pour l'attribut.

       • Si vous choisissez Utiliser un attribut de message personnalisé existant, choisissez l'attribut dans Nom de l'attribut de message personnalisé. L'alarme utilise la valeur par défaut de l'attribut que vous choisissez.

       Vous pouvez modifier la valeur par défaut de chaque actif que vous créez à partir de ce modèle d'actif.

    3. Pour Gérer votre fonction Lambda, effectuez l'une des opérations suivantes :

       • Pour AWS IoT SiteWise créer une nouvelle fonction Lambda, choisissez Créer une nouvelle fonction Lambda à partir d'un modèle géré par AWS.

       • Pour utiliser une fonction Lambda existante, choisissez Utiliser une fonction Lambda existante et choisissez le nom de la fonction.

       Pour plus d'informations, consultez la section Gestion des notifications d'alarme dans le Guide du AWS IoT Events développeur.

13. (Facultatif) Dans la section Définir l'action d'état, procédez comme suit :

    1. Choisissez Modifier l'action.

    2. Sous Ajouter des actions à l'état d'alarme, ajoutez des actions, puis choisissez Enregistrer.

       Vous pouvez ajouter jusqu'à 10 actions.

    AWS IoT Events peut effectuer des actions lorsque l'alarme est active. Vous pouvez définir des actions intégrées pour utiliser un minuteur ou définir une variable, ou envoyer des données à d'autres AWS ressources. Pour plus d'informations, consultez la section Actions prises en charge dans le Guide du AWS IoT Events développeur.

14. (Facultatif) Sous Gérer le modèle d'alarme dans SiteWise Monitor - facultatif , choisissez Actif ou Inactif.

    Utilisez cette option pour mettre à jour le modèle d'alarme dans SiteWise Monitorss. Cette option est activée par défaut.

15. Sous Accusé de réception du flux, choisissez Actif ou Inactif. Pour plus d'informations sur le flux d'accusé de réception, consultezÉtats d'alarme.

16. Choisissez Ajouter une alarme.

    Note

    La AWS IoT SiteWise console effectue plusieurs requêtes d'API pour ajouter l'alarme au modèle d'actif. Lorsque vous choisissez Ajouter une alarme, la console ouvre une boîte de dialogue qui indique la progression de ces demandes d'API. Restez sur cette page jusqu'à ce que chaque demande d'API aboutisse ou jusqu'à ce qu'une demande d'API échoue. Si une demande échoue, fermez la boîte de dialogue, corrigez le problème et choisissez Ajouter une alarme pour réessayer.

Pour définir un AWS IoT Events alarme sur un modèle d'actif

1. Accédez à la console AWS IoT Events.

2. Dans le volet de navigation, choisissez Modèles d'alarme.

3. Choisissez Créer un modèle d'alarme.

4. Saisissez un nom pour votre alarme.

5. (Facultatif) Entrez la description de votre alarme.

6. Dans la section Cible de l'alarme, procédez comme suit :

   1. Pour les options Target, choisissez propriété de l'AWS IoT SiteWise actif.

   2. Choisissez le modèle d'actif pour lequel vous souhaitez ajouter l'alarme.

7. Dans la section Définitions des seuils, vous définissez le moment où l'alarme est détectée et la gravité de l'alarme. Procédez comme suit :

   1. Sélectionnez la propriété sur laquelle l'alarme est détectée. Chaque fois que cette propriété reçoit une nouvelle valeur, AWS IoT SiteWise envoie la valeur AWS IoT Events à pour évaluer l'état de l'alarme.

   2. Sélectionnez l'opérateur à utiliser pour comparer la propriété à la valeur de seuil. Sélectionnez l’une des options suivantes :

      • < inférieur à

      • <= inférieur ou égal

      • == égal

      • ! = pas égal

      • >= supérieur ou égal

      • > supérieur à

   3. Dans Valeur, sélectionnez la propriété d'attribut à utiliser comme valeur de seuil. AWS IoT Events compare la valeur de la propriété à la valeur de cet attribut.

   4. Entrez la gravité de l'alarme. Utilisez un chiffre que votre équipe comprend pour refléter la gravité de cette alarme.

8. (Facultatif) Dans la section Paramètres de notification - facultatif, procédez comme suit :

   1. Pour Protocole, choisissez l'une des options suivantes :

      • E-mail et SMS  : l'alarme avertit les utilisateurs d'IAM Identity Center par un SMS et un e-mail.

      • E-mail  : l'alarme envoie un e-mail aux utilisateurs d'IAM Identity Center.

      • Texte  : l'alarme envoie un message SMS aux utilisateurs d'IAM Identity Center.

   2. Pour Expéditeur, choisissez l'expéditeur.

      Important

      Vous devez vérifier l'adresse e-mail de l'expéditeur dans Amazon Simple Email Service (Amazon SES). Pour plus d'informations, consultez la section Vérification des adresses e-mail dans Amazon SES, dans le manuel Amazon Simple Email Service Developer Guide.

   3. Choisissez l'attribut dans Attribut du destinataire - facultatif . L'alarme utilise la valeur par défaut de l'attribut que vous choisissez.

   4. Choisissez l'attribut dans Attribut de message personnalisé - facultatif . L'alarme utilise la valeur par défaut de l'attribut que vous choisissez.

9. Dans la section Instance, spécifiez l'état par défaut de cette alarme. Vous pouvez activer ou désactiver cette alarme pour tous les actifs que vous créez à partir de ce modèle d'actif lors d'une étape ultérieure.

10. Dans les paramètres avancés, vous pouvez configurer les autorisations, les paramètres de notification supplémentaires, les actions relatives à l'état de l'alarme, le modèle d'alarme dans SiteWise Monitor et le flux d'accusé de réception.

    Note

    AWS IoT Events les alarmes nécessitent les rôles de service suivants :

    • Un rôle qui AWS IoT Events suppose d'envoyer les valeurs d'état d'alarme à AWS IoT SiteWise.

    • Rôle qui AWS IoT Events suppose d'envoyer des données à Lambda. Vous n'avez besoin de ce rôle que si votre alarme envoie des notifications.

    1. Dans la section Accusé de réception, choisissez Activé ou Désactivé. Pour plus d'informations sur le flux d'accusé de réception, consultezÉtats d'alarme.

    2. Dans la section Autorisations, procédez comme suit :

       1. Pour AWS IoT Events le rôle, utilisez un rôle existant ou créez-en un avec les autorisations requises. Ce rôle nécessite l'iotsitewise:BatchPutAssetPropertyValueautorisation et une relation de confiance qui permettent à iotevents.amazonaws.com d'assumer le rôle.

       2. Pour le rôle Lambda, utilisez un rôle existant ou créez-en un avec les autorisations requises. Ce rôle nécessite les sso-directory:DescribeUser autorisations lambda:InvokeFunction et une relation de confiance qui permet iotevents.amazonaws.com d'assumer le rôle.

    3. (Facultatif) Dans le volet Paramètres de notification supplémentaires, procédez comme suit :

       1. Pour Gérer votre fonction Lambda, effectuez l'une des opérations suivantes :

          • Pour AWS IoT Events créer une nouvelle fonction Lambda, choisissez Créer une nouvelle fonction Lambda.

          • Pour utiliser une fonction Lambda existante, choisissez Utiliser une fonction Lambda existante et choisissez le nom de la fonction.

          Pour plus d'informations, consultez la section Gestion des notifications d'alarme dans le Guide du AWS IoT Events développeur.

    4. (Facultatif) Dans la section Définir l'état, action facultative, procédez comme suit :

       1. Sous Actions relatives à l'état de l'alarme, ajoutez des actions, puis choisissez Enregistrer.

          Vous pouvez ajouter jusqu'à 10 actions.

       AWS IoT Events peut effectuer des actions lorsque l'alarme est active. Vous pouvez définir des actions intégrées pour utiliser un minuteur ou définir une variable, ou envoyer des données à d'autres AWS ressources. Pour plus d'informations, consultez la section Actions prises en charge dans le Guide du AWS IoT Events développeur.

11. Choisissez Créer.

    Note

    La AWS IoT Events console effectue plusieurs requêtes d'API pour ajouter l'alarme au modèle d'actif. Lorsque vous choisissez Ajouter une alarme, la console ouvre une boîte de dialogue qui indique la progression de ces demandes d'API. Restez sur cette page jusqu'à ce que chaque demande d'API aboutisse ou jusqu'à ce qu'une demande d'API échoue. Si une demande échoue, fermez la boîte de dialogue, corrigez le problème et choisissez Ajouter une alarme pour réessayer.

Pour définir une alarme sur un modèle d'actif (CLI)

1. Créez un fichier, appelé asset-model-payload.json. Suivez les étapes décrites dans ces autres sections pour ajouter les détails de votre modèle d'actif au fichier, mais ne soumettez pas la demande de création ou de mise à jour du modèle d'actif. Dans cette section, vous ajoutez une définition d'alarme aux détails du modèle d'actif dans le asset-model-payload.json fichier.

   • Pour plus d'informations sur la création d'un modèle d'actif, consultezCréez un modèle d'actif (AWS CLI).

   • Pour plus d'informations sur la mise à jour d'un modèle d'actif existant, consultezMettre à jour un modèle d'actif, un modèle de composant ou une interface (AWS CLI).

   Note

   Votre modèle d'actif doit définir au moins une propriété de l'actif, y compris la propriété de l'actif à surveiller à l'aide de l'alarme.

2. Ajoutez un modèle composite d'alarme (assetModelCompositeModels) au modèle d'actif. Un modèle composite AWS IoT Events d'alarme spécifie le IOT_EVENTS type et spécifie une propriété de source d'alarme. Vous ajoutez la propriété de source d'alarme après avoir créé le modèle d'alarme dans AWS IoT Events.

   Important

   Le modèle composite d'alarme doit porter le même nom que le modèle AWS IoT Events d'alarme que vous créerez ultérieurement. Les noms des modèles d'alarme ne peuvent contenir que des caractères alphanumériques. Spécifiez un nom alphanumérique unique afin de pouvoir utiliser le même nom pour le modèle d'alarme.

   {
     ...
     "assetModelCompositeModels": [
       {
         "name": "BoilerTemperatureHighAlarm",
         "type": "AWS/ALARM",
         "properties": [
           {
             "name": "AWS/ALARM_TYPE",
             "dataType": "STRING",
             "type": {
               "attribute": {
                 "defaultValue": "IOT_EVENTS"
               }
             }
           },
           {
             "name": "AWS/ALARM_STATE",
             "dataType": "STRUCT",
             "dataTypeSpec": "AWS/ALARM_STATE",
             "type": {
               "measurement": {}
             }
           }
         ]
       }
     ]
   }

3. Ajoutez un attribut de seuil d'alarme au modèle d'actif. Spécifiez la valeur par défaut à utiliser pour ce seuil. Vous pouvez modifier cette valeur par défaut pour chaque actif en fonction de ce modèle.

   Note

   L'attribut de seuil d'alarme doit être un INTEGER ou DOUBLE a.

   {
     ...
     "assetModelProperties": [
       ...
       {
         "name": "Temperature Max Threshold",
         "dataType": "DOUBLE",
         "type": {
           "attribute": {
             "defaultValue": "105.0"
           }
         }
       }
     ]
   }

4. (Facultatif) Ajoutez des attributs de notification d'alarme au modèle d'actif. Ces attributs spécifient le destinataire de l'IAM Identity Center et les autres entrées AWS IoT Events utilisées pour envoyer des notifications lorsque l'état de l'alarme change d'état. Vous pouvez modifier ces valeurs par défaut pour chaque actif en fonction de ce modèle.

   Important

   Vous pouvez envoyer des notifications d'alarme aux AWS IAM Identity Center utilisateurs. Pour utiliser cette fonctionnalité, vous devez activer IAM Identity Center. Vous ne pouvez activer IAM Identity Center que dans une seule AWS région à la fois. Cela signifie que vous ne pouvez définir des notifications d'alarme que dans la région où vous activez IAM Identity Center. Pour plus d'informations, consultez Démarrer dans le Guide de l'utilisateur AWS IAM Identity Center .

   Procédez comme suit :

   1. Ajoutez un attribut qui spécifie l'ID de votre banque d'identités IAM Identity Center. Vous pouvez utiliser l'opération d'ListInstancesAPI IAM Identity Center pour répertorier vos magasins d'identités. Cette opération ne fonctionne que dans la région où vous activez IAM Identity Center.

      aws sso-admin list-instances

      Spécifiez ensuite l'ID de la banque d'identités (par exempled-123EXAMPLE) comme valeur par défaut pour l'attribut.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "identityStoreId",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "d-123EXAMPLE"
              }
            }
          }
        ]
      }

   2. Ajoutez un attribut qui spécifie l'ID de l'utilisateur IAM Identity Center qui reçoit les notifications. Pour définir un destinataire de notification par défaut, ajoutez un ID utilisateur IAM Identity Center comme valeur par défaut. Pour obtenir un ID utilisateur IAM Identity Center, effectuez l'une des opérations suivantes :

      1. Vous pouvez utiliser l'ListUsersAPI IAM Identity Center pour obtenir l'ID d'un utilisateur dont vous connaissez le nom d'utilisateur. Remplacez-le d-123EXAMPLE par l'ID de votre banque d'identités et remplacez-le Name par le nom d'utilisateur de l'utilisateur.

         aws identitystore list-users \
           --identity-store-id d-123EXAMPLE \
           --filters AttributePath=UserName,AttributeValue=Name

      2. Utilisez la console IAM Identity Center pour parcourir vos utilisateurs et trouver un ID utilisateur.

      Spécifiez ensuite l'ID utilisateur (par exemple123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE) comme valeur par défaut pour l'attribut, ou définissez l'attribut sans valeur par défaut.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "userId",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
              }
            }
          }
        ]
      }

   3. (Facultatif) Ajoutez un attribut qui spécifie l'ID d'expéditeur par défaut pour les notifications par SMS (texte). L'ID de l'expéditeur s'affiche en tant qu'expéditeur du message sur les messages envoyés par Amazon Simple Notification Service (Amazon SNS). Pour plus d'informations, voir Demander un identifiant d'expéditeur AWS End User Messaging SMS dans le Guide de AWS End User Messaging SMS l'utilisateur.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "senderId",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "MyFactory"
              }
            }
          }
        ]
      }

   4. (Facultatif) Ajoutez un attribut qui spécifie l'adresse e-mail par défaut à utiliser comme adresse d'expédition dans les notifications par e-mail.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "fromAddress",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "my.factory@example.com"
              }
            }
          }
        ]
      }

   5. (Facultatif) Ajoutez un attribut qui spécifie l'objet par défaut à utiliser dans les notifications par e-mail.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "emailSubject",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "[ALERT] High boiler temperature"
              }
            }
          }
        ]
      }

   6. (Facultatif) Ajoutez un attribut qui spécifie un message supplémentaire à inclure dans les notifications. Par défaut, les messages de notification contiennent des informations relatives à l'alarme. Vous pouvez également inclure un message supplémentaire fournissant plus d'informations à l'utilisateur.

      {
        ...
        "assetModelProperties": [
          ...
          {
            "name": "additionalMessage",
            "dataType": "STRING",
            "type": {
              "attribute": {
                "defaultValue": "Turn off the power before you check the alarm."
              }
            }
          }
        ]
      }

5. Créez le modèle d'actif ou mettez à jour le modèle d'actif existant. Effectuez l’une des actions suivantes :

   • Pour créer le modèle d'actif, exécutez la commande suivante.

     aws iotsitewise create-asset-model --cli-input-json file://asset-model-payload.json

   • Pour mettre à jour le modèle d'actif existant, exécutez la commande suivante. asset-model-idRemplacez-le par l'ID du modèle d'actif.

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

   Après avoir exécuté la commande, notez-la assetModelId dans la réponse.

Pour créer un AWS IoT Events modèle d'alarme (CLI)

1. Lorsque vous créez le modèle d'alarme dans AWS IoT Events, vous devez spécifier l'ID de chaque propriété utilisée par l'alarme, notamment les éléments suivants :

   • La propriété de l'état d'alarme dans le modèle d'actif composite

   • La propriété surveillée par l'alarme

   • L'attribut threshold

   • (Facultatif) L'attribut IAM Identity Center Identity Store ID ID

   • (Facultatif) L'attribut d'ID utilisateur IAM Identity Center

   • (Facultatif) L'attribut ID de l'expéditeur du SMS

   • (Facultatif) L'attribut d'adresse e-mail

   • (Facultatif) L'attribut d'objet de l'e-mail

   • (Facultatif) L'attribut de message supplémentaire

   Exécutez la commande suivante pour récupérer les ID de ces propriétés sur le modèle d'actif. asset-model-idRemplacez-le par l'ID du modèle d'actif de l'étape précédente.

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

   L'opération renvoie une réponse qui contient les détails du modèle de ressource. Notez l'ID de chaque propriété utilisée par l'alarme. Vous utilisez ces ID lorsque vous créez le modèle AWS IoT Events d'alarme à l'étape suivante.

2. Créez le modèle d'alarme dans AWS IoT Events. Procédez comme suit :

   1. Créez un fichier, appelé alarm-model-payload.json.

   2. Copiez l'objet JSON suivant dans le fichier.

   3. Entrez le nom (alarmModelName), la description (alarmModelDescription) et la gravité (severity) de votre alarme. Pour la gravité, spécifiez un entier qui reflète les niveaux de gravité de votre entreprise.

      Important

      Le modèle d'alarme doit porter le même nom que le modèle composite d'alarme que vous avez défini précédemment dans votre modèle d'actif.

      Les noms des modèles d'alarme ne peuvent contenir que des caractères alphanumériques.

      {
        "alarmModelName": "BoilerTemperatureHighAlarm",
        "alarmModelDescription": "Detects when the boiler temperature is high.",
        "severity": 3
      }

   4. Ajoutez la règle de comparaison (alarmRule) à l'alarme. Cette règle définit la propriété à surveiller (inputProperty), la valeur de seuil à comparer (threshold) et l'opérateur de comparaison à utiliser (comparisonOperator).

      • assetModelIdRemplacez-le par l'ID du modèle d'actif.

      • alarmPropertyIdRemplacez-le par l'ID de la propriété surveillée par l'alarme.

      • Remplacez thresholdAttributeId par l'ID de la propriété d'attribut de seuil.

      • Remplacez GREATER par l'opérateur à utiliser pour comparer les valeurs des propriétés avec le seuil. Sélectionnez l’une des options suivantes :

        • LESS

        • LESS_OR_EQUAL

        • EQUAL

        • NOT_EQUAL

        • GREATER_OR_EQUAL

        • GREATER

      {
        "alarmModelName": "BoilerTemperatureHighAlarm",
        "alarmModelDescription": "Detects when the boiler temperature is high.",
        "severity": 3,
        "alarmRule": {
          "simpleRule": {
            "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
            "comparisonOperator": "GREATER",
            "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
          }
        }
      }

   5. Ajoutez une action (alarmEventActions) pour envoyer l'état de l'alarme au AWS IoT SiteWise moment où l'alarme change d'état.

      Note

      Pour une configuration avancée, vous pouvez définir des actions supplémentaires à effectuer lorsque l'alarme change d'état. Par exemple, vous pouvez appeler une AWS Lambda fonction ou publier dans une rubrique MQTT. Pour plus d'informations, consultez la section Utilisation d'autres AWS services dans le Guide du AWS IoT Events développeur.

      • assetModelIdRemplacez-le par l'ID du modèle d'actif.

      • alarmPropertyIdRemplacez-le par l'ID de la propriété surveillée par l'alarme.

      • Remplacez-le alarmStatePropertyId par l'ID de la propriété d'état d'alarme dans le modèle composite d'alarme.

      {
        "alarmModelName": "BoilerTemperatureHighAlarm",
        "alarmModelDescription": "Detects when the boiler temperature is high.",
        "severity": 3,
        "alarmRule": {
          "simpleRule": {
            "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
            "comparisonOperator": "GREATER",
            "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
          }
        },
        "alarmEventActions": {
          "alarmActions": [
            {
              "iotSiteWise": {
                "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                "propertyId": "'alarmStatePropertyId'"
              }
            }
          ]
        }
      }

   6. (Facultatif) Configurez les paramètres de notification d'alarme. L'action de notification d'alarme utilise une fonction Lambda de votre compte pour envoyer des notifications d'alarme. Pour de plus amples informations, veuillez consulter Exigences relatives aux notifications d'alarme dans AWS IoT SiteWise. Dans les paramètres de notification d'alarme, vous pouvez configurer les notifications par SMS et par e-mail à envoyer aux utilisateurs d'IAM Identity Center. Procédez comme suit :

      1. Ajoutez la configuration de notification d'alarme (alarmNotification) à la charge utile dansalarm-model-payload.json.

         • Remplacez-le alarmNotificationFunctionArn par l'ARN de la fonction Lambda qui gère les notifications d'alarme.

         {
           "alarmModelName": "BoilerTemperatureHighAlarm",
           "alarmModelDescription": "Detects when the boiler temperature is high.",
           "severity": 3,
           "alarmRule": {
             "simpleRule": {
               "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
               "comparisonOperator": "GREATER",
               "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
             }
           },
           "alarmEventActions": {
             "alarmActions": [
               {
                 "iotSiteWise": {
                   "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                   "propertyId": "'alarmStatePropertyId'"
                 }
               }
             ]
           },
           "alarmNotification": {
             "notificationActions": [
               {
                 "action": {
                   "lambdaAction": {
                     "functionArn": "alarmNotificationFunctionArn"
                   }
                 }
               }
             ]
           }
         }

      2. (Facultatif) Configurez les notifications par SMS (smsConfigurations) à envoyer à un utilisateur d'IAM Identity Center lorsque l'état de l'alarme change d'état.

         • Remplacez-le identityStoreIdAttributeId par l'ID de l'attribut qui contient l'ID de la banque d'identités IAM Identity Center.

         • userIdAttributeIdRemplacez-le par l'ID de l'attribut qui contient l'ID de l'utilisateur IAM Identity Center.

         • Remplacez-le senderIdAttributeId par l'ID de l'attribut qui contient l'ID d'expéditeur Amazon SNS, ou supprimez-le senderId de la charge utile.

         • additionalMessageAttributeIdRemplacez-le par l'ID de l'attribut qui contient le message supplémentaire ou supprimez-le additionalMessage de la charge utile.

         {
           "alarmModelName": "BoilerTemperatureHighAlarm",
           "alarmModelDescription": "Detects when the boiler temperature is high.",
           "severity": 3,
           "alarmRule": {
             "simpleRule": {
               "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
               "comparisonOperator": "GREATER",
               "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
             }
           },
           "alarmEventActions": {
             "alarmActions": [
               {
                 "iotSiteWise": {
                   "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                   "propertyId": "'alarmStatePropertyId'"
                 }
               }
             ]
           },
           "alarmNotification": {
             "notificationActions": [
               {
                 "action": {
                   "lambdaAction": {
                     "functionArn": "alarmNotificationFunctionArn"
                   }
                 },
                 "smsConfigurations": [
                   {
                     "recipients": [
                       {
                         "ssoIdentity": {
                           "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                           "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                         }
                       }
                     ],
                     "senderId": "$sitewise.assetModel.`assetModelId`.`senderIdAttributeId`.propertyValue.value",
                     "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                   }
                 ]
               }
             ]
           }
         }

      3. (Facultatif) Configurez les notifications par e-mail (emailConfigurations) à envoyer à un utilisateur d'IAM Identity Center lorsque l'état de l'alarme change d'état.

         • identityStoreIdAttributeIdRemplacez-le par l'ID de la propriété d'attribut IAM Identity Store ID.

         • Remplacez-le userIdAttributeId par l'ID de la propriété d'attribut d'ID utilisateur IAM Identity Center.

         • Remplacez-le fromAddressAttributeId par l'ID de la propriété d'attribut d'adresse « de » ou retirez-le from de la charge utile.

         • Remplacez-le emailSubjectAttributeId par l'ID de la propriété d'attribut d'objet de l'e-mail ou supprimez-le subject de la charge utile.

         • Remplacez-le additionalMessageAttributeId par l'ID de la propriété d'attribut de message supplémentaire ou supprimez-la additionalMessage de la charge utile.

         {
           "alarmModelName": "BoilerTemperatureHighAlarm",
           "alarmModelDescription": "Detects when the boiler temperature is high.",
           "severity": 3,
           "alarmRule": {
             "simpleRule": {
               "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
               "comparisonOperator": "GREATER",
               "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
             }
           },
           "alarmEventActions": {
             "alarmActions": [
               {
                 "iotSiteWise": {
                   "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                   "propertyId": "'alarmStatePropertyId'"
                 }
               }
             ]
           },
           "alarmNotification": {
             "notificationActions": [
               {
                 "action": {
                   "lambdaAction": {
                     "functionArn": "alarmNotificationFunctionArn"
                   }
                 },
                 "smsConfigurations": [
                   {
                     "recipients": [
                       {
                         "ssoIdentity": {
                           "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                           "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                         }
                       }
                     ],
                     "senderId": "$sitewise.assetModel.`assetModelId`.`senderIdAttributeId`.propertyValue.value",
                     "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                   }
                 ],
                 "emailConfigurations": [
                   {
                     "from": "$sitewise.assetModel.`assetModelId`.`fromAddressAttributeId`.propertyValue.value",
                     "recipients": {
                       "to": [
                         {
                           "ssoIdentity": {
                             "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                             "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                           }
                         }
                       ]
                     },
                     "content": {
                       "subject": "$sitewise.assetModel.`assetModelId`.`emailSubjectAttributeId`.propertyValue.value",
                       "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                     }
                   }
                 ]
               }
             ]
           }
         }

   7. (Facultatif) Ajoutez les fonctionnalités d'alarme (alarmCapabilities) à la charge utile. alarm-model-payload.json Dans cet objet, vous pouvez spécifier si le flux d'accusé de réception est activé et l'état d'activation par défaut pour les actifs en fonction du modèle d'actif. Pour plus d'informations sur le flux d'accusé de réception, consultezÉtats d'alarme.

      {
        "alarmModelName": "BoilerTemperatureHighAlarm",
        "alarmModelDescription": "Detects when the boiler temperature is high.",
        "severity": 3,
        "alarmRule": {
          "simpleRule": {
            "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
            "comparisonOperator": "GREATER",
            "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
          }
        },
        "alarmEventActions": {
          "alarmActions": [
            {
              "iotSiteWise": {
                "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                "propertyId": "'alarmStatePropertyId'"
              }
            }
          ]
        },
        "alarmNotification": {
          "notificationActions": [
            {
              "action": {
                "lambdaAction": {
                  "functionArn": "alarmNotificationFunctionArn"
                }
              },
              "smsConfigurations": [
                {
                  "recipients": [
                    {
                      "ssoIdentity": {
                        "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                        "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                      }
                    }
                  ],
                  "senderId": "$sitewise.assetModel.`assetModelId`.`senderIdAttributeId`.propertyValue.value",
                  "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                }
              ],
              "emailConfigurations": [
                {
                  "from": "$sitewise.assetModel.`assetModelId`.`fromAddressAttributeId`.propertyValue.value",
                  "recipients": {
                    "to": [
                      {
                        "ssoIdentity": {
                          "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                          "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                        }
                      }
                    ]
                  },
                  "content": {
                    "subject": "$sitewise.assetModel.`assetModelId`.`emailSubjectAttributeId`.propertyValue.value",
                    "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                  }
                }
              ]
            }
          ]
        },
        "alarmCapabilities": {
          "initializationConfiguration": {
            "disabledOnInitialization": false
          },
          "acknowledgeFlow": {
            "enabled": true
          }
        }
      }

   8. Ajoutez le rôle de service IAM (roleArn) que AWS IoT Events vous pouvez assumer pour envoyer des données à AWS IoT SiteWise. Ce rôle nécessite l'iotsitewise:BatchPutAssetPropertyValueautorisation et une relation de confiance qui permet iotevents.amazonaws.com d'assumer le rôle. Pour envoyer des notifications, ce rôle nécessite également les sso-directory:DescribeUser autorisations lambda:InvokeFunction et. Pour plus d'informations, consultez la section Rôles des services d'alarme dans le Guide du AWS IoT Events développeur.

      • Remplacez le roleArn par l'ARN du rôle que AWS IoT Events vous pouvez assumer pour effectuer ces actions.

      {
        "alarmModelName": "BoilerTemperatureHighAlarm",
        "alarmModelDescription": "Detects when the boiler temperature is high.",
        "severity": 3,
        "alarmRule": {
          "simpleRule": {
            "inputProperty": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.propertyValue.value",
            "comparisonOperator": "GREATER",
            "threshold": "$sitewise.assetModel.`assetModelId`.`thresholdAttributeId`.propertyValue.value"
          }
        },
        "alarmEventActions": {
          "alarmActions": [
            {
              "iotSiteWise": {
                "assetId": "$sitewise.assetModel.`assetModelId`.`alarmPropertyId`.assetId",
                "propertyId": "'alarmStatePropertyId'"
              }
            }
          ]
        },
        "alarmNotification": {
          "notificationActions": [
            {
              "action": {
                "lambdaAction": {
                  "functionArn": "alarmNotificationFunctionArn"
                }
              },
              "smsConfigurations": [
                {
                  "recipients": [
                    {
                      "ssoIdentity": {
                        "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                        "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                      }
                    }
                  ],
                  "senderId": "$sitewise.assetModel.`assetModelId`.`senderIdAttributeId`.propertyValue.value",
                  "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                }
              ],
              "emailConfigurations": [
                {
                  "from": "$sitewise.assetModel.`assetModelId`.`fromAddressAttributeId`.propertyValue.value",
                  "recipients": {
                    "to": [
                      {
                        "ssoIdentity": {
                          "identityStoreId": "$sitewise.assetModel.`assetModelId`.`identityStoreIdAttributeId`.propertyValue.value",
                          "userId": "$sitewise.assetModel.`assetModelId`.`userIdAttributeId`.propertyValue.value"
                        }
                      }
                    ]
                  },
                  "content": {
                    "subject": "$sitewise.assetModel.`assetModelId`.`emailSubjectAttributeId`.propertyValue.value",
                    "additionalMessage": "$sitewise.assetModel.`assetModelId`.`additionalMessageAttributeId`.propertyValue.value"
                  }
                }
              ]
            }
          ]
        },
        "alarmCapabilities": {
          "initializationConfiguration": {
            "disabledOnInitialization": false
          },
          "acknowledgeFlow": {
            "enabled": false
          }
        },
        "roleArn": "arn:aws:iam::123456789012:role/MyIoTEventsAlarmRole"
      }

   9. Exécutez la commande suivante pour créer le modèle AWS IoT Events d'alarme à partir de la charge utile dansalarm-model-payload.json.

      aws iotevents create-alarm-model --cli-input-json file://alarm-model-payload.json

   10. L'opération renvoie une réponse qui inclut l'ARN du modèle d'alarme,alarmModelArn. Copiez cet ARN pour le définir dans la définition de l'alarme de votre modèle d'actif à l'étape suivante.

Pour activer le flux de données entre AWS IoT SiteWise and AWS IoT Events (CLIP)

• Définissez le modèle d'alarme comme source de l'alarme dans le modèle d'actif. Procédez comme suit :

  1. Exécutez la commande suivante pour récupérer la définition de modèle de ressource existante. asset-model-idRemplacez-le par l'ID du modèle d'actif.

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

     L'opération renvoie une réponse qui contient les détails du modèle de ressource.

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

  3. Supprimez les paires clé-valeur suivantes du update-asset-model-payload.json fichier :

     • assetModelId

     • assetModelArn

     • assetModelCreationDate

     • assetModelLastUpdateDate

     • assetModelStatus

  4. Ajoutez la propriété de source d'alarme (AWS/ALARM_SOURCE) au modèle composite d'alarme que vous avez défini précédemment. Remplacez-le alarmModelArn par l'ARN du modèle d'alarme, qui définit la valeur de la propriété de la source d'alarme.

     {
       ...
       "assetModelCompositeModels": [
         ...
         {
           "name": "BoilerTemperatureHighAlarm",
           "type": "AWS/ALARM",
           "properties": [
             {
               "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
               "name": "AWS/ALARM_TYPE",
               "dataType": "STRING",
               "type": {
                 "attribute": {
                   "defaultValue": "IOT_EVENTS"
                 }
               }
             },
             {
               "id": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
               "name": "AWS/ALARM_STATE",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/ALARM_STATE",
               "type": {
                 "measurement": {}
               }
             },
             {
               "name": "AWS/ALARM_SOURCE",
               "dataType": "STRING",
               "type": {
                 "attribute": {
                   "defaultValue": "alarmModelArn"
                 }
               }
             }
           ]
         }
       ]
     }

  5. Exécutez la commande suivante pour mettre à jour le modèle d'actif avec la définition stockée dans le update-asset-model-payload.json fichier. asset-model-idRemplacez-le par l'ID du modèle d'actif.

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