QuickSight / Client / get_dashboard_embed_url

get_dashboard_embed_url#

QuickSight.Client.get_dashboard_embed_url(**kwargs)#

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. 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 generated URL:

  • They must be used together.

  • They can be used one time only.

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

  • You are charged only when the URL is used or there is interaction with Amazon QuickSight.

  • The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.

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

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

See also: AWS API Documentation

Request Syntax

response = client.get_dashboard_embed_url(
    AwsAccountId='string',
    DashboardId='string',
    IdentityType='IAM'|'QUICKSIGHT'|'ANONYMOUS',
    SessionLifetimeInMinutes=123,
    UndoRedoDisabled=True|False,
    ResetDisabled=True|False,
    StatePersistenceEnabled=True|False,
    UserArn='string',
    Namespace='string',
    AdditionalDashboardIds=[
        'string',
    ]
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID for the Amazon Web Services account that contains the dashboard that you’re embedding.

  • DashboardId (string) –

    [REQUIRED]

    The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.

  • IdentityType (string) –

    [REQUIRED]

    The authentication method that the user uses to sign in.

  • SessionLifetimeInMinutes (integer) – How many minutes the session is valid. The session lifetime must be 15-600 minutes.

  • UndoRedoDisabled (boolean) – Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.

  • ResetDisabled (boolean) – Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.

  • StatePersistenceEnabled (boolean) – 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 (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE , the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon 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 .

  • UserArn (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.

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

  • Namespace (string) – The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you’re not using a custom namespace, set Namespace = default .

  • AdditionalDashboardIds (list) –

    A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set “ --dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS “, the session can access all three dashboards.

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    Output returned from the GetDashboardEmbedUrl operation.

    • 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 Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceExistsException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.DomainNotWhitelistedException

  • QuickSight.Client.exceptions.QuickSightUserNotFoundException

  • QuickSight.Client.exceptions.IdentityTypeNotSupportedException

  • QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.UnsupportedPricingPlanException

  • QuickSight.Client.exceptions.InternalFailureException