Skip to content

Generate Embed Url For Anonymous User

quicksight_generate_embed_url_for_anonymous_user R Documentation

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

Description

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.

Usage

quicksight_generate_embed_url_for_anonymous_user(AwsAccountId,
  SessionLifetimeInMinutes, Namespace, SessionTags,
  AuthorizedResourceArns, ExperienceConfiguration, AllowedDomains)

Arguments

AwsAccountId

[required] The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

SessionLifetimeInMinutes

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

Namespace

[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

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 Tagsin the Amazon QuickSight User Guide.

AuthorizedResourceArns

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

ExperienceConfiguration

[required] The configuration of the experience that you are embedding.

AllowedDomains

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

Value

A list with the following syntax: 

list(
  EmbedUrl = "string",
  Status = 123,
  RequestId = "string",
  AnonymousUserArn = "string"
)

Request syntax

svc$generate_embed_url_for_anonymous_user(
  AwsAccountId = "string",
  SessionLifetimeInMinutes = 123,
  Namespace = "string",
  SessionTags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  AuthorizedResourceArns = list(
    "string"
  ),
  ExperienceConfiguration = list(
    Dashboard = list(
      InitialDashboardId = "string",
      EnabledFeatures = list(
        "SHARED_VIEW"
      ),
      DisabledFeatures = list(
        "SHARED_VIEW"
      ),
      FeatureConfigurations = list(
        SharedView = list(
          Enabled = TRUE|FALSE
        )
      )
    ),
    DashboardVisual = list(
      InitialDashboardVisualId = list(
        DashboardId = "string",
        SheetId = "string",
        VisualId = "string"
      )
    ),
    QSearchBar = list(
      InitialTopicId = "string"
    ),
    GenerativeQnA = list(
      InitialTopicId = "string"
    )
  ),
  AllowedDomains = list(
    "string"
  )
)