Embedded analytics for AWS Quick Sight
Important
AWS Quick Sight has new API operations for embedding analytics:
GenerateEmbedUrlForAnonymousUser and
GenerateEmbedUrlForRegisteredUser.
You can still use the GetDashboardEmbedUrl and
GetSessionEmbedUrl API operations to embed dashboards and the
AWS Quick Sight console, but they don't contain the latest embedding capabilities. For
more information about embedding using the old API operations, see Embedding analytics using the GetDashboardEmbedURL and GetSessionEmbedURL API operations.
|  Applies to: Enterprise Edition |
|   Intended audience: AWS Quick developers |
With AWS Quick Sight embedded analytics, you can seamlessly integrate data-driven experiences into your software applications. You can style the embedded components to match your brand. This capability brings the power of AWS Quick Sight to your end users, where they can analyze and interact with data without ever leaving the application. Improving the user experience by reducing cognitive complexity gives users a better opportunity for deeper understanding and effectiveness.
AWS Quick Sight supports embedding for these elements:
-
AWS Quick Sight console (full authoring experience for registered users )
-
AWS Quick Sight dashboards and visuals (for registered users, anonymous users, public end users)
-
AWS Quick Sight Q search bar (for registered users and anonymous users)
With an embedded AWS Quick Sight console, you embed the full AWS Quick Sight experience. Doing this makes it possible to use AWS Quick Sight authoring tools as part of your application, rather than in the context of the AWS Management Console or a standalone website. Users of an embedded AWS Quick Sight console need to be registered as AWS Quick Sight authors or admins in your AWS account. They also need to be authenticated into the same AWS account, using any of the AWS Quick Sight-supported authentication methods.
With an embedded AWS Quick Sight dashboard or visual, readers get the same functionality and interactivity as they do in a published dashboard or visual. To use an embedded dashboard or visual, readers (viewers) can include any of the following:
-
AWS Quick Sight users authenticated in your AWS account by any method supported by AWS Quick Sight.
-
Unauthenticated visitors to a website or application – This option requires session packs with capacity pricing . For information about subscription types, see Understanding AWS Quick Sight subscriptions and roles.
-
Multiple end users viewing a display on monitors or large screens by programmatic access.
If your app also resides in AWS, the app doesn't need to reside on the same AWS account as the AWS Quick Sight subscription. However, the app needs to be able to assume the AWS Identity and Access Management (IAM) role that you use for the API calls.
Before you can embed content, make sure that you're using AWS Quick Sight Enterprise edition in the AWS account where you plan to use embedding.
AWS Quick Sight embedding is available in all supported AWS Regions.