Table Of Contents


User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . quicksight ]



Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference .

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--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>]


--aws-account-id (string)

The ID for the AWS account that contains the dashboard that you're embedding.

--dashboard-id (string)

The ID for the dashboard, also added to the IAM policy.

--identity-type (string)

The authentication method that the user uses to sign in.

Possible values:

  • IAM

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

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

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

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

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

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

--user-arn (string)

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:

  • Active Directory (AD) users or group members
  • Invited nonfederated users
  • IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.

--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.


EmbedUrl -> (string)

An 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 value that enables a single sign-on session.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The AWS request ID for this operation.