QuickSight / Client / generate_embed_url_for_anonymous_user

generate_embed_url_for_anonymous_user#

QuickSight.Client.generate_embed_url_for_anonymous_user(**kwargs)#

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.

The following rules apply to the generated URL:

  • It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.

  • The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.

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

For more information, see Embedded Analytics 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.generate_embed_url_for_anonymous_user(
    AwsAccountId='string',
    SessionLifetimeInMinutes=123,
    Namespace='string',
    SessionTags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    AuthorizedResourceArns=[
        'string',
    ],
    ExperienceConfiguration={
        'Dashboard': {
            'InitialDashboardId': 'string'
        },
        'DashboardVisual': {
            'InitialDashboardVisualId': {
                'DashboardId': 'string',
                'SheetId': 'string',
                'VisualId': 'string'
            }
        },
        'QSearchBar': {
            'InitialTopicId': 'string'
        }
    },
    AllowedDomains=[
        'string',
    ]
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

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

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

  • Namespace (string) –

    [REQUIRED]

    The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

  • SessionTags (list) –

    The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

    These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see `Using Row-Level Security (RLS) with Tags <https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html>`__in the Amazon QuickSight User Guide.

    • (dict) –

      The key-value pair used for the row-level security tags feature.

      • Key (string) – [REQUIRED]

        The key for the tag.

      • Value (string) – [REQUIRED]

        The value that you want to assign the tag.

  • AuthorizedResourceArns (list) –

    [REQUIRED]

    The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session.

    If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view.

    If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

    Currently, you can pass up to 25 theme ARNs in each API call.

    • (string) –

  • ExperienceConfiguration (dict) –

    [REQUIRED]

    The configuration of the experience that you are embedding.

    • Dashboard (dict) –

      The type of embedding experience. In this case, Amazon QuickSight dashboards.

      • InitialDashboardId (string) – [REQUIRED]

        The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.

        The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

    • DashboardVisual (dict) –

      The type of embedding experience. In this case, Amazon QuickSight visuals.

      • InitialDashboardVisualId (dict) – [REQUIRED]

        The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.

        The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

        • DashboardId (string) – [REQUIRED]

          The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual’s on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

        • SheetId (string) – [REQUIRED]

          The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual’s on-visual menu of the Amazon QuickSight console.

        • VisualId (string) – [REQUIRED]

          The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual’s on-visual menu of the Amazon QuickSight console.

    • QSearchBar (dict) –

      The Q search bar that you want to use for anonymous user embedding.

      • InitialTopicId (string) – [REQUIRED]

        The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.

        The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

  • AllowedDomains (list) –

    The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.

    To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.

    • (string) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • EmbedUrl (string) –

      The embed URL for the dashboard.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • AnonymousUserArn (string) –

      The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.SessionLifetimeInMinutesInvalidException

  • QuickSight.Client.exceptions.UnsupportedUserEditionException

  • QuickSight.Client.exceptions.UnsupportedPricingPlanException

  • QuickSight.Client.exceptions.InternalFailureException