QuickSight / Client / get_session_embed_url

get_session_embed_url

QuickSight.Client.get_session_embed_url(**kwargs)

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the ``UpdateUser ``API operation. Use ``RegisterUser ``API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:

• Embedding Analytics

• Customizing Access to the Amazon QuickSight Console

See also: AWS API Documentation

Request Syntax

response = client.get_session_embed_url(
    AwsAccountId='string',
    EntryPoint='string',
    SessionLifetimeInMinutes=123,
    UserArn='string'
)

Parameters:

• AwsAccountId (string) –

  [REQUIRED]

  The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

• EntryPoint (string) –

  The URL you use to access the embedded session. The entry point URL is constrained to the following paths:

  • /start

  • /start/analyses

  • /start/dashboards

  • /start/favorites

  • /dashboards/DashboardId ``- where ``DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard

  • /analyses/AnalysisId ``- where ``AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis

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

• UserArn (string) –

  The Amazon QuickSight user’s Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be 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.

Return type:

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 web page to embed your Amazon QuickSight session. 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.QuickSightUserNotFoundException

• QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidException

• QuickSight.Client.exceptions.UnsupportedUserEditionException

• QuickSight.Client.exceptions.InternalFailureException