Interface RegisteredUserEmbeddingExperienceConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,RegisteredUserEmbeddingExperienceConfiguration>, SdkBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,RegisteredUserEmbeddingExperienceConfiguration>, SdkPojo

Enclosing class:

RegisteredUserEmbeddingExperienceConfiguration

@Mutable
@NotThreadSafe
public static interface RegisteredUserEmbeddingExperienceConfiguration.Builder
extends SdkPojo, CopyableBuilder<RegisteredUserEmbeddingExperienceConfiguration.Builder,RegisteredUserEmbeddingExperienceConfiguration>

Method Summary

Modifier and Type	Method	Description
default RegisteredUserEmbeddingExperienceConfiguration.Builder	dashboard(Consumer<RegisteredUserDashboardEmbeddingConfiguration.Builder> dashboard)	The configuration details for providing a dashboard embedding experience.
RegisteredUserEmbeddingExperienceConfiguration.Builder	dashboard(RegisteredUserDashboardEmbeddingConfiguration dashboard)	The configuration details for providing a dashboard embedding experience.
default RegisteredUserEmbeddingExperienceConfiguration.Builder	dashboardVisual(Consumer<RegisteredUserDashboardVisualEmbeddingConfiguration.Builder> dashboardVisual)	The type of embedding experience.
RegisteredUserEmbeddingExperienceConfiguration.Builder	dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual)	The type of embedding experience.
default RegisteredUserEmbeddingExperienceConfiguration.Builder	generativeQnA(Consumer<RegisteredUserGenerativeQnAEmbeddingConfiguration.Builder> generativeQnA)	The configuration details for embedding the Generative Q&A experience.
RegisteredUserEmbeddingExperienceConfiguration.Builder	generativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration generativeQnA)	The configuration details for embedding the Generative Q&A experience.
default RegisteredUserEmbeddingExperienceConfiguration.Builder	qSearchBar(Consumer<RegisteredUserQSearchBarEmbeddingConfiguration.Builder> qSearchBar)	The configuration details for embedding the Q search bar.
RegisteredUserEmbeddingExperienceConfiguration.Builder	qSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar)	The configuration details for embedding the Q search bar.
default RegisteredUserEmbeddingExperienceConfiguration.Builder	quickChat(Consumer<RegisteredUserQuickChatEmbeddingConfiguration.Builder> quickChat)	The configuration details for embedding the Quick chat agent.
RegisteredUserEmbeddingExperienceConfiguration.Builder	quickChat(RegisteredUserQuickChatEmbeddingConfiguration quickChat)	The configuration details for embedding the Quick chat agent.
default RegisteredUserEmbeddingExperienceConfiguration.Builder	quickSightConsole(Consumer<RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder> quickSightConsole)	The configuration details for providing each Amazon Quick Sight console embedding experience.
RegisteredUserEmbeddingExperienceConfiguration.Builder	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

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods 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 the RegisteredUserDashboardEmbeddingConfiguration.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).

Parameters:

dashboard - a consumer that will call methods on RegisteredUserDashboardEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dashboard(RegisteredUserDashboardEmbeddingConfiguration)

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 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 Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

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 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 Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

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 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 Quick Suite User Guide:

• Embedding the Full Functionality of the Amazon Quick Sight Console for Authenticated Users

• Customizing Access to the Amazon Quick Suite Console

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 the RegisteredUserQuickSightConsoleEmbeddingConfiguration.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).

Parameters:

quickSightConsole - a consumer that will call methods on RegisteredUserQuickSightConsoleEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• quickSightConsole(RegisteredUserQuickSightConsoleEmbeddingConfiguration)

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 the RegisteredUserQSearchBarEmbeddingConfiguration.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).

Parameters:

qSearchBar - a consumer that will call methods on RegisteredUserQSearchBarEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• qSearchBar(RegisteredUserQSearchBarEmbeddingConfiguration)

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 the RegisteredUserDashboardVisualEmbeddingConfiguration.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).

Parameters:

dashboardVisual - a consumer that will call methods on RegisteredUserDashboardVisualEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dashboardVisual(RegisteredUserDashboardVisualEmbeddingConfiguration)

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 the RegisteredUserGenerativeQnAEmbeddingConfiguration.Builder avoiding the need to create one manually via RegisteredUserGenerativeQnAEmbeddingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to generativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration).

Parameters:

generativeQnA - a consumer that will call methods on RegisteredUserGenerativeQnAEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• generativeQnA(RegisteredUserGenerativeQnAEmbeddingConfiguration)

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 the RegisteredUserQuickChatEmbeddingConfiguration.Builder avoiding the need to create one manually via RegisteredUserQuickChatEmbeddingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quickChat(RegisteredUserQuickChatEmbeddingConfiguration).

Parameters:

quickChat - a consumer that will call methods on RegisteredUserQuickChatEmbeddingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• quickChat(RegisteredUserQuickChatEmbeddingConfiguration)