Amazon QuickSight

{'StatePersistenceEnabled': 'boolean'}

Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

• They must be used together.

• They can be used one time only.

• They are valid for 5 minutes after you run this command.

• The resulting user session is valid for 10 hours.

For more information, see Embedding Amazon QuickSight in the Amazon QuickSight User Guide .

See also: AWS API Documentation

Request Syntax

client.get_dashboard_embed_url(
    AwsAccountId='string',
    DashboardId='string',
    IdentityType='IAM'|'QUICKSIGHT',
    SessionLifetimeInMinutes=123,
    UndoRedoDisabled=True|False,
    ResetDisabled=True|False,
    StatePersistenceEnabled=True|False,
    UserArn='string'
)

type AwsAccountId:

string

param AwsAccountId:

[REQUIRED]

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

type DashboardId:

string

param DashboardId:

[REQUIRED]

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

type IdentityType:

string

param IdentityType:

[REQUIRED]

The authentication method that the user uses to sign in.

type SessionLifetimeInMinutes:

integer

param SessionLifetimeInMinutes:

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

type UndoRedoDisabled:

boolean

param UndoRedoDisabled:

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

type ResetDisabled:

boolean

param ResetDisabled:

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

type StatePersistenceEnabled:

boolean

param StatePersistenceEnabled:

Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.

type UserArn:

string

param UserArn:

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.

Omit this parameter for users in the third group – IAM users and IAM role-based sessions.

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • EmbedUrl (string) --

    A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

  • Status (integer) --

    The HTTP status of the request.

  • RequestId (string) --

    The AWS request ID for this operation.