

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á.

# Interaja com outros AWS serviços
<a name="interact-with-other-services"></a>

AWS IoT SiteWise pode publicar dados de ativos no agente de mensagens de publicação e assinatura do AWS IoT MQTT, para que você possa interagir com seus dados de ativos de outros serviços. AWS AWS IoT SiteWise atribui a cada propriedade do ativo um tópico MQTT exclusivo que você pode usar para rotear seus dados de ativos para outros AWS serviços usando as regras AWS IoT principais. Por exemplo, você pode configurar as regras AWS IoT principais para realizar as seguintes tarefas:
+ Identificar falhas no equipamento e notificar o pessoal adequado enviando dados para o [AWS IoT Events](https://docs.aws.amazon.com/iotevents/latest/developerguide/).
+ Criar um histórico dos dados de ativos selecionados para uso em soluções de software externas enviando dados para o [Amazon DynamoDB](https://docs.aws.amazon.com/dynamodb/).
+ Gerar relatórios semanais acionando uma função do [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/).

Você pode seguir um tutorial que percorre as etapas necessárias para configurar uma regra que armazena valores de propriedade no DynamoDB. Para obter mais informações, consulte [Publicar atualizações de valores de propriedade no Amazon DynamoDB](publish-to-amazon-dynamodb.md).

Para obter mais informações sobre como configurar uma regra, consulte [Rules](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html) no *AWS IoT Developer Guide*.

Você também pode voltar a consumir dados de outros AWS serviços AWS IoT SiteWise. Para ingerir dados por meio da ação de AWS IoT SiteWise regra, consulte[Ingira dados para AWS IoT SiteWise usar regras AWS IoT Core](iot-rules.md).

**Topics**
+ [Noções básicas sobre as propriedades de ativo em tópicos MQTT](mqtt-topics.md)
+ [Ative as notificações de propriedades de ativos em AWS IoT SiteWise](property-notifications.md)
+ [Consulte notificações de propriedades de ativos em AWS IoT SiteWise](query-notification-messages.md)
+ [Exportar dados para o Amazon S3 com notificações de propriedades de ativo](export-to-s3.md)
+ [Integre AWS IoT SiteWise com a Grafana](grafana-integration.md)
+ [Integre AWS IoT SiteWise e AWS IoT TwinMaker](integrate-tm.md)
+ [Detectar anomalias com o Lookout for Equipment](anomaly-detection.md)

# Noções básicas sobre as propriedades de ativo em tópicos MQTT
<a name="mqtt-topics"></a>

Cada propriedade de ativo tem um caminho de tópico MQTT exclusivo no formato a seguir.

```
$aws/sitewise/asset-models/assetModelId/assets/assetId/properties/propertyId
```

**nota**  
AWS IoT SiteWise não suporta o caractere curinga do filtro de tópicos `#` (de vários níveis) no mecanismo de regras AWS IoT principais. Use o caractere curinga `+` (de nível único). Por exemplo, use o filtro de tópico a seguir para fazer a correspondência de todas as atualizações de um modelo de ativo específico.  

```
$aws/sitewise/asset-models/assetModelId/assets/+/properties/+
```
Para saber mais sobre caracteres curinga de filtro de tópico, consulte [Tópicos](https://docs.aws.amazon.com/iot/latest/developerguide/topics.html) no *Guia do desenvolvedor da Core AWS IoT *.

# Ative as notificações de propriedades de ativos em AWS IoT SiteWise
<a name="property-notifications"></a>

Você pode ativar as notificações de propriedades para publicar atualizações de dados de ativos e AWS IoT Core, em seguida, executar consultas em seus dados. Com notificações de propriedades de ativos, AWS IoT SiteWise fornece um CloudFormation modelo que você pode usar para exportar AWS IoT SiteWise dados para o Amazon S3.

**nota**  
Os dados do ativo são enviados AWS IoT Core sempre que são recebidos AWS IoT SiteWise, independentemente de o valor ter sido alterado.

**Topics**
+ [Ativar notificações de propriedades de ativo (console)](#enable-property-notifications-console)
+ [Ativar notificações de propriedades de ativo (AWS CLI)](#enable-property-notifications-cli)

## Ativar notificações de propriedades de ativo (console)
<a name="enable-property-notifications-console"></a>

Por padrão, AWS IoT SiteWise não publica atualizações de valores de propriedades. Você pode usar o AWS IoT SiteWise console para ativar as notificações para uma propriedade do ativo.

**Como habilitar ou desabilitar notificações de propriedade de um ativo (console)**

1. <a name="sitewise-open-console"></a>Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).

1. <a name="sitewise-choose-assets"></a>No painel de navegação, selecione **Ativos**.

1. Escolha o ativo para habilitar as notificações de uma propriedade.
**dica**  <a name="sitewise-expand-asset-hierarchy"></a>
Você pode escolher o ícone de seta para expandir uma hierarquia de ativos para localizar seu ativo.

1. Escolha **Editar**.

1. Para o **Status da notificação** da propriedade de ativo, escolha **HABILITADO**.  
![\[AWS IoT SiteWise Captura de tela da página “Editar ativo” com “Status da notificação” destacado.\]](http://docs.aws.amazon.com/pt_br/iot-sitewise/latest/userguide/images/sitewise-enable-property-notifications-console.png)

   Você também pode escolher **DESABILITADO** para desabilitar notificações para a propriedade do ativo.

1. Escolha **Salvar**.

## Ativar notificações de propriedades de ativo (AWS CLI)
<a name="enable-property-notifications-cli"></a>

Por padrão, AWS IoT SiteWise não publica atualizações de valores de propriedades. Você pode usar o AWS Command Line Interface (AWS CLI) para ativar ou desativar as notificações de uma propriedade do ativo.

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 [UpdateAssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)operação para ativar ou desativar as notificações de uma propriedade do ativo. Especifique os seguintes parâmetros:
+ `assetId` – a ID do ativo.
+ `propertyId` – a ID da propriedade do ativo.
+ `propertyNotificationState` – o estado de notificação do valor da propriedade: `ENABLED` ou `DISABLED`.
+ `propertyAlias` – o alias da propriedade. Especifique o alias existente da propriedade ao atualizar o estado da notificação. Se você omitir esse parâmetro, o alias existente da propriedade será removido.

**Como habilitar ou desabilitar notificações para a propriedade de um ativo (CLI)**

1. Execute o seguinte comando para recuperar o alias da propriedade de ativo. *asset-id*Substitua pela ID do ativo e *property-id* pela ID da propriedade.

   ```
   aws iotsitewise describe-asset-property \
     --asset-id asset-id \
     --property-id property-id
   ```

   A operação retorna uma resposta que contém os detalhes da propriedade do ativo no formato a seguir. O alias da propriedade está em `assetProperty.alias` no objeto JSON.

   ```
   {
     "assetId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
     "assetName": "Wind Turbine 7",
     "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
     "assetProperty": {
       "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
       "name": "Wind Speed",
       "alias": "/company/windfarm/3/turbine/7/windspeed",
       "notification": {
         "topic": "$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE",
         "state": "DISABLED"
       },
       "dataType": "DOUBLE",
       "unit": "m/s",
       "type": {
         "measurement": {}
       }
     }
   }
   ```

1. Execute o seguinte comando para habilitar notificações para a propriedade de ativo. *property-alias*Substitua pelo alias da propriedade da resposta do comando anterior ou omita `--property-alias` a atualização da propriedade sem um alias.

   ```
   aws iotsitewise update-asset-property \
     --asset-id asset-id \
     --property-id property-id \
     --property-notification-state ENABLED \
     --property-alias property-alias
   ```

   Você também pode passar `--property-notification-state DISABLED` para desabilitar notificações para a propriedade de ativo.

# Consulte notificações de propriedades de ativos em AWS IoT SiteWise
<a name="query-notification-messages"></a>

Para consultar notificações de propriedades de ativos, crie AWS IoT Core regras compostas por instruções SQL.

AWS IoT SiteWise publica atualizações de dados de propriedades de ativos no AWS IoT Core no seguinte formato.

```
{
  "type": "PropertyValueUpdate",
  "payload": {
    "assetId": "String",
    "propertyId": "String",
    "values": [
      {
        "timestamp": {
          "timeInSeconds": Number,
          "offsetInNanos": Number
        },
        "quality": "String",
        "value": {
          "booleanValue": Boolean,
          "doubleValue": Number,
          "integerValue": Number,
          "stringValue": "String",
          "nullValue": {
            "valueType": "String
            }           
        }
      }
    ]
  }
}
```

Cada estrutura na `values` lista é uma estrutura timestamp-quality-value (TQV).
+ O `timestamp` contém o horário Unix epoch atual em segundos, com correção em nanossegundos.
+ `quality` contém uma das seguintes strings, que indicam a qualidade do ponto de dados:
  + `GOOD` – os dados não são afetados por nenhum problema.
  + `BAD` – os dados são afetados por um problema, como a falha do sensor.
  + `UNCERTAIN` – os dados são afetados por um problema, como a imprecisão do sensor.
+ O `value` contém um dos campos a seguir, a depender do tipo de propriedade:
  + `booleanValue`
  + `doubleValue`
  + `integerValue`
  + `stringValue`
  + `nullValue`

`nullValue`— Uma estrutura com o campo a seguir indicando o tipo do valor da propriedade com valor Nulo e qualidade de `BAD` ou. `UNCERTAIN`
+ `valueType`— Enumeração de \$1"B”, “D”, “S”, “I"\$1

Para analisar valores fora da matriz `values`, é necessário usar consultas complexas de objetos aninhados nas instruções SQL das regras. Para obter mais informações, consulte [NConsultas de objeto aninhado](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-nested-queries.html) no *AWS IoT Guia do desenvolvedor* ou consulte o [Publicar atualizações de valores de propriedade no Amazon DynamoDB](publish-to-amazon-dynamodb.md) tutorial para ver um exemplo específico de análise de mensagens de notificação de propriedade de ativos.

**Example Exemplo de consulta para extrair a matriz de valores**  
A instrução a seguir demonstra como consultar a matriz de valores de propriedade atualizados para uma propriedade específica de tipo duplo em todos os ativos com essa propriedade.  

```
SELECT
  (SELECT VALUE (value.doubleValue) FROM payload.values) AS windspeed
FROM
  '$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/+/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE' 
WHERE
  type = 'PropertyValueUpdate'
```
A instrução de consulta de regra anterior produz dados no formato a seguir.  

```
{
  "windspeed": [
    26.32020195042838,
    26.282584572975477,
    26.352566977372508,
    26.283084346171442,
    26.571883739599322,
    26.60684140743005,
    26.628738636715045,
    26.273486932802125,
    26.436379105473964,
    26.600590095377303
  ]
}
```

**Example Exemplo de consulta para extrair um único valor**  
A instrução a seguir demonstra como consultar o primeiro valor da matriz de valores de propriedade para uma propriedade específica de tipo duplo em todos os ativos com essa propriedade.  

```
SELECT
  get((SELECT VALUE (value.doubleValue) FROM payload.values), 0) AS windspeed
FROM
  '$aws/sitewise/asset-models/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE/assets/+/properties/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE' 
WHERE
  type = 'PropertyValueUpdate'
```

A instrução de consulta de regra anterior produz dados no formato a seguir.

```
{
  "windspeed": 26.32020195042838
}
```

**Importante**  
Essa instrução de consulta de regra ignora atualizações de valor diferentes da primeira em cada lote. Cada lote pode conter até 10 valores. Se você precisar incluir os valores restantes, deverá configurar uma solução mais complexa para gerar valores de propriedade do ativo para outros serviços. Por exemplo, você pode configurar uma regra com uma AWS Lambda ação para republicar cada valor na matriz em outro tópico e configurar outra regra para consultar esse tópico e publicar cada valor na ação de regra desejada.

# Exportar dados para o Amazon S3 com notificações de propriedades de ativo
<a name="export-to-s3"></a>

Você pode exportar dados recebidos AWS IoT SiteWise para um bucket do Amazon S3 em sua conta. Você pode fazer backup de seus dados em um formato que permite criar relatórios históricos ou analisar os dados com métodos complexos. 

 Para exportar dados de séries temporais de AWS IoT SiteWise, habilite o recurso de camada fria para que os dados sejam armazenados em um bucket do Amazon S3. Consulte [Gerenciar armazenamento de dados em AWS IoT SiteWise](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/manage-data-storage.html) para obter detalhes. 

 Para exportar modelos de ativos e metadados de ativos AWS IoT SiteWise, use o recurso de operações em massa para exportar metadados para um bucket do Amazon S3. Consulte [Operações em massa com ativos e modelos](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/bulk-operations-assets-and-models.html) para obter detalhes. 

# Integre AWS IoT SiteWise com a Grafana
<a name="grafana-integration"></a>

Grafana é uma plataforma de visualização de dados usada para visualizar e monitorar dados em painéis. Na versão 10.4.0 e posterior do Grafana, use o AWS IoT SiteWise plug-in para visualizar seus AWS IoT SiteWise dados de ativos nos painéis do Grafana. Os usuários podem visualizar dados de várias AWS fontes (como AWS IoT SiteWise Amazon Timestream CloudWatch e Amazon) e outras fontes de dados com um único painel da Grafana.

Você tem duas opções para usar o AWS IoT SiteWise plug-in:
+ **Servidores locais do Grafana**

  Você pode configurar o AWS IoT SiteWise plug-in em um servidor Grafana que você gerencia. Para obter mais informações sobre como adicionar e usar o plug-in, consulte o arquivo [README da AWS IoT SiteWise fonte de dados](https://github.com/grafana/iot-sitewise-datasource/blob/main/src/README.md) no site. GitHub 
+ **AWS Serviço gerenciado para Grafana**

  Você pode usar o AWS IoT SiteWise plug-in no AWS Managed Service for Grafana (AMG). A AMG gerencia os servidores Grafana para você, de modo que seja possível visualizar seus dados sem precisar criar, empacotar ou implantar qualquer hardware ou qualquer outra infraestrutura do Grafana. Para obter mais informações, consulte os tópicos a seguir no *AWS Guia do usuário do Managed Service for Grafana*:
  + [O que é o Amazon Managed Service for Grafana (AMG)?](https://docs.aws.amazon.com/grafana/latest/userguide/what-is-Amazon-Managed-Service-Grafana.html)
  + [Usando a fonte AWS IoT SiteWise de dados](https://docs.aws.amazon.com/grafana/latest/userguide/using-iotsitewise-in-AMG.html)

**Example Exemplo de painel do Grafana**  
O painel do Grafana a seguir visualiza o [parque eólico de demonstração](getting-started-demo.md). Você pode acessar este painel de demonstração no site do [Grafana Play](https://play.grafana.org/d/avzwehmz/demo-wind-farm?orgId=1).  

![\[Um exemplo de painel do Grafana que visualiza o parque eólico de AWS IoT SiteWise demonstração.\]](http://docs.aws.amazon.com/pt_br/iot-sitewise/latest/userguide/images/grafana-dashboard-example.png)


# Integre AWS IoT SiteWise e AWS IoT TwinMaker
<a name="integrate-tm"></a>

A integração com AWS IoT TwinMaker concede acesso a funcionalidades robustas AWS IoT SiteWise, como `ExecuteQuery` API de recuperação de AWS IoT SiteWise dados e pesquisa avançada de ativos no AWS IoT SiteWise console. Para integrar os serviços e usar esses recursos, você deve primeiro habilitar a integração.

**Topics**
+ [Habilitar a integração](#it-enable)
+ [Integrando e AWS IoT SiteWise AWS IoT TwinMaker](#it-integrate)

## Habilitar a integração
<a name="it-enable"></a>

Os administradores podem usar políticas AWS JSON para especificar quem tem acesso ao quê. Ou seja, qual *entidade principal* pode executar *ações* em quais *recursos* e em que *condições*. O elemento `Action` de uma política JSON descreve as ações que podem ser usadas para permitir ou negar acesso em uma política. Para obter mais informações sobre as ações AWS IoT SiteWise suportadas, consulte [Ações definidas por AWS IoT SiteWise](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotsitewise.html#awsiotsitewise-actions-as-permissions) na *Referência de Autorização de Serviço*.

*Para obter mais informações sobre funções AWS IoT TwinMaker vinculadas ao serviço, consulte [Funções vinculadas ao serviço AWS IoT TwinMaker no Guia do usuário](https://docs.aws.amazon.com/iot-twinmaker/latest/guide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles-service-linked).AWS IoT TwinMaker *

Antes de integrar AWS IoT SiteWise e AWS IoT TwinMaker, você deve conceder as seguintes permissões que permitem AWS IoT SiteWise a integração com um espaço de trabalho AWS IoT TwinMaker vinculado:
+ `iotsitewise:EnableSiteWiseIntegration`— Permite AWS IoT SiteWise a integração com um AWS IoT TwinMaker espaço de trabalho vinculado. Essa integração permite AWS IoT TwinMaker ler todas as suas informações de modelagem AWS IoT SiteWise por meio de uma função AWS IoT TwinMaker vinculada ao serviço. Para habilitar essa permissão, adicione a seguinte política ao perfil do IAM:

------
#### [ JSON ]

****  

  ```
  {
    "Version":"2012-10-17",		 	 	 
    "Statement": [
      {
        "Effect": "Allow",
        "Action": [
          "iotsitewise:EnableSiteWiseIntegration"
        ],
        "Resource": "*"
      }
    ]
  }
  ```

------

## Integrando e AWS IoT SiteWise AWS IoT TwinMaker
<a name="it-integrate"></a>

Para integrar AWS IoT SiteWise e AWS IoT TwinMaker, você deve ter o seguinte:
+ AWS IoT SiteWise função vinculada ao serviço configurada em sua conta
+ AWS IoT TwinMaker função vinculada ao serviço configurada em sua conta
+ AWS IoT TwinMaker espaço de trabalho com ID `IoTSiteWiseDefaultWorkspace` em sua conta na região.

### Para integrar usando o AWS IoT SiteWise console
<a name="it-integrate-console"></a>

Ao ver o banner **Integração com o AWS IoT TwinMaker** no console, escolha **Conceder permissão**. Os pré-requisitos são criados na conta.

### Para integrar usando o AWS CLI
<a name="it-integrate-cli"></a>

Para integrar AWS IoT SiteWise e AWS IoT TwinMaker usar o AWS CLI, digite os seguintes comandos:

1. Chame `CreateServiceLinkedRole` com um `AWSServiceName` de `iotsitewise.amazonaws.com`.

   ```
   aws iam create-service-linked-role --aws-service-name iotsitewise.amazonaws.com
   ```

1. Chame `CreateServiceLinkedRole` com um `AWSServiceName` de ` iottwinmaker.amazonaws.com`.

   ```
   aws iam create-service-linked-role --aws-service-name iottwinmaker.amazonaws.com
   ```

1. Chame `CreateWorkspace` com um `ID` de `IoTSiteWiseDefaultWorkspace`.

   ```
    aws iottwinmaker create-workspace --workspace-id IoTSiteWiseDefaultWorkspace
   ```

# Detectar anomalias com o Lookout for Equipment
<a name="anomaly-detection"></a>

**nota**  
A detecção de anomalias só está disponível nas regiões onde o Amazon Lookout for Equipment está disponível.

Você pode se integrar AWS IoT SiteWise ao Amazon Lookout for Equipment para obter informações sobre seu equipamento industrial por meio da detecção de anomalias e da manutenção preditiva de equipamentos industriais. O Lookout for Equipment é um serviço de machine learning (ML) para monitoramento de equipamentos industriais que detecta comportamento anormal dos equipamentos e identifica possíveis falhas. Com o Lookout for Equipment, você pode implementar programas de manutenção preditiva e identificar processos de equipamentos abaixo do ideal. Para ter mais informações sobre o Lookout for Equipment, consulte [What is Amazon Lookout for Equipment?](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/what-is.html) no *Guia do usuário do Amazon Lookout for Equipment*.

Quando você cria uma previsão para treinar um modelo de ML para detectar o comportamento anômalo do equipamento, AWS IoT SiteWise envia os valores das propriedades do ativo para a Lookout for Equipment para treinar um modelo de ML para detectar o comportamento anômalo do equipamento. Para estabelecer uma definição de previsão em um modelo de ativo, especifique os perfis do IAM necessários para que o Lookout for Equipment acesse os dados e as propriedades para enviar ao Lookout for Equipment e envie dados processados ao Amazon S3. Para obter mais informações, consulte [Crie modelos de ativos em AWS IoT SiteWise](create-asset-models.md).

Para integrar AWS IoT SiteWise o Lookout for Equipment, você executará as seguintes etapas de alto nível:
+ Adicione uma definição de previsão em um modelo de ativo que descreva quais propriedades você deseja rastrear. A definição de previsão é uma coleção reutilizável de medições, transformações e métricas que é usada para criar previsões dos ativos com base nesse modelo de ativo.
+ Treine a previsão com base nos dados históricos que você fornece.
+ Inferência de cronograma, que AWS IoT SiteWise informa com que frequência executar uma previsão específica.

Depois que a inferência é programada, o modelo do Lookout for Equipment monitora os dados que recebe dos equipamentos e procura anomalias no comportamento dos equipamentos. Você pode visualizar e analisar os resultados no SiteWise Monitor, usando as operações da API AWS IoT SiteWise GET ou o console Lookout for Equipment. Também é possível criar alarmes usando detectores de alarme do modelo de ativo para alertar você sobre o comportamento anormal dos equipamentos.

**Topics**
+ [Adicionar uma definição de previsão (console)](#ad-add-prediction-definition-console)
+ [Treinar uma previsão (console)](#ad-train-prediction-console)
+ [Iniciar ou interromper a inferência em uma previsão (console)](#ad-start-stop-inference-console)
+ [Adicionar uma definição de previsão (CLI)](#ad-add-prediction-definition-cli)
+ [Treinar uma previsão e iniciar a inferência (CLI)](#ad-train-inference-prediction-cli)
+ [Treinar uma previsão (CLI)](#ad-train-prediction-cli)
+ [Iniciar ou interromper a inferência em uma previsão (CLI)](#ad-start-stop-inference-cli)

## Adicionar uma definição de previsão (console)
<a name="ad-add-prediction-definition-console"></a>

Para começar a enviar dados coletados pela AWS IoT SiteWise Lookout for Equipment, você deve adicionar AWS IoT SiteWise uma definição de previsão a um modelo de ativo.

**Para adicionar uma definição de previsão a um modelo AWS IoT SiteWise de ativo**

1. <a name="sitewise-open-console"></a>Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).

1. No painel de navegação, selecione **Modelos** e escolha o modelo de ativo para o qual você deseja adicionar a definição de previsão.

1. Escolha **Previsões**.

1. Escolha **Adicionar definição de previsão**.

1. Defina detalhes sobre a definição de previsão.

   1. Insira um **Nome** exclusivo e uma **Descrição** para a definição de previsão. Escolha o nome com cuidado, pois depois de criada a definição de previsão, você não poderá mudar o nome.

   1. Crie ou selecione um **Perfil de permissões do IAM** que permita que o AWS IoT SiteWise compartilhe os dados de ativos com o Amazon Lookout for Equipment. O perfil deve ter as políticas do IAM e de confiança a seguir. Se precisar de ajuda para criar o perfil, consulte [Criar um perfil do IAM usando políticas de confiança personalizadas (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-custom.html).

      **Política do IAM**

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Sid": "L4EPermissions",
                  "Effect": "Allow",
                  "Action": [
                      "lookoutequipment:CreateDataset",
                      "lookoutequipment:CreateModel",
                      "lookoutequipment:CreateInferenceScheduler",
                      "lookoutequipment:DescribeDataset",
                      "lookoutequipment:DescribeModel",
                      "lookoutequipment:DescribeInferenceScheduler",
                      "lookoutequipment:ListInferenceExecutions",
                      "lookoutequipment:StartDataIngestionJob",
                      "lookoutequipment:StartInferenceScheduler",
                      "lookoutequipment:UpdateInferenceScheduler",
                      "lookoutequipment:StopInferenceScheduler"
                  ],
                  "Resource": [
                      "arn:aws:lookoutequipment:us-east-1:123456789012:inference-scheduler/IoTSiteWise_*",
                      "arn:aws:lookoutequipment:us-east-1:123456789012:model/IoTSiteWise_*",
                      "arn:aws:lookoutequipment:us-east-1:123456789012:dataset/IoTSiteWise_*"
                  ]
              },
              {
                  "Sid": "L4EPermissions2",
                  "Effect": "Allow",
                  "Action": [
                      "lookoutequipment:DescribeDataIngestionJob"
                  ],
                  "Resource": "*"
              },
              {
                  "Sid": "S3Permissions",
                  "Effect": "Allow",
                  "Action": [
                      "s3:CreateBucket",
                      "s3:ListBucket",
                      "s3:PutObject",
                      "s3:GetObject"
                  ],
                  "Resource": [
                      "arn:aws:s3:::iotsitewise-*"
                  ]
              },
              {
                  "Sid": "IAMPermissions",
                  "Effect": "Allow",
                  "Action": [
                      "iam:GetRole",
                      "iam:PassRole"
                  ],
                  "Resource": "arn:aws:iam::111122223333:role/Role_name"
              }
          ]
      }
      ```

------

      **Política de confiança**

------
#### [ JSON ]

****  

      ```
      {
          "Version":"2012-10-17",		 	 	 
          "Statement": [
              {
                  "Effect": "Allow",
                  "Principal": {
                      "Service": "iotsitewise.amazonaws.com"
                  },
                  "Action": "sts:AssumeRole",
                  "Condition": {
                      "StringEquals": {
                          "aws:SourceAccount": "123456789012"
                      },
                      "ArnEquals": {
                          "aws:SourceArn": "arn:aws:iotsitewise:us-east-1:123456789012:asset/*"
                      }
                  }
              },
              {
                  "Effect": "Allow",
                  "Principal": {
                      "Service": "lookoutequipment.amazonaws.com"
                  },
                  "Action": "sts:AssumeRole",
                  "Condition": {
                      "StringEquals": {
                          "aws:SourceAccount": "123456789012"
                      },
                      "ArnEquals": {
                          "aws:SourceArn": "arn:aws:lookoutequipment:us-east-1:123456789012:*"
                      }
                  }
              }
          ]
      }
      ```

------

   1. Escolha **Próximo**.

1. Selecione os atributos de dados (medições, transformações e métricas) que você deseja enviar para o Lookout for Equipment.

   1. (Opcional) Selecione as medições.

   1. (Opcional) Selecione as transformações.

   1. (Opcional) Selecione as métricas.

   1. Escolha **Próximo**.

1. Revise suas seleções. Para adicionar a definição de previsão ao modelo de ativo, na página de resumo, escolha **Adicionar definição de previsão**.

Você também pode **Editar** ou **Excluir** uma definição de previsão existente que tenha previsões ativas anexadas.

## Treinar uma previsão (console)
<a name="ad-train-prediction-console"></a>

Depois de adicionar uma definição de previsão a um modelo de ativo, você poderá treinar as previsões que estão nos ativos.

**Para treinar uma previsão em AWS IoT SiteWise**

1. <a name="sitewise-open-console"></a>Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).

1. No painel de navegação, selecione **Ativos** e selecione o ativo que deseja monitorar.

1. Escolha **Previsões**.

1. Selecione as previsões que deseja treinar.

1. Em **Ações**, escolha **Começar o treinamento** e faça o seguinte:

   1. Em **Detalhes da previsão**, selecione uma função de permissões do IAM que permita AWS IoT SiteWise compartilhar seus dados de ativos com o Lookout for Equipment. Se precisar criar um novo perfil, escolha **Criar um novo perfil**.

   1. Em **Configurações de dados de treinamento**, insira um **Intervalo de tempo dos dados de treinamento** para selecionar quais dados usar para treinar a previsão.

   1. (Opcional) Selecione a taxa de amostragem dos dados após o pós-processamento.

   1. (Opcional) Para **Rótulos de dados**, forneça um bucket e um prefixo do Amazon S3 que contenham os dados de rotulagem. Para ter mais informações sobre rotulagem de dados, consulte [Labeling your data](https://docs.aws.amazon.com/lookout-for-equipment/latest/ug/labeling-data.html) no *Guia do usuário do Amazon Lookout for Equipment*.

   1. Escolha **Próximo**.

1. (Opcional) Se você quiser que a previsão fique ativa assim que o treinamento for concluído, em **Configurações avançadas**, selecione **Ativar automaticamente a previsão após o treinamento** e faça o seguinte:

   1. Em **Dados de entrada**, em **Frequência de upload de dados**, defina a frequência de upload dos dados e, em **Tempo de atraso de compensação**, defina a quantidade de buffer a ser usada.

   1. Escolha **Próximo**.

1. Revise os detalhes da previsão e escolha **Salvar e iniciar**.

## Iniciar ou interromper a inferência em uma previsão (console)
<a name="ad-start-stop-inference-console"></a>

**nota**  
As cobranças do Lookout for Equipment se aplicam a inferências programadas com os dados transferidos AWS IoT SiteWise entre o Lookout for Equipment e o Lookout for Equipment. Para ter mais informações, consulte [Amazon Lookout for Equipment pricing](https://aws.amazon.com/lookout-for-equipment/pricing/).

Se você adicionou a previsão `lookoutequipment:CreateDataset`, mas não optou por ativá-la após o treinamento, deverá ativá-la para começar a monitorar os ativos.

**Como iniciar a inferência para uma previsão**

1. <a name="sitewise-open-console"></a>Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).

1. No painel de navegação, escolha **Ativos** e selecione o ativo ao qual a previsão é adicionada.

1. Escolha **Previsões**.

1. Selecione as previsões que deseja ativar.

1. Em **Ações**, escolha **Iniciar inferência** e faça o seguinte:

   1. Em **Dados de entrada**, em **Frequência de upload de dados**, defina a frequência de upload dos dados e, em **Tempo de atraso de compensação**, defina a quantidade de buffer a ser usada.

   1. Escolha **Salvar e iniciar**.

**Como interromper a inferência de uma previsão**

1. <a name="sitewise-open-console"></a>Navegue até o [console do AWS IoT SiteWise](https://console.aws.amazon.com/iotsitewise/).

1. No painel de navegação, escolha **Ativos** e selecione o ativo ao qual a previsão é adicionada.

1. Escolha **Previsões**.

1. Selecione as previsões que deseja interromper.

1. Em **Ações**, escolha **Interromper inferência**.

## Adicionar uma definição de previsão (CLI)
<a name="ad-add-prediction-definition-cli"></a>

Para definir uma definição de previsão em um modelo de ativo novo ou existente, você pode usar o AWS Command Line Interface (AWS CLI). Depois de definir a definição de previsão no modelo de ativo, você treina e programa a inferência para uma previsão em um ativo AWS IoT SiteWise para fazer a detecção de anomalias com o Lookout for Equipment.

**Pré-requisitos**

Para concluir essas etapas, você deve ter um modelo de ativo e pelo menos um ativo criado. Para obter mais informações, consulte [Criar um modelo de ativo (AWS CLI)](create-asset-models.md#create-asset-model-cli) e [Criar um ativo (AWS CLI)](create-assets.md#create-asset-cli).

Se você é novato AWS IoT SiteWise, deve chamar a operação de `CreateBulkImportJob` API para importar valores de propriedades de ativos AWS IoT SiteWise, que serão usados para treinar o modelo. Para obter mais informações, consulte [Criar um trabalho de importação AWS IoT SiteWise em massa (AWS CLI)](CreateBulkImportJob.md).

**Como adicionar uma definição de previsão**

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.
   + Para ter 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 ter 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).

1. Adicione um modelo composto do Lookout for Equipment (`assetModelCompositeModels`) ao modelo de ativo adicionando o código a seguir.
   + Substitua `Property` pelo ID das propriedades que deseja incluir. Para obtê-los IDs, ligue [https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html).
   + `RoleARN`Substitua pelo ARN de uma função do IAM que permite que a Lookout for Equipment acesse seus dados. AWS IoT SiteWise 

   ```
   { 
     ...
     "assetModelCompositeModels": [
       {
         "name": "L4Epredictiondefinition",
         "type": "AWS/L4E_ANOMALY",
         "properties": [
             {
               "name": "AWS/L4E_ANOMALY_RESULT",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_RESULT",
               "unit": "none",
               "type": {
                 "measurement": {}
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_INPUT",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_INPUT",
               "type": {
                  "attribute": {
                    "defaultValue": "{\"properties\": [\"Property1\", \"Property2\"]}"
                  }
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_PERMISSIONS",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_PERMISSIONS",
               "type": {
                 "attribute": {
                   "defaultValue": "{\"roleArn\": \"RoleARN\"}"
                 }
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_DATASET",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_DATASET",
               "type": {
                   "attribute": {}
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_MODEL",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_MODEL",
               "type": {
                 "attribute": {}
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_INFERENCE",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_INFERENCE",
               "type": {
                 "attribute": {}
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_TRAINING_STATUS",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_TRAINING_STATUS",
               "type": {
                 "attribute": {
                   "defaultValue": "{}"
                 }
               }
             },
             {
               "name": "AWS/L4E_ANOMALY_INFERENCE_STATUS",
               "dataType": "STRUCT",
               "dataTypeSpec": "AWS/L4E_ANOMALY_INFERENCE_STATUS",
               "type": {
                 "attribute": {
                   "defaultValue": "{}"
                 }
               }
             }
      ]
   }
   ```

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 seguinte comando:

     ```
     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. Substitua `asset-model-id` pelo ID do modelo de ativo que você deseja atualizar.

     ```
     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. 

## Treinar uma previsão e iniciar a inferência (CLI)
<a name="ad-train-inference-prediction-cli"></a>

Agora que a definição de previsão está estabelecida, você pode treinar ativos com base nela e iniciar a inferência. Se você quiser treinar a previsão, mas não iniciar a inferência, vá para [Treinar uma previsão (CLI)](#ad-train-prediction-cli). Para treinar a previsão e iniciar a inferência no ativo, você precisará do `assetId` do recurso de destino.

**Como treinar e iniciar a inferência da previsão**

1. Execute o comando a seguir para encontrar `assetModelCompositeModelId` em `assetModelCompositeModelSummaries`. Substitua *`asset-model-id`* pelo ID do modelo de ativo criado em [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli).

   ```
   aws iotsitewise describe-asset-model \
     --asset-model-id asset-model-id \
   ```

1. Execute o seguinte comando para encontrar `actionDefinitionId` da ação `TrainingWithInference`. Substitua *`asset-model-id`* pelo ID usado na etapa anterior e substitua *`asset-model-composite-model-id`* pelo ID retornado na etapa anterior.

   ```
   aws iotsitewise describe-asset-model-composite-model \
     --asset-model-id asset-model-id \
     --asset-model-composite-model-id asset-model-composite-model-id \
   ```

1. Crie um arquivo chamado `train-start-inference-prediction.json` e adicione o código a seguir, substituindo o seguinte:
   + `asset-id` pelo ID do ativo de destino.
   + `action-definition-id`com o ID da TrainingWithInference ação
   + `StartTime` pelo início dos dados de treinamento, fornecido em segundos epoch.
   + `EndTime` pelo fim dos dados de treinamento, fornecido em segundos epoch.
   + `TargetSamplingRate` pela taxa de amostragem dos dados após o pós-processamento pelo Lookout for Equipment. Os valores permitidos são: `PT1S | PT5S | PT10S | PT15S | PT30S | PT1M | PT5M | PT10M | PT15M | PT30M | PT1H`.

   ```
   {
     "targetResource": {
       "assetId": "asset-id"
     },
     "actionDefinitionId": "action-definition-Id",
     "actionPayload":{
       "stringValue": "{\"l4ETrainingWithInference\":{\"trainingWithInferenceMode\":\"START\",\"trainingPayload\":{\"exportDataStartTime\":StartTime,\"exportDataEndTime\":EndTime},\"targetSamplingRate\":\"TargetSamplingRate\"},\"inferencePayload\":{\"dataDelayOffsetInMinutes\":0,\"dataUploadFrequency\":\"PT5M\"}}}"
     }
   }
   ```

1. Execute o comando a seguir para iniciar o treinamento e a inferência:

   ```
   aws iotsitewise execute-action --cli-input-json file://train-start-inference-prediction.json
   ```

## Treinar uma previsão (CLI)
<a name="ad-train-prediction-cli"></a>

Agora que a definição de previsão está estabelecida, você pode treinar ativos com base nela. Para treinar a previsão no ativo, você precisará do `assetId` do recurso de destino.

**Como treinar a previsão**

1. Execute o comando a seguir para encontrar `assetModelCompositeModelId` em `assetModelCompositeModelSummaries`. Substitua *`asset-model-id`* pelo ID do modelo de ativo criado em [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli).

   ```
   aws iotsitewise describe-asset-model \
     --asset-model-id asset-model-id \
   ```

1. Execute o seguinte comando para encontrar `actionDefinitionId` da ação `Training`. Substitua *`asset-model-id`* pelo ID usado na etapa anterior e substitua *`asset-model-composite-model-id`* pelo ID retornado na etapa anterior.

   ```
   aws iotsitewise describe-asset-model-composite-model \
     --asset-model-id asset-model-id \
     --asset-model-composite-model-id asset-model-composite-model-id \
   ```

1. Crie um arquivo chamado `train-prediction.json` e adicione o código a seguir, substituindo o seguinte:
   + `asset-id` pelo ID do ativo de destino.
   + `action-definition-id` pelo ID da ação de treinamento.
   + `StartTime` pelo início dos dados de treinamento, fornecido em segundos epoch.
   + `EndTime` pelo fim dos dados de treinamento, fornecido em segundos epoch.
   + (Opcional) `BucketName` pelo nome do bucket do Amazon S3 que contém os dados de rótulo.
   + (Opcional) `Prefix` pelo prefixo associado ao bucket do Amazon S3.
   + `TargetSamplingRate` pela taxa de amostragem dos dados após o pós-processamento pelo Lookout for Equipment. Os valores permitidos são: `PT1S | PT5S | PT10S | PT15S | PT30S | PT1M | PT5M | PT10M | PT15M | PT30M | PT1H`.
**nota**  
Inclua o nome e o prefixo do bucket, ou nenhum deles.

   ```
   {
     "targetResource": {
       "assetId": "asset-id"
     },
     "actionDefinitionId": "action-definition-Id",
     "actionPayload":{ "stringValue": "{\"l4ETraining\": {\"trainingMode\":\"START\",\"exportDataStartTime\": StartTime, \"exportDataEndTime\": EndTime, \"targetSamplingRate\":\"TargetSamplingRate\"}, \"labelInputConfiguration\": {\"bucketName\": \"BucketName\", \"prefix\": \"Prefix\"}}}"
   }
   }
   ```

1. Execute o seguinte comando para iniciar o treinamento:

   ```
   aws iotsitewise execute-action --cli-input-json file://train-prediction.json
   ```

Antes de começar a inferência, o treinamento deve ser concluído. Para verificar o status do treinamento, faça um dos seguintes procedimentos:
+ No console, navegue até o ativo em que a previsão está ativada.
+ A partir do AWS CLI, ligue `BatchGetAssetPropertyValue` usando o `propertyId` da `trainingStatus` propriedade.

## Iniciar ou interromper a inferência em uma previsão (CLI)
<a name="ad-start-stop-inference-cli"></a>

Depois que a previsão for treinada, você poderá iniciar a inferência para fazer com que o Lookout for Equipment comece a monitorar os ativos. Para iniciar ou interromper a inferência, você precisará de `assetId` do recurso de destino.

**Como iniciar a inferência**

1. Execute o comando a seguir para encontrar `assetModelCompositeModelId` em `assetModelCompositeModelSummaries`. Substitua *`asset-model-id`* pelo ID do modelo de ativo criado em [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli).

   ```
   aws iotsitewise describe-asset-model \
     --asset-model-id asset-model-id \
   ```

1. Execute o seguinte comando para encontrar `actionDefinitionId` da ação `Inference`. Substitua *`asset-model-id`* pelo ID usado na etapa anterior e substitua *`asset-model-composite-model-id`* pelo ID retornado na etapa anterior.

   ```
   aws iotsitewise describe-asset-model-composite-model \
     --asset-model-id asset-model-id \
     --asset-model-composite-model-id asset-model-composite-model-id \
   ```

1. Crie um arquivo chamado `start-inference.json` e adicione o código a seguir, substituindo o seguinte:
   + `asset-id` pelo ID do ativo de destino.
   + `action-definition-id` pelo ID da ação que dá início à inferência.
   + `Offset` pela quantidade de buffer a ser usada.
   + `Frequency` pela frequência de upload dos dados.

   ```
   {
     "targetResource": {
       "assetId": "asset-id"
     },
     "actionDefinitionId": "action-definition-Id",
     "actionPayload":{ "stringValue": "{\"l4EInference\": {\"inferenceMode\":\"START\",\"dataDelayOffsetInMinutes\": Offset, \"dataUploadFrequency\": \"Frequency\"}}"
   }}
   ```

1. Execute o seguinte comando para iniciar a inferência:

   ```
   aws iotsitewise execute-action --cli-input-json file://start-inference.json 
   ```

**Como interromper a inferência**

1. Execute o comando a seguir para encontrar `assetModelCompositeModelId` em `assetModelCompositeModelSummaries`. Substitua *`asset-model-id`* pelo ID do modelo de ativo criado em [Atualizar um modelo de ativo, modelo de componente ou interface (AWS CLI)](update-asset-models.md#update-asset-model-cli).

   ```
   aws iotsitewise describe-asset-model \
     --asset-model-id asset-model-id \
   ```

1. Execute o seguinte comando para encontrar `actionDefinitionId` da ação `Inference`. Substitua *`asset-model-id`* pelo ID usado na etapa anterior e substitua *`asset-model-composite-model-id`* pelo ID retornado na etapa anterior.

   ```
   aws iotsitewise describe-asset-model-composite-model \
     --asset-model-id asset-model-id \
     --asset-model-composite-model-id asset-model-composite-model-id \
   ```

1. Crie um arquivo chamado `stop-inference.json` e adicione o código a seguir, substituindo o seguinte:
   + `asset-id` pelo ID do ativo de destino.
   + `action-definition-id` pelo ID da ação que dá início à inferência.

   ```
   {
     "targetResource": {
       "assetId": "asset-id"
     },
     "actionDefinitionId": "action-definition-Id",
     "actionPayload":{ "stringValue": "{\"l4EInference\":{\"inferenceMode\":\"STOP\"}}"
   }}
   ```

1. Execute o seguinte comando para interromper a inferência:

   ```
   aws iotsitewise execute-action --cli-input-json file://stop-inference.json 
   ```