QuickSight Boto 3 Docs 1.9.185 documentation

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 .

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 .

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

See also: AWS API Documentation

Request Syntax

response = client.get_dashboard_embed_url( AwsAccountId='string', DashboardId='string', IdentityType='IAM'|'QUICKSIGHT', SessionLifetimeInMinutes=123, UndoRedoDisabled=True|False, ResetDisabled=True|False ) 
Parameters
  • AwsAccountId (string) --

    [REQUIRED]

    AWS account ID that contains the dashboard you are embedding.

  • DashboardId (string) --

    [REQUIRED]

    The ID for the dashboard, also added to IAM policy

  • IdentityType (string) --

    [REQUIRED]

    The authentication method the user uses to sign in (IAM only).

  • SessionLifetimeInMinutes (integer) -- How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
  • UndoRedoDisabled (boolean) -- Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
  • ResetDisabled (boolean) -- Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
Return type

dict

Returns

Response Syntax

{ 'EmbedUrl': 'string', 'Status': 123, 'RequestId': 'string' } 

Response Structure

  • (dict) --

    • EmbedUrl (string) --

      URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.

    • Status (integer) --

      The http status of the request.

    • RequestId (string) --

      The AWS request ID for this operation.

ncG1vNJzZmian6m8dHrAppizp56WxLR6wqikaK5hZLGwr9SmnKeskam2sLqOmqeiZ2Fjhm99l25mq52Wmr%2BmusKeZqydoqu2pLHSaKiuoZOgwKqzx61loaydoQ%3D%3D

 Share!