

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

# Integração de eventos do Amazon Quick Sight
<a name="events-integration"></a>

Com a Amazon EventBridge, você pode responder automaticamente a eventos no Amazon Quick Sight, como criação de novos painéis ou atualizações. Esses eventos são entregues quase EventBridge em tempo real. Como desenvolvedor, é possível definir regras simples para indicar eventos de interesse e determinar ações a serem executadas quando um evento corresponder a uma regra. Com o uso de eventos, é possível implementar casos de uso, como backup e implantação contínuos.

**Topics**
+ [Eventos suportados](#events-supported)
+ [Exemplo de carga útil do evento](#sample-events-payload)
+ [Criação de regras para enviar eventos do Amazon Quick Sight para a Amazon CloudWatch](events-send-cloudwatch.md)
+ [Criação de regras para enviar eventos do Amazon Quick Sight para AWS Lambda](events-send-lambda.md)

## Eventos suportados
<a name="events-supported"></a>

Atualmente, o Amazon Quick Sight oferece suporte aos seguintes eventos.


| Asset type (Tipo de ativo) | Ação | Tipo de informação detalhada do evento | Informação detalhada do evento | 
| --- | --- | --- | --- | 
| Painel | Criar | Criação bem-sucedida do painel Amazon Quick Sight | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",<br />    "versionNumber": 1<br />}</pre> | 
| Painel | Criar | Falha na criação do painel Amazon Quick Sight | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",<br />    "versionNumber": 1,<br />    "errors": [<br />      {<br />        "Type": "PARAMETER_NOT_FOUND",<br />        "Message": "Missing property abc"<br />      },<br />      {<br />        "Type": "DATA_SET_NOT_FOUND",<br />        "Message": "Cannot find dataset with id abc"<br />      }<br />    ]<br />}</pre> | 
| Painel | Criar | Permissões do painel Amazon Quick Sight atualizadas | <pre>{"dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }</pre> | 
| Painel | Atualizar | Atualização bem-sucedida do painel Amazon Quick Sight | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",<br />    "versionNumber": 1<br />}</pre> | 
| Painel | Atualizar | Falha na atualização do painel Amazon Quick Sight | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",<br />    "versionNumber": 1,<br />    "errors": [<br />      {<br />        "Type": "PARAMETER_NOT_FOUND",<br />        "Message": "Missing property abc"<br />      },<br />      {<br />        "Type": "DATA_SET_NOT_FOUND",<br />        "Message": "Cannot find dataset with id abc"<br />      }<br />    ]<br />}</pre> | 
| Painel | Atualizar | Permissões do painel Amazon Quick Sight atualizadas | <pre>{"dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83"}</pre> | 
| Painel | Publicar | Versão publicada do Amazon Quick Sight Dashboard atualizada | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",<br />    "versionNumber": 2<br />}</pre> | 
| Painel | Delete | Painel do Amazon Quick Sight excluído | <pre>{<br />    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83"<br />}</pre> | 
| Análise | Criar | Criação bem-sucedida da análise Amazon Quick Sight | <pre>{<br />    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"<br />}</pre> | 
| Análise | Criar | Falha na criação do Amazon Quick Sight Analysis | <pre>{<br />    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5",<br />    "errors": [<br />      {<br />        "Type": "PARAMETER_NOT_FOUND",<br />        "Message": "Missing property abc"<br />      },<br />      {<br />        "Type": "DATA_SET_NOT_FOUND",<br />        "Message": "Cannot find dataset with id abc"<br />      }<br />    ]<br />}</pre> | 
| Análise | Criar | Permissões do Amazon Quick Sight Analysis atualizadas | <pre>{"analysisId": "e5f37119-e24c-4874-901a-af9032b729b5" }</pre> | 
| Análise | Delete | Análise do Amazon Quick Sight excluída | <pre>{<br />    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"<br />}</pre> | 
| Análise | Atualizar | Atualização bem-sucedida do Amazon Quick Sight Analysis | <pre>{<br />    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"<br />}</pre> | 
| Análise | Atualizar | Falha na atualização do Amazon Quick Sight Analysis | <pre>{<br />    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5",    <br />    "errors": [        <br />        {            <br />            "Type": "PARAMETER_NOT_FOUND",            <br />            "Message": "Missing property abc"        <br />        },        <br />        {             <br />            "Type": "DATA_SET_NOT_FOUND",            <br />            "Message": "Cannot find dataset with id abc"        <br />        }    <br />    ]<br />}</pre> | 
| Análise | Atualizar | Permissões do Amazon Quick Sight Analysis atualizadas | <pre>{"analysisId": "e5f37119-e24c-4874-901a-af9032b729b5" }</pre> | 
| Conexão de VPC | Criar | Criação bem-sucedida da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "CREATION_SUCCESSFUL"<br />}</pre> | 
| Conexão de VPC | Criar | Falha na criação da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "CREATION_FAILED"<br />}</pre> | 
| Conexão de VPC | Atualizar | Atualização bem-sucedida da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "UPDATE_SUCCESSFUL"<br />}</pre> | 
| Conexão de VPC | Atualizar | Falha na atualização da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "UPDATE_FAILED"<br />}</pre> | 
| Conexão de VPC | Delete | Exclusão bem-sucedida da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "DELETED"<br />}</pre> | 
| Conexão de VPC | Delete | Falha na exclusão da conexão VPC do Amazon Quick Sight | <pre>{<br />    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",<br />    "availabilityStatus": "DELETION_FAILED"<br />}</pre> | 
| Pasta | Criar | Pasta Amazon Quick Sight criada | <pre>{<br />    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be",<br />    "parentFolderArn": "arn:aws:quicksight:us-east-1:123456789012:folder/098765432134"<br />}</pre> | 
| Pasta | Criar | Permissões da pasta Amazon Quick Sight atualizadas | <pre>{"folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" }</pre> | 
| Pasta | Atualizar | Pasta Amazon Quick Sight atualizada | <pre>{<br />    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"<br />}</pre> | 
| Pasta | Atualizar | Permissões da pasta Amazon Quick Sight atualizadas | <pre>{"folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" }</pre> | 
| Pasta | Delete | Pasta Amazon Quick Sight excluída | <pre>{<br />    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"<br />}</pre> | 
| Pasta | Atualização da associação | A associação ao Amazon Quick Sight Folder foi atualizada | <pre>{<br />    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be",<br />    "membersAdded": ["arn:aws:quicksight:us-east-1:123456789012:analysis/e5f37119-e24c-4874-901a-af9032b729b5"],<br />    "membersRemoved": []<br />}</pre> | 
| Conjunto de dados | Criar | Conjunto de dados Amazon Quick Sight criado | <pre>{<br />    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"<br />}</pre> | 
| Conjunto de dados | Criar | Permissões do conjunto de dados Amazon Quick Sight atualizadas | <pre>{"datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa" }</pre> | 
| Conjunto de dados | Atualizar | Conjunto de dados Amazon Quick Sight atualizado | <pre>{<br />    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"<br />}</pre> | 
| Conjunto de dados | Atualizar | Permissões do conjunto de dados Amazon Quick Sight atualizadas | <pre>{"datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa" }</pre> | 
| Conjunto de dados | Delete | Conjunto de dados Amazon Quick Sight excluído | <pre>{<br />    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"<br />}</pre> | 
| DataSource | Criar |  DataSource Criação bem-sucedida do Amazon Quick Sight | <pre>{<br />    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"<br />}</pre> | 
| DataSource | Criar | Falha na DataSource criação do Amazon Quick Sight | <pre>{<br />    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824",<br />    "error": {<br />        "message": "AMAZON_ELASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7",<br />        "type": "ENGINE_VERSION_NOT_SUPPORTED"<br />    }<br />}</pre> | 
| DataSource | Criar |  DataSource Permissões do Amazon Quick Sight atualizadas | <pre>{"datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824" }</pre> | 
| DataSource | Atualizar |  DataSource Atualização do Amazon Quick Sight bem-sucedida | <pre>{<br />    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"<br />}</pre> | 
| DataSource | Atualizar | Falha na DataSource atualização do Amazon Quick Sight | <pre>{<br />    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824",<br />    "error": {<br />        "message": "AMAZON_ELASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7",<br />        "type": "ENGINE_VERSION_NOT_SUPPORTED"<br />    }<br />}</pre> | 
| DataSource | Atualizar |  DataSource Permissões do Amazon Quick Sight atualizadas | <pre>{"datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824" }</pre> | 
| DataSource | Delete | Amazon Quick Sight DataSource excluído | <pre>{<br />    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"<br />}</pre> | 
| Tema | Criar | Criação bem-sucedida do tema Amazon Quick Sight | <pre>{<br />    ""themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83", <br />    "versionNumber": 1"<br />}</pre> | 
| Tema | Criar | Falha na criação do tema Amazon Quick Sight | <pre>{ <br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83", <br />    "versionNumber": 1<br />}</pre> | 
| Tema | Criar | Permissões do tema Amazon Quick Sight atualizadas | <pre>{"themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }</pre> | 
| Tema | Atualizar | Atualização do tema Amazon Quick Sight bem-sucedida | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    <br />    "versionNumber": 2<br />}</pre> | 
| Tema | Atualizar | Falha na atualização do tema Amazon Quick Sight | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    <br />    "versionNumber": 2<br />}</pre> | 
| Tema | Atualizar | Permissões do tema Amazon Quick Sight atualizadas | <pre>{"themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }</pre> | 
| Tema | Delete | Tema Amazon Quick Sight excluído | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83"<br />}</pre> | 
| Tema | Criação do alias | Alias do tema Amazon Quick Sight criado | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    <br />    "aliasName": "MyThemeAlias"    <br />    "versionNumber": 2<br />}</pre> | 
| Tema | Atualização do alias | Alias do Amazon Quick Sight atualizado | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    <br />    "aliasName": "MyThemeAlias"    <br />    "versionNumber": 4<br />}</pre> | 
| Tema | Exclusão do alias | Alias do tema Amazon Quick Sight excluído | <pre>{<br />    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    <br />    "aliasName": "MyThemeAlias"    <br />    "versionNumber": 2<br />}</pre> | 

## Exemplo de carga útil do evento
<a name="sample-events-payload"></a>

Todos os eventos seguem a [estrutura padrão do EventBridge objeto](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-events-structure.html). O campo de detalhes é um objeto em JSON que contém mais informações sobre o evento.

```
{
  "version": "0",
  "id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
  "detail-type": "QuickSight Dashboard Creation Successful",
  "source": "aws.quicksight",
  "account": "123456789012",
  "time": "2023-10-30T22:06:31Z",
  "region": "us-east-1",
  "resources": ["arn:aws:quicksight:us-east-1:123456789012:dashboard/6fdbc328-ebbd-457f-aa02-9780173afc83"],
  "detail": {
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 1
  }
}
```

# Criação de regras para enviar eventos do Amazon Quick Sight para a Amazon CloudWatch
<a name="events-send-cloudwatch"></a>

Você pode criar regras simples para indicar quais eventos do Amazon Quick Sight interessam a você e quais ações automatizadas devem ser tomadas quando um evento corresponde a uma regra. Por exemplo, você pode configurar o Amazon Quick Sight para enviar eventos para a Amazon CloudWatch sempre que um ativo do Amazon Quick Sight for colocado em uma pasta. Para obter mais informações, consulte o [guia EventBridge do usuário da Amazon](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html).

1. Faça login no Console de gerenciamento da AWS e abra o CloudWatch console em [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).

1. Em **Events (Eventos)**, no painel de navegação, escolha **Rules (Regras)**.

1. Escolha **Create rule**.

1. Insira um nome e uma descrição para a regra. O nome da regra deve ser exclusivo dentro dessa região. Por exemplo, digite `QuickSightAssetChangeRuleCloudWatch`.

1. Escolha o barramento de eventos **padrão**.

1. Escolha **Rule with an event pattern** (Regra com padrão de eventos), depois selecione **Next** (Próximo).

1. Em **Origem do evento**, escolha **AWS eventos ou eventos de EventBridge parceiros**.

1. Na seção **Método de criação**, escolha **Padrão personalizado (editor JSON)**.

1. Na caixa de texto **Padrão de evento**, insira o trecho de código apresentado a seguir e escolha **Próximo**.

   ```
   {
     "source": ["aws.quicksight"]
   }
   ```

   Como alternativa, você pode criar a regra que se inscreve somente em um subconjunto de tipos de eventos no Amazon Quick Sight. Por exemplo, a regra apresentada a seguir será acionada somente quando um ativo for adicionado ou removido de uma pasta com o ID `77e307e8-b41b-472a-90e8-fe3f471537be`.

   ```
   {
     "source": ["aws.quicksight"],
     "detail-type": ["QuickSight Folder Membership Updated"],
     "detail": {
       "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"
     }
   }
   ```

1. Em **Targets**, escolha **AWS serviço** > **grupo de CloudWatch registros.**

1. Escolha um grupo de logs existente ou crie um novo grupo ao inserir um novo nome para o grupo de logs.

1. Como opção, é possível adicionar outro destino para esta regra.

1. Em **Configure tags** (Configurar etiquetas), escolha **Next** (Próximo).

1. Escolha **Criar regra**.

Para obter mais informações, consulte [Criação de EventBridge regras da Amazon que reagem a eventos](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule.html) no guia do EventBridge usuário da Amazon.

# Criação de regras para enviar eventos do Amazon Quick Sight para AWS Lambda
<a name="events-send-lambda"></a>

Neste tutorial, você cria uma AWS Lambda função que registra os eventos do ativo na conta Amazon Quick Sight. Em seguida, você criará uma regra que executa a função sempre que houver uma alteração em um ativo. Este tutorial pressupõe que você já se inscreveu no Amazon Quick Sight.

**Etapa 1: criar uma Lambda função**

Crie uma função Lambda para registrar em log os eventos de alteração de estado. Você especifica essa função quando cria sua regra.

1. Faça login no Console de gerenciamento da AWS e abra o AWS Lambda console em [https://console.aws.amazon.com/lambda/](https://console.aws.amazon.com/lambda/).

1. Se você estiver começando a usar o Lambda, verá uma página de boas-vindas. Escolha **Get Started Now (Começar agora)**. Do contrário, escolha **Create function (Criar função)**.

1. Escolha **Author from scratch**.

1. Na página Criar função, insira um nome e uma descrição para a função do Lambda. Por exemplo, atribua à função o nome `QuickSightAssetChangeFn`.

1. Em **Runtime**, selecione **Node.js 18.x**.

1. Em **Architecture** (Arquitetura), escolha **x86\$164**.

1. Em **Perfil de execução**, escolha **Criar um novo perfil com as permissões básicas do Lambda** ou **Usar um perfil existente** e selecione o perfil desejado.

1. Escolha a opção **Criar função**.

1. Na **QuickSightAssetChange**página, escolha **index.js**.

1. No painel de **index.js**, exclua o código existente.

1. Insira o trecho de código apresentado a seguir.

   ```
   console.log('Loading function');
   exports.handler = async (event, context) => {
     console.log('Received QuickSight event:', JSON.stringify(event));
   };
   ```

1. Escolha **Deploy (Implantar)**.

**Etapa 2: Criar uma regra**

Crie uma regra para executar sua função Lambda sempre que você tiver um ativo do create/update/delete Amazon Quick Sight.

1. Faça login no Console de gerenciamento da AWS e abra o EventBridge console da Amazon em [https://console.aws.amazon.com/events/](https://console.aws.amazon.com/events/).

1. No painel de navegação, escolha **Regras**.

1. Escolha **Create rule**.

1. Insira um nome e uma descrição para a regra. Por exemplo, digite `QuickSightAssetChangeRule`.

1. Selecione o barramento de eventos **padrão**.

1. Escolha **Rule with an event pattern** (Regra com padrão de eventos), depois selecione **Next** (Próximo).

1. Em **Origem do evento**, escolha **AWS eventos ou eventos de EventBridge parceiros**.

1. Na seção **Método de criação**, escolha **Padrão personalizado (editor JSON)**.

1. Na caixa de texto **Padrão de evento**, insira o trecho de código apresentado a seguir e escolha **Próximo**.

   ```
   {
     "source": ["aws.quicksight"]
   }
   ```

   Como alternativa, você pode criar a regra que se inscreve somente em um subconjunto de tipos de eventos no Amazon Quick Sight. Por exemplo, a regra apresentada a seguir será acionada somente quando um ativo for adicionado ou removido de uma pasta com o ID `77e307e8-b41b-472a-90e8-fe3f471537be`.

   ```
   {
     "source": ["aws.quicksight"],
     "detail-type": ["QuickSight Folder Membership Updated"],
     "detail": {
       "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"
     }
   }
   ```

1. Em **Tipos de destino**, escolha **Serviço da AWS ** e **Função do Lambda**.

1. Em **Function** (Função), selecione a função do Lambda que você criou. Escolha **Próximo**.

1. Em **Configure tags** (Configurar etiquetas), escolha **Next** (Próximo).

1. Revise as etapas da sua regra. Em seguida, escolha **Create rule** (Criar regra).

**Etapa 3: Testar a regra**

Para testar a regra, crie uma análise. Após aguardar um minuto, verifique se a função do Lambda foi invocada.

1. Abra o console do Amazon Quick Sight em [https://quicksight.aws.amazon.com/](https://quicksight.aws.amazon.com/).

1. Criar uma nova análise.

1. No painel de navegação, escolha **Rules** (Regras) e escolha o nome da regra criada por você.

1. Em **Detalhes da regra**, escolha **Monitoramento**.

1. Você será redirecionado para o CloudWatch console da Amazon. Se você não for redirecionado, escolha **Exibir as métricas em CloudWatch**.

1. Em **All metrics** (Todas as métricas), escolha o nome da regra que você criou. O gráfico indica que a regra foi invocada.

1. No painel de navegação, escolha **Grupos de logs**.

1. Escolha o nome do grupo de logs para a função do Lambda. Por exemplo, .`/aws/lambda/function-name`

1. Escolha o nome do fluxo de logs para visualizar os dados fornecidos pela função para a instância que você iniciou. Será exibido um resultado semelhante ao seguinte:

   ```
   {
     "version": "0",
     "id": "3acb26c8-397c-4c89-a80a-ce672a864c55",
     "detail-type": "QuickSight Analysis Creation Successful",
     "source": "aws.quicksight",
     "account": "123456789012",
     "time": "2023-10-30T22:06:31Z",
     "region": "us-east-1",
     "resources": ["arn:aws:quicksight:us-east-1:123456789012:analysis/e5f37119-e24c-4874-901a-af9032b729b5"],
     "detail": {
       "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"
     }
   }
   ```

Para ver um exemplo do evento Amazon Quick Sight no formato JSON, consulte [Visão geral dos eventos do Amazon Quick Sight](https://docs.aws.amazon.com/quicksight/latest/developerguide/events.html).