public static interface RegisteredUserEmbeddingExperienceConfiguration.Builder extends SdkPojo, CopyableBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,RegisteredUserEmbeddingExperienceConfiguration>
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRegisteredUserEmbeddingExperienceConfiguration.Builder dashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard)
The configuration details for providing a dashboard embedding experience.
dashboard - The configuration details for providing a dashboard embedding experience.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.Builder avoiding the need to create one manually via
RegisteredUserDashboardEmbeddingConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to
dashboard(RegisteredUserDashboardEmbeddingConfiguration).
dashboard - a consumer that will call methods on RegisteredUserDashboardEmbeddingConfiguration.Builderdashboard(RegisteredUserDashboardEmbeddingConfiguration)RegisteredUserEmbeddingExperienceConfiguration.Builder quickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole)
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:
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.
quickSightConsole - 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:
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.
default RegisteredUserEmbeddingExperienceConfiguration.Builder quickSightConsole(Consumer<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder> quickSightConsole)
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:
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.
This is a convenience method that creates an instance of theRegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder avoiding the need to create one
manually via RegisteredUserQuickSightConsoleEmbeddingConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to quickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration).
quickSightConsole - a consumer that will call methods on
RegisteredUserQuickSightConsoleEmbeddingConfiguration.BuilderquickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration)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 QuickSight User Guide.
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 QuickSight User Guide.
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 QuickSight User Guide.
This is a convenience method that creates an instance of theRegisteredUserQSearchBarEmbeddingConfiguration.Builder avoiding the need to create one manually via
RegisteredUserQSearchBarEmbeddingConfiguration.builder().
When the Consumer completes, SdkBuilder.build()
is called immediately and its result is passed to
qSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration).
qSearchBar - a consumer that will call methods on RegisteredUserQSearchBarEmbeddingConfiguration.BuilderqSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration)RegisteredUserEmbeddingExperienceConfiguration.Builder dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual)
The type of embedding experience. In this case, Amazon QuickSight visuals.
dashboardVisual - The type of embedding experience. In this case, Amazon QuickSight visuals.default RegisteredUserEmbeddingExperienceConfiguration.Builder dashboardVisual(Consumer<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder> dashboardVisual)
The type of embedding experience. In this case, Amazon QuickSight visuals.
This is a convenience method that creates an instance of theRegisteredUserDashboardVisualEmbeddingConfiguration.Builder avoiding the need to create one manually
via RegisteredUserDashboardVisualEmbeddingConfiguration.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration).
dashboardVisual - a consumer that will call methods on
RegisteredUserDashboardVisualEmbeddingConfiguration.BuilderdashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration)Copyright © 2023. All rights reserved.