Customizing an Amazon Q Business web experience

Creating an Amazon Q Business application environment automatically creates a web experience with a shareable URL. Before you share your web experience URL, you can choose to customize it.

Note

As of Oct 31, 2024, once you have created a new Amazon Q Business application environment, the default web experience will allow users to interact directly with the LLM to get answers from its general knowledge or uploaded file content (available to Pro users only), even if the Admin has not yet connected any enterprise data sources.

For existing application environments, the Allow direct access to LLM setting will remain as previously configured. For new application environments, the Allow direct access to LLM setting will be enabled by default, though Admins can still disable this if desired.

You can customize a web experience by using either the AWS Management Console or the Amazon Q API. If you use the API, customizing your Amazon Q Business can involve a combination of the following API operations:

• CreateApplication – Creates an Amazon Q Business application

• CreateWebExperience – Creates an Amazon Q Business web experience

• GetWebExperience – Gets the properties of the web experience that you set up

• ListWebExperiences – Lists Amazon Q Business web experiences that you created

When you customize your web experience, you can personalize it by changing its title and subtitle adding a welcome message, and displaying sample prompts.

Note

You can't run any chat queries from the web experience customize mode.

The following tabs provide a procedure for the AWS Management Console and code examples for the AWS CLI.

Console

To customize an Amazon Q Business web experience

1. Sign in to the AWS Management Console and open the Amazon Q Business console.

2. Complete the steps to create your Amazon Q Business application.

3. Then, from the Amazon Q Business application environment page, select the application whose web experience you want to customize. Then, select Customize web experience.

4. In Customize web experience, from the right navigation pane, select Customize web experience.

5. In Customize web experience, enter the following information for your web experience:

   • Title – A title for your web experience. End users see this title on their web experience page.

   • Subtitle - optional – A subtitle for your web experience to highlight other information for your end users. This subtitle is visible to your end users on their web experience page.

   • Welcome message – Provide an optional welcome message for your end users. We recommend mentioning data sources and application environment capabilities.

   • Display sample prompts – Provide a list of sample prompts on the end user's conversation start screen.

6. Choose Save.

AWS CLI

To create and customize a web experience

aws qbusiness create-web-experience \
--application-id application-id \
--role-arn roleArn \
--identity-provider-configuration {"SamlConfiguration":{"authenticationUrl":"saml-single-signon-url"},"OpenIDConnectConfiguration":{"secretsArn":"secret-manager-arn-for-oidc-client-secret","secretsRole":"role-manager-arn-to-access-oidc-secret-manager-arn"}} \
--title optional-title \
--subtitle optional-subtitle \ 
--welcome-message optional-welcome-message \
--sample-prompts-control-mode ENABLED