Amazon QuickSight events integration - Amazon QuickSight
Supported eventsExample event payload

Amazon QuickSight events integration

With Amazon EventBridge, you can respond automatically to events in Amazon QuickSight 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

QuickSight currently supports the following events.

Asset type Action Event detail type Event detail

Dashboard

Create

QuickSight Dashboard Creation Successful

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

Dashboard

Create

QuickSight 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

Update

QuickSight Dashboard Update Successful

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

Dashboard

Update

QuickSight 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

Publish

QuickSight Dashboard Published Version Updated

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

Dashboard

Delete

QuickSight Dashboard Deleted

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

Analysis

Create

QuickSight Analysis Creation Successful

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

Analysis

Create

QuickSight 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

Delete

QuickSight Analysis Deleted

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

Analysis

Update

QuickSight Analysis update successful

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

Analysis

Update

QuickSight 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"        
        }    
    ]
}

VPC connection

Create

QuickSight VPC Connection Creation Successful

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

VPC connection

Create

QuickSight VPC Connection Creation Failed

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

VPC connection

Update

QuickSight VPC Connection Update Successful

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

VPC connection

Update

QuickSight VPC Connection Update Failed

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

VPC connection

Delete

QuickSight VPC Connection Deletion Successful

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

VPC connection

Delete

QuickSight VPC Connection Deletion Failed

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

Folder

Create

QuickSight Folder Created

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

Folder

Update

QuickSight Folder Updated

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

Folder

Delete

QuickSight Folder Deleted

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

Folder

Membership update

QuickSight 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

QuickSight Dataset Created

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

Dataset

Update

QuickSight Dataset Updated

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

Dataset

Delete

QuickSight Dataset Deleted

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

DataSource

Create

QuickSight DataSource Creation Successful

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

DataSource

Create

QuickSight 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

Update

QuickSight DataSource Update Successful

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

DataSource

Update

QuickSight 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

Delete

QuickSight DataSource Deleted

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

Theme

Create

QuickSight Theme creation successful

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

Theme

Create

QuickSight Theme creation failed

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

Theme

Update

QuickSight Theme update successful

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

Theme

Update

QuickSight Theme update failed

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

Theme

Delete

QuickSight Theme deleted

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

Theme

Alias Create

QuickSight Theme alias created

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

Theme

Alias Update

QuickSight Alias updated

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

Theme

Alias Delete

QuickSight 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
  }
}