Generate Embed Url For Registered User With Identity

quicksight_generate_embed_url_for_registered_user_with_identity

R Documentation

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website

Description

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessions for the authenticated user that the API call is being made for.

This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sight with the scope value set to quicksight:read. Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.

Usage

quicksight_generate_embed_url_for_registered_user_with_identity(
  AwsAccountId, SessionLifetimeInMinutes, ExperienceConfiguration,
  AllowedDomains)

Arguments

AwsAccountId	[required] The ID of the Amazon Web Services registered user.
SessionLifetimeInMinutes	The validity of the session in minutes.
ExperienceConfiguration	[required] The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console. Exactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuration.
AllowedDomains	A list of domains to be allowed to generate the embed URL.

Value

A list with the following syntax:

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

Request syntax

svc$generate_embed_url_for_registered_user_with_identity(
  AwsAccountId = "string",
  SessionLifetimeInMinutes = 123,
  ExperienceConfiguration = list(
    Dashboard = list(
      InitialDashboardId = "string",
      FeatureConfigurations = list(
        StatePersistence = list(
          Enabled = TRUE|FALSE
        ),
        Bookmarks = list(
          Enabled = TRUE|FALSE
        ),
        SharedView = list(
          Enabled = TRUE|FALSE
        ),
        AmazonQInQuickSight = list(
          ExecutiveSummary = list(
            Enabled = TRUE|FALSE
          )
        ),
        Schedules = list(
          Enabled = TRUE|FALSE
        ),
        RecentSnapshots = list(
          Enabled = TRUE|FALSE
        ),
        ThresholdAlerts = list(
          Enabled = TRUE|FALSE
        ),
        DashboardCustomizationSummary = list(
          Enabled = TRUE|FALSE
        )
      )
    ),
    QuickSightConsole = list(
      InitialPath = "string",
      FeatureConfigurations = list(
        StatePersistence = list(
          Enabled = TRUE|FALSE
        ),
        SharedView = list(
          Enabled = TRUE|FALSE
        ),
        AmazonQInQuickSight = list(
          DataQnA = list(
            Enabled = TRUE|FALSE
          ),
          GenerativeAuthoring = list(
            Enabled = TRUE|FALSE
          ),
          ExecutiveSummary = list(
            Enabled = TRUE|FALSE
          ),
          DataStories = list(
            Enabled = TRUE|FALSE
          )
        ),
        Schedules = list(
          Enabled = TRUE|FALSE
        ),
        RecentSnapshots = list(
          Enabled = TRUE|FALSE
        ),
        ThresholdAlerts = list(
          Enabled = TRUE|FALSE
        ),
        DashboardCustomizationSummary = list(
          Enabled = TRUE|FALSE
        )
      )
    ),
    QSearchBar = list(
      InitialTopicId = "string"
    ),
    DashboardVisual = list(
      InitialDashboardVisualId = list(
        DashboardId = "string",
        SheetId = "string",
        VisualId = "string"
      )
    ),
    GenerativeQnA = list(
      InitialTopicId = "string"
    ),
    QuickChat = list()
  ),
  AllowedDomains = list(
    "string"
  )
)