As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Monitore dados com alarmes em AWS IoT SiteWise
Você pode configurar alarmes para que seus dados alertem sua equipe quando seu equipamento ou processos funcionarem abaixo da qualidade. O desempenho ideal de uma máquina ou de um processo significa que os valores de determinadas métricas devem estar dentro de um intervalo de limites alto e baixo. Quando essas métricas estão fora do intervalo operacional, os operadores de equipamentos devem ser notificados para que possam corrigir o problema. Use alarmes para identificar problemas rapidamente e notificar os operadores para maximizar o desempenho de equipamentos e processos.
**Topics**
+ [Tipos de alarmes](#alarm-types)
+ [Estados de alarme](#alarm-states)
+ [Propriedades do estado do alarme](#alarm-state-properties)
+ [Defina alarmes em modelos de ativos em AWS IoT SiteWise](define-alarms.md)
+ [Configure alarmes em ativos no AWS IoT SiteWise](configure-alarms.md)
+ [Responda aos alarmes em AWS IoT SiteWise](respond-to-alarms.md)
+ [Ingerir um estado de alarme externo em AWS IoT SiteWise](ingest-external-alarm-state.md)
## Tipos de alarmes
Você pode definir alarmes que são detectados na AWS nuvem e alarmes que você detecta com processos externos. AWS IoT SiteWise suporta os seguintes tipos de alarmes:
+ **AWS IoT Events alarmes**
**nota**
Aviso de fim do suporte: suporte AWS encerrado para AWS IoT Events. Para obter mais informações, consulte [AWS IoT Events Fim do suporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
AWS IoT Events alarmes são alarmes que detectam em. AWS IoT Events AWS IoT SiteWise envia valores de propriedades de ativos para um modelo de alarme em AWS IoT Events. Em seguida, AWS IoT Events envia o estado do alarme para AWS IoT SiteWise. Você pode configurar opções como quando o alarme detecta e quem notificar quando o estado do alarme mudar. Você também pode definir as [AWS IoT Events ações](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) que ocorrem quando o estado do alarme muda.
Os alarmes em AWS IoT Events são exemplos de modelos de alarme. O modelo de alarme especifica o limite e a gravidade do alarme, o que fazer quando o estado do alarme muda e muito mais. Ao configurar cada característica do modelo de alarme, você especifica uma propriedade de atributo do modelo de ativo que o alarme monitora. Todos os ativos baseados no modelo de ativos usam o valor do atributo ao AWS IoT Events avaliar essa característica do alarme. Para obter mais informações, consulte [Usar alarmes](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-alarms.html), no *Guia do desenvolvedor do AWS IoT Events *.
Você pode responder a um AWS IoT Events alarme quando ele muda de estado. Por exemplo, você pode reconhecer ou adiar um alarme quando ele se torna ativo. Você também pode habilitar, desabilitar e redefinir os alarmes.
SiteWise Os usuários do Monitor podem visualizar, configurar e responder aos AWS IoT Events alarmes nos portais do SiteWise Monitor. Para obter mais informações, consulte [Monitorar com alarmes](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html), no *Guia do aplicativo do AWS IoT SiteWise Monitor *.
**nota**
AWS IoT Events cobranças se aplicam para avaliar esses alarmes e transferir dados entre AWS IoT SiteWise e. AWS IoT Events Para obter mais informações, consulte [Preços do AWS IoT Events](https://aws.amazon.com/iot-events/pricing/).
+ **Alarmes externos**
Alarmes externos são alarmes que você avalia externamente. AWS IoT SiteWise Use alarmes externos se você tiver uma fonte de dados que informe o estado do alarme. O alarme externo contém uma propriedade de medição à qual você ingere os dados do estado do alarme.
Você não pode reconhecer ou adiar um alarme externo quando ele muda de estado.
SiteWise Os usuários do monitor podem ver o estado dos alarmes externos nos portais do SiteWise Monitor, mas não podem configurar nem responder a esses alarmes.
AWS IoT SiteWise não avalia o estado dos alarmes externos.
## Estados de alarme
Os alarmes industriais incluem informações sobre o estado do equipamento ou processo que monitoram e informações (opcionais) sobre a resposta do operador ao estado do alarme.
Ao definir um AWS IoT Events alarme, você especifica se deseja ou não ativar o *fluxo de reconhecimento*. Por padrão, o fluxo de reconhecimento está habilitado. Quando você ativa essa opção, os operadores podem reconhecer o alarme e deixar uma nota com detalhes sobre o alarme ou as ações que tomaram para resolvê-lo. Se um operador não reconhecer um alarme ativo antes que ele se torne inativo, o alarme será travado. O estado travado indica que o alarme ficou ativo e não foi reconhecido e, portanto, o operador precisa verificar o equipamento ou o processo e reconhecer o alarme travado.
Os alarmes têm os seguintes estados:
+ **Normal** (`Normal`): o alarme está habilitado, mas inativo. O processo industrial ou equipamento opera conforme o esperado.
+ **Ativo** (`Active`): o alarme está ativo. O processo industrial ou equipamento está fora de sua faixa operacional e precisa de atenção.
+ **Reconhecido ** (`Acknowledged`): um operador reconheceu o estado do alarme.
Esse estado se aplica somente aos alarmes nos quais você habilita o fluxo de reconhecimento.
+ **Travado** (`Latched`): o alarme voltou ao normal, mas estava ativo e nenhum operador o reconheceu. O processo industrial ou equipamento requer atenção para reconfigurar o alarme para normal.
Esse estado se aplica somente aos alarmes nos quais você habilita o fluxo de reconhecimento.
+ **Adiado** (`SnoozeDisabled`): o alarme está desabilitado porque um operador adiou o alarme. O operador define a duração da soneca do alarme. Após esse período, o alarme retorna ao estado normal.
+ **Desabilitado** (`Disabled`): o alarme está desabilitado e não será detectado.
## Propriedades do estado do alarme
AWS IoT SiteWise armazena dados do estado do alarme como um objeto JSON serializado em uma string. Esse objeto contém o estado e informações adicionais sobre o alarme, como ações de resposta do operador e a regra que o alarme avalia.
Você identifica a propriedade do estado do alarme pelo nome e tipo de estrutura, `AWS/ALARM_STATE`. Para obter mais informações, consulte [Defina alarmes em modelos de ativos em AWS IoT SiteWise](define-alarms.md).
O objeto dos dados do estado do alarme contém as seguintes informações:
`stateName`
O estado do alarme. Para obter mais informações, consulte [Estados de alarme](#alarm-states).
Tipo de dados: `STRING`
`customerAction`
(Opcional) Um objeto que contém informações sobre a resposta do operador ao alarme. Os operadores podem habilitar, desabilitar, reconhecer e adiar os alarmes. Quando fazem isso, os dados do estado do alarme incluem sua resposta e a nota que eles podem deixar quando responderem. Esse objeto contém as seguintes informações:
`actionName`
O nome da ação que o operador adota para responder ao alarme. Este valor contém uma das seguintes strings:
+ `ENABLE`
+ `DISABLE`
+ `SNOOZE`
+ `ACKNOWLEDGE`
+ `RESET`
Tipo de dados: `STRING`
`enable`
(Opcional) Um objeto que está presente no `customerAction` quando o operador habilita o alarme. Quando um operador habilita o alarme, o estado do alarme muda para `Normal`. Esse objeto contém as seguintes informações:
`note`
(Opcional) A nota que o cliente deixa quando habilita o alarme.
Tipo de dados: `STRING`
Tamanho máximo: 128 caracteres
`disable`
(Opcional) Um objeto que está presente em `customerAction` quando o operador desabilita o alarme. Quando um operador habilita o alarme, o estado do alarme muda para `Disabled`. Esse objeto contém as seguintes informações:
`note`
(Opcional) A nota que o cliente deixa quando desabilita o alarme.
Tipo de dados: `STRING`
Tamanho máximo: 128 caracteres
`acknowledge`
(Opcional) Um objeto que está presente em `customerAction` quando o operador reconhece o alarme. Quando um operador habilita o alarme, o estado do alarme muda para `Acknowledged`. Esse objeto contém as seguintes informações:
`note`
(Opcional) A nota que o cliente deixa quando reconhece o alarme.
Tipo de dados: `STRING`
Tamanho máximo: 128 caracteres
`snooze`
(Opcional) Um objeto que está presente `customerAction` quando o operador adia o alarme. Quando um operador habilita o alarme, o estado do alarme muda para `SnoozeDisabled`. Esse objeto contém as seguintes informações:
`snoozeDuration`
A duração em segundos em que o operador adia o alarme. O alarme muda para o estado `Normal` depois desse período.
Tipo de dados: `INTEGER`
`note`
(Opcional) A nota que o cliente deixa quando adia o alarme.
Tipo de dados: `STRING`
Tamanho máximo: 128 caracteres
`ruleEvaluation`
(Opcional) Um objeto que contém informações sobre a regra que avalia o alarme. Esse objeto contém as seguintes informações:
`simpleRule`
Um objeto que contém informações sobre uma regra simples, que compara um valor de propriedade a um valor limite com um operador de comparação. Esse objeto contém as seguintes informações:
`inputProperty`
O valor da propriedade que esse alarme avalia.
Tipo de dados: `DOUBLE`
`operator`
O operador de comparação que esse alarme usa para comparar a propriedade com o limite. Este valor contém uma das seguintes strings:
+ `<`: menor que
+ `<=`: menor ou igual a
+ `==`: igual
+ `!=`: não igual
+ `>=`: maior ou igual a
+ `>`: maior que
Tipo de dados: `STRING`
`threshold`
O valor limite com o qual esse alarme compara o valor da propriedade.
Tipo de dados: `DOUBLE`
# Defina alarmes em modelos de ativos em AWS IoT SiteWise
Os modelos de ativo promovem a padronização de seus dados industriais. É possível estabelecer definições de alarme em modelos de ativos para padronizar os alarmes para todos os ativos com base em um modelo de ativo.
Você usa *modelos de ativos compostos* para definir alarmes no modelo de ativos. Os modelos de ativos compostos são modelos de ativos que padronizam um conjunto específico de propriedades em outro modelo de ativo. Modelos de ativos compostos garantem que determinadas propriedades estejam presentes em um modelo de ativo. Os alarmes têm propriedades de tipo, estado e fonte (opcionais) e, portanto, o modelo composto de alarme garante que essas propriedades existam.
Cada modelo composto tem um tipo que define as propriedades para o modelo composto. Os modelos compostos de alarme definem propriedades para tipo de alarme, estado de alarme e fonte de alarme (opcional). Quando você cria um ativo a partir de um modelo de ativo com modelos compostos, o ativo inclui as propriedades do modelo composto juntamente com as propriedades que você especifica no modelo de ativo.
Cada propriedade em um modelo composto deve ter o nome que a identifique por seu tipo de modelo composto. As propriedades do modelo composto são compatíveis propriedades com tipos de dados complexos. Essas propriedades têm o tipo de dados `STRUCT` e um atributo `dataTypeSpec` que especifica o tipo de dados complexos da propriedade. As propriedades de tipos de dados complexos contêm dados JSON serializados como strings.
Os modelos compostos de alarme têm as propriedades abaixo. Cada propriedade em um modelo composto deve ter o nome que os identifica por seu tipo de modelo composto.
**Tipo de alarme**
O tipo do alarme. Especifique um dos seguintes:
+ `IOT_EVENTS`— Um AWS IoT Events alarme. AWS IoT SiteWise envia dados AWS IoT Events para avaliar o estado desse alarme. Você deve especificar a propriedade da fonte de alarme para definir o modelo de AWS IoT Events alarme para essa definição de alarme.
**nota**
Aviso de fim do suporte: suporte AWS encerrado para AWS IoT Events. Para obter mais informações, consulte [AWS IoT Events Fim do suporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
+ `EXTERNAL`: um alarme externo. Você ingere o estado do alarme como medição.
Nome da propriedade: `AWS/ALARM_TYPE`
Tipo de propriedade: [atributo](attributes.md)
Tipo de dados: `STRING`
**Estado do alarme**
Os dados de séries temporais do estado do alarme. Este é um objeto serializado como uma string que contém o estado e outras informações sobre o alarme. Para obter mais informações, consulte [Propriedades do estado do alarme](industrial-alarms.md#alarm-state-properties).
Nome da propriedade: `AWS/ALARM_STATE`
Tipo de propriedade: [medição](measurements.md)
Tipo de dados: `STRUCT`
Tipo de estrutura de dados: `AWS/ALARM_STATE`
**Fonte de alarme**
(Opcional) O nome do recurso da Amazon (ARN) do recurso que avalia o estado do alarme. Para AWS IoT Events alarmes, esse é o ARN do modelo de alarme.
Nome da propriedade: `AWS/ALARM_SOURCE`
Tipo de propriedade: [atributo](attributes.md)
Tipo de dados: `STRING`
**Example Exemplo de modelo de alarme composto**
O modelo de ativos a seguir representa uma caldeira que tem um alarme para monitorar sua temperatura. AWS IoT SiteWise envia os dados de temperatura AWS IoT Events para detectar o alarme.
```
{
"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 notificações de alarme em AWS IoT SiteWise](iot-events-alarm-notification-requirements.md)
+ [Defina AWS IoT Events alarmes para AWS IoT SiteWise](define-iot-events-alarms.md)
+ [Defina alarmes externos em AWS IoT SiteWise](define-external-alarms.md)
# Requisitos para notificações de alarme em AWS IoT SiteWise
AWS IoT Events usa uma AWS Lambda função na sua AWS conta para enviar notificações de alarme. Você deve criar essa função Lambda na mesma AWS região dos seus alarmes para ativar as notificações de alarme. Essa função do Lambda usa o [Amazon Simple Notification Service (Amazon SNS)](https://docs.aws.amazon.com/sns/latest/dg/welcome.html) para enviar notificações por texto e o [Amazon Simple Email Service (Amazon SES)](https://docs.aws.amazon.com/ses/latest/dg/Welcome.html) para enviar notificações por e-mail. Ao criar o AWS IoT Events alarme, você configura os protocolos e as configurações que o alarme usa para enviar notificações.
**nota**
Aviso de fim do suporte: suporte AWS encerrado para AWS IoT Events. Para obter mais informações, consulte [AWS IoT Events Fim do suporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
AWS IoT Events fornece um modelo de AWS CloudFormation pilha que você pode usar para criar essa função Lambda em sua conta. Para obter mais informações, consulte [Notificação de alarme da função do Lambda](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) no *Guia do desenvolvedor do AWS IoT Events *.
# Defina AWS IoT Events alarmes para AWS IoT SiteWise
**nota**
Aviso de fim do suporte: suporte AWS encerrado para AWS IoT Events. Para obter mais informações, consulte [AWS IoT Events Fim do suporte](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html).
Quando você cria um AWS IoT Events alarme, AWS IoT SiteWise envia valores de propriedades do ativo AWS IoT Events para avaliar o estado do alarme. AWS IoT Events as definições de alarme dependem de um modelo de alarme que você define em AWS IoT Events. Para definir um AWS IoT Events alarme em um modelo de ativo, você define um modelo composto de alarme que especifica o modelo de AWS IoT Events alarme como sua propriedade de fonte de alarme.
AWS IoT Events os alarmes dependem de entradas, como limites de alarme e configurações de notificação de alarme. Você define essas entradas como atributos no modelo do ativo. Em seguida, você pode personalizar essas entradas em cada ativo com base no modelo. O AWS IoT SiteWise console pode criar esses atributos para você. Se você definir alarmes com a API AWS CLI ou, deverá definir manualmente esses atributos no modelo de ativo.
Você também pode definir outras ações que acontecem quando o alarme detecta, como ações personalizadas de notificação de alarme. Por exemplo, você pode configurar uma ação que envie uma notificação push para um tópico do Amazon SNS. Para obter mais informações sobre as ações que você pode definir, consulte [Trabalhando com outros AWS serviços](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-other-aws-services.html) no *Guia do AWS IoT Events desenvolvedor*.
Quando você atualiza ou exclui um modelo de ativo, AWS IoT SiteWise pode verificar se um modelo de alarme AWS IoT Events está monitorando uma propriedade de ativo associada a esse modelo de ativo. Isso impede que você exclua uma propriedade do ativo que um AWS IoT Events alarme está usando atualmente. Para ativar esse recurso AWS IoT SiteWise, você deve ter a `iotevents:ListInputRoutings` permissão. Essa permissão permite AWS IoT SiteWise fazer chamadas para a operação de [ListInputRoutings](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputRoutings.html)API suportada pelo AWS IoT Events. Para obter mais informações, consulte [ListInputRoutings Permissão (opcional)](alarms-iam-permissions.md#alarms-listInputRoutings-permissions).
**nota**
O atributo de notificações de alarme não está disponível na região da China (Pequim).
**Topics**
+ [Definir um AWS IoT Events alarme (AWS IoT SiteWise console)](#define-iot-events-alarm-console)
+ [Definir um AWS IoT Events alarme (AWS IoT Events console)](#define-iot-events-alarm-console-ite-console)
+ [Definir um AWS IoT Events alarme (AWS CLI)](#define-iot-events-alarm-cli)
## Definir um AWS IoT Events alarme (AWS IoT SiteWise console)
Você pode usar o AWS IoT SiteWise console para definir um AWS IoT Events alarme em um modelo de ativo existente. Para definir um AWS IoT Events alarme em um novo modelo de ativo, crie o modelo de ativo e conclua essas etapas. Para obter mais informações, consulte [Crie modelos de ativos em AWS IoT SiteWise](create-asset-models.md).
**Importante**
Cada alarme requer um atributo que especifique o valor limite a ser comparado ao alarme. Você deve definir o atributo de valor limite no modelo do ativo antes de definir um alarme.
Pense em um exemplo em que você deseja definir um alarme que detecta quando uma turbina eólica excede sua taxa máxima de velocidade do vento de 50 mph. Antes de definir o alarme, você deve definir um atributo (**Velocidade máxima do vento**) com um valor padrão do `50`.
**Para definir um AWS IoT Events alarme em um modelo de ativo**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Modelos**.
1. Escolha o modelo de ativo para o qual o alarme será definido.
1. Escolha a guia **Alarme**.
1. Escolha **Adicionar alarme**.
1. Na seção **Opções do tipo de alarme**, escolha **alarme do AWS IoT Events **.
1. Na seção **Detalhes básicos**, faça o seguinte:
1. Insira um nome para o alarme.
1. (Opcional) Insira uma descrição do seu alarme.
1. Na página **Definir limite**, você define quando o alarme detecta e a gravidade do alarme. Faça o seguinte:
1. Selecione a **Propriedade** na qual o alarme detecta. Cada vez que essa propriedade recebe um novo valor, AWS IoT SiteWise envia o valor AWS IoT Events para avaliar o estado do alarme.
1. Selecione o **Operador** a ser usado para comparar a propriedade com o valor limite. Escolha uma das seguintes opções:
+ **< menor que**
+ **<= menor ou igual a**
+ **== igual**
+ **\$1= não igual**
+ **>= maior ou igual a**
+ **> maior que**
1. Em **Valor**, selecione a propriedade do atributo a ser usada como valor limite. AWS IoT Events compara o valor da propriedade com o valor desse atributo.
1. Insira a **Gravidade** do alarme. Use um número que sua equipe entenda para refletir a gravidade desse alarme.
1. (Opcional) Na seção **Configurações de notificação - *opcional***, faça o seguinte:
1. Selecione **Ativo**.
**nota**
Se escolher **Inativo**, você e sua equipe não receberão nenhuma notificação de alarme.
1. Em **Destinatário**, escolha o destinatário.
**Importante**
Você pode enviar notificações de alarme aos Centro de Identidade do AWS IAM usuários. Para usar esse recurso, você deve habilitar o Centro de identidade do IAM. Você só pode ativar o IAM Identity Center em uma AWS região por vez. Isso significa que você pode definir notificações de alarme somente na região em que você habilita o Centro de identidade do IAM. Para obter mais informações, consulte [Conceitos básicos](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html) no *Guia do usuário do Centro de Identidade do AWS IAM *.
1. Para o **Protocolo**, escolha uma das seguintes opções:
+ **E-mail e texto**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem SMS e uma mensagem de e-mail.
+ **E-mail**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem de e-mail.
+ **Texto**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem SMS.
1. Em **Remetente**, escolha o remetente.
**Importante**
Você deve verificar o endereço de e-mail do remetente no Amazon Simple Email Service (Amazon SES). Para ter mais informações, consulte [Verifying an email address identity](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html#just-verify-email-proc) no *Guia do desenvolvedor do Amazon Simple Email Service*.
1. Na seção **Estado padrão do ativo**, você pode definir o estado padrão para os alarmes criados a partir desse modelo de ativo.
**nota**
Você ativa ou desativa esse alarme para ativos que você cria a partir desse modelo de ativo em uma etapa posterior.
1. Na seção **Configurações avançadas**, você pode definir as permissões, as configurações adicionais de notificação, as ações do estado do alarme, o modelo de alarme no SiteWise Monitor e o fluxo de reconhecimento.
**nota**
AWS IoT Events os alarmes exigem as seguintes funções de serviço:
Uma função que AWS IoT Events pressupõe enviar valores de estado de alarme para AWS IoT SiteWise.
Uma função que AWS IoT Events pressupõe enviar dados para o Lambda. Você só precisa desse perfil se o alarme enviar notificações.
Na página **Permissões**, faça o seguinte:
1. Para o **perfil AWS IoT Events **, use um perfil existente ou crie um perfil com as permissões necessárias. Esse perfil requer a permissão de `iotsitewise:BatchPutAssetPropertyValue` e um relacionamento de confiança que permita que iotevents.amazonaws.com assuma o perfil.
1. Para o **AWS IoT Events perfil do Lambda**, use um perfil existente ou crie um perfil com as permissões necessárias. Esse perfil requer as permissões `lambda:InvokeFunction` e `sso-directory:DescribeUser` e um relacionamento de confiança que permita que `iotevents.amazonaws.com` assuma o perfil.
1. (Opcional) Na seção **Configurações de notificação adicionais**, faça o seguinte:
1. Para o **Atributo destinatário**, você define um atributo cujo valor especifica o destinatário da notificação. Você pode escolher os usuários do Centro de identidade do IAM como destinatários.
Você pode criar um atributo ou usar um atributo existente no modelo de ativo.
+ Se você escolher **Criar um novo atributo de destinatário**, especifique o **Nome do atributo do destinatário** e o **Valor padrão do destinatário - **opcional**** para o atributo.
+ Se você escolher **Usar um atributo de destinatário existente**, escolha o atributo em **Nome do atributo de destinatário**. O alarme usa o valor padrão do atributo escolhido.
Você pode substituir o valor padrão em cada ativo criado a partir desse modelo de ativo.
1. Para **Atributo de mensagem personalizada**, você define um atributo cujo valor especifica a mensagem personalizada a ser enviada, além da mensagem padrão de alteração de estado. Por exemplo, você pode especificar uma mensagem que ajude sua equipe a entender como lidar com esse alarme.
Você pode escolher criar um atributo ou usar um atributo existente no modelo de ativo.
+ Se você optar por **Criar um novo atributo de mensagem personalizada**, especifique o **Nome do atributo de mensagem personalizada** e o **Valor padrão da mensagem personalizada - *opcional*** para o atributo.
+ Se você escolher **Usar um atributo de mensagem personalizada existente**, escolha o atributo em **Nome do atributo de mensagem personalizada**. O alarme usa o valor padrão do atributo escolhido.
Você pode substituir o valor padrão em cada ativo criado a partir desse modelo de ativo.
1. Em **Gerencie sua função do Lambda**, siga um destes procedimentos:
+ Para AWS IoT SiteWise criar uma nova função Lambda, escolha **Criar um novo lambda a partir de um modelo gerenciado pela AWS**.
+ Para usar um perfil da função do Lambda existente, escolha **Usar um lambda existente** e escolha o nome da função.
Para obter mais informações, consulte [Gerenciar notificações de alarme](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) no *Guia do desenvolvedor do AWS IoT Events *.
1. (Opcional) Na seção **Definir ação de estado** faça o seguinte:
1. Escolha **Editar ação**.
1. Em **Adicionar ações de estado de alarme**, adicione ações. e escolha **Salvar**.
Você pode adicionar até 10 ações.
AWS IoT Events pode realizar ações quando o alarme está ativo. Você pode definir ações integradas para usar um cronômetro, definir uma variável ou enviar dados para outros AWS recursos. Para obter mais informações, consulte [Ações compatíveis](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) no *Guia do desenvolvedor do AWS IoT Events *.
1. (Opcional) Em **Gerenciar modelo de alarme em SiteWise Monitor - *opcional***, escolha **Ativo** ou **Inativo**.
Use essa opção para que você possa atualizar o modelo de alarme em SiteWise Monitores. Essa opção é habilitada por padrão.
1. Em **Reconhecer fluxo**, escolha **Ativo** ou **Inativo**. Para obter mais informações sobre o fluxo de reconhecimento, consulte [Estados de alarme](industrial-alarms.md#alarm-states).
1. Escolha **Adicionar alarme**.
**nota**
O AWS IoT SiteWise console faz várias solicitações de API para adicionar o alarme ao modelo de ativos. Quando você escolhe **Adicionar alarme**, o console abre uma caixa de diálogo que mostra o progresso dessas solicitações de API. Permaneça nesta página até que cada solicitação de API seja bem-sucedida ou até que uma solicitação de API falhe. Se uma solicitação falhar, feche a caixa de diálogo, corrija o problema e escolha **Adicionar alarme** para tentar novamente.
## Definir um AWS IoT Events alarme (AWS IoT Events console)
Você pode usar o AWS IoT Events console para definir um AWS IoT Events alarme em um modelo de ativo existente. Para definir um AWS IoT Events alarme em um novo modelo de ativo, crie o modelo de ativo e conclua essas etapas. Para obter mais informações, consulte [Crie modelos de ativos em AWS IoT SiteWise](create-asset-models.md).
**Importante**
Cada alarme requer um atributo que especifique o valor limite a ser comparado ao alarme. Você deve definir o atributo de valor limite no modelo do ativo antes de definir um alarme.
Pense em um exemplo em que você deseja definir um alarme que detecta quando uma turbina eólica excede sua taxa máxima de velocidade do vento de 50 mph. Antes de definir o alarme, você deve definir um atributo (**Velocidade máxima do vento**) com um valor padrão do `50`.
**Para definir um AWS IoT Events alarme em um modelo de ativo**
1. Navegue até o [console do AWS IoT Events](https://console.aws.amazon.com/iotevents/).
1. No painel de navegação, selecione **Modelos de alarme**.
1. Selecione **Criar modelo de alarme**.
1. Insira um nome para o alarme.
1. (Opcional) Insira uma descrição do seu alarme.
1. Na seção **Alarme de destino**, faça o seguinte:
1. Para **Opções de destino**, escolha **Propriedade do ativo do AWS IoT SiteWise **.
1. Escolha o modelo de ativo para o qual deseja adicionar um alarme.
1. Na página **Definir limite**, você define quando o alarme detecta e a gravidade do alarme. Faça o seguinte:
1. Selecione a **Propriedade** na qual o alarme detecta. Cada vez que essa propriedade recebe um novo valor, AWS IoT SiteWise envia o valor AWS IoT Events para avaliar o estado do alarme.
1. Selecione o **Operador** a ser usado para comparar a propriedade com o valor limite. Escolha uma das seguintes opções:
+ **< menor que**
+ **<= menor ou igual a**
+ **== igual**
+ **\$1= não igual**
+ **>= maior ou igual a**
+ **> maior que**
1. Em **Valor**, selecione a propriedade do atributo a ser usada como valor limite. AWS IoT Events compara o valor da propriedade com o valor desse atributo.
1. Insira a **Gravidade** do alarme. Use um número que sua equipe entenda para refletir a gravidade desse alarme.
1. (Opcional) Na seção **Configurações de notificação - *opcional***, faça o seguinte:
1. Para o **Protocolo**, escolha uma das seguintes opções:
+ **E-mail e texto**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem SMS e uma mensagem de e-mail.
+ **E-mail**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem de e-mail.
+ **Texto**: o alarme notifica os usuários do Centro de identidade do IAM com uma mensagem SMS.
1. Em **Remetente**, escolha o remetente.
**Importante**
Você deve verificar o endereço de e-mail do remetente no Amazon Simple Email Service (Amazon SES). Para mais informações, consulte [Verificar endereços de e-mail no Amazon SES](https://docs.aws.amazon.com/ses/latest/dg/verify-addresses-and-domains.html) no *Guia do desenvolvedor do Amazon Simple Email Service*.
1. Escolha o atributo em **Atributo do destinatário - *opcional***. O alarme usa o valor padrão do atributo escolhido.
1. Escolha o atributo em **Atributo de mensagem personalizada - *opcional***. O alarme usa o valor padrão do atributo escolhido.
1. Na seção **Instância**, especifique o **Estado padrão** para esse alarme. Você pode ativar ou desativar esse alarme para todos os ativos criados a partir desse modelo de ativo em uma etapa posterior.
1. **Nas configurações avançadas**, você pode definir as permissões, as configurações adicionais de notificação, as ações do estado do alarme, o modelo de alarme no SiteWise Monitor e o fluxo de reconhecimento.
**nota**
AWS IoT Events os alarmes exigem as seguintes funções de serviço:
Uma função que AWS IoT Events pressupõe enviar valores de estado de alarme para AWS IoT SiteWise.
Uma função que AWS IoT Events pressupõe enviar dados para o Lambda. Você só precisa desse perfil se o alarme enviar notificações.
1. Na seção **Reconhecer fluxo**, escolha **Habilitado** ou **Desabilitado**. Para obter mais informações sobre o fluxo de reconhecimento, consulte [Estados de alarme](industrial-alarms.md#alarm-states).
1. Na página **Permissões**, faça o seguinte:
1. Para o **perfil AWS IoT Events **, use um perfil existente ou crie um perfil com as permissões necessárias. Esse perfil requer a permissão de `iotsitewise:BatchPutAssetPropertyValue` e um relacionamento de confiança que permita que iotevents.amazonaws.com assuma o perfil.
1. Para o **perfil do Lambda**, use um perfil existente ou crie um perfil com as permissões necessárias. Esse perfil requer as permissões `lambda:InvokeFunction` e `sso-directory:DescribeUser` e um relacionamento de confiança que permita que `iotevents.amazonaws.com` assuma o perfil.
1. (Opcional) No painel **Configurações de notificação adicionais**, faça o seguinte:
1. Em **Gerencie sua função do Lambda**, siga um destes procedimentos:
+ Para AWS IoT Events criar uma nova função Lambda, escolha **Criar uma nova função Lambda**.
+ Para usar uma função do Lambda existente, escolha **Usar uma função do Lambda existente** e escolha o nome da função.
Para obter mais informações, consulte [Gerenciar notificações de alarme](https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html) no *Guia do desenvolvedor do AWS IoT Events *.
1. (Opcional) Na seção **Definir ação de estado - *opcional***, faça o seguinte:
1. Em **Ações de estado de alarme**, adicione ações e escolha **Salvar**.
Você pode adicionar até 10 ações.
AWS IoT Events pode realizar ações quando o alarme está ativo. Você pode definir ações integradas para usar um cronômetro, definir uma variável ou enviar dados para outros AWS recursos. Para obter mais informações, consulte [Ações compatíveis](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-supported-actions.html) no *Guia do desenvolvedor do AWS IoT Events *.
1. Escolha **Criar**.
**nota**
O AWS IoT Events console faz várias solicitações de API para adicionar o alarme ao modelo de ativos. Quando você escolhe **Adicionar alarme**, o console abre uma caixa de diálogo que mostra o progresso dessas solicitações de API. Permaneça nesta página até que cada solicitação de API seja bem-sucedida ou até que uma solicitação de API falhe. Se uma solicitação falhar, feche a caixa de diálogo, corrija o problema e escolha **Adicionar alarme** para tentar novamente.
## Definir um AWS IoT Events alarme (AWS CLI)
Você pode usar o AWS Command Line Interface (AWS CLI) para definir um AWS IoT Events alarme que monitora uma propriedade do ativo. Você pode definir o alarme em um modelo de ativo novo ou existente. Depois de definir o alarme no modelo de ativo, você cria um alarme AWS IoT Events e o conecta ao modelo de ativo. Neste processo, você faz o seguinte:
**Topics**
+ [Etapa 1: definir um alarme em um modelo de ativo](#define-iot-events-alarm-definition-cli)
+ [Etapa 2: Definir um modelo AWS IoT Events de alarme](#define-iot-events-alarm-model-cli)
+ [Etapa 3: Habilitar o fluxo de dados entre AWS IoT SiteWise e AWS IoT Events](#define-iot-events-alarm-data-flow-cli)
### Etapa 1: definir um alarme em um modelo de ativo
Adicione uma definição de alarme e as propriedades associadas a um modelo de ativo novo ou existente.
**Para definir um alarme em um modelo de ativo (CLI)**
1. Crie um arquivo chamado `asset-model-payload.json`. Siga as etapas nessas outras seções para adicionar os detalhes do seu modelo de ativo para o arquivo, mas não envie a solicitação para criar ou atualizar o modelo de ativo. Nesta seção, você adiciona uma definição de alarme aos detalhes do modelo de ativo no arquivo `asset-model-payload.json`.
+ Para obter mais informações sobre como criar um modelo de ativo, consulte [Criar um modelo de ativo (AWS CLI)](create-asset-models.md#create-asset-model-cli).
+ Para obter mais informações sobre como atualizar um modelo de ativo existente, consulte [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli).
**nota**
Seu modelo de ativo deve definir pelo menos uma propriedade do ativo, incluindo a propriedade do ativo a ser monitorada com o alarme.
1. Adicione um modelo de alarme composto (`assetModelCompositeModels`) para o modelo do ativo. Um modelo composto de AWS IoT Events alarme especifica o `IOT_EVENTS` tipo e especifica uma propriedade da fonte de alarme. Você adiciona a propriedade da fonte de alarme depois de criar o modelo de alarme em AWS IoT Events.
**Importante**
O modelo composto de alarme deve ter o mesmo nome do modelo de AWS IoT Events alarme que você criar posteriormente. Nomes de modelo de alarme podem conter apenas caracteres alfanuméricos. Especifique um nome alfanumérico exclusivo para que você possa usar o mesmo nome para o modelo de 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": {}
}
}
]
}
]
}
```
1. Adicione um atributo de limite de alarme ao modelo de ativo. Especifique o valor padrão a ser usado para esse limite. Você pode substituir esse valor padrão em cada ativo com base nesse modelo.
**nota**
O atributo de limite de alarme deve ser um `INTEGER` ou um `DOUBLE`.
```
{
...
"assetModelProperties": [
...
{
"name": "Temperature Max Threshold",
"dataType": "DOUBLE",
"type": {
"attribute": {
"defaultValue": "105.0"
}
}
}
]
}
```
1. (Opcional) Adicione atributos de notificação de alarme ao modelo de ativo. Esses atributos especificam o destinatário do IAM Identity Center e outras entradas AWS IoT Events usadas para enviar notificações quando o alarme muda de estado. Você pode substituir esses padrões em cada ativo com base nesse modelo.
**Importante**
Você pode enviar notificações de alarme aos Centro de Identidade do AWS IAM usuários. Para usar esse recurso, você deve habilitar o Centro de identidade do IAM. Você só pode ativar o IAM Identity Center em uma AWS região por vez. Isso significa que você pode definir notificações de alarme somente na região em que você habilita o Centro de identidade do IAM. Para obter mais informações, consulte [Conceitos básicos](https://docs.aws.amazon.com/singlesignon/latest/userguide/getting-started.html) no *Guia do usuário do Centro de Identidade do AWS IAM *.
Faça o seguinte:
1. Adicionar um atributo que especifique o ID do seu repositório de identidades do Centro de identidade do IAM. Você pode usar a operação da [ListInstances](https://docs.aws.amazon.com/singlesignon/latest/APIReference/API_ListInstances.html)API do IAM Identity Center para listar seus repositórios de identidade. Essa operação funciona somente na região em que você habilita o Centro de identidade do IAM.
```
aws sso-admin list-instances
```
Em seguida, especifique a ID do repositório de identidade (por exemplo, `d-123EXAMPLE`) como o valor padrão para o atributo.
```
{
...
"assetModelProperties": [
...
{
"name": "identityStoreId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "d-123EXAMPLE"
}
}
}
]
}
```
1. Adicionar um atributo que especifique a ID do usuário do Centro de identidade do IAM que recebe notificações. Para definir um destinatário padrão da notificação, adicione uma ID de usuário do Centro de identidade do IAM como valor padrão. Faça o seguinte para obter uma ID de usuário do Centro de identidade do IAM:
1. Você pode usar a [ListUsers](https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.html)API do IAM Identity Center para obter o ID de um usuário cujo nome de usuário você conhece. *d-123EXAMPLE*Substitua pela ID do seu repositório de identidades e *Name* substitua pelo nome de usuário do usuário.
```
aws identitystore list-users \
--identity-store-id d-123EXAMPLE \
--filters AttributePath=UserName,AttributeValue=Name
```
1. Use o [console do Centro de identidade do IAM](https://console.aws.amazon.com/singlesignon) para procurar seus usuários e encontrar uma ID de usuário.
Em seguida, especifique a ID do usuário (por exemplo, `123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE`) como o valor padrão para o atributo ou defina o atributo sem um valor padrão.
```
{
...
"assetModelProperties": [
...
{
"name": "userId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "123EXAMPLE-a1b2c3d4-5678-90ab-cdef-33333EXAMPLE"
}
}
}
]
}
```
1. (Opcional) Adicione um atributo que especifique a ID do remetente padrão para notificações por mensagens SMS (texto). A ID do remetente é exibida como o remetente da mensagem em mensagens enviadas pelo Amazon Simple Notification Service (Amazon SNS). Para obter mais informações, consulte [Solicitar uma ID de remetente AWS End User Messaging SMS no](https://docs.aws.amazon.com/sms-voice/latest/userguide/sender-id-request.html) *Guia do AWS End User Messaging SMS usuário*.
```
{
...
"assetModelProperties": [
...
{
"name": "senderId",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "MyFactory"
}
}
}
]
}
```
1. (Opcional) Adicione um atributo que especifique o endereço de e-mail padrão a ser usado como endereço *De* nas notificações por e-mail.
```
{
...
"assetModelProperties": [
...
{
"name": "fromAddress",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "my.factory@example.com"
}
}
}
]
}
```
1. (Opcional) Adicione um atributo que especifique o assunto padrão a ser usado nas notificações por e-mail.
```
{
...
"assetModelProperties": [
...
{
"name": "emailSubject",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "[ALERT] High boiler temperature"
}
}
}
]
}
```
1. (Opcional) Adicione um atributo que especifique uma mensagem adicional a ser incluída nas notificações. Por padrão, as mensagens de notificação incluem informações sobre o alarme. Você também pode incluir uma mensagem adicional que forneça mais informações ao usuário.
```
{
...
"assetModelProperties": [
...
{
"name": "additionalMessage",
"dataType": "STRING",
"type": {
"attribute": {
"defaultValue": "Turn off the power before you check the alarm."
}
}
}
]
}
```
1. Crie o modelo de ativo ou atualize o modelo de ativo existente. Execute um destes procedimentos:
+ Para criar o modelo de ativo, execute o comando a seguir.
```
aws iotsitewise create-asset-model --cli-input-json file://asset-model-payload.json
```
+ Para atualizar o modelo de ativo existente, execute o comando a seguir. *asset-model-id*Substitua pelo ID do modelo de ativo.
```
aws iotsitewise update-asset-model \
--asset-model-id asset-model-id \
--cli-input-json file://asset-model-payload.json
```
Depois de executar o comando, observe o `assetModelId` na resposta.
#### Exemplo: modelo de ativos de caldeiras
O modelo de ativo a seguir representa uma caldeira que relata dados de temperatura. Esse modelo de ativos define um alarme que detecta quando a caldeira superaquece.
```
{
"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": {}
}
}
]
}
]
}
```
### Etapa 2: Definir um modelo AWS IoT Events de alarme
Crie o modelo de alarme em AWS IoT Events. Em AWS IoT Events, você usa *expressões* para especificar valores em modelos de alarme. Você pode usar expressões para especificar valores AWS IoT SiteWise para avaliar e usar como entradas para o alarme. Ao AWS IoT SiteWise enviar valores da propriedade do ativo para o modelo de alarme, AWS IoT Events avalia a expressão para obter o valor da propriedade ou o ID do ativo. Você pode usar as expressões a seguir no modelo de alarme:
+ **Valores de propriedade de ativos**
Para obter o valor de uma propriedade de ativos, use a expressão a seguir. *assetModelId*Substitua pela ID do modelo de ativo e *propertyId* substitua pela ID da propriedade.
```
$sitewise.assetModel.`assetModelId`.`propertyId`.propertyValue.value
```
+ **Ativo IDs**
Para obter a ID do ativo, use a expressão a seguir. *assetModelId*Substitua pela ID do modelo de ativo e *propertyId* substitua pela ID da propriedade.
```
$sitewise.assetModel.`assetModelId`.`propertyId`.assetId
```
**nota**
Ao criar o modelo de alarme, você pode definir literais em vez de expressões que são avaliadas como AWS IoT SiteWise valores. Isso pode reduzir o número de atributos que você define em seu modelo de ativo. No entanto, se você definir um valor como substantivo, não poderá personalizar esse valor nos ativos com base no modelo do ativo. Seus AWS IoT SiteWise Monitor usuários também não podem personalizar o alarme, pois podem definir as configurações de alarme somente nos ativos.
**Para criar um modelo AWS IoT Events de alarme (CLI)**
1. Ao criar o modelo de alarme em AWS IoT Events, você deve especificar o ID de cada propriedade que o alarme usa, o que inclui o seguinte:
+ A propriedade do estado do alarme no modelo de ativo composto
+ A propriedade que o alarme monitora
+ O atributo limite
+ (Opcional) O atributo de ID do repositório de identidades do Centro de identidade do IAM
+ (Opcional) O atributo de ID de usuário do Centro de identidade do IAM
+ (Opcional) O atributo de ID de remetente de SMS
+ (Opcional) O atributo e-mail do endereço *De*
+ (Opcional) O atributo do assunto do e-mail
+ (Opcional) O atributo adicional de mensagem
Execute o comando a seguir para recuperar essas propriedades no modelo de ativo. IDs *asset-model-id*Substitua pelo ID do modelo de ativo da etapa anterior.
```
aws iotsitewise describe-asset-model --asset-model-id asset-model-id
```
A operação retorna uma resposta que contém os detalhes do modelo de ativo. Anote a ID de cada propriedade que o alarme usa. Você os usa IDs ao criar o modelo de AWS IoT Events alarme na próxima etapa.
1. Crie o modelo de alarme em AWS IoT Events. Faça o seguinte:
1. Crie um arquivo chamado `alarm-model-payload.json`.
1. Copie o JSON a seguir no arquivo.
1. Insira um nome(`alarmModelName`), uma descrição (`alarmModelDescription`) e a gravidade (`severity`) para o alarme. Para gravidade, especifique um número inteiro que reflita os níveis de gravidade da sua empresa.
**Importante**
O modelo de alarme deve ter o mesmo nome do modelo de alarme composto que você definiu em seu modelo de ativo anteriormente.
Nomes de modelo de alarme podem conter apenas caracteres alfanuméricos.
```
{
"alarmModelName": "BoilerTemperatureHighAlarm",
"alarmModelDescription": "Detects when the boiler temperature is high.",
"severity": 3
}
```
1. Adicione a regra de comparação (`alarmRule`) para o alarme. Essa regra define a propriedade a ser monitorada (`inputProperty`), o valor limite a ser comparado (`threshold`) e o operador de comparação a ser usado (`comparisonOperator`).
+ *assetModelId*Substitua pelo ID do modelo de ativo.
+ *alarmPropertyId*Substitua pela ID da propriedade que o alarme monitora.
+ *thresholdAttributeId*Substitua pelo ID da propriedade do atributo de limite.
+ *GREATER*Substitua pelo operador a ser usado para comparar os valores da propriedade com o limite. Escolha uma das seguintes opções:
+ `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. Adicione uma ação (`alarmEventActions`) para enviar o estado do alarme para AWS IoT SiteWise quando o alarme muda de estado.
**nota**
Para configuração avançada, você pode definir ações adicionais a serem realizadas quando o alarme mudar de estado. Por exemplo, você pode chamar uma função AWS Lambda ou publicar em um tópico do MQTT. Para obter mais informações, consulte [Trabalhando com outros AWS serviços](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-other-aws-services.html) no *Guia do AWS IoT Events desenvolvedor*.
+ *assetModelId*Substitua pelo ID do modelo de ativo.
+ *alarmPropertyId*Substitua pela ID da propriedade que o alarme monitora.
+ *alarmStatePropertyId*Substitua pela ID da propriedade do estado do alarme no modelo composto do 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'"
}
}
]
}
}
```
1. (Opcional) Definir configurações de notificação de alarmes. A ação de notificação de alarme usa uma função do Lambda em sua conta para enviar notificações de alarme. Para obter mais informações, consulte [Requisitos para notificações de alarme em AWS IoT SiteWise](iot-events-alarm-notification-requirements.md). Nas configurações de notificação de alarme, você pode configurar notificações por SMS e e-mail para enviar aos usuários do Centro de identidade do IAM. Faça o seguinte:
1. Adicione a configuração de notificação de alarme (`alarmNotification`) à carga útil em `alarm-model-payload.json`.
+ *alarmNotificationFunctionArn*Substitua pelo ARN da função Lambda que gerencia as notificações de 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"
}
}
}
]
}
}
```
1. (Opcional) Configure as notificações por SMS (`smsConfigurations`) para enviar a um usuário do Centro de identidade do IAM quando o alarme mudar de estado.
+ *identityStoreIdAttributeId*Substitua pelo ID do atributo que contém o ID do repositório de identidades do IAM Identity Center.
+ *userIdAttributeId*Substitua pelo ID do atributo que contém o ID do usuário do IAM Identity Center.
+ *senderIdAttributeId*Substitua pelo ID do atributo que contém o ID do remetente do Amazon SNS ou remova-o `senderId` da carga.
+ *additionalMessageAttributeId*Substitua pela ID do atributo que contém a mensagem adicional ou remova `additionalMessage` da carga.
```
{
"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 as notificações por e-mail (`emailConfigurations`) para enviar a um usuário do Centro de identidade do IAM quando o alarme mudar de estado.
+ *identityStoreIdAttributeId*Substitua pelo ID da propriedade do atributo ID do repositório de identidades do IAM Identity Center.
+ *userIdAttributeId*Substitua pelo ID da propriedade do atributo ID do usuário do IAM Identity Center.
+ *fromAddressAttributeId*Substitua pela ID da propriedade do atributo de endereço “de” ou remova `from` da carga.
+ *emailSubjectAttributeId*Substitua pela ID da propriedade do atributo do assunto do e-mail ou `subject` remova da carga.
+ *additionalMessageAttributeId*Substitua pela ID da propriedade adicional do atributo da mensagem ou `additionalMessage` remova da carga.
```
{
"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) Adicione as funcionalidades de alarme (`alarmCapabilities`) à carga útil em `alarm-model-payload.json`. Nesse objeto, você pode especificar se o fluxo de reconhecimento está habilitado e o estado de habilitação padrão para ativos com base no modelo do ativo. Para obter mais informações sobre o fluxo de reconhecimento, consulte [Estados de alarme](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. Adicione a função de serviço do IAM (`roleArn`) que AWS IoT Events pode assumir o envio de dados para AWS IoT SiteWise. Esse perfil requer a permissão `iotsitewise:BatchPutAssetPropertyValue` e um relacionamento de confiança que permita que `iotevents.amazonaws.com` assuma o perfil. Para enviar notificações, esse perfil também requer as permissões `lambda:InvokeFunction` e `sso-directory:DescribeUser`. Para obter mais informações, consulte [Perfis de serviço de alarme](https://docs.aws.amazon.com/iotevents/latest/developerguide/security-iam.html) no *Guia do desenvolvedor do AWS IoT Events *.
+ `roleArn`Substitua o pelo ARN da função que AWS IoT Events pode assumir para realizar essas ações.
```
{
"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. Execute o comando a seguir para criar o modelo de AWS IoT Events alarme a partir da carga em`alarm-model-payload.json`.
```
aws iotevents create-alarm-model --cli-input-json file://alarm-model-payload.json
```
1. A operação retorna uma resposta que inclui o ARN do modelo de alarme, `alarmModelArn` Copie esse ARN para configurar a definição de alarme em seu modelo de ativo na próxima etapa.
### Etapa 3: Habilitar o fluxo de dados entre AWS IoT SiteWise e AWS IoT Events
Depois de criar os recursos necessários em AWS IoT SiteWise e AWS IoT Events, você pode ativar o fluxo de dados entre os recursos para ativar seu alarme. Nesta seção, você atualiza a definição de alarme no modelo de ativo para usar o modelo de alarme criado na etapa anterior.
**Para habilitar o fluxo de dados entre AWS IoT SiteWise e AWS IoT Events (CLI)**
+ Defina o modelo de alarme como a fonte do alarme no modelo de ativo. Faça o seguinte:
1. Execute o seguinte comando para recuperar a definição do modelo de ativo existente. *asset-model-id*Substitua pelo ID do modelo de ativo.
```
aws iotsitewise describe-asset-model --asset-model-id asset-model-id
```
A operação retorna uma resposta que contém os detalhes do modelo de ativo.
1. Crie um arquivo chamado `update-asset-model-payload.json` e copie a resposta do comando anterior no arquivo.
1. Remova os seguintes pares de chave-valor do arquivo `update-asset-model-payload.json`:
+ `assetModelId`
+ `assetModelArn`
+ `assetModelCreationDate`
+ `assetModelLastUpdateDate`
+ `assetModelStatus`
1. Adicione a propriedade da fonte de alarme (`AWS/ALARM_SOURCE`) ao modelo de alarme composto que você definiu anteriormente. *alarmModelArn*Substitua pelo ARN do modelo de alarme, que define o valor da propriedade da fonte de 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"
}
}
}
]
}
]
}
```
1. Execute o seguinte comando para atualizar o modelo de ativo com a definição armazenada no arquivo `update-asset-model-payload.json`. *asset-model-id*Substitua pelo ID do modelo de ativo.
```
aws iotsitewise update-asset-model \
--asset-model-id asset-model-id \
--cli-input-json file://update-asset-model-payload.json
```
Seu modelo de ativo agora define um alarme que detecta em AWS IoT Events. O alarme monitora a propriedade de destino em todos os ativos com base nesse modelo de ativo. Você pode configurar o alarme em cada ativo para personalizar propriedades como o limite ou o destinatário do Centro de identidade do IAM para cada ativo. Para obter mais informações, consulte [Configure alarmes em ativos no AWS IoT SiteWise](configure-alarms.md).
# Defina alarmes externos em AWS IoT SiteWise
Os alarmes externos contêm o estado de um alarme que você detecta fora do AWS IoT SiteWise.
## Definir um alarme externo (console)
Você pode usar o AWS IoT SiteWise console para definir um alarme externo em um modelo de ativo existente. Para definir um alarme externo em um novo modelo de ativo, crie o modelo de ativo e execute essas etapas. Para obter mais informações, consulte [Crie modelos de ativos em AWS IoT SiteWise](create-asset-models.md).
**Para definir um alarme em um modelo de ativo**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Modelos**.
1. Escolha o modelo de ativo para o qual o alarme será definido.
1. Escolha a guia **Definições de alarme**.
1. Escolha **Adicionar alarme**.
1. Em **Opções do tipo de alarme**, escolha **Alarme externo**.
1. Insira um nome para o alarme.
1. (Opcional) Insira uma descrição do seu alarme.
1. Escolha **Adicionar alarme**.
## Definir um alarme externo (CLI)
Você pode usar o AWS CLI para definir um alarme externo em um modelo de ativo novo ou existente.
Para adicionar um alarme externo a um modelo de ativo, você adiciona um modelo de alarme composto ao modelo de ativo. Um modelo de alarme composto especifica o tipo do `EXTERNAL` e não especifica uma propriedade da fonte de alarme. O exemplo de alarme composto a seguir define um alarme externo 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 obter mais informações sobre como adicionar um modelo composto a um modelo de ativo novo ou existente, consulte o seguinte:
+ [Criar um modelo de ativo (AWS CLI)](create-asset-models.md#create-asset-model-cli)
+ [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli)
Depois de definir o alarme externo, você pode ingerir o estado do alarme nos ativos com base no modelo do ativo. Para obter mais informações, consulte [Ingerir um estado de alarme externo em AWS IoT SiteWise](ingest-external-alarm-state.md).
# Configure alarmes em ativos no AWS IoT SiteWise
Depois de definir um AWS IoT Events alarme em um modelo de ativo, você pode configurar o alarme em cada ativo com base no modelo de ativo. Você pode editar o valor limite e as configurações de notificação do alarme. Cada um desses valores é um atributo no ativo, então você pode atualizar o valor padrão do atributo para configurar esses valores.
**nota**
Você pode configurar esses valores para AWS IoT Events alarmes, mas não para alarmes externos.
**Topics**
+ [Configurar um valor limite (console)](#configure-alarm-threshold-value-console)
+ [Configurar um valor limite (AWS CLI)](#configure-alarm-threshold-value-cli)
+ [Defina as configurações de notificação em AWS IoT SiteWise](configure-alarm-notification-settings.md)
## Configurar um valor limite (console)
Você pode usar o AWS IoT SiteWise console para atualizar o valor do atributo que especifica o valor limite de um alarme.
**Para atualizar o valor limite de um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual você deseja atualizar um valor limite de alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha **Editar**.
1. Encontre o atributo que o alarme usa para seu valor limite e, então, insira seu novo valor.
1. Escolha **Salvar**.
## Configurar um valor limite (AWS CLI)
Você pode usar o AWS Command Line Interface (AWS CLI) para atualizar o valor do atributo que especifica o valor limite de um alarme.
Para executar este procedimento, é necessário saber quais são o `assetId` do ativo e o `propertyId` da propriedade. Você também pode usar o ID externo. Se você criou um ativo e não o conhece`assetId`, use a [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para listar todos os ativos de um modelo específico. Use a [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operação para visualizar as propriedades do seu ativo, incluindo propriedades IDs.
Use a operação [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) para atribuir valores de atributo ao ativo. É possível usar essa operação para definir vários atributos de uma vez. A carga útil dessa operação contém uma lista de entradas, e cada entrada contém a ID do ativo, a ID da propriedade e o valor do atributo.
**Como atualizar o valor de um atributo (AWS CLI)**
1. Crie um arquivo chamado `batch-put-payload.json` e copie o seguinte objeto JSON no arquivo. Este exemplo de carga útil demonstra como definir a latitude e a longitude de uma turbina eólica. Atualize os IDs valores e os carimbos de data/hora para modificar a carga útil do seu 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 na carga contém um `entryId` que você pode definir como qualquer string exclusiva. Se qualquer entrada de solicitação falhar, cada erro conterá o `entryId` da solicitação correspondente, para que você saiba quais solicitações tentar novamente.
+ Para definir um valor de atributo, você pode incluir uma estrutura timestamp-quality-value (TQV) na lista de `propertyValues` para cada propriedade de atributo. Essa estrutura deve conter o novo `value` e o `timestamp` atual.
+ `value` – uma estrutura contendo um dos valores a seguir, a depender do tipo de propriedade sendo definida:
+ `booleanValue`
+ `doubleValue`
+ `integerValue`
+ `stringValue`
+ `nullValue`
+ `timestamp`— Uma estrutura que contém o tempo atual da época do Unix em segundos,. `timeInSeconds` AWS IoT SiteWise rejeita todos os pontos de dados com carimbos de data/hora que existiam há mais de 7 dias ou menos de 5 minutos no futuro.
Para obter mais informações sobre como preparar uma carga útil para [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html), consulte [Ingira dados com AWS IoT SiteWise APIs](ingest-api.md).
1. Execute o seguinte comando para enviar os valores de atributo ao AWS IoT SiteWise:
```
aws iotsitewise batch-put-asset-property-value -\-cli-input-json file://batch-put-payload.json
```
# Defina as configurações de notificação em AWS IoT SiteWise
Você pode definir as configurações de notificação de alarme usando o AWS IoT SiteWise console ou o AWS Command Line Interface (AWS CLI).
## Definir configurações de notificação (console)
Você pode usar o AWS IoT SiteWise console para atualizar o valor dos atributos que especificam as configurações de notificação para um alarme.
**Para atualizar as configurações de notificação de um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual você deseja atualizar as configurações do alarme.
1. Escolha **Editar**.
1. Encontre o atributo que o alarme usa para a configuração de notificação que você quer alterar e, em seguida, insira seu novo valor.
1. Escolha **Salvar**.
## Definir configurações de notificação (CLI)
Você pode usar o AWS Command Line Interface (AWS CLI) para atualizar o valor do atributo que especifica as configurações de notificação para um alarme.
Para executar este procedimento, é necessário saber quais são o `assetId` do ativo e o `propertyId` da propriedade. Você também pode usar o ID externo. Se você criou um ativo e não o conhece`assetId`, use a [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para listar todos os ativos de um modelo específico. Use a [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operação para visualizar as propriedades do seu ativo, incluindo propriedades IDs.
Use a operação [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html) para atribuir valores de atributo ao ativo. É possível usar essa operação para definir vários atributos de uma vez. A carga útil dessa operação contém uma lista de entradas, e cada entrada contém a ID do ativo, a ID da propriedade e o valor do atributo.
**Como atualizar o valor de um atributo (AWS CLI)**
1. Crie um arquivo chamado `batch-put-payload.json` e copie o seguinte objeto JSON no arquivo. Este exemplo de carga útil demonstra como definir a latitude e a longitude de uma turbina eólica. Atualize os IDs valores e os carimbos de data/hora para modificar a carga útil do seu 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 na carga contém um `entryId` que você pode definir como qualquer string exclusiva. Se qualquer entrada de solicitação falhar, cada erro conterá o `entryId` da solicitação correspondente, para que você saiba quais solicitações tentar novamente.
+ Para definir um valor de atributo, você pode incluir uma estrutura timestamp-quality-value (TQV) na lista de `propertyValues` para cada propriedade de atributo. Essa estrutura deve conter o novo `value` e o `timestamp` atual.
+ `value` – uma estrutura contendo um dos valores a seguir, a depender do tipo de propriedade sendo definida:
+ `booleanValue`
+ `doubleValue`
+ `integerValue`
+ `stringValue`
+ `nullValue`
+ `timestamp`— Uma estrutura que contém o tempo atual da época do Unix em segundos,. `timeInSeconds` AWS IoT SiteWise rejeita todos os pontos de dados com carimbos de data/hora que existiam há mais de 7 dias ou menos de 5 minutos no futuro.
Para obter mais informações sobre como preparar uma carga útil para [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html), consulte [Ingira dados com AWS IoT SiteWise APIs](ingest-api.md).
1. Execute o seguinte comando para enviar os valores de atributo ao AWS IoT SiteWise:
```
aws iotsitewise batch-put-asset-property-value -\-cli-input-json file://batch-put-payload.json
```
# Responda aos alarmes em AWS IoT SiteWise
Quando um AWS IoT Events alarme muda de estado, você pode fazer o seguinte para responder ao alarme:
+ Reconheça um alarme para indicar que você está lidando com o problema.
+ Adie um alarme para desabilitá-lo temporariamente.
+ Desabilite um alarme para desabilitá-lo permanentemente até que você o habilite novamente.
+ Habilite um alarme desabilitado para detectar o estado do alarme.
+ Reconfigure um alarme para limpar seu estado e o valor mais recente.
Você pode usar o AWS IoT SiteWise console ou a AWS IoT Events API para responder a um alarme.
**nota**
Você pode responder aos AWS IoT Events alarmes, mas não aos alarmes externos.
**Topics**
+ [Responder a um alarme (console)](#respond-to-alarm-console)
+ [Responder a um alarme (API)](#respond-to-alarm-cli)
## Responder a um alarme (console)
Você pode usar o AWS IoT SiteWise console para reconhecer, adiar, desativar ou ativar um alarme.
**Topics**
+ [Reconhecer um alarme (console)](#acknowledge-alarm-console)
+ [Adiar um alarme (console)](#snooze-alarm-console)
+ [Desabilitar um alarme (console)](#disable-alarm-console)
+ [Habilitar um alarme (console)](#enable-alarm-console)
+ [Reconfigurar um alarme (console)](#reset-alarm-console)
### Reconhecer um alarme (console)
Você pode reconhecer um alarme para indicar que está lidando com o problema.
**nota**
Você deve habilitar o fluxo de reconhecimento no alarme para poder reconhecer o alarme. Essa opção é habilitada por padrão se você definir o alarme no console do AWS IoT SiteWise .
**Para reconhecer um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja reconhecer um alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha a guia **Alarmes**.
1. Selecione o alarme a ser reconhecido e, em seguida, escolha **Ações** para abrir o menu de ação de resposta.
1. Escolha **Reconhecer**. O estado do alarme muda para **Confirmado.**
### Adiar um alarme (console)
Você pode adiar um alarme para desabilitá-lo temporariamente. Especifique o período de adiamento do alarme.
**Para adiar um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja adiar um alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha a guia **Alarmes**.
1. Selecione o alarme a adiar e, depois, escolha **Ações** para abrir o menu de ação de resposta.
1. Escolha **Adiar**. Um modelo é aberto onde você especifica a duração do adiamento.
1. Escolha a **Duração do adiamento** ou insira uma **Duração de adiamento personalizada**.
1. Escolha **Salvar**. O estado do alarme muda para **Adiado**.
### Desabilitar um alarme (console)
Você pode desabilitar um alarme para que ele não detecte mais. Depois de desabilitar o alarme, você deve habilitá-lo novamente se quiser que o alarme detecte.
**Para desabilitar um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja desabilitar um alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha a guia **Alarmes**.
1. Selecione o alarme a ser desabilitado e, em seguida, escolha **Ações** para abrir o menu de ação de resposta.
1. Escolha **Desabilitar**. O estado do alarme muda para **Desabilitado**.
### Habilitar um alarme (console)
Você pode habilitar um alarme detectar novamente depois de desabilitá-lo ou adiá-lo.
**Para habilitar um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja habilitar um alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha a guia **Alarmes**.
1. Selecione o alarme a ser habilitado e, em seguida, escolha **Ações** para abrir o menu de ação de resposta.
1. Escolha **Habilitar**. O estado do alarme muda para **Normal**.
### Reconfigurar um alarme (console)
Você pode reconfigurar um alarme para limpar seu estado e o valor mais recente.
**Para reconfigurar um alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja reconfigurar um alarme.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha a guia **Alarmes**.
1. Selecione o alarme a ser habilitado e, em seguida, escolha **Ações** para abrir o menu de ação de resposta.
1. Escolha **Redefinir**. O estado do alarme muda para **Normal**.
## Responder a um alarme (API)
Você pode usar a AWS IoT Events API para reconhecer, adiar, desativar, ativar ou redefinir um alarme. Para obter mais informações, consulte as seguintes operações em *Referência de API do 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 obter mais informações, consulte [Responder a alarmes](https://docs.aws.amazon.com/iotevents/latest/developerguide/respond-to-alarms.html), no *Guia do desenvolvedor do AWS IoT Events *.
# Ingerir um estado de alarme externo em AWS IoT SiteWise
Alarmes externos são alarmes que você avalia externamente. AWS IoT SiteWise Você pode usar alarmes externos quando você tem uma fonte de dados que relata o estado do alarme que você deseja ingerir em AWS IoT SiteWise.
As propriedades do estado do alarme exigem um formato específico para os valores dos dados do estado do alarme. Cada valor de dados deve ser um objeto JSON serializado em uma string. Então, você ingere a string serializada como um valor de string. Para obter mais informações, consulte [Propriedades do estado do alarme](industrial-alarms.md#alarm-state-properties).
**Example Exemplo de valor de dados do estado do alarme (não serializado)**
```
{
"stateName": "Active"
}
```
**Example Exemplo de valor de dados do estado do alarme (serializado)**
```
{\"stateName\":\"Active\"}
```
**nota**
Se sua fonte de dados não puder relatar dados nesse formato ou você não puder converter seus dados nesse formato antes de ingeri-los, você pode optar por não usar uma propriedade de alarme. Em vez disso, você pode ingerir os dados como uma propriedade de medição com o tipo de dados de string, por exemplo. Para obter mais informações, consulte [Definir fluxos de dados de equipamentos (medições)](measurements.md) e [Ingerir dados para AWS IoT SiteWise](industrial-data-ingestion.md).
# Mapeie fluxos externos de estado de alarme em AWS IoT SiteWise
Você pode definir aliases de propriedades para mapear seus fluxos de dados para suas propriedades de estado de alarme. Isso ajuda você a identificar facilmente uma propriedade do estado de alarme ao ingerir ou recuperar dados. Para obter mais informações sobre propriedade de aliases, consulte [Gerencie fluxos de dados para AWS IoT SiteWise](manage-data-streams.md).
**Topics**
+ [Mapear fluxos de estado de alarme externo (console)](#connect-alarm-data-stream-console)
+ [Mapear fluxos de estado de alarme externo (AWS CLI)](#connect-alarm-data-stream-cli)
## Mapear fluxos de estado de alarme externo (console)
Você pode definir aliases de propriedades para mapear seus fluxos de dados para suas propriedades de estado de alarme. Isso ajuda você a identificar facilmente uma propriedade do estado de alarme ao ingerir ou recuperar dados. Para obter mais informações sobre propriedade de aliases, consulte [Gerencie fluxos de dados para AWS IoT SiteWise](manage-data-streams.md).
Você pode usar o AWS IoT SiteWise console para definir um alias para uma propriedade de estado de alarme.
**Para definir um alias de propriedade para uma propriedade de estado de alarme (console)**
1. Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).
1. No painel de navegação, selecione **Ativos**.
1. Escolha o ativo para o qual deseja definir um apelido de propriedade.
**dica**
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.
1. Escolha **Editar**.
1. Role a tela até **Alarmes** e expanda a seção.
1. Em **Alarmes externos**, insira o alias em **Alias de propriedade – *opcional***.
1. Escolha **Salvar**.
## Mapear fluxos de estado de alarme externo (AWS CLI)
Você pode definir aliases de propriedades para mapear seus fluxos de dados para suas propriedades de estado de alarme. Isso ajuda você a identificar facilmente uma propriedade do estado de alarme ao ingerir ou recuperar dados. Para obter mais informações sobre propriedade de aliases, consulte [Gerencie fluxos de dados para AWS IoT SiteWise](manage-data-streams.md).
Você pode usar o AWS Command Line Interface (AWS CLI) para definir um alias para uma propriedade de estado de alarme.
Para executar este procedimento, é necessário saber quais são o `assetId` do ativo e o `propertyId` da propriedade. Você também pode usar o ID externo. Se você criou um ativo e não o conhece`assetId`, use a [ListAssets](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ListAssets.html)API para listar todos os ativos de um modelo específico. Use a [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)operação para visualizar as propriedades do seu ativo, incluindo propriedades IDs.
**nota**
A [DescribeAsset](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAsset.html)resposta inclui a lista de modelos de ativos compostos para o ativo. Cada alarme é um modelo composto. Para encontrar o `propertyId`, encontre o modelo composto para o alarme e, em seguida, encontre a propriedade do `AWS/ALARM_STATE` nesse modelo composto.
Para obter informações sobre como definir a o alias da propriedade, consulte [Atualizar um alias de propriedade do ativo](update-data-streams-method.md).
# Ingerir dados do estado do alarme em AWS IoT SiteWise
As propriedades do estado do alarme esperam que o estado do alarme seja uma string JSON serializada. Para inserir o estado de alarme em um alarme externo AWS IoT SiteWise, você ingere essa string serializada como um valor de string com carimbo de data e hora. O exemplo a seguir demonstra um valor de dados de estado para um alarme ativo.
```
{\"stateName\":\"Active\"}
```
Para identificar uma propriedade de estado de alarme, você pode especificar um dos seguintes elementos:
+ O `assetId` e `propertyId` da propriedade do alarme para o qual você está enviando dados.
+ O `propertyAlias`, que é um alias de fluxo de dados (por exemplo, `/company/windfarm/3/turbine/7/temperature/high`). Para usar esta opção, primeiro você deve definir o alias da propriedade do seu alarme. Para saber como definir aliases de propriedades para propriedades de estado do alarme, consulte [Mapeie fluxos externos de estado de alarme em AWS IoT SiteWise](connect-alarm-data-streams.md).
O exemplo de carga útil [BatchPutAssetPropertyValue](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html)da API a seguir demonstra como formatar o estado de um alarme externo. Esse alarme externo relata quando a leitura de rotações por minuto (RPM) de uma turbina eólica está muito alta.
**Example Exemplo de BatchPutAssetPropertyValue carga útil para dados de estado de alarme**
```
{
"entries": [
{
"entryId": "unique entry ID",
"propertyAlias": "/company/windfarm/3/turbine/7/temperature/high",
"propertyValues": [
{
"value": {
"stringValue": "{\"stateName\":\"Active\"}"
},
"timestamp": {
"timeInSeconds": 1607550262
}
}
]
}
]
}
```
Para obter mais informações sobre como usar a API `BatchPutAssetPropertyValue` para ingerir dados, consulte [Ingira dados com AWS IoT SiteWise APIs](ingest-api.md).
Para obter mais informações outras formas de ingerir dados, consulte [Ingerir dados para AWS IoT SiteWise](industrial-data-ingestion.md).