Amazon Quick Sight events integration - Amazon Quick Suite
Supported eventsExample event payload

Amazon Quick Sight events integration

With Amazon EventBridge, you can respond automatically to events in Amazon Quick Sight such as new dashboard creation or updates. These events are delivered to EventBridge in near real time. As a developer, you can write simple rules to indicate which events are of interest, and what actions to take when an event matches a rule. By using events, you can complete use cases such as continuous backup and deployment.

Topics

Supported events

Amazon Quick Sight currently supports the following events.

Asset type Action Event detail type Event detail

Dashboard

Create

Amazon Quick Sight Dashboard Creation Successful

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 1
}

Dashboard

Create

Amazon Quick Sight Dashboard Creation Failed

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 1,
    "errors": [
      {
        "Type": "PARAMETER_NOT_FOUND",
        "Message": "Missing property abc"
      },
      {
        "Type": "DATA_SET_NOT_FOUND",
        "Message": "Cannot find dataset with id abc"
      }
    ]
}

Dashboard

Create

Amazon Quick Sight Dashboard Permissons Updated

 
{"dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }

Dashboard

Update

Amazon Quick Sight Dashboard Update Successful

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 1
}

Dashboard

Update

Amazon Quick Sight Dashboard Update Failed

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 1,
    "errors": [
      {
        "Type": "PARAMETER_NOT_FOUND",
        "Message": "Missing property abc"
      },
      {
        "Type": "DATA_SET_NOT_FOUND",
        "Message": "Cannot find dataset with id abc"
      }
    ]
}

Dashboard

Update

Amazon Quick Sight Dashboard Permissons Updated

 
{"dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83"}

Dashboard

Publish

Amazon Quick Sight Dashboard Published Version Updated

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83",
    "versionNumber": 2
}

Dashboard

Delete

Amazon Quick Sight Dashboard Deleted

 
{
    "dashboardId": "6fdbc328-ebbd-457f-aa02-9780173afc83"
}

Analysis

Create

Amazon Quick Sight Analysis Creation Successful

 
{
    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"
}

Analysis

Create

Amazon Quick Sight Analysis Creation Failed

 
{
    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5",
    "errors": [
      {
        "Type": "PARAMETER_NOT_FOUND",
        "Message": "Missing property abc"
      },
      {
        "Type": "DATA_SET_NOT_FOUND",
        "Message": "Cannot find dataset with id abc"
      }
    ]
}

Analysis

Create

Amazon Quick Sight Analysis Permissons Updated

 
{"analysisId": "e5f37119-e24c-4874-901a-af9032b729b5" }

Analysis

Delete

Amazon Quick Sight Analysis Deleted

 
{
    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"
}

Analysis

Update

Amazon Quick Sight Analysis update successful

 
{
    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5"
}

Analysis

Update

Amazon Quick Sight Analysis update failed

 
{
    "analysisId": "e5f37119-e24c-4874-901a-af9032b729b5",    
    "errors": [        
        {            
            "Type": "PARAMETER_NOT_FOUND",            
            "Message": "Missing property abc"        
        },        
        {             
            "Type": "DATA_SET_NOT_FOUND",            
            "Message": "Cannot find dataset with id abc"        
        }    
    ]
}

Analysis

Update

Amazon Quick Sight Analysis Permissons Updated

 
{"analysisId": "e5f37119-e24c-4874-901a-af9032b729b5" }

VPC connection

Create

Amazon Quick Sight VPC Connection Creation Successful

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "CREATION_SUCCESSFUL"
}

VPC connection

Create

Amazon Quick Sight VPC Connection Creation Failed

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "CREATION_FAILED"
}

VPC connection

Update

Amazon Quick Sight VPC Connection Update Successful

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "UPDATE_SUCCESSFUL"
}

VPC connection

Update

Amazon Quick Sight VPC Connection Update Failed

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "UPDATE_FAILED"
}

VPC connection

Delete

Amazon Quick Sight VPC Connection Deletion Successful

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "DELETED"
}

VPC connection

Delete

Amazon Quick Sight VPC Connection Deletion Failed

 
{
    "vpcConnectionId": "53d34238-57e7-488d-b99a-a0037d275a4e",
    "availabilityStatus": "DELETION_FAILED"
}

