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

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

Overview

The type of experience you want to embed. For registered users, you can embed QuickSight 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.

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:



29891
29892
29893
29894
29895
29896
29897
29898
29899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29891

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 Quick Sight visuals.

Returns:



29891
29892
29893
29894
29895
29896
29897
29898
29899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29891

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&A experience.

For more information about embedding the Generative Q&A experience, see Embedding Overview in the Amazon Quick Sight User Guide.

Returns:



29891
29892
29893
29894
29895
29896
29897
29898
29899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29891

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 in the Amazon Quick Sight User Guide.

Returns:



29891
29892
29893
29894
29895
29896
29897
29898
29899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29891

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 Quick Sight 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 Quick Sight 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 Quick Sight 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:

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.

Returns:



29891
29892
29893
29894
29895
29896
29897
29898
29899
 
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 29891

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