Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . quicksight ]

get-dashboard-embed-url

Description

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

See 'aws help' for descriptions of global parameters.

Synopsis

  get-dashboard-embed-url
--aws-account-id <value>
--dashboard-id <value>
--identity-type <value>
[--session-lifetime-in-minutes <value>]
[--undo-redo-disabled | --no-undo-redo-disabled]
[--reset-disabled | --no-reset-disabled]
[--user-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

AWS account ID that contains the dashboard you are embedding.

--dashboard-id (string)

The ID for the dashboard, also added to IAM policy

--identity-type (string)

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

Possible values:

  • IAM
  • QUICKSIGHT

--session-lifetime-in-minutes (long)

How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

--undo-redo-disabled | --no-undo-redo-disabled (boolean)

Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

--reset-disabled | --no-reset-disabled (boolean)

Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

--user-arn (string)

The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

  • Amazon QuickSight users in your account (readers, authors, or admins)
  • AD users
  • Invited non-federated users
  • Federated IAM users
  • Federated IAM role-based sessions

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

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.