Managing Amazon Q Business web
experiences
To manage Amazon Q Business web experiences, you can take the following
actions:
Creating a web experience
To create an Amazon Q Business web experience, you can use the console
or the CreateWebExperience API operation.
The following tabs provide a procedure for the AWS Management Console and code examples for
the AWS CLI.
- Console
-
If you use the console, this action is spread across two steps:
Configuring an Amazon Q Business
application and Customizing web experience. Amazon Q Business creates a web experience for you when you
configure your application environment. To create a web experience, you must
create an application environment.
- AWS CLI
-
To create an Amazon Q Business web
experience
aws qbusiness create-web-experience \
--application-id application-id \
--sample-prompts-control-mode sample-prompts \
--subtitle subtitle \
--tags tags \
--title title \
--welcome-message welcome-message \
Deleting a web experience
To delete an Amazon Q Business web experience, you can use the console
or the DeleteWebExperience API operation.
If you're using the API, you can delete a web experience without deleting the
application environment that it's a part of.
If you're using the console, the only way to delete your Amazon Q Business web experience is to delete the Amazon Q Business application environment that
it's attached to.
The following tabs provide a procedure for the AWS Management Console and code examples for
the AWS CLI.
- Console
-
To delete an Amazon Q Business web
experience
-
Sign in to the AWS Management Console and open the Amazon Q Business console at https://console.aws.amazon.com/amazonq/business/.
-
In Applications, choose
Actions.
-
Choose Delete.
-
In the dialog box that opens, type
Delete to confirm deletion, and
then choose Delete.
You are returned to the service console while your
application environment is deleted. When the deletion process is
complete, the console displays a message confirming
successful deletion. Both the application environment and the web
experience are deleted.
- AWS CLI
-
To delete an Amazon Q Business web
experience
aws qbusiness delete-web-experience \
--application-id application-id \
--web-experience-id web-experience-id
Getting properties of a web experience
To get the properties of an Amazon Q Business web experience, you can
use the console or the GetWebExperience API operation.
The following tabs provide a procedure for the AWS Management Console and code examples for
the AWS CLI.
- Console
-
To get properties of an Amazon Q Business web experience
-
Sign in to the AWS Management Console and open the Amazon Q Business console at https://console.aws.amazon.com/amazonq/business/.
-
In Applications, select the name of
your application environment from the list of applications.
-
For Web experience settings, the
following settings are available:
-
Web experience IAM role ARN
– The IAM role assumed by end
users when they log in to your web experience.
-
Deployed URL – The
deployed URL of your web experience.
-
Tags – Tags that are
attached to your web experience.
To update a setting, choose
Edit.
- AWS CLI
-
To get properties of an Amazon Q Business web experience
aws qbusiness get-web-experience \
--application-id application-id \
--web-experience-id web-experience-id
Listing web experiences
To list Amazon Q Business web experiences, you can use the console or
the ListWebExperiences API operation.
If you use the console, you can only see the web experience that's attached to
a single application environment.
The following tabs provide a procedure for the AWS Management Console and code examples for
the AWS CLI.
- Console
-
To list Amazon Q Business web
experiences
- AWS CLI
-
To list Amazon Q Business web
experiences
aws qbusiness get-web-experience \
--application-id application-id \
--web-experience-id web-experience-id \
--max-results max-results-to-return
Updating a web experience
To update an Amazon Q Business web experience, you can use the console
or the UpdateWebExperience API operation.
The following tabs provide a procedure for the AWS Management Console and code examples for
the AWS CLI.
- Console
-
To update an Amazon Q Business web
experience
-
Sign in to the AWS Management Console and open the Amazon Q Business console at https://console.aws.amazon.com/amazonq/business/.
-
In Applications, select the name of
your application environment from the list of applications.
-
On your application page, select Web experience
settings and then select
Edit.
-
On the Deploy web experience page,
you can edit your web experience settings.
- AWS CLI
-
To update an Amazon Q Business web
experience
aws qbusiness update-web-experience \
--application-id application-id \
--web-experience-id web-experience-id \
--authentication-configuration authentication-configuration \
--sample-prompts-control-mode sample-prompts \
--subtitle subtitle \
--title title \
--welcome-message welcome-message
