Quick Sight Reporting now supports triggering scheduled reports via API

Quick Sight Reporting has expanded its event driven reporting capabilities by adding the ability to distribute pixel-perfect reports and dashboard reports via emails using APIs. Using the AWS SDK, developers can invoke StartDashboardSnapshotJobSchedule API to run the report, which will follow the configured scheduled report settings, including export type (PDF, CSV, Excel etc.) and email set up (subject line, body text, and attachment setting). The developer needs to obtain the schedule ID of an existing report schedule in Quick Sight console and provide it as an input to the API.

Within the Quick Sight console, running an email report on demand was already possible through the Run now option, but that required customers to be logged into Quick Sight. With this launch, developers can set up automated workflows to listen for Quick Sight events, such as dataset refresh events or signals specific to their business (outside of Quick Sight), and then start a report schedule programmatically to deliver to pre-selected readers.

Triggering email report schedule via API is now available in all supported Amazon Quick Sight regions - see here for Quick Sight regional endpoints.

For more on how to set up this setting, go to our documentation.


This is a companion discussion topic for the original entry at https://aws.amazon.com/about-aws/whats-new/2024/10/quicksight-reporting-triggering-scheduled-reports-api/