Creating Embedded Dashboards with Amazon QuickSight - Amazon QuickSight

Creating Embedded Dashboards with Amazon QuickSight

    Applies to: Enterprise Edition 

    Intended audience: Amazon QuickSight developers 

In the following sections, you can find detailed information on how to set up embedded dashboards. Users can be authenticated either by AWS Managed Microsoft AD or by Federated Single Sign-On (SAML, OpenID Connect, or IAM Federation). To generate a URL to access an embedded dashboard, you use an IAM role to get a temporary set of credentials on behalf of the user.

In addition to reviewing the steps described in the following sections, you might be interested in the examples available at the following links:

  • Amazon QuickSight Embedding SDK Sample – This example explains how to use a JavaScript SDK created by the Amazon QuickSight team to simplify dashboard embedding. This example is also available on NPM.

  • Amazon QuickSight Embedding Sample with Infrastructure – This example sets up a serverless environment to host embedded dashboards on a website. It uses AWS services such as AWS CloudFormation, Amazon API Gateway, Amazon Cognito, and AWS Lambda. We use Amazon Cognito for authenticating users into the app. You can also use your own identity provider and change the Lambda code accordingly). Amazon API Gateway is used to expose an API that can be invoked by the web app. The API gateway triggers a function in AWS Lambda, which eventually calls the GetDashboardEmbedUrl API with the parameters that you pass to the API gateway, along with the Amazon Cognito user credentials. An authenticated Amazon Cognito role, bound to the Cognito Identity Pool, is used to call the embedding API to get the embedding URL.