Folder

Create

Amazon Quick Sight Folder Created

 
{
    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be",
    "parentFolderArn": "arn:aws:quicksight:us-east-1:123456789012:folder/098765432134"
}

Folder

Create

Amazon Quick Sight Folder Permissions Updated

 
{"folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" }

Folder

Update

Amazon Quick Sight Folder Updated

 
{
    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"
}

Folder

Update

Amazon Quick Sight Folder Permissions Updated

 
{"folderId": "77e307e8-b41b-472a-90e8-fe3f471537be" }

Folder

Delete

Amazon Quick Sight Folder Deleted

 
{
    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be"
}

Folder

Membership update

Amazon Quick Sight Folder Membership Updated

 
{
    "folderId": "77e307e8-b41b-472a-90e8-fe3f471537be",
    "membersAdded": ["arn:aws:quicksight:us-east-1:123456789012:analysis/e5f37119-e24c-4874-901a-af9032b729b5"],
    "membersRemoved": []
}

Dataset

Create

Amazon Quick Sight Dataset Created

 
{
    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"
}

Dataset

Create

Amazon Quick Sight Dataset Permissions Updated

 
{"datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa" }

Dataset

Update

Amazon Quick Sight Dataset Updated

 
{
    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"
}

Dataset

Update

Amazon Quick Sight Dataset Permissions Updated

 
{"datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa" }

Dataset

Delete

Amazon Quick Sight Dataset Deleted

 
{
    "datasetId": "a6553a81-f97e-4ffa-a860-baea63196efa"
}

DataSource

Create

Amazon Quick Sight DataSource Creation Successful

 
{
    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"
}

DataSource

Create

Amazon Quick Sight DataSource Creation Failed

 
{
    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824",
    "error": {
        "message": "AMAZON_ELASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7",
        "type": "ENGINE_VERSION_NOT_SUPPORTED"
    }
}

DataSource

Create

Amazon Quick Sight DataSource Permissions Updated

 
{"datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824" }

DataSource

Update

Amazon Quick Sight DataSource Update Successful

 
{
    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"
}

DataSource

Update

Amazon Quick Sight DataSource Update Failed

 
{
    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824",
    "error": {
        "message": "AMAZON_ELASTICSEARCH engine version 7.4 is lower than minimum supported version 7.7",
        "type": "ENGINE_VERSION_NOT_SUPPORTED"
    }
}

DataSource

Update

Amazon Quick Sight DataSource Permissions Updated

 
{"datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824" }

DataSource

Delete

Amazon Quick Sight DataSource Deleted

 
{
    "datasourceId": "230caa6e-dc87-406b-91fb-037f29c32824"
}

Theme

Create

Amazon Quick Sight Theme Creation Successful

 
{
    ""themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83", 
    "versionNumber": 1"
}

Theme

Create

Amazon Quick Sight Theme Creation Failed

 
{ 
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83", 
    "versionNumber": 1
}

Theme

Create

Amazon Quick Sight Theme Permissions Updated

 
{"themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }

Theme

Update

Amazon Quick Sight Theme Update Successful

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    
    "versionNumber": 2
}

Theme

Update

Amazon Quick Sight Theme Update Failed

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    
    "versionNumber": 2
}

Theme

Update

Amazon Quick Sight Theme Permissions Updated

 
{"themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83" }

Theme

Delete

Amazon Quick Sight Theme deleted

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83"
}

Theme

Alias Create

Amazon Quick Sight Theme Alias Created

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    
    "aliasName": "MyThemeAlias"    
    "versionNumber": 2
}

Theme

Alias Update

Amazon Quick Sight Alias Updated

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    
    "aliasName": "MyThemeAlias"    
    "versionNumber": 4
}

Theme

Alias Delete

Amazon Quick Sight Theme Alias Deleted

 
{
    "themeId": "6fdbc328-ebbd-457f-aa02-9780173afc83",    
    "aliasName": "MyThemeAlias"    
    "versionNumber": 2
}

Example event payload

All events follow the standard EventBridge object structure. The detail field is a JSON object that contains more information about the event.

{
  "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
  }
}