Interface RegisteredUserEmbeddingExperienceConfiguration.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,,RegisteredUserEmbeddingExperienceConfiguration> SdkBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,,RegisteredUserEmbeddingExperienceConfiguration> SdkPojo
- Enclosing class:
RegisteredUserEmbeddingExperienceConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionThe configuration details for providing a dashboard embedding experience.The configuration details for providing a dashboard embedding experience.dashboardVisual(Consumer<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder> dashboardVisual) The type of embedding experience.dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual) The type of embedding experience.The configuration details for embedding the Generative Q&A experience.generativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA) The configuration details for embedding the Generative Q&A experience.The configuration details for embedding the Q search bar.The configuration details for embedding the Q search bar.The configuration details for embedding the Quick chat agent.The configuration details for embedding the Quick chat agent.quickSightConsole(Consumer<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder> quickSightConsole) The configuration details for providing each Amazon Quick Sight console embedding experience.quickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole) The configuration details for providing each Amazon Quick Sight console embedding experience.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
dashboard
RegisteredUserEmbeddingExperienceConfiguration.Builder dashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard) The configuration details for providing a dashboard embedding experience.
- Parameters:
dashboard- The configuration details for providing a dashboard embedding experience.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashboard
default RegisteredUserEmbeddingExperienceConfiguration.Builder dashboard(Consumer<RegisteredUserDashboardEmbeddingConfiguration.Builder> dashboard) The configuration details for providing a dashboard embedding experience.
This is a convenience method that creates an instance of theRegisteredUserDashboardEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserDashboardEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todashboard(RegisteredUserDashboardEmbeddingConfiguration).- Parameters:
dashboard- a consumer that will call methods onRegisteredUserDashboardEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
quickSightConsole
RegisteredUserEmbeddingExperienceConfiguration.Builder quickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole) 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 Quick Suite User Guide.
Use
GenerateEmbedUrlForRegisteredUserwhere 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 theUpdateUserAPI operation. Use theRegisterUserAPI operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite 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 Quick Suite Developer Portal.
- Parameters:
quickSightConsole- 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 Quick Suite User Guide.Use
GenerateEmbedUrlForRegisteredUserwhere 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 theUpdateUserAPI operation. Use theRegisterUserAPI operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite 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 Quick Suite Developer Portal.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
quickSightConsole
default RegisteredUserEmbeddingExperienceConfiguration.Builder quickSightConsole(Consumer<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder> quickSightConsole) 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 Quick Suite User Guide.
Use
GenerateEmbedUrlForRegisteredUserwhere 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 theUpdateUserAPI operation. Use theRegisterUserAPI operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon Quick Suite 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 Quick Suite Developer Portal.
This is a convenience method that creates an instance of theRegisteredUserQuickSightConsoleEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserQuickSightConsoleEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toquickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration).- Parameters:
quickSightConsole- a consumer that will call methods onRegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
qSearchBar
RegisteredUserEmbeddingExperienceConfiguration.Builder qSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar) 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.
- Parameters:
qSearchBar- 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:
- Returns a reference to this object so that method calls can be chained together.
-
qSearchBar
default RegisteredUserEmbeddingExperienceConfiguration.Builder qSearchBar(Consumer<RegisteredUserQSearchBarEmbeddingConfiguration.Builder> qSearchBar) 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.
This is a convenience method that creates an instance of theRegisteredUserQSearchBarEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserQSearchBarEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toqSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration).- Parameters:
qSearchBar- a consumer that will call methods onRegisteredUserQSearchBarEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dashboardVisual
RegisteredUserEmbeddingExperienceConfiguration.Builder dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual) The type of embedding experience. In this case, Amazon Quick Sight visuals.
- Parameters:
dashboardVisual- The type of embedding experience. In this case, Amazon Quick Sight visuals.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashboardVisual
default RegisteredUserEmbeddingExperienceConfiguration.Builder dashboardVisual(Consumer<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder> dashboardVisual) The type of embedding experience. In this case, Amazon Quick Sight visuals.
This is a convenience method that creates an instance of theRegisteredUserDashboardVisualEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserDashboardVisualEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration).- Parameters:
dashboardVisual- a consumer that will call methods onRegisteredUserDashboardVisualEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
generativeQnA
RegisteredUserEmbeddingExperienceConfiguration.Builder generativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA) 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.
- Parameters:
generativeQnA- 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:
- Returns a reference to this object so that method calls can be chained together.
-
generativeQnA
default RegisteredUserEmbeddingExperienceConfiguration.Builder generativeQnA(Consumer<RegisteredUserGenerativeQnAEmbeddingConfiguration.Builder> generativeQnA) 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.
This is a convenience method that creates an instance of theRegisteredUserGenerativeQnAEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserGenerativeQnAEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed togenerativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration).- Parameters:
generativeQnA- a consumer that will call methods onRegisteredUserGenerativeQnAEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
quickChat
RegisteredUserEmbeddingExperienceConfiguration.Builder quickChat(RegisteredUserQuickChatEmbeddingConfiguration quickChat) The configuration details for embedding the Quick chat agent.
- Parameters:
quickChat- The configuration details for embedding the Quick chat agent.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
quickChat
default RegisteredUserEmbeddingExperienceConfiguration.Builder quickChat(Consumer<RegisteredUserQuickChatEmbeddingConfiguration.Builder> quickChat) The configuration details for embedding the Quick chat agent.
This is a convenience method that creates an instance of theRegisteredUserQuickChatEmbeddingConfiguration.Builderavoiding the need to create one manually viaRegisteredUserQuickChatEmbeddingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toquickChat(RegisteredUserQuickChatEmbeddingConfiguration).- Parameters:
quickChat- a consumer that will call methods onRegisteredUserQuickChatEmbeddingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-