Class: Aws::QuickSight::Types::RegisteredUserEmbeddingExperienceConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-quicksight/types.rb

Overview

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

<note markdown=“1”> Exactly one of the experience configurations is required. You can choose ‘Dashboard` or `QuickSightConsole`. You cannot choose more than one experience configuration.

</note>

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dashboard ⇒ Types::RegisteredUserDashboardEmbeddingConfiguration

The configuration details for providing a dashboard embedding experience.

Returns:



27359
27360
27361
27362
27363
27364
27365
27366
27367
 
# File 'lib/aws-sdk-quicksight/types.rb', line 27359

class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
  :dashboard,
  :quick_sight_console,
  :q_search_bar,
  :dashboard_visual,
  :generative_qn_a)
  SENSITIVE = []
  include Aws::Structure
end

#dashboard_visual ⇒ Types::RegisteredUserDashboardVisualEmbeddingConfiguration

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

Returns:



27359
27360
27361
27362
27363
27364
27365
27366
27367
 
# File 'lib/aws-sdk-quicksight/types.rb', line 27359

class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
  :dashboard,
  :quick_sight_console,
  :q_search_bar,
  :dashboard_visual,
  :generative_qn_a)
  SENSITIVE = []
  include Aws::Structure
end

#generative_qn_a ⇒ Types::RegisteredUserGenerativeQnAEmbeddingConfiguration

The configuration details for embedding the Generative Q&amp;A experience.

For more information about embedding the Generative Q&amp;A experience, see [Embedding Overview] in the *Amazon QuickSight User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html

Returns:



27359
27360
27361
27362
27363
27364
27365
27366
27367
 
# File 'lib/aws-sdk-quicksight/types.rb', line 27359

class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
  :dashboard,
  :quick_sight_console,
  :q_search_bar,
  :dashboard_visual,
  :generative_qn_a)
  SENSITIVE = []
  include Aws::Structure
end

#q_search_bar ⇒ Types::RegisteredUserQSearchBarEmbeddingConfiguration

The configuration details for embedding the Q search bar.

For more information about embedding the Q search bar, see

Embedding Overview][1

in the *Amazon QuickSight User Guide*.

[1]: docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html

Returns:



27359
27360
27361
27362
27363
27364
27365
27366
27367
 
# File 'lib/aws-sdk-quicksight/types.rb', line 27359

class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
  :dashboard,
  :quick_sight_console,
  :q_search_bar,
  :dashboard_visual,
  :generative_qn_a)
  SENSITIVE = []
  include Aws::Structure
end

#quick_sight_console ⇒ Types::RegisteredUserQuickSightConsoleEmbeddingConfiguration

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see [Customizing Access to the Amazon QuickSight Console] in the *Amazon QuickSight User Guide*.

Use ‘ GenerateEmbedUrlForRegisteredUser ` where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 the ` 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 the Full Functionality of the Amazon QuickSight Console for Authenticated Users]

  • Customizing Access to the Amazon QuickSight Console][1

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

[1]: docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html [2]: docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html [3]: docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html

Returns:



27359
27360
27361
27362
27363
27364
27365
27366
27367
 
# File 'lib/aws-sdk-quicksight/types.rb', line 27359

class RegisteredUserEmbeddingExperienceConfiguration < Struct.new(
  :dashboard,
  :quick_sight_console,
  :q_search_bar,
  :dashboard_visual,
  :generative_qn_a)
  SENSITIVE = []
  include Aws::Structure
end