Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Supervise los datos con las alarmas integradas AWS IoT SiteWise
Puede configurar alarmas para que sus datos le alerten a usted y a sus colaboradores cuando su equipo o los procesos no funcionen de manera óptima. Un rendimiento óptimo de una máquina o de un proceso significa que los valores de determinadas métricas deben estar dentro de un rango de límites altos y bajos. Cuando estas métricas están fuera de su rango de operación, se debe notificar a los operadores de los equipos para que solucionen el problema. Use alarmas para identificar rápidamente los problemas y notificar a los operadores para que maximicen el rendimiento del equipo y de los procesos.
**Topics**
+ [Tipos de Alarmas](#alarm-types)
+ [Estados de alarma](#alarm-states)
+ [Propiedades del estado de alarma](#alarm-state-properties)
+ [Defina las alarmas en los modelos de activos en AWS IoT SiteWise](define-alarms.md)
+ [Configure las alarmas de los activos en AWS IoT SiteWise](configure-alarms.md)
+ [Responda a las alarmas en AWS IoT SiteWise](respond-to-alarms.md)
+ [Introduzca un estado de alarma externo en AWS IoT SiteWise](ingest-external-alarm-state.md)
## Tipos de Alarmas
Puede definir las alarmas que detecte en la AWS nube y las alarmas que detecte con procesos externos. AWS IoT SiteWise admite los siguientes tipos de alarmas:
+ **AWS IoT Events alarmas**
**nota**
Aviso de fin de soporte: se AWS ha finalizado el soporte para AWS IoT Events. Para obtener más información, consulte [AWS IoT Events el fin del soporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
AWS IoT Events las alarmas son alarmas que detectan la entrada AWS IoT Events. AWS IoT SiteWise envía los valores de las propiedades de los activos a un modelo de alarma en AWS IoT Events. A continuación, AWS IoT Events envía el estado de alarma a AWS IoT SiteWise. Puede configurar opciones, como cuándo detecta algo la alarma y a quién notificar cuando cambie el estado de alarma. También puede definir las [acciones de AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) que se deben producirse cuando cambie el estado de alarma.
Las alarmas AWS IoT Events son instancias de modelos de alarma. El modelo de alarma especifica el umbral y la gravedad de la alarma, qué hacer cuando cambie el estado de alarma y más. Al configurar cada característica del modelo de alarma, se especifica una propiedad de atributo a partir del modelo de activo que monitorea la alarma. Todos los activos basados en el modelo de activos utilizan el valor del atributo al AWS IoT Events evaluar esa característica de la alarma. Para obtener más información, consulte [Uso de alarmas](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-alarms.html) en la *Guía para desarrolladores de AWS IoT Events *.
Puede responder a una AWS IoT Events alarma cuando cambia de estado. Por ejemplo, puede reconocer o posponer una alarma cuando se activa. También puede habilitar, deshabilitar y restablecer las alarmas.
SiteWise Los usuarios de Monitor pueden visualizar, configurar y responder a AWS IoT Events las alarmas en los portales de SiteWise Monitor. Para obtener más información, consulte [Supervisión con alarmas](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html) en la *Guía de la aplicación AWS IoT SiteWise Monitor *.
**nota**
AWS IoT Events se aplican cargos para evaluar estas alarmas y transferir datos entre AWS IoT SiteWise y AWS IoT Events. Para más información, consulte [Precios de AWS IoT Events](https://aws.amazon.com/iot-events/pricing/).
+ **Alarmas externas**
Las alarmas externas son alarmas que se evalúan fuera de ellas AWS IoT SiteWise. Utilice alarmas externas si tiene un origen de datos que notifique estados de alarma. La alarma externa contiene una propiedad de medición a la que se ingieren los datos del estado de alarma.
No se puede reconocer ni posponer una alarma externa cuando cambia de estado.
SiteWise Los usuarios de Monitor pueden ver el estado de las alarmas externas en los portales de SiteWise Monitor, pero no pueden configurarlas ni responder a ellas.
AWS IoT SiteWise no evalúa el estado de las alarmas externas.
## Estados de alarma
Las alarmas industriales incluyen información sobre el estado del equipo o proceso que monitorean, e información (opcional) sobre la respuesta del operador al estado de alarma.
Al definir una AWS IoT Events alarma, se especifica si se habilita o no el *flujo de confirmación*. El flujo de reconocimiento está habilitado de forma predeterminada. Al habilitar esta opción, los operadores pueden reconocer la alarma y dejar una nota con detalles sobre la alarma o las acciones que han tomado para solucionarla. Si un operador no confirma una alarma activa antes de que se inactive, la alarma se queda bloqueada. El estado bloqueado indica que la alarma se ha activado pero no se ha confirmado, por lo que el operador debe comprobar el equipo o el proceso y reconocer la alarma bloqueada.
Las alarmas tienen los siguientes estados:
+ **Normal** (`Normal`): la alarma está habilitada pero inactiva. El proceso o equipo industrial funciona según lo esperado.
+ **Activa** (`Active`): la alarma está activa. El proceso o equipo industrial está fuera de su rango de operación y requiere atención.
+ **Confirmado** (`Acknowledged`): un operador ha confirmado el estado de la alarma.
Este estado solo se aplica a las alarmas en las que se habilita el flujo de reconocimiento.
+ **Bloqueado** (`Latched`): la alarma ha vuelto a la normalidad, pero estaba activa y ningún operador la ha confirmado. El proceso o equipo industrial requiere la atención de un operador para restablecer la alarma a su estado normal.
Este estado solo se aplica a las alarmas en las que se habilita el flujo de reconocimiento.
+ **Silenciado** (`SnoozeDisabled`): la alarma está desactivada porque un operador la ha pospuesto. El operador define el tiempo durante el que se pospone la alarma. Transcurrido ese tiempo, la alarma vuelve al estado normal.
+ **Deshabilitada** (`Disabled`): la alarma está deshabilitada y no es capaz de detectar nada.
## Propiedades del estado de alarma
AWS IoT SiteWise almacena los datos del estado de la alarma como un objeto JSON serializado en una cadena. Este objeto contiene el estado e información adicional sobre la alarma, como las acciones de respuesta del operador y la regla que evalúa la alarma.
La propiedad del estado de alarma se identifica por su nombre y tipo de estructura, `AWS/ALARM_STATE`. Para obtener más información, consulte [Defina las alarmas en los modelos de activos en AWS IoT SiteWise](define-alarms.md).
El objeto datos de estado de la alarma contiene la siguiente información:
`stateName`
El estado de la alarma. Para obtener más información, consulte [Estados de alarma](#alarm-states).
Tipo de datos: `STRING`
`customerAction`
(opcional) objeto que contiene información sobre la respuesta de un operador a la alarma. Los operadores pueden habilitar, deshabilitar, confirmar y posponer las alarmas. Cuando lo hacen, los datos del estado de alarma incluyen su respuesta y la nota que pueden dejar al responder. Este objeto contiene la siguiente información:
`actionName`
El nombre de la acción que realiza el operador para responder a la alarma. Este valor contiene uno de los siguientes strings:
+ `ENABLE`
+ `DISABLE`
+ `SNOOZE`
+ `ACKNOWLEDGE`
+ `RESET`
Tipo de datos: `STRING`
`enable`
(opcional) objeto que está presente en `customerAction` cuando el operador habilita la alarma. Cuando un operador habilita la alarma, el estado de alarma cambia a `Normal`. Este objeto contiene la siguiente información:
`note`
(opcional) la nota que deja el cliente cuando habilita la alarma.
Tipo de datos: `STRING`
Longitud máxima: 128 caracteres
`disable`
(opcional) objeto que está presente en `customerAction` cuando el operador deshabilita la alarma. Cuando un operador habilita la alarma, el estado de alarma cambia a `Disabled`. Este objeto contiene la siguiente información:
`note`
(opcional) la nota que deja el cliente cuando deshabilita la alarma.
Tipo de datos: `STRING`
Longitud máxima: 128 caracteres
`acknowledge`
(opcional) objeto que está presente en `customerAction` cuando el operador confirma la alarma. Cuando un operador habilita la alarma, el estado de alarma cambia a `Acknowledged`. Este objeto contiene la siguiente información:
`note`
(opcional) la nota que deja el cliente cuando confirma la alarma.
Tipo de datos: `STRING`
Longitud máxima: 128 caracteres
`snooze`
(opcional) objeto que está presente en `customerAction` cuando el operador pospone la alarma. Cuando un operador habilita la alarma, el estado de alarma cambia a `SnoozeDisabled`. Este objeto contiene la siguiente información:
`snoozeDuration`
El tiempo en segundos durante el que el operador pospone la alarma. La alarma cambia al estado `Normal` pasado este tiempo.
Tipo de datos: `INTEGER`
`note`
(opcional) la nota que deja el cliente al posponer la alarma.
Tipo de datos: `STRING`
Longitud máxima: 128 caracteres
`ruleEvaluation`
(opcional) objeto que contiene información sobre la regla que evalúa la alarma. Este objeto contiene la siguiente información:
`simpleRule`
objeto que contiene información acerca de una regla simple, que compara el valor de la propiedad frente a un valor de umbral con un operador de comparación. Este objeto contiene la siguiente información:
`inputProperty`
El valor de la propiedad que evalúa esta alarma.
Tipo de datos: `DOUBLE`
`operator`
El operador de comparación que utiliza esta alarma para comparar la propiedad con el umbral. Este valor contiene uno de los siguientes strings:
+ `<`: menor que
+ `<=`: menor que o igual a
+ `==`: igual
+ `!=`: distinto de
+ `>=`: mayor que o igual a
+ `>`: mayor que
Tipo de datos: `STRING`
`threshold`
El valor de umbral frente al que esta alarma compara el valor de la propiedad.
Tipo de datos: `DOUBLE`
# Defina las alarmas en los modelos de activos en AWS IoT SiteWise
Los modelos de activos impulsan la normalización de sus datos y alarmas industriales. Puede establecer definiciones de alarmas en los modelos de activos, para estandarizar las alarmas de todos los activos basados en un modelo de activo.
Puede utilizar *modelos de activos compuestos* para definir alarmas en este modelo de activos. Los modelos de activos compuestos son modelos de activos que estandarizan un conjunto específico de propiedades en otro modelo de activo. Los modelos de activos compuestos garantizan la inclusión de determinadas propiedades en un modelo de activo. Las alarmas tienen propiedades de tipo, estado y origen (opcional), por lo que el modelo compuesto de alarmas exige que existan estas propiedades.
Cada modelo de activo compuesto tiene un tipo que define las propiedades que admite el modelo compuesto. Los modelos compuestos de alarmas definen las propiedades de tipo de alarma, estado de alarma y origen de alarma (opcional). Al crear un activo a partir de un modelo de activo con modelos compuestos, el activo incluye las propiedades del modelo compuesto junto con las propiedades que especifique en el modelo de activo.
Cada propiedad de un modelo compuesto debe tener el nombre que la identifique para su tipo de modelo compuesto. Las propiedades del modelo compuesto admiten propiedades con tipos de datos complejos. Estas propiedades tienen el tipo de datos `STRUCT` y una característica `dataTypeSpec` que especifica el tipo de datos complejo de la propiedad. Las propiedades de los tipos de datos complejos contienen datos JSON serializados en cadenas.
Los modelos compuestos de alarmas tienen las siguientes propiedades. Cada propiedad debe tener el nombre que la identifique para su tipo de modelo compuesto.
**Tipo de alarma**
El tipo de alarma. Especifique uno de los siguientes valores:
+ `IOT_EVENTS`— Una AWS IoT Events alarma. AWS IoT SiteWise envía datos AWS IoT Events para evaluar el estado de esta alarma. Debe especificar la propiedad de la fuente de la alarma para definir el modelo de AWS IoT Events alarma para esta definición de alarma.
**nota**
Aviso de fin de soporte: soporte AWS finalizado para AWS IoT Events. Para obtener más información, consulte [AWS IoT Events el fin del soporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
+ `EXTERNAL`: una alarma externa. El estado de la alarma se ingiere en forma de medida.
Nombre de la propiedad: `AWS/ALARM_TYPE`
Tipo de propiedad: [atributo](attributes.md)
Tipo de datos: `STRING`
**Estado de alarma**
Los datos de serie temporal del estado de la alarma. Se trata de un objeto serializado en una cadena que contiene el estado y otra información sobre la alarma. Para obtener más información, consulte [Propiedades del estado de alarma](industrial-alarms.md#alarm-state-properties).
Nombre de la propiedad: `AWS/ALARM_STATE`
Tipo de propiedad: [medida](measurements.md)
Tipo de datos: `STRUCT`
Tipo de estructura de datos: `AWS/ALARM_STATE`
**Origen de alarma**
(opcional) el nombre de recurso de Amazon (ARN) del recurso que evalúa el estado de la alarma. En el AWS IoT Events caso de las alarmas, este es el ARN del modelo de alarma.
Nombre de la propiedad: `AWS/ALARM_SOURCE`
Tipo de propiedad: [atributo](attributes.md)
Tipo de datos: `STRING`
**Example Ejemplo de modelo compuesto de alarma**
El siguiente modelo de activos representa una caldera que tiene una alarma para controlar su temperatura. AWS IoT SiteWise envía los datos de temperatura AWS IoT Events para detectar la alarma.
```
{
"assetModelName": "Boiler",
"assetModelDescription": "A boiler that alarms when its temperature exceeds its limit.",
"assetModelProperties": [
{
"name": "Temperature",
"dataType": "DOUBLE",
"unit": "Celsius",
"type": {
"measurement": {}
}
},
{
"name": "High Temperature",
"dataType": "DOUBLE",
"unit": "Celsius",
"type": {
"attribute": {
"defaultValue": "105.0"
}
}
}
],
"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": {}
}
},
{
"name": "AWS/ALARM_SOURCE",
"dataType": "STRING",
"type": {
"attribute": {}
}
}
]
}
]
}
```
**Topics**
+ [Requisitos para las notificaciones de alarma en AWS IoT SiteWise](iot-events-alarm-notification-requirements.md)
+ [Defina AWS IoT Events alarmas para AWS IoT SiteWise](define-iot-events-alarms.md)
+ [Defina las alarmas externas en AWS IoT SiteWise](define-external-alarms.md)
# Requisitos para las notificaciones de alarma en AWS IoT SiteWise
AWS IoT Events utiliza una AWS Lambda función de su AWS cuenta para enviar notificaciones de alarma. Debe crear esta función Lambda en la misma AWS región que sus alarmas para activar las notificaciones de alarma. Esta función de Lambda utiliza [Amazon Simple Notification Service (Amazon SNS)](https://docs.aws.amazon.com/sns/latest/dg/welcome.html) para enviar notificaciones de texto y [Amazon Simple Email Service (Amazon SES)](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html) para enviar notificaciones por correo electrónico. Al crear la AWS IoT Events alarma, se configuran los protocolos y los ajustes que utiliza la alarma para enviar las notificaciones.
**nota**
Aviso de fin de soporte: se AWS ha finalizado el soporte para AWS IoT Events. Para obtener más información, consulte [AWS IoT Events el fin del soporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
AWS IoT Events proporciona una plantilla de AWS CloudFormation pila que puede utilizar para crear esta función Lambda en su cuenta. Para obtener más información, consulte [Notificación de alarma de la función de Lambda](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) en la *Guía para desarrolladores de AWS IoT Events *.
# Defina AWS IoT Events alarmas para AWS IoT SiteWise
**nota**
Aviso de fin de soporte: se AWS ha finalizado el soporte para AWS IoT Events. Para obtener más información, consulte [AWS IoT Events el fin del soporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
Al crear una AWS IoT Events alarma, AWS IoT SiteWise envía los valores de las propiedades de los activos AWS IoT Events para evaluar el estado de la alarma. AWS IoT Events las definiciones de alarma dependen del modelo de alarma en el que se defina AWS IoT Events. Para definir una AWS IoT Events alarma en un modelo de activos, defina un modelo compuesto de alarmas que especifique el modelo de AWS IoT Events alarma como su propiedad de origen de alarma.
AWS IoT Events las alarmas dependen de entradas como los umbrales de alarma y la configuración de las notificaciones de alarmas. Estas entradas se definen como atributos en el modelo de activo. A continuación, puede personalizar estas entradas en cada activo basado en el modelo. La AWS IoT SiteWise consola puede crear estos atributos por usted. Si define las alarmas con la API AWS CLI o la API, debe definir estos atributos manualmente en el modelo de activos.
También puede definir otras acciones, como las acciones de notificación de alarma personalizadas, que deben producirse cuando la alarma detecte algo. Por ejemplo, puede configurar una acción que envíe una notificación push a un tema de Amazon SNS. Para obtener más información sobre las acciones que puede definir, consulte [Trabajar con otros AWS servicios](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-other-aws-services.html) en la *Guía para AWS IoT Events desarrolladores*.
Al actualizar o eliminar un modelo de activos, AWS IoT SiteWise puede comprobar si un modelo de alarma AWS IoT Events monitorea una propiedad de activo asociada a este modelo de activos. Esto le impide eliminar una propiedad de activo que una AWS IoT Events alarma esté utilizando actualmente. Para activar esta función AWS IoT SiteWise, debe tener el `iotevents:ListInputRoutings` permiso. Este permiso permite AWS IoT SiteWise realizar llamadas a la operación de [ListInputRoutings](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputRoutings.html)API admitida por AWS IoT Events. Para obtener más información, consulte [ListInputRoutings Permiso (opcional)](alarms-iam-permissions.md#alarms-listInputRoutings-permissions).
**nota**
La característica de notificaciones de alarma no está disponible en la región de China (Pekín).
**Topics**
+ [Defina una AWS IoT Events alarma (AWS IoT SiteWise consola)](#define-iot-events-alarm-console)
+ [Defina una AWS IoT Events alarma (AWS IoT Events consola)](#define-iot-events-alarm-console-ite-console)
+ [Defina una AWS IoT Events alarma (AWS CLI)](#define-iot-events-alarm-cli)
## Defina una AWS IoT Events alarma (AWS IoT SiteWise consola)
Puede utilizar la AWS IoT SiteWise consola para definir una AWS IoT Events alarma en un modelo de activos existente. Para definir una AWS IoT Events alarma en un nuevo modelo de activos, cree el modelo de activos y, a continuación, complete estos pasos. Para obtener más información, consulte [Cree modelos de activos en AWS IoT SiteWise](create-asset-models.md).
**importante**
Cada alarma requiere un atributo que especifique el valor de umbral con el que comparar la alarma. Debe definir el atributo de valor de umbral en el modelo de activo antes de poder definir una alarma.
Considere un ejemplo en el que desee definir una alarma que detecte cuando una turbina eólica supere su índice de velocidad máxima del viento de 80 km/h. Antes de definir la alarma, debe definir un atributo (**Velocidad máxima del viento**) con un valor predeterminado de `50`.
**Para definir una AWS IoT Events alarma en un modelo de activos**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Models (Modelos)**.
1. Elija el modelo de activo para el que desee definir una alarma.
1. Seleccione la pestaña **Alarma**.
1. Seleccione **Añadir alarma**.
1. En la sección **Opciones de tipos de alarma**, seleccione **Alarma de AWS IoT Events **.
1. En la sección **Detalles de regla** haga lo siguiente:
1. Escriba un nombre para la alarma.
1. (Opcional) Ingrese una descripción para su alarma.
1. En la sección **Definiciones de umbral** se define cuándo debe detectar algo la alarma y la gravedad de la alarma. Haga lo siguiente:
1. Seleccione la **Propiedad** sobre la que debe detectar la alarma. Cada vez que esta propiedad recibe un nuevo valor, AWS IoT SiteWise envía el valor AWS IoT Events a para evaluar el estado de la alarma.
1. Seleccione el **Operador** que se utilizará para comparar la propiedad con el valor de umbral. Puede elegir entre las siguientes opciones:
+ **< Menor que**
+ **<= Menor que o igual a**
+ **== (igual)**
+ **\$1= Distinto de**
+ **>= Mayor que o igual a**
+ **> Mayor que**
1. En **Valor**, seleccione la propiedad del atributo que desee utilizar como valor de umbral. AWS IoT Events compara el valor de la propiedad con el valor de este atributo.
1. Introduzca la **Gravedad** de la alarma. Use un número que pueda comprender su equipo para reflejar la gravedad de esta alarma.
1. (Opcional) En la sección **Configuración de notificaciones: *opcional***, haga lo siguiente:
1. Elija **Activar**.
**nota**
Si elige **Inactivo**, ni usted ni su equipo recibirán ninguna notificación de alarma.
1. En **Destinatario**, elija el destinatario.
**importante**
Puede enviar notificaciones de alarma a AWS IAM Identity Center los usuarios. Para utilizar esta característica, debe habilitar IAM Identity Center. Solo puede activar el IAM Identity Center en una AWS región a la vez. Esto significa que solo puede definir las notificaciones de alarma en la región en la que habilite IAM Identity Center. Para obtener más información, consulte la [Introducción](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html) de la *Guía del usuario de AWS IAM Identity Center *.
1. En **Protocolo** elija una de las siguientes opciones:
+ **Correo electrónico y texto**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje SMS y un mensaje de correo electrónico.
+ **Correo electrónico**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje de correo electrónico.
+ **Texto**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje SMS.
1. En **Remitente**, elija el remitente.
**importante**
Debe verificar la dirección de correo electrónico del remitente en Amazon Simple Email Service (Amazon SES). Para obtener más información, consulte [Verificación de una identidad de dirección de correo electrónico](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#just-verify-email-proc) en la *Guía para desarrolladores de Amazon Simple Email Service*.
1. En la sección **Estado predeterminado del activo**, puede establecer el estado predeterminado para las alarmas creadas a partir de este modelo de activos.
**nota**
Podrá activar o desactivar esta alarma para los activos que cree a partir de este modelo de activo en un paso posterior.
1. En la sección de **configuración avanzada**, puede configurar los permisos, los ajustes de notificación adicionales, las acciones del estado de alarma, el modelo de alarma en SiteWise Monitor y el flujo de confirmación.
**nota**
AWS IoT Events las alarmas requieren las siguientes funciones de servicio:
Una función que se AWS IoT Events supone que debe enviar los valores del estado de alarma a AWS IoT SiteWise.
Una función que AWS IoT Events asume el envío de datos a Lambda. Solo necesita esta función si su alarma envía notificaciones.
En la sección **Permisos**, haga lo siguiente:
1. En **Rol de AWS IoT Events **, utilice un rol existente o cree uno con los permisos necesarios. Este rol requiere el permiso `iotsitewise:BatchPutAssetPropertyValue` y una relación de confianza que permita a iotevents.amazonaws.com asumir ese rol.
1. Para el **AWS IoT Events rol de Lambda**, utilice un rol existente o cree un rol con los permisos necesarios. Este rol requiere los permisos `lambda:InvokeFunction` y `sso-directory:DescribeUser` y una relación de confianza que permita a `iotevents.amazonaws.com` asumir ese rol.
1. (Opcional) En la sección **Configuración de notificación adicional**, haga lo siguiente:
1. En **Atributo del destinatario**, defina un atributo cuyo valor especifique el destinatario de la notificación. Puede elegir a los usuarios del IAM Identity Center como destinatarios.
Puede crear un atributo o utilizar uno existente en el modelo de activo.
+ Si elige **Crear un nuevo atributo de destinatario**, especifique el **Nombre del atributo de destinatario** y el **Valor predeterminado del destinatario: **opcional**** para el atributo.
+ Si elige **Usar un atributo de destinatario existente**, elija el atributo en **Nombre del atributo del destinatario**. La alarma utiliza el valor predeterminado del atributo que elija.
Puede anular el valor predeterminado de cada activo que cree desde este modelo de activo.
1. En **Atributo del mensaje personalizado**, defina un atributo cuyo valor especifique el mensaje personalizado que se debe enviar además del mensaje de cambio de estado predeterminado. Por ejemplo, puede especificar un mensaje que ayude a su equipo a entender cómo abordar esta alarma.
Puede optar por crear un atributo o utilizar uno existente en el modelo de activo.
+ Si opta por **Crear un nuevo atributo de mensaje personalizado**, especifique el **Nombre de atributo del mensaje personalizado** y el **Valor predeterminado del mensaje personalizado: *opcional*** para el atributo.
+ Si opta por **Usar un atributo de mensaje personalizado existente**, elija el atributo en **Nombre de atributo del mensaje personalizado**. La alarma utiliza el valor predeterminado del atributo que elija.
Puede anular el valor predeterminado de cada activo que cree desde este modelo de activo.
1. En **Gestionar su función de Lambda**, realice alguna de las siguientes operaciones:
+ Para AWS IoT SiteWise crear una nueva función de Lambda, elija **Crear una nueva lambda a partir de una plantilla gestionada por AWS**.
+ Para usar una función de Lambda existente, elija **Usar una Lambda existente** y elija el nombre de la función.
Para obtener más información, consulte [Administración de notificaciones de alarma](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) en la *Guía para desarrolladores de AWS IoT Events *.
1. (Opcional) En la sección **Configurar acción de estado**, haga lo siguiente:
1. Elija **Editar acción**.
1. En **Agregar acciones del estado de la alarma**, añada acciones y, a continuación, seleccione **Guardar**.
Puede agregar hasta 10 acciones.
AWS IoT Events puede realizar acciones cuando la alarma está activa. Puede definir acciones integradas para usar un temporizador o establecer una variable, o enviar datos a otros AWS recursos. Para obtener más información, consulte [Acciones admitidas](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) en la *Guía para desarrolladores de AWS IoT Events *.
1. (Opcional) En **Administrar el modelo de alarma en el SiteWise monitor (*opcional***), seleccione **Activo** o **Inactivo**.
Utilice esta opción para actualizar el modelo de alarma en SiteWise Monitorss. Esta opción está habilitada de forma predeterminada.
1. En **Flujo de reconocimiento**, seleccione **Activo** o **Inactivo**. Para obtener más información sobre el flujo de reconocimiento, consulte [Estados de alarma](industrial-alarms.md#alarm-states).
1. Seleccione **Añadir alarma**.
**nota**
La AWS IoT SiteWise consola realiza varias solicitudes de API para añadir la alarma al modelo de activos. Al elegir **Agregar alarma**, la consola abre un cuadro de diálogo que muestra el progreso de estas solicitudes de API. Permanezca en esta página hasta que cada solicitud de API se realice correctamente o hasta que falle una solicitud de API. Si se produce un error en una solicitud, cierre el cuadro de diálogo, corrija el problema y seleccione **Agregar alarma** para volver a intentarlo.
## Defina una AWS IoT Events alarma (AWS IoT Events consola)
Puede utilizar la AWS IoT Events consola para definir una AWS IoT Events alarma en un modelo de activos existente. Para definir una AWS IoT Events alarma en un nuevo modelo de activos, cree el modelo de activos y, a continuación, complete estos pasos. Para obtener más información, consulte [Cree modelos de activos en AWS IoT SiteWise](create-asset-models.md).
**importante**
Cada alarma requiere un atributo que especifique el valor de umbral con el que comparar la alarma. Debe definir el atributo de valor de umbral en el modelo de activo antes de poder definir una alarma.
Considere un ejemplo en el que desee definir una alarma que detecte cuando una turbina eólica supere su índice de velocidad máxima del viento de 80 km/h. Antes de definir la alarma, debe definir un atributo (**Velocidad máxima del viento**) con un valor predeterminado de `50`.
**Para definir una AWS IoT Events alarma en un modelo de activos**
1. Vaya a la [consola de AWS IoT Events](https://console.aws.amazon.com/iotevents/).
1. En el panel de navegación, elija **Modelos de alarmas**.
1. Elija **Crear modelo de alarma**.
1. Escriba un nombre para la alarma.
1. (Opcional) Ingrese una descripción para su alarma.
1. En la sección **Destino de la alarma**, haga lo siguiente:
1. En **Opciones de destino**, elija la **propiedad del activo de AWS IoT SiteWise **.
1. Elija el ,modelo de activo para el que desea añadir una alarma.
1. En la sección **Definiciones de umbral** se define cuándo debe detectar algo la alarma y la gravedad de la alarma. Haga lo siguiente:
1. Seleccione la **Propiedad** sobre la que debe detectar la alarma. Cada vez que esta propiedad recibe un nuevo valor, AWS IoT SiteWise envía el valor AWS IoT Events a para evaluar el estado de la alarma.
1. Seleccione el **Operador** que se utilizará para comparar la propiedad con el valor de umbral. Puede elegir entre las siguientes opciones:
+ **< Menor que**
+ **<= Menor que o igual a**
+ **== (igual)**
+ **\$1= Distinto de**
+ **>= Mayor que o igual a**
+ **> Mayor que**
1. En **Valor**, seleccione la propiedad del atributo que desee utilizar como valor de umbral. AWS IoT Events compara el valor de la propiedad con el valor de este atributo.
1. Introduzca la **Gravedad** de la alarma. Use un número que pueda comprender su equipo para reflejar la gravedad de esta alarma.
1. (Opcional) En la sección **Configuración de notificaciones: *opcional***, haga lo siguiente:
1. En **Protocolo** elija una de las siguientes opciones:
+ **Correo electrónico y texto**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje SMS y un mensaje de correo electrónico.
+ **Correo electrónico**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje de correo electrónico.
+ **Texto**: la alarma notifica a los usuarios del IAM Identity Center con un mensaje SMS.
1. En **Remitente**, elija el remitente.
**importante**
Debe verificar la dirección de correo electrónico del remitente en Amazon Simple Email Service (Amazon SES). Para obtener más información, consulte [Verificación de direcciones de correo electrónico en Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html), en la *Guía para desarrolladores de Amazon Simple Email Service*.
1. Elija el atributo en **Atributo del destinatario: *(opcional)***. La alarma utiliza el valor predeterminado del atributo que elija.
1. Elija el atributo en **Atributo del mensaje personalizado: *(opcional)***. La alarma utiliza el valor predeterminado del atributo que elija.
1. En la sección **Instancia**, especifique el **Estado predeterminado** de esta alarma. Podrá activar o desactivar esta alarma para todos los activos que cree a partir de este modelo de activo en un paso posterior.
1. En los **ajustes avanzados**, puede configurar los permisos, los ajustes de notificación adicionales, las acciones del estado de alarma, el modelo de alarma en SiteWise Monitor y el flujo de confirmación.
**nota**
AWS IoT Events las alarmas requieren las siguientes funciones de servicio:
Una función que se AWS IoT Events supone que debe enviar los valores del estado de alarma a AWS IoT SiteWise.
Una función que AWS IoT Events asume el envío de datos a Lambda. Solo necesita esta función si su alarma envía notificaciones.
1. En la sección **Flujo de reconocimiento**, elija **Habilitado** o **Deshabilitado**. Para obtener más información sobre el flujo de reconocimiento, consulte [Estados de alarma](industrial-alarms.md#alarm-states).
1. En la sección **Permisos**, haga lo siguiente:
1. En **Rol de AWS IoT Events **, utilice un rol existente o cree uno con los permisos necesarios. Este rol requiere el permiso `iotsitewise:BatchPutAssetPropertyValue` y una relación de confianza que permita a iotevents.amazonaws.com asumir ese rol.
1. Para el **rol de Lambda**, utilice un rol existente o cree un rol con los permisos necesarios. Este rol requiere los permisos `lambda:InvokeFunction` y `sso-directory:DescribeUser` y una relación de confianza que permita a `iotevents.amazonaws.com` asumir ese rol.
1. (Opcional) En el panel de **Configuración de notificación adicional**, haga lo siguiente:
1. En **Gestionar su Función de Lambda**, realice alguna de las siguientes operaciones:
+ Para AWS IoT Events crear una nueva función Lambda, elija **Crear una nueva función Lambda**.
+ Para usar una función de Lambda existente, elija **Usar una función de Lambda existente** y elija el nombre de la función.
Para obtener más información, consulte [Administración de notificaciones de alarma](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) en la *Guía para desarrolladores de AWS IoT Events *.
1. (Opcional) En la sección **Establecer acción de estado: *opcional***, haga lo siguiente:
1. En **Acciones de estado de alarma**, añada acciones y, a continuación, seleccione **Guardar**.
Puede agregar hasta 10 acciones.
AWS IoT Events puede realizar acciones cuando la alarma está activa. Puede definir acciones integradas para usar un temporizador o establecer una variable, o enviar datos a otros AWS recursos. Para obtener más información, consulte [Acciones admitidas](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) en la *Guía para desarrolladores de AWS IoT Events *.
1. Seleccione **Crear**.
**nota**
La AWS IoT Events consola realiza varias solicitudes de API para añadir la alarma al modelo de activos. Al elegir **Agregar alarma**, la consola abre un cuadro de diálogo que muestra el progreso de estas solicitudes de API. Permanezca en esta página hasta que cada solicitud de API se realice correctamente o hasta que falle una solicitud de API. Si se produce un error en una solicitud, cierre el cuadro de diálogo, corrija el problema y seleccione **Agregar alarma** para volver a intentarlo.
## Defina una AWS IoT Events alarma (AWS CLI)
Puede usar el AWS Command Line Interface (AWS CLI) para definir una AWS IoT Events alarma que supervise la propiedad de un activo. Puede definir una alarma en un modelo de activo nuevo o existente. Después de definir la alarma en el modelo de activos, se crea una alarma AWS IoT Events y se conecta al modelo de activos. En este proceso, hará lo siguiente:
**Topics**
+ [Paso 1: definición de una alarma en un modelo de activos](#define-iot-events-alarm-definition-cli)
+ [Paso 2: Defina un modelo AWS IoT Events de alarma](#define-iot-events-alarm-model-cli)
+ [Paso 3: Habilite el flujo de datos entre y AWS IoT SiteWise AWS IoT Events](#define-iot-events-alarm-data-flow-cli)
### Paso 1: definición de una alarma en un modelo de activos
Añada una definición de alarma y las propiedades asociadas a un modelo de activos nuevo o existente.
**Para definir una alarma en un modelo de activo (CLI)**
1. Cree un archivo denominado `asset-model-payload.json`. Siga los pasos de estas otras secciones para añadir los detalles de su modelo de activo al archivo, pero no envíe la solicitud para crear o actualizar el modelo de activo. En esta sección, debe añadir una definición de alarma a los detalles del modelo de activo del archivo `asset-model-payload.json`.
+ Para obtener más información acerca de cómo crear un modelo de activos, consulte [Creación de un modelo de activos (AWS CLI)](create-asset-models.md#create-asset-model-cli).
+ Para obtener más información acerca de cómo actualizar un modelo de activo existente, consulte [Actualice un modelo de activo, un modelo de componentes o una interfaz (AWS CLI)](update-asset-models.md#update-asset-model-cli).
**nota**
Su modelo de activo debe definir al menos una propiedad de activo, incluida la propiedad del activo que se va a monitorear con la alarma.
1. Añada un modelo compuesto de alarma (`assetModelCompositeModels`) al modelo de activo. Un modelo compuesto de AWS IoT Events alarmas especifica el `IOT_EVENTS` tipo y especifica una propiedad de la fuente de la alarma. La propiedad de la fuente de alarma se añade después de crear el modelo de alarma en AWS IoT Events.
**importante**
El modelo compuesto de alarma debe tener el mismo nombre que el modelo de AWS IoT Events alarma que cree más adelante. Los nombres de modelo de la alarma pueden contener únicamente caracteres alfanuméricos. Especifique un nombre alfanumérico único para poder usar el mismo nombre para el modelo de alarma.
```
{
...
"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": {}
}
}
]
}
]
}
```
1. Añada un atributo de umbral de alarma al modelo de activo. Especifique el valor predeterminado que se utilizará para este umbral. Puede anular este valor predeterminado de cada activo basado en este modelo.
**nota**
El atributo de umbral de alarma debe ser un `INTEGER` o un `DOUBLE`.
```
{
...
"assetModelProperties": [
...
{
"name": "Temperature Max Threshold",
"dataType": "DOUBLE",
"type": {
"attribute": {
"defaultValue": "105.0"
}
}
}
]
}
```
1. (Opcional) Añada atributos de notificaciones de alarma al modelo de activo. Estos atributos especifican el destinatario del IAM Identity Center y otras entradas que se AWS IoT Events utilizan para enviar notificaciones cuando la alarma cambia de estado. Puede anular estos valores predeterminados en cada activo basado en este modelo.
**importante**
Puede enviar notificaciones de alarma a AWS IAM Identity Center los usuarios. Para utilizar esta característica, debe habilitar IAM Identity Center. Solo puede activar el IAM Identity Center en una AWS región a la vez. Esto significa que solo puede definir las notificaciones de alarma en la región en la que habilite IAM Identity Center. Para obtener más información, consulte la [Introducción](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html) de la *Guía del usuario de AWS IAM Identity Center *.
Haga lo siguiente:
1. Añada un atributo que especifique el ID de su almacén de identidades de IAM Identity Center. Puede utilizar la operación de la [ListInstances](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html)API del IAM Identity Center para enumerar sus almacenes de identidades. Esta operación solo funciona en la región en la que se habilite IAM Identity Center.
```
aws sso-admin list-instances
```
A continuación, especifique el ID del almacén de identidades (por ejemplo, `d-123EXAMPLE`) como valor predeterminado para el atributo.
```
{
...
"assetModelProperties": [
...
{
"name": "identityStoreId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "d-123EXAMPLE"
}
}
}
]
}
```
1. Añada un atributo que especifique el ID del usuario de IAM Identity Center que recibe notificaciones. Para definir un destinatario de notificación predeterminado, añada un ID de usuario de IAM Identity Center como valor predeterminado. Realice una de las siguientes acciones para obtener un ID de usuario de IAM Identity Center:
1. Puede utilizar la [ListUsers](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.html)API del IAM Identity Center para obtener el ID de un usuario cuyo nombre de usuario conozca. *d-123EXAMPLE*Sustitúyalo por el ID de tu almacén de identidades y *Name* sustitúyelo por el nombre de usuario del usuario.
```
aws identitystore list-users \
--identity-store-id d-123EXAMPLE \
--filters AttributePath=UserName,AttributeValue=Name
```
1. Utilice la [consola de IAM Identity Center](https://console.aws.amazon.com/singlesignon) para explorar los usuarios y buscar un ID de usuario.
A continuación, especifique el ID de usuario (por ejemplo, `123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE`) como valor predeterminado para el atributo o defina el atributo sin un valor predeterminado.
```
{
...
"assetModelProperties": [
...
{
"name": "userId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
}
}
}
]
}
```
1. (Opcional) Añada un atributo que especifique el ID de remitente predeterminado para las notificaciones de mensajes SMS (de texto). El ID del remitente aparece como el remitente del mensaje en los mensajes que envía Amazon Simple Notification Service (Amazon SNS). Para obtener más información, consulte [Solicitar un identificador de remitente AWS End User Messaging SMS en](https://docs.aws.amazon.com/sms-voice/latest/userguide/sender-id-request.html) la *Guía del AWS End User Messaging SMS usuario*.
```
{
...
"assetModelProperties": [
...
{
"name": "senderId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "MyFactory"
}
}
}
]
}
```
1. (Opcional) Añada un atributo que especifique la dirección de correo electrónico predeterminada que se debe utilizar como dirección de origen *de* en las notificaciones por correo electrónico.
```
{
...
"assetModelProperties": [
...
{
"name": "fromAddress",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "my.factory@example.com"
}
}
}
]
}
```
1. (Opcional) Añada un atributo que especifique el asunto predeterminado que se debe utilizar en las notificaciones por correo electrónico.
```
{
...
"assetModelProperties": [
...
{
"name": "emailSubject",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "[ALERT] High boiler temperature"
}
}
}
]
}
```
1. (Opcional) Añada un atributo que especifique un mensaje adicional para incluirlo en las notificaciones. De forma predeterminada, los mensajes de la notificación incluyen información sobre la alarma. También puede incluir un mensaje adicional que proporcione al usuario más información.
```
{
...
"assetModelProperties": [
...
{
"name": "additionalMessage",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "Turn off the power before you check the alarm."
}
}
}
]
}
```
1. Cree el modelo de activo o actualice el modelo de activo existente. Realice una de las siguientes acciones:
+ Ejecute el siguiente comando para crear el modelo de activo.
```
aws iotsitewise create-asset-model --cli-input-json file://asset-model-payload.json
```
+ Ejecute el siguiente comando para actualizar el modelo de activo existente. *asset-model-id*Sustitúyalo por el ID del modelo de activo.
```
aws iotsitewise update-asset-model \
--asset-model-id asset-model-id \
--cli-input-json file://asset-model-payload.json
```
Después de ejecutar el comando, anote `assetModelId` en la respuesta.
#### Ejemplo: modelo de activo de caldera
El siguiente modelo de activo representa una caldera que informa de los datos de temperatura. Este modelo de activos define una alarma que detecta cuando la caldera se sobrecalienta.
```
{
"assetModelName": "Boiler Model",
"assetModelDescription": "Represents a boiler.",
"assetModelProperties": [
{
"name": "Temperature",
"dataType": "DOUBLE",
"unit": "C",
"type": {
"measurement": {}
}
},
{
"name": "Temperature Max Threshold",
"dataType": "DOUBLE",
"type": {
"attribute": {
"defaultValue": "105.0"
}
}
},
{
"name": "identityStoreId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "d-123EXAMPLE"
}
}
},
{
"name": "userId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
}
}
},
{
"name": "senderId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "MyFactory"
}
}
},
{
"name": "fromAddress",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "my.factory@example.com"
}
}
},
{
"name": "emailSubject",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "[ALERT] High boiler temperature"
}
}
},
{
"name": "additionalMessage",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "Turn off the power before you check the alarm."
}
}
}
],
"assetModelHierarchies": [
],
"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": {}
}
}
]
}
]
}
```
### Paso 2: Defina un modelo AWS IoT Events de alarma
Cree el modelo de alarma en AWS IoT Events. En AWS IoT Events, se utilizan *expresiones* para especificar valores en los modelos de alarma. Puede utilizar expresiones para especificar los valores desde los AWS IoT SiteWise que evaluar y utilizarlos como entradas para la alarma. Cuando AWS IoT SiteWise envía los valores de las propiedades del activo al modelo de alarma, AWS IoT Events evalúa la expresión para obtener el valor de la propiedad o el identificador del activo. Puede utilizar las siguientes expresiones en el modelo de alarma:
+ **Valores de propiedades de activos**
Para obtener el valor de la propiedad de un activo, utilice la siguiente expresión. *assetModelId*Sustitúyala por la ID del modelo de activos y *propertyId* sustitúyala por la ID de la propiedad.
```
$sitewise.assetModel.`assetModelId`.`propertyId`.propertyValue.value
```
+ **Activo IDs**
Para obtener el ID del activo, utilice la siguiente expresión. *assetModelId*Sustitúyalo por el ID del modelo de activo y *propertyId* sustitúyalo por el ID de la propiedad.
```
$sitewise.assetModel.`assetModelId`.`propertyId`.assetId
```
**nota**
Al crear el modelo de alarma, puede definir literales en lugar de expresiones que se evalúan como AWS IoT SiteWise valores. Esto puede reducir el número de atributos que define en su modelo de activo. Sin embargo, si define un valor como literal, no podrá personalizar ese valor en los activos basados en el modelo de activo. AWS IoT SiteWise Monitor Los usuarios tampoco pueden personalizar la alarma, ya que solo pueden configurar los ajustes de alarma en los activos.
**Para crear un modelo AWS IoT Events de alarma (CLI)**
1. Al crear el modelo de alarma en AWS IoT Events, debe especificar el ID de cada propiedad que utilice la alarma, que incluye lo siguiente:
+ La propiedad del estado de alarma en el modelo de activo compuesto
+ La propiedad que monitorea la alarma
+ El atributo de umbral
+ (Opcional) El atributo de ID del almacén de identidades de IAM Identity Center
+ (Opcional) El atributo de ID de usuario de IAM Identity Center
+ (Opcional) El atributo de ID del remitente del SMS
+ (Opcional) El atributo de dirección de origen *de* del correo electrónico
+ (Opcional) El atributo de asunto del correo electrónico
+ (Opcional) El atributo de mensaje adicional
Ejecute el siguiente comando para recuperar estas propiedades en el modelo de activos. IDs *asset-model-id*Sustitúyalo por el ID del modelo de activos del paso anterior.
```
aws iotsitewise describe-asset-model --asset-model-id asset-model-id
```
La operación devuelve una respuesta que contiene los detalles del modelo de activo. Anote el ID de cada propiedad que utiliza la alarma. Los usará IDs cuando cree el modelo de AWS IoT Events alarma en el siguiente paso.
1. Cree el modelo de alarma en AWS IoT Events. Haga lo siguiente:
1. Cree un archivo denominado `alarm-model-payload.json`.
1. Copie el objeto JSON siguiente en el archivo.
1. Escriba un nombre (`alarmModelName`), la descripción (`alarmModelDescription`) y gravedad (`severity`) de su alarma. Para la gravedad, especifique un número entero que refleje los niveles de gravedad de su empresa.
**importante**
El modelo de alarma debe tener el mismo nombre que el modelo compuesto de alarma que definió anteriormente en su modelo de activo.
Los nombres de modelo de la alarma pueden contener únicamente caracteres alfanuméricos.
```
{
"alarmModelName": "BoilerTemperatureHighAlarm",
"alarmModelDescription": "Detects when the boiler temperature is high.",
"severity": 3
}
```
1. Añada la regla de comparación (`alarmRule`) a la alarma. Esta regla define la propiedad que se debe monitorear (`inputProperty`), el valor de umbral que se va a comparar (`threshold`) y el operador de comparación que se debe usar (`comparisonOperator`).
+ *assetModelId*Sustitúyalo por el ID del modelo de activos.
+ *alarmPropertyId*Sustitúyalo por el ID de la propiedad que monitorea la alarma.
+ *thresholdAttributeId*Sustitúyalo por el ID de la propiedad del atributo de umbral.
+ *GREATER*Sustitúyalo por el operador que se utilizará para comparar los valores de las propiedades con el umbral. Puede elegir entre las siguientes opciones:
+ `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"
}
}
}
```
1. Agregar una acción (`alarmEventActions`) para enviar el estado de alarma al AWS IoT SiteWise cuando la alarma cambie de estado.
**nota**
Para una configuración avanzada, puede definir acciones adicionales que deben realizarse cuando la alarma cambie de estado. Por ejemplo, puede llamar a una función de AWS Lambda o publicar en un tema de MQTT. Para obtener más información, consulte [Trabajar con otros AWS servicios](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-other-aws-services.html) en la *Guía para AWS IoT Events desarrolladores*.
+ *assetModelId*Sustitúyalo por el ID del modelo de activos.
+ *alarmPropertyId*Sustitúyalo por el ID de la propiedad que monitorea la alarma.
+ *alarmStatePropertyId*Sustitúyalo por el ID de la propiedad del estado de alarma en el modelo compuesto de alarmas.
```
{
"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'"
}
}
]
}
}
```
1. (Opcional) Configure las opciones de notificación de alarmas. La acción de notificación de alarmas utiliza una función de Lambda en su cuenta para enviar notificaciones de alarma. Para obtener más información, consulte [Requisitos para las notificaciones de alarma en AWS IoT SiteWise](iot-events-alarm-notification-requirements.md). En los ajustes de notificación de alarmas, puede configurar las notificaciones por SMS y correo electrónico para enviarlas a los usuarios del IAM Identity Center. Haga lo siguiente:
1. Añada la configuración de notificaciones de alarma (`alarmNotification`) a la carga en `alarm-model-payload.json`.
+ *alarmNotificationFunctionArn*Sustitúyalo por el ARN de la función Lambda que gestiona las notificaciones de alarma.
```
{
"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"
}
}
}
]
}
}
```
1. (Opcional) Configure las notificaciones por SMS (`smsConfigurations`) para enviarlas a un usuario de IAM Identity Center cuando la alarma cambie de estado.
+ *identityStoreIdAttributeId*Sustitúyalo por el ID del atributo que contiene el ID del almacén de identidades del IAM Identity Center.
+ *userIdAttributeId*Sustitúyalo por el ID del atributo que contiene el ID del usuario del Centro de Identidad de IAM.
+ *senderIdAttributeId*Sustitúyalo por el ID del atributo que contiene el ID del remitente de Amazon SNS o elimínelo `senderId` de la carga útil.
+ *additionalMessageAttributeId*Sustitúyalo por el ID del atributo que contiene el mensaje adicional o elimínelo `additionalMessage` de la carga útil.
```
{
"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"
}
]
}
]
}
}
```
1. (Opcional) Configure las notificaciones por correo electrónico (`emailConfigurations`) para enviarlas a un usuario de IAM Identity Center cuando la alarma cambie de estado.
+ *identityStoreIdAttributeId*Sustitúyalo por el ID de la propiedad del atributo ID del almacén de identidades del IAM Identity Center.
+ *userIdAttributeId*Sustitúyalo por el ID de la propiedad del atributo de ID de usuario del IAM Identity Center.
+ *fromAddressAttributeId*Sustitúyalo por el ID de la propiedad del atributo de dirección «de» o elimínelo `from` de la carga útil.
+ *emailSubjectAttributeId*Sustitúyalo por el ID de la propiedad del atributo del asunto del correo electrónico o elimínalo `subject` de la carga útil.
+ *additionalMessageAttributeId*Sustitúyala por el ID de la propiedad de atributo de mensaje adicional o elimínala `additionalMessage` de la carga útil.
```
{
"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"
}
}
]
}
]
}
}
```
1. (Opcional) Añada las funciones de alarma (`alarmCapabilities`) a la carga en `alarm-model-payload.json`. En este objeto, puede especificar si se habilita el flujo de reconocimiento y el estado de activación predeterminado de los activos basados en el modelo de activo. Para obtener más información sobre el flujo de reconocimiento, consulte [Estados de alarma](industrial-alarms.md#alarm-states).
```
{
"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
}
}
}
```
1. Añada la función de servicio de IAM (`roleArn`) a la que AWS IoT Events se pueden enviar los datos. AWS IoT SiteWise Este rol requiere el permiso `iotsitewise:BatchPutAssetPropertyValue` y una relación de confianza que permita a `iotevents.amazonaws.com` asumir el rol. Para enviar notificaciones, este rol también requiere los permisos `lambda:InvokeFunction` y `sso-directory:DescribeUser`. Para obtener más información, consulte [Rol de servicio de alarmas](https://docs.aws.amazon.com/iotevents/latest/developerguide/security-iam.html) en la *Guía para desarrolladores de AWS IoT Events *.
+ Sustituya el `roleArn` por el ARN del rol que AWS IoT Events puede asumir para realizar estas acciones.
```
{
"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"
}
```
1. Ejecute el siguiente comando para crear el modelo de AWS IoT Events alarma a partir de la carga útil entrante. `alarm-model-payload.json`
```
aws iotevents create-alarm-model --cli-input-json file://alarm-model-payload.json
```
1. La operación devuelve una respuesta que incluye el ARN del modelo de alarma, `alarmModelArn`. Copie este ARN para configurar en el siguiente paso la definición de la alarma en su modelo de activos.
### Paso 3: Habilite el flujo de datos entre y AWS IoT SiteWise AWS IoT Events
Después de crear los recursos necesarios en AWS IoT SiteWise y AWS IoT Events, puede habilitar el flujo de datos entre los recursos para activar la alarma. En esta sección, usted actualiza la definición de alarma en el modelo de activo para usar el modelo de alarma que ha creado en el paso anterior.
**Para habilitar el flujo de datos entre AWS IoT SiteWise y AWS IoT Events (CLI)**
+ Configure el modelo de alarma como origen de la alarma en el modelo de activo. Haga lo siguiente:
1. Ejecute el siguiente comando para recuperar la definición del modelo de activo existente. *asset-model-id*Sustitúyalo por el ID del modelo de activos.
```
aws iotsitewise describe-asset-model --asset-model-id asset-model-id
```
La operación devuelve una respuesta que contiene los detalles del modelo de activo.
1. Cree un archivo llamado `update-asset-model-payload.json` y copie la respuesta del comando anterior en el archivo.
1. Elimine los siguientes pares de clave-valor del archivo `update-asset-model-payload.json`:
+ `assetModelId`
+ `assetModelArn`
+ `assetModelCreationDate`
+ `assetModelLastUpdateDate`
+ `assetModelStatus`
1. Añada la propiedad de origen de alarma (`AWS/ALARM_SOURCE`) al modelo compuesto de alarmas que definió anteriormente. *alarmModelArn*Sustitúyalo por el ARN del modelo de alarma, que establece el valor de la propiedad de la fuente de alarma.
```
{
...
"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"
}
}
}
]
}
]
}
```
1. Ejecute el siguiente comando para actualizar el modelo de activo con la definición almacenada en el archivo `update-asset-model-payload.json`. *asset-model-id*Sustitúyalo por el ID del modelo de activos.
```
aws iotsitewise update-asset-model \
--asset-model-id asset-model-id \
--cli-input-json file://update-asset-model-payload.json
```
Su modelo de activo ahora define una alarma capaz de detectar en AWS IoT Events. La alarma monitorea la propiedad de destino en todos los activos basados en este modelo de activo. Puede configurar la alarma de cada activo para personalizar propiedades como el umbral o el destinatario de IAM Identity Center para cada activo. Para obtener más información, consulte [Configure las alarmas de los activos en AWS IoT SiteWise](configure-alarms.md).
# Defina las alarmas externas en AWS IoT SiteWise
Las alarmas externas contienen el estado de las alarmas que se detectan fuera de AWS IoT SiteWise.
## Definición de una alarma externa (consola)
Puede utilizar la AWS IoT SiteWise consola para definir una alarma externa en un modelo de activos existente. Para definir una alarma externa en un nuevo modelo de activo, cree el modelo de activo y, a continuación, siga estos pasos. Para obtener más información, consulte [Cree modelos de activos en AWS IoT SiteWise](create-asset-models.md).
**Para definir una alarma en un modelo de activo**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Models (Modelos)**.
1. Elija el modelo de activo para el que desee definir una alarma.
1. Seleccione la pestaña **Definiciones de alarma**.
1. Seleccione **Añadir alarma**.
1. En **Opciones de tipos de alarmas**, seleccione **Alarma externa**.
1. Escriba un nombre para la alarma.
1. (Opcional) Ingrese una descripción para su alarma.
1. Seleccione **Añadir alarma**.
## Definición de una alarma externa (CLI)
Puede utilizarla AWS CLI para definir una alarma externa en un modelo de activos nuevo o existente.
Para añadir una alarma externa a un modelo de activo, añada un modelo compuesto de alarma al modelo de activo. Un modelo compuesto de alarmas externas especifica el tipo de `EXTERNAL`, pero no especifica la propiedad de origen de alarma. El siguiente ejemplo de alarma compuesta define una alarma externa de temperatura.
```
{
...
"assetModelCompositeModels": [
{
"name": "BoilerTemperatureHighAlarm",
"type": "AWS/ALARM",
"properties": [
{
"name": "AWS/ALARM_TYPE",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "EXTERNAL"
}
}
},
{
"name": "AWS/ALARM_STATE",
"dataType": "STRUCT",
"dataTypeSpec": "AWS/ALARM_STATE",
"type": {
"measurement": {}
}
}
]
}
]
}
```
Para obtener más información sobre cómo añadir un modelo compuesto a un modelo de activo nuevo o existente, consulte lo siguiente:
+ [Creación de un modelo de activos (AWS CLI)](create-asset-models.md#create-asset-model-cli)
+ [Actualice un modelo de activo, un modelo de componentes o una interfaz (AWS CLI)](update-asset-models.md#update-asset-model-cli)
Después de definir la alarma externa, puede ingerir el estado de alarma a los activos basados en el modelo de activo. Para obtener más información, consulte [Introduzca un estado de alarma externo en AWS IoT SiteWise](ingest-external-alarm-state.md).
# Configure las alarmas de los activos en AWS IoT SiteWise
Tras definir una AWS IoT Events alarma en un modelo de activo, puede configurar la alarma en cada activo en función del modelo de activo. Puede editar el valor de umbral y los ajustes de notificación de la alarma. Cada uno de estos valores es un atributo del activo, por lo que puede actualizar el valor predeterminado del atributo para configurar estos valores.
**nota**
Puede configurar estos valores para AWS IoT Events las alarmas, pero no para las alarmas externas.
**Topics**
+ [Configuración de un valor de umbral (consola)](#configure-alarm-threshold-value-console)
+ [Configuración de un valor de umbral (AWS CLI)](#configure-alarm-threshold-value-cli)
+ [Configure los ajustes de notificación en AWS IoT SiteWise](configure-alarm-notification-settings.md)
## Configuración de un valor de umbral (consola)
Puede utilizar la AWS IoT SiteWise consola para actualizar el valor del atributo que especifica el valor umbral de una alarma.
**Para actualizar el valor del umbral de una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea actualizar un valor del umbral de la alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Elija **Edit (Edición de)**.
1. Busque el atributo que utiliza la alarma para su valor de umbral y, a continuación, introduzca su nuevo valor.
1. Seleccione **Save**.
## Configuración de un valor de umbral (AWS CLI)
Puede usar el AWS Command Line Interface (AWS CLI) para actualizar el valor del atributo que especifica el valor umbral de una alarma.
Debe conocer los `assetId` de sus activos y los `propertyId` de las propiedades para completar este procedimiento. También puede utilizar el ID externo. Si has creado un activo y no lo sabes`assetId`, usa la [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para enumerar todos los activos de un modelo específico. Utilice la [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operación para ver las propiedades de su activo, incluida la propiedad IDs.
Utilice la operación [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) para asignar valores de atributo a su activo. Puede utilizar esta operación para establecer varios atributos a la vez. La carga de esta operación contiene una lista de entradas y cada una contiene el ID de activo, el ID de propiedad y el valor de atributo.
**Actualización del valor de un atributo (AWS CLI)**
1. Cree un archivo llamado `batch-put-payload.json` y copie el siguiente objeto JSON en el archivo. En esta carga de ejemplo se muestra cómo establecer la latitud y la longitud de una turbina eólica. Actualice los IDs valores y las marcas de tiempo para modificar la carga útil según su caso de uso.
```
{
"entries": [
{
"entryId": "windfarm3-turbine7-latitude",
"assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"propertyValues": [
{
"value": {
"doubleValue": 47.6204
},
"timestamp": {
"timeInSeconds": 1575691200
}
}
]
},
{
"entryId": "windfarm3-turbine7-longitude",
"assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE",
"propertyValues": [
{
"value": {
"doubleValue": 122.3491
},
"timestamp": {
"timeInSeconds": 1575691200
}
}
]
}
]
}
```
+ Cada entrada de la carga contiene un `entryId` que puede definir como una única cadena. Si la entrada de la solicitud no se realiza correctamente, cada error contendrá el `entryId` de la solicitud correspondiente para que sepa qué solicitudes deben volver a intentarse.
+ Para establecer un valor de atributo, puede incluir una estructura timestamp-quality-value (TQV) en la lista de propiedades de `propertyValues` cada atributo. Esta estructura debe contener el nuevo `value` y la `timestamp` actual.
+ `value`: una estructura que contiene uno de los siguientes campos, en función del tipo de propiedad que se establezca:
+ `booleanValue`
+ `doubleValue`
+ `integerValue`
+ `stringValue`
+ `nullValue`
+ `timestamp`— Una estructura que contiene el tiempo de época actual de Unix en segundos,. `timeInSeconds` AWS IoT SiteWise rechaza todos los puntos de datos con marcas de tiempo que hayan existido durante más de 7 días o más de 5 minutos en el futuro.
Para obtener más información acerca de cómo preparar una carga para [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html), consulte [Ingiera datos con AWS IoT SiteWise APIs](ingest-api.md).
1. Ejecute el siguiente comando para enviar los valores del atributo a AWS IoT SiteWise:
```
aws iotsitewise batch-put-asset-property-value -\-cli-input-json file://batch-put-payload.json
```
# Configure los ajustes de notificación en AWS IoT SiteWise
Puede configurar los ajustes de notificación de alarmas mediante la AWS IoT SiteWise consola o el AWS Command Line Interface (AWS CLI).
## Configuración de ajustes de notificación (consola)
Puede utilizar la AWS IoT SiteWise consola para actualizar el valor de los atributos que especifican la configuración de notificación de una alarma.
**Para actualizar los ajustes de notificación de una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea actualizar la configuración de la alarma.
1. Elija **Edit (Edición de)**.
1. Busque el atributo que utiliza la alarma utiliza para el ajuste de notificación que desee cambiar y, a continuación, introduzca su nuevo valor.
1. Seleccione **Save**.
## Configuración de ajustes de notificaciones (CLI)
Puede usar el AWS Command Line Interface (AWS CLI) para actualizar el valor del atributo que especifica la configuración de notificación de una alarma.
Debe conocer los `assetId` de sus activos y los `propertyId` de las propiedades para completar este procedimiento. También puede utilizar el ID externo. Si has creado un activo y no lo sabes`assetId`, usa la [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para enumerar todos los activos de un modelo específico. Utilice la [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operación para ver las propiedades de su activo, incluida la propiedad IDs.
Utilice la operación [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) para asignar valores de atributo a su activo. Puede utilizar esta operación para establecer varios atributos a la vez. La carga de esta operación contiene una lista de entradas y cada una contiene el ID de activo, el ID de propiedad y el valor de atributo.
**Actualización del valor de un atributo (AWS CLI)**
1. Cree un archivo llamado `batch-put-payload.json` y copie el siguiente objeto JSON en el archivo. En esta carga de ejemplo se muestra cómo establecer la latitud y la longitud de una turbina eólica. Actualice los IDs valores y las marcas de tiempo para modificar la carga útil según su caso de uso.
```
{
"entries": [
{
"entryId": "windfarm3-turbine7-latitude",
"assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
"propertyValues": [
{
"value": {
"doubleValue": 47.6204
},
"timestamp": {
"timeInSeconds": 1575691200
}
}
]
},
{
"entryId": "windfarm3-turbine7-longitude",
"assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
"propertyId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE",
"propertyValues": [
{
"value": {
"doubleValue": 122.3491
},
"timestamp": {
"timeInSeconds": 1575691200
}
}
]
}
]
}
```
+ Cada entrada de la carga contiene un `entryId` que puede definir como una única cadena. Si la entrada de la solicitud no se realiza correctamente, cada error contendrá el `entryId` de la solicitud correspondiente para que sepa qué solicitudes deben volver a intentarse.
+ Para establecer un valor de atributo, puede incluir una estructura timestamp-quality-value (TQV) en la lista de propiedades de `propertyValues` cada atributo. Esta estructura debe contener el nuevo `value` y la `timestamp` actual.
+ `value`: una estructura que contiene uno de los siguientes campos, en función del tipo de propiedad que se establezca:
+ `booleanValue`
+ `doubleValue`
+ `integerValue`
+ `stringValue`
+ `nullValue`
+ `timestamp`— Una estructura que contiene el tiempo de época actual de Unix en segundos,. `timeInSeconds` AWS IoT SiteWise rechaza todos los puntos de datos con marcas de tiempo que hayan existido durante más de 7 días o más de 5 minutos en el futuro.
Para obtener más información acerca de cómo preparar una carga para [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html), consulte [Ingiera datos con AWS IoT SiteWise APIs](ingest-api.md).
1. Ejecute el siguiente comando para enviar los valores del atributo a AWS IoT SiteWise:
```
aws iotsitewise batch-put-asset-property-value -\-cli-input-json file://batch-put-payload.json
```
# Responda a las alarmas en AWS IoT SiteWise
Cuando una AWS IoT Events alarma cambia de estado, puedes hacer lo siguiente para responder a la alarma:
+ Confirmar la alarma para indicar que está gestionando el problema.
+ Posponer la alarma para desactivarla temporalmente.
+ Deshabilitar la alarma para desactivarla permanentemente hasta que la vuelva a habilitar.
+ Habilitar una alarma deshabilitada para detectar el estado de alarma.
+ Restablecer la alarma para borrar su estado y su último valor.
Puedes usar la AWS IoT SiteWise consola o la AWS IoT Events API para responder a una alarma.
**nota**
Puede responder a AWS IoT Events las alarmas, pero no a las externas.
**Topics**
+ [Respuesta a una alarma (consola)](#respond-to-alarm-console)
+ [Respuesta a una alarma (API)](#respond-to-alarm-cli)
## Respuesta a una alarma (consola)
Puede usar la AWS IoT SiteWise consola para reconocer, posponer, deshabilitar o activar una alarma.
**Topics**
+ [Confirmación de una alarma (consola)](#acknowledge-alarm-console)
+ [Posponer una alarma (consola)](#snooze-alarm-console)
+ [Deshabilitación de una alarma (consola)](#disable-alarm-console)
+ [Habilitar una alarma (consola)](#enable-alarm-console)
+ [Restablecer una alarma (consola)](#reset-alarm-console)
### Confirmación de una alarma (consola)
Se puede confirmar la alarma para indicar que se está gestionando el problema.
**nota**
Es necesario habilitar el flujo de reconocimiento en la alarma para poder confirmarla. Esta opción está habilitada de forma predeterminada si define la alarma desde la consola de AWS IoT SiteWise .
**Para confirmar una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea confirmar una alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Seleccione la pestaña **Alarmas**.
1. Seleccione la alarma que desee reconocer y, a continuación, elija **Acciones** para abrir el menú de acciones de respuesta.
1. Seleccione **Confirmar**. El estado de la alarma cambia a **Confirmado**.
### Posponer una alarma (consola)
Puede posponer una alarma para deshabilitarla temporalmente. Especifique el tiempo durante el que se debe posponer la alarma.
**Para posponer una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea posponer una alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Seleccione la pestaña **Alarmas**.
1. Seleccione la alarma que desee posponer y, a continuación, elija **Acciones** para abrir el menú de acciones de respuesta.
1. Seleccione **Posponer**. Se abre un modelo en el que se especifica la duración de la pausa.
1. Elija la **duración de la acción de posponer** o introduzca una **duración personalizada de la acción de posponer**.
1. Seleccione **Save**. El estado de la alarma cambia a **Silenciado**.
### Deshabilitación de una alarma (consola)
Se puede deshabilitar una alarma para que no detecte nada más. Después de deshabilitar la alarma, debe volver a habilitarla si desea que la alarma detecte algo.
**Para deshabilitar una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea deshabilitar una alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Seleccione la pestaña **Alarmas**.
1. Seleccione la alarma que desee deshabilitar y, a continuación, elija **Acciones** para abrir el menú de acciones de respuesta.
1. Elija **Deshabilitar**. El estado de la alarma cambia a **Deshabilitado**.
### Habilitar una alarma (consola)
Puede habilitar una alarma para que se vuelva a detectar después de deshabilitarla o posponerla.
**Para habilitar una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea habilitar una alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Seleccione la pestaña **Alarmas**.
1. Seleccione la alarma que desee habilitar y, a continuación, elija **Acciones** para abrir el menú de acciones de respuesta.
1. Seleccione **Habilitar**. El estado de la alarma cambia a **Normal**.
### Restablecer una alarma (consola)
Puede restablecer una alarma para borrar su estado y su último valor.
**Para restablecer una alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea restablecer una alarma.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Seleccione la pestaña **Alarmas**.
1. Seleccione la alarma que desee habilitar y, a continuación, elija **Acciones** para abrir el menú de acciones de respuesta.
1. Elija **Restablecer**. El estado de la alarma cambia a **Normal**.
## Respuesta a una alarma (API)
Puedes usar la AWS IoT Events API para reconocer, posponer, deshabilitar, activar o restablecer una alarma. Para obtener más información, consulte las siguientes operaciones en la *Referencia de la API de AWS IoT Events *:
+ [BatchAcknowledgeAlarm](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html)
+ [BatchSnoozeAlarm](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html)
+ [BatchDisableAlarm](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html)
+ [BatchEnableAlarm](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html)
+ [BatchResetAlarm](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html)
Para obtener más información, consulte [Respuesta a las alarmas](https://docs.aws.amazon.com/iotevents/latest/developerguide/respond-to-alarms.html) en la *Guía para desarrolladores de AWS IoT Events *.
# Introduzca un estado de alarma externo en AWS IoT SiteWise
Las alarmas externas son alarmas que se evalúan fuera de ellas AWS IoT SiteWise. Puede utilizar alarmas externas si tiene un origen de datos que notifique el estado de alarma que desea ingerir a AWS IoT SiteWise.
Las propiedades de los estados de alarma requieren un formato específico para los valores de los datos de los estados de alarma. Cada valor de datos debe ser un objeto JSON serializado en una cadena. A continuación, ingiera la cadena serializada como valor de cadena. Para obtener más información, consulte [Propiedades del estado de alarma](industrial-alarms.md#alarm-state-properties).
**Example Ejemplo de valor de los datos de estado de alarma (no serializado)**
```
{
"stateName": "Active"
}
```
**Example Ejemplo de valor de los datos de estado de alarma (serializado)**
```
{\"stateName\":\"Active\"}
```
**nota**
Si su origen de datos no puede generar datos en este formato o no puede convertirlos a este formato antes de ingerirlos, puede optar por no utilizar una propiedad de alarma. En su lugar, puede ingerir los datos como una propiedad de medición con el tipo de datos de cadena, por ejemplo. Para obtener más información, consulte [Definición de flujos de datos procedentes del equipo (mediciones)](measurements.md) y [Ingiera datos para AWS IoT SiteWise](industrial-data-ingestion.md).
# Mapee los flujos de estados de alarma externos AWS IoT SiteWise
Puede definir alias de propiedades para asignar sus flujos de datos a las propiedades de su estado de alarma. Esto le ayuda a identificar fácilmente una propiedad de estado de alarma cuando ingiera o recupera datos. Para obtener más información acerca de los alias de propiedad, consulte [Gestione los flujos de datos para AWS IoT SiteWise](manage-data-streams.md).
**Topics**
+ [Asignación de flujos de estados de alarmas externas (consola)](#connect-alarm-data-stream-console)
+ [Asignación de flujos de estados de alarmas externas (AWS CLI)](#connect-alarm-data-stream-cli)
## Asignación de flujos de estados de alarmas externas (consola)
Puede definir alias de propiedades para asignar sus flujos de datos a las propiedades de su estado de alarma. Esto le ayuda a identificar fácilmente una propiedad de estado de alarma cuando ingiera o recupera datos. Para obtener más información acerca de los alias de propiedad, consulte [Gestione los flujos de datos para AWS IoT SiteWise](manage-data-streams.md).
Puede utilizar la AWS IoT SiteWise consola para configurar un alias para una propiedad de estado de alarma.
**Para configurar un alias de propiedad para una propiedad de estado de alarma (consola)**
1. Vaya a la [consola de AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. En el panel de navegación, elija **Activos**.
1. Elija el activo para el que desea configurar un alias de propiedad.
**sugerencia**
Puede elegir el icono de flecha para expandir una jerarquía de activos y encontrar su activo.
1. Elija **Edit (Edición de)**.
1. Desplácese hasta **Alarmas** y expanda la sección.
1. En **Alarmas externas**, introduce el alias en **Alias de propiedad – *opcional***.
1. Seleccione **Save**.
## Asignación de flujos de estados de alarmas externas (AWS CLI)
Puede definir alias de propiedades para asignar sus flujos de datos a las propiedades de su estado de alarma. Esto le ayuda a identificar fácilmente una propiedad de estado de alarma cuando ingiera o recupera datos. Para obtener más información acerca de los alias de propiedad, consulte [Gestione los flujos de datos para AWS IoT SiteWise](manage-data-streams.md).
Puedes usar el AWS Command Line Interface (AWS CLI) para configurar un alias para una propiedad de estado de alarma.
Debe conocer los `assetId` de sus activos y los `propertyId` de las propiedades para completar este procedimiento. También puede utilizar el ID externo. Si has creado un activo y no lo conoces`assetId`, usa la [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para enumerar todos los activos de un modelo específico. Utilice la [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operación para ver las propiedades de su activo, incluida la propiedad IDs.
**nota**
La [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)respuesta incluye la lista de modelos de activos compuestos para el activo. Cada alarma es un modelo compuesto. Para encontrar el `propertyId`, busque el modelo compuesto de la alarma y, a continuación, busque la propiedad de `AWS/ALARM_STATE` en ese modelo compuesto.
Para obtener información acerca de cómo establecer el alias de la propiedad, consulte [Actualice el alias de una propiedad de un activo](update-data-streams-method.md).
# Ingiera los datos del estado de alarma en AWS IoT SiteWise
Las propiedades del estado de alarma esperan que el estado de la alarma sea una cadena JSON serializada. Para transferir el estado de alarma a una alarma externa AWS IoT SiteWise, ingiera esta cadena serializada como un valor de cadena con una marca de tiempo. En el ejemplo siguiente se muestra un valor de datos de estado para una alarma activa.
```
{\"stateName\":\"Active\"}
```
Para identificar una propiedad del estado de alarma, puede especificar uno de los elementos siguientes:
+ El `assetId` y el `propertyId` de la propiedad de alarma a la que se envían los datos.
+ El `propertyAlias`, que es un alias de flujo de datos (por ejemplo, `/company/windfarm/3/turbine/7/temperature/high`). Para utilizar esta opción, primero debe establecer el alias de la propiedad de la alarma. Para obtener información sobre cómo configurar los alias de propiedad para las propiedades de los estados de alarma, consulte [Mapee los flujos de estados de alarma externos AWS IoT SiteWise](connect-alarm-data-streams.md).
En el siguiente ejemplo de carga útil de la [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html)API, se muestra cómo formatear el estado de una alarma externa. Esta alarma externa informa cuando la lectura de rotaciones por minuto (RPM) de una turbina eólica es demasiado alta.
**Example Ejemplo de BatchPutAssetPropertyValue carga útil para datos de estado de alarma**
```
{
"entries": [
{
"entryId": "unique entry ID",
"propertyAlias": "/company/windfarm/3/turbine/7/temperature/high",
"propertyValues": [
{
"value": {
"stringValue": "{\"stateName\":\"Active\"}"
},
"timestamp": {
"timeInSeconds": 1607550262
}
}
]
}
]
}
```
Para obtener más información sobre cómo usar la API `BatchPutAssetPropertyValue` para ingerir datos, consulte [Ingiera datos con AWS IoT SiteWise APIs](ingest-api.md).
Para obtener más información acerca de otras formas de ingerir datos, consulte [Ingiera datos para AWS IoT SiteWise](industrial-data-ingestion.md).