View a markdown version of this page

AWS Quick Sight events integration - AWS Quick

AWS Quick Sight events integration

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

Supported events

AWS Quick Sight currently supports the following events.

Asset type Action Event detail type Event detail

Dashboard

Create

AWS Quick Sight Dashboard Creation Successful

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

Dashboard

Create

AWS 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

AWS Quick Sight Dashboard Permissons Updated

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

Dashboard

Update

AWS Quick Sight Dashboard Update Successful

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

Dashboard

Update

AWS 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

AWS Quick Sight Dashboard Permissons Updated

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

Dashboard

Publish

AWS Quick Sight Dashboard Published Version Updated

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

Dashboard

Delete

AWS Quick Sight Dashboard Deleted

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

Analysis

Create

AWS Quick Sight Analysis Creation Successful

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

Analysis

Create

AWS 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

AWS Quick Sight Analysis Permissons Updated

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

Analysis

Delete

AWS Quick Sight Analysis Deleted

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

Analysis

Update

AWS Quick Sight Analysis update successful

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

Analysis

Update

AWS 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

AWS Quick Sight Analysis Permissons Updated

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

VPC connection

Create

AWS Quick Sight VPC Connection Creation Successful

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

VPC connection

Create

AWS Quick Sight VPC Connection Creation Failed

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

VPC connection

Update

AWS Quick Sight VPC Connection Update Successful

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

VPC connection

Update

AWS Quick Sight VPC Connection Update Failed

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

VPC connection

Delete

AWS Quick Sight VPC Connection Deletion Successful

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

VPC connection

Delete

AWS Quick Sight VPC Connection Deletion Failed

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

Folder

Create

AWS Quick Sight Folder Created

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

Folder

Create

AWS Quick Sight Folder Permissions Updated

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

Folder

Update

AWS Quick Sight Folder Updated

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

Folder

Update

AWS Quick Sight Folder Permissions Updated

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

Folder

Delete

AWS Quick Sight Folder Deleted

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

Folder

Membership update

AWS 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

AWS Quick Sight Dataset Created

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

Dataset

Create

AWS Quick Sight Dataset Permissions Updated

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

Dataset

Update

AWS Quick Sight Dataset Updated

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

Dataset

Update

AWS Quick Sight Dataset Permissions Updated

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

Dataset

Delete

AWS Quick Sight Dataset Deleted

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

DataSource

Create

AWS Quick Sight DataSource Creation Successful

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

DataSource

Create

AWS 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

AWS Quick Sight DataSource Permissions Updated

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

DataSource

Update

AWS Quick Sight DataSource Update Successful

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

DataSource

Update

AWS 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

AWS Quick Sight DataSource Permissions Updated

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

DataSource

Delete

AWS Quick Sight DataSource Deleted

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

Theme

Create

AWS Quick Sight Theme Creation Successful

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

Theme

Create

AWS Quick Sight Theme Creation Failed

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

Theme

Create

AWS Quick Sight Theme Permissions Updated

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

Theme

Update

AWS Quick Sight Theme Update Successful

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

Theme

Update

AWS Quick Sight Theme Update Failed

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

Theme

Update

AWS Quick Sight Theme Permissions Updated

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

Theme

Delete

AWS Quick Sight Theme deleted

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

Theme

Alias Create

AWS Quick Sight Theme Alias Created

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

Theme

Alias Update

AWS Quick Sight Alias Updated

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

Theme

Alias Delete

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