Amazon QuickSight events integration - Amazon QuickSight

Important: We've redesigned the Amazon QuickSight analysis workspace. You might encounter screenshots or procedural text that doesn't reflect the new look in the QuickSight console. We're in the process of updating screenshots and procedural text.

To find a feature or item, use the Quick search bar.

For more information on QuickSight's new look, see Introducing new analysis experience on Amazon QuickSight.

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.

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

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": [] }

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