Skip to content

/AWS1/CL_QQB=>UPDATEWEBEXPERIENCE()

About UpdateWebExperience

Updates an Amazon Q Business web experience.

Method Signature

IMPORTING

Required arguments:

IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

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

IV_WEBEXPERIENCEID TYPE /AWS1/QQBWEBEXPERIENCEID /AWS1/QQBWEBEXPERIENCEID

The identifier of the Amazon Q Business web experience.

Optional arguments:

IV_ROLEARN TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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

IO_AUTHNTCTNCONFIGURATION TYPE REF TO /AWS1/CL_QQBWEBEXPERIENCEAUT00 /AWS1/CL_QQBWEBEXPERIENCEAUT00

The authentication configuration of the Amazon Q Business web experience.

IV_TITLE TYPE /AWS1/QQBWEBEXPERIENCETITLE /AWS1/QQBWEBEXPERIENCETITLE

The title of the Amazon Q Business web experience.

IV_SUBTITLE TYPE /AWS1/QQBWEBEXPERIENCESUBTITLE /AWS1/QQBWEBEXPERIENCESUBTITLE

The subtitle of the Amazon Q Business web experience.

IV_WELCOMEMESSAGE TYPE /AWS1/QQBWEBEXPERIENCEWELCOM00 /AWS1/QQBWEBEXPERIENCEWELCOM00

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

IV_SAMPLEPROMPTSCONTROLMODE TYPE /AWS1/QQBWEBEXPERIENCESAMPLE00 /AWS1/QQBWEBEXPERIENCESAMPLE00

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

IO_IDENTITYPROVIDERCONF TYPE REF TO /AWS1/CL_QQBIDENTITYPVDRCONF /AWS1/CL_QQBIDENTITYPVDRCONF

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

IT_ORIGINS TYPE /AWS1/CL_QQBWEBEXPERIENCEORI00=>TT_WEBEXPERIENCEORIGINS TT_WEBEXPERIENCEORIGINS

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.

IO_BROWSEREXTENSIONCONF TYPE REF TO /AWS1/CL_QQBBROWSEREXTENSION00 /AWS1/CL_QQBBROWSEREXTENSION00

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

IO_CUSTOMIZATIONCONF TYPE REF TO /AWS1/CL_QQBCUSTOMIZATIONCONF /AWS1/CL_QQBCUSTOMIZATIONCONF

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QQBUPWEBEXPERIENCERSP /AWS1/CL_QQBUPWEBEXPERIENCERSP