Qbusiness  >  Operations  >  update_web_experience

update_web_experience

Operation

update_web_experience async

update_web_experience(input: UpdateWebExperienceInput, plugins: list[Plugin] | None = None) -> UpdateWebExperienceOutput

Updates an Amazon Q Business web experience.

Parameters:

Name	Type	Description	Default
input	UpdateWebExperienceInput	An instance of UpdateWebExperienceInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
UpdateWebExperienceOutput	An instance of UpdateWebExperienceOutput.

Input

UpdateWebExperienceInput dataclass

Dataclass for UpdateWebExperienceInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

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

authentication_configuration class-attribute instance-attribute

authentication_configuration: WebExperienceAuthConfiguration | None = None

The authentication configuration of the Amazon Q Business web experience.

browser_extension_configuration class-attribute instance-attribute

browser_extension_configuration: BrowserExtensionConfiguration | None = None

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

Note

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..

customization_configuration class-attribute instance-attribute

customization_configuration: CustomizationConfiguration | None = None

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

identity_provider_configuration class-attribute instance-attribute

identity_provider_configuration: IdentityProviderConfiguration | None = None

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

origins class-attribute instance-attribute

origins: list[str] | None = None

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

Note

• 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.

role_arn class-attribute instance-attribute

role_arn: str | None = None

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

sample_prompts_control_mode class-attribute instance-attribute

sample_prompts_control_mode: WebExperienceSamplePromptsControlMode | None = None

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

subtitle class-attribute instance-attribute

subtitle: str | None = None

The subtitle of the Amazon Q Business web experience.

title class-attribute instance-attribute

title: str | None = None

The title of the Amazon Q Business web experience.

web_experience_id class-attribute instance-attribute

web_experience_id: str | None = None

The identifier of the Amazon Q Business web experience.

welcome_message class-attribute instance-attribute

welcome_message: str | None = None

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

Output

UpdateWebExperienceOutput dataclass

Dataclass for UpdateWebExperienceOutput structure.