Managing Amazon Q Business web experiences for anonymous access

To manage Amazon Q Business web experiences for anonymous access, you can take the following actions:

Share an anonymous web experience

If you created a web experience when you created your application, you can preview that Amazon Q Business web experience for anonymous access, using the console or the CreateAnonymousWebExperienceUrl API operation.

Note

• The preview URL for the web experience is for one-time use only and has to be regenerated every time. This URL must be accessed within 5 minutes of creation. Once accessed, the session remains active for the configured duration. To use the web experience in your applications, you must use the Amazon Q embedded feature and call the CreateAnonymousWebExperienceUrl API operation whenever you need a new application session or after one hour whichever comes first.

• All anonymous web experience URLs generated are able to process billable chat requests until the sessions expire. For more information, see Amazon Q Business pricing.

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

Console

1. After Creating an anonymous access application environment in the console with a web experience, you can navigate to your anonymous application.

2. In the Web experience settings section in the console, you can Preview web experience to view the web experience.

3. Alternatively, you can choose to Share the web experience URL to share the web experience. To do this, you can choose the duration your Testing link is valid for and choose Create URL. The URL will be automatically copied to your clipboard.

AWS CLI

To share an Amazon Q Business anonymous web experience url

After Creating an anonymous access application environment with a web experience, you can do the following.

aws qbusiness create-anonymous-web-experience-url \ 
--application-id <your-application-id> \
--web-experience-id <web-experience-id>
--session-duration-in-minutes<x-minutes >

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.

Note

Even after deleting the web experience all URLs connected to this web experience continue to process billable chat requests until their sessions expire. For more information, see Share an anonymous web experience.

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

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

2. In Applications, choose Actions.

3. Choose Delete.

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

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

2. In Applications, select the name of your application environment from the list of applications.

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

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

2. For Applications, the Amazon Q Business web experience attached to your application environment is shown.

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

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

2. In Applications, select the name of your application environment from the list of applications.

3. Select Customize web experience.

4. Expand the right navigation menu to 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 \
--subtitle subtitle \     
--title title \
--welcome-message welcome-message