Interface UpdateWebExperienceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>, QBusinessRequest.Builder, SdkBuilder<UpdateWebExperienceRequest.Builder,UpdateWebExperienceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateWebExperienceRequest

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

Method Summary

Modifier and Type	Method	Description
UpdateWebExperienceRequest.Builder	applicationId(String applicationId)	The identifier of the Amazon Q Business application attached to the web experience.
default UpdateWebExperienceRequest.Builder	authenticationConfiguration(Consumer<WebExperienceAuthConfiguration.Builder> authenticationConfiguration)	Deprecated. Property associated with legacy SAML IdP flow.
UpdateWebExperienceRequest.Builder	authenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)	Deprecated. Property associated with legacy SAML IdP flow.
default UpdateWebExperienceRequest.Builder	browserExtensionConfiguration(Consumer<BrowserExtensionConfiguration.Builder> browserExtensionConfiguration)	The browser extension configuration for an Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	browserExtensionConfiguration(BrowserExtensionConfiguration browserExtensionConfiguration)	The browser extension configuration for an Amazon Q Business web experience.
default UpdateWebExperienceRequest.Builder	customizationConfiguration(Consumer<CustomizationConfiguration.Builder> customizationConfiguration)	Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.
UpdateWebExperienceRequest.Builder	customizationConfiguration(CustomizationConfiguration customizationConfiguration)	Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.
default UpdateWebExperienceRequest.Builder	identityProviderConfiguration(Consumer<IdentityProviderConfiguration.Builder> identityProviderConfiguration)	Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	identityProviderConfiguration(IdentityProviderConfiguration identityProviderConfiguration)	Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	origins(String... origins)	Updates the website domain origins that are allowed to embed the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	origins(Collection<String> origins)	Updates the website domain origins that are allowed to embed the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateWebExperienceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateWebExperienceRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.
UpdateWebExperienceRequest.Builder	samplePromptsControlMode(String samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
UpdateWebExperienceRequest.Builder	samplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)	Determines whether sample prompts are enabled in the web experience for an end user.
UpdateWebExperienceRequest.Builder	subtitle(String subtitle)	The subtitle of the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	title(String title)	The title of the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	webExperienceId(String webExperienceId)	The identifier of the Amazon Q Business web experience.
UpdateWebExperienceRequest.Builder	welcomeMessage(String welcomeMessage)	A customized welcome message for an end user in an Amazon Q Business web experience.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.qbusiness.model.QBusinessRequest.Builder

build

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

applicationId

UpdateWebExperienceRequest.Builder applicationId(String applicationId)

The identifier of the Amazon Q Business application attached to the web experience.

Parameters:

applicationId - The identifier of the Amazon Q Business application attached to the web experience.

Returns:

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

webExperienceId

UpdateWebExperienceRequest.Builder webExperienceId(String webExperienceId)

The identifier of the Amazon Q Business web experience.

Parameters:

webExperienceId - The identifier of the Amazon Q Business web experience.

Returns:

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

roleArn

UpdateWebExperienceRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the role with permission to access the Amazon Q Business web experience and required resources.

Returns:

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

authenticationConfiguration

@Deprecated
UpdateWebExperienceRequest.Builder authenticationConfiguration(WebExperienceAuthConfiguration authenticationConfiguration)

Deprecated.

Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration of the Amazon Q Business web experience.

Parameters:

authenticationConfiguration - The authentication configuration of the Amazon Q Business web experience.

Returns:

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

authenticationConfiguration

@Deprecated
default UpdateWebExperienceRequest.Builder authenticationConfiguration(Consumer<WebExperienceAuthConfiguration.Builder> authenticationConfiguration)

Deprecated.

Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management.

The authentication configuration of the Amazon Q Business web experience.

This is a convenience method that creates an instance of the WebExperienceAuthConfiguration.Builder avoiding the need to create one manually via WebExperienceAuthConfiguration.builder().

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

Parameters:

authenticationConfiguration - a consumer that will call methods on WebExperienceAuthConfiguration.Builder

Returns:

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

See Also:

• authenticationConfiguration(WebExperienceAuthConfiguration)

title

UpdateWebExperienceRequest.Builder title(String title)

The title of the Amazon Q Business web experience.

Parameters:

title - The title of the Amazon Q Business web experience.

Returns:

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

subtitle

UpdateWebExperienceRequest.Builder subtitle(String subtitle)

The subtitle of the Amazon Q Business web experience.

Parameters:

subtitle - The subtitle of the Amazon Q Business web experience.

Returns:

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

welcomeMessage

UpdateWebExperienceRequest.Builder welcomeMessage(String welcomeMessage)

A customized welcome message for an end user in an Amazon Q Business web experience.

Parameters:

welcomeMessage - A customized welcome message for an end user in an Amazon Q Business web experience.

Returns:

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

samplePromptsControlMode

UpdateWebExperienceRequest.Builder samplePromptsControlMode(String samplePromptsControlMode)

Determines whether sample prompts are enabled in the web experience for an end user.

Parameters:

samplePromptsControlMode - Determines whether sample prompts are enabled in the web experience for an end user.

Returns:

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

See Also:

• WebExperienceSamplePromptsControlMode
• WebExperienceSamplePromptsControlMode

samplePromptsControlMode

UpdateWebExperienceRequest.Builder samplePromptsControlMode(WebExperienceSamplePromptsControlMode samplePromptsControlMode)

Determines whether sample prompts are enabled in the web experience for an end user.

Parameters:

samplePromptsControlMode - Determines whether sample prompts are enabled in the web experience for an end user.

Returns:

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

See Also:

• WebExperienceSamplePromptsControlMode
• WebExperienceSamplePromptsControlMode

identityProviderConfiguration

UpdateWebExperienceRequest.Builder identityProviderConfiguration(IdentityProviderConfiguration identityProviderConfiguration)

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Parameters:

identityProviderConfiguration - Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Returns:

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

identityProviderConfiguration

default UpdateWebExperienceRequest.Builder identityProviderConfiguration(Consumer<IdentityProviderConfiguration.Builder> identityProviderConfiguration)

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

This is a convenience method that creates an instance of the IdentityProviderConfiguration.Builder avoiding the need to create one manually via IdentityProviderConfiguration.builder().

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

Parameters:

identityProviderConfiguration - a consumer that will call methods on IdentityProviderConfiguration.Builder

Returns:

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

See Also:

• identityProviderConfiguration(IdentityProviderConfiguration)

origins

UpdateWebExperienceRequest.Builder origins(Collection<String> origins)

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).

• Any values except null submitted as part of this update will replace all previous values.

• You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Parameters:

origins - Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).

• Any values except null submitted as part of this update will replace all previous values.

• You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Returns:

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

origins

UpdateWebExperienceRequest.Builder origins(String... origins)

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).

• Any values except null submitted as part of this update will replace all previous values.

• You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Parameters:

origins - Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol ( http/https), the domain name, and the port number (if specified).

• Any values except null submitted as part of this update will replace all previous values.

• You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Returns:

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

browserExtensionConfiguration

UpdateWebExperienceRequest.Builder browserExtensionConfiguration(BrowserExtensionConfiguration browserExtensionConfiguration)

The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

Parameters:

browserExtensionConfiguration - The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

Returns:

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

browserExtensionConfiguration

default UpdateWebExperienceRequest.Builder browserExtensionConfiguration(Consumer<BrowserExtensionConfiguration.Builder> browserExtensionConfiguration)

The browser extension configuration for an Amazon Q Business web experience.

For Amazon Q Business application using external OIDC-compliant identity providers (IdPs). The IdP administrator must add the browser extension sign-in redirect URLs to the IdP application. For more information, see Configure external OIDC identity provider for your browser extensions..

This is a convenience method that creates an instance of the BrowserExtensionConfiguration.Builder avoiding the need to create one manually via BrowserExtensionConfiguration.builder().

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

Parameters:

browserExtensionConfiguration - a consumer that will call methods on BrowserExtensionConfiguration.Builder

Returns:

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

See Also:

• browserExtensionConfiguration(BrowserExtensionConfiguration)

customizationConfiguration

UpdateWebExperienceRequest.Builder customizationConfiguration(CustomizationConfiguration customizationConfiguration)

Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

Parameters:

customizationConfiguration - Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

Returns:

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

customizationConfiguration

default UpdateWebExperienceRequest.Builder customizationConfiguration(Consumer<CustomizationConfiguration.Builder> customizationConfiguration)

Updates the custom logo, favicon, font, and color used in the Amazon Q web experience.

This is a convenience method that creates an instance of the CustomizationConfiguration.Builder avoiding the need to create one manually via CustomizationConfiguration.builder().

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

Parameters:

customizationConfiguration - a consumer that will call methods on CustomizationConfiguration.Builder

Returns:

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

See Also:

• customizationConfiguration(CustomizationConfiguration)

overrideConfiguration

UpdateWebExperienceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateWebExperienceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.