Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
quicksight_get_dashboard_embed_url(AwsAccountId, DashboardId,
IdentityType, SessionLifetimeInMinutes, UndoRedoDisabled, ResetDisabled)[required] AWS account ID that contains the dashboard you are embedding.
[required] The ID for the dashboard, also added to IAM policy
[required] The authentication method the user uses to sign in (IAM only).
How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
svc$get_dashboard_embed_url( AwsAccountId = "string", DashboardId = "string", IdentityType = "IAM"|"QUICKSIGHT", SessionLifetimeInMinutes = 123, UndoRedoDisabled = TRUE|FALSE, ResetDisabled = TRUE|FALSE )
Currently, you can use GetDashboardEmbedURL only from the server, not
from the user's browser.
CLI Sample:
Assume the role with permissions enabled for actions:
quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can
use assume-role, assume-role-with-web-identity, or
assume-role-with-saml.
aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
If the user does not exist in QuickSight, register the user:
aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1
Get the URL for the embedded dashboard
aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM