Skip to content

update_web_experience

Operation

update_web_experience

update_web_experience(request: UpdateWebExperienceInput | UpdateWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateWebExperienceInputDict]) -> UpdateWebExperienceOutput

Updates an Amazon Q Business web experience.

Parameters:

Name Type Description Default
request UpdateWebExperienceInput | UpdateWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateWebExperienceOutput

An instance of UpdateWebExperienceOutput.

update_web_experience async

update_web_experience(request: UpdateWebExperienceInput | UpdateWebExperienceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateWebExperienceInputDict]) -> UpdateWebExperienceOutput

Updates an Amazon Q Business web experience.

Parameters:

Name Type Description Default
request UpdateWebExperienceInput | UpdateWebExperienceInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateWebExperienceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateWebExperienceOutput

An instance of UpdateWebExperienceOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateWebExperienceInputDict

Bases: TypedDict

Dictionary form of UpdateWebExperienceInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

authentication_configuration instance-attribute

The authentication configuration of the Amazon Q Business web experience.

browser_extension_configuration instance-attribute
browser_extension_configuration: BrowserExtensionConfiguration | BrowserExtensionConfigurationDict | 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 instance-attribute
customization_configuration: CustomizationConfiguration | CustomizationConfigurationDict | None

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

identity_provider_configuration instance-attribute
identity_provider_configuration: IdentityProviderConfiguration | IdentityProviderConfigurationDict | None

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

origins instance-attribute
origins: Sequence[str] | 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 instance-attribute
role_arn: str | 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 instance-attribute
sample_prompts_control_mode: str | None

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

subtitle instance-attribute
subtitle: str | None

The subtitle of the Amazon Q Business web experience.

title instance-attribute
title: str | None

The title of the Amazon Q Business web experience.

web_experience_id instance-attribute
web_experience_id: Required[str]

The identifier of the Amazon Q Business web experience.

welcome_message instance-attribute
welcome_message: str | None

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

UpdateWebExperienceInput dataclass

Bases: _SerdeShape

Dataclass for UpdateWebExperienceInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

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

authentication_configuration class-attribute instance-attribute
authentication_configuration: WebExperienceAuthConfiguration | None = ...

The authentication configuration of the Amazon Q Business web experience.

browser_extension_configuration class-attribute instance-attribute
browser_extension_configuration: BrowserExtensionConfiguration | 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 = ...

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

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

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

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: str | None = ...

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

subtitle class-attribute instance-attribute
subtitle: str | None = ...

The subtitle of the Amazon Q Business web experience.

title class-attribute instance-attribute
title: str | None = ...

The title of the Amazon Q Business web experience.

web_experience_id class-attribute instance-attribute
web_experience_id: str | None = ...

The identifier of the Amazon Q Business web experience.

welcome_message class-attribute instance-attribute
welcome_message: str | None = ...

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

Output

UpdateWebExperienceOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateWebExperienceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.