amazon-quicksight-embedding-sdk | A SDK to help users embed QuickSight dashboards on other pages | AWS library

The process to set up QuickSight embedding is similar in both cases. The differences between setting up the two embedded experiences are as follows:. Details for each option are provided below in step 2.
You use a different SDK object for each embedded QuickSight experience. You use embedDashboard to embed a dashboard, and you use embedSession to embed an authoring portal.
You use a different API for each embedded experience. For more information, see QuickSight Embedding APIs
Different options are supported for each embedded experience.
Embedded dashboards are always read-only. The level of interactivity is set when the dashboard is published.
Embedded authoring ports allow the user to create QuickSight assets, just like they can in the AWS console for QuickSight. Exactly what the user can do in the console is controlled by a custom permission profile. The profile can remove abilities such as creating or updating data sources and datasets. You can set also the default visual type. Embedded consoles currently don't support screen scaling in formatting options.
Do ONE of the following:.
Option 1: Use the Amazon QuickSight Embedding SDK in the browser:
Option 2: Install and use the QuickSight Embedding SDK in Node.js:
If you want your application to get notified and respond when the Amazon QuickSight dashboard is fully loaded, use a load callback. Choose one of the following:.
Use options:
Or, register the "load" event on the returned dashboard object:
If you want your application get notified and respond when the embedded QuickSight session fails to load, use a error callback. Choose one of the following:.
Use options:
Or, register the "error" event on the returned dashboard object:
To register the "error" event on the returned console session object:
Forbidden -- the URL's authentication code expired
Unauthorized -- the session obtained from the authentication code expired
If you want your application to get notified and respond when the parameters in Amazon QuickSight dashboard changes, use the parameter change callback. Choose one of the following:.
Use options:
Or, register the "parametersChange" event on the returned dashboard object:
If you want your application to get notified and respond when the selected sheet in Amazon QuickSight dashboard changes, use the selected sheet change callback. Choose one of the following:.
Use options:
Or, register the "selectedSheetChange" event on the returned dashboard object: