Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Updates an Amazon Q Business web experience.

put/applications/{applicationId}/experiences/{webExperienceId}

Path parameters

applicationIdstring required

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

webExperienceIdstring required

The identifier of the Amazon Q Business web experience.

Request body

roleArnstring

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

titlestring

The title of the Amazon Q Business web experience.

subtitlestring

The subtitle of the Amazon Q Business web experience.

welcomeMessagestring

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

samplePromptsControlMode'ENABLED' | 'DISABLED'

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

originsOrigin[]
<p>Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the <i>base URL</i> for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified).</p> <note> <ul> <li> <p>Any values except <code>null</code> submitted as part of this update will replace all previous values.</p> </li> <li> <p>You must only submit a <i>base URL</i> and not a full path. For example, <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>

Response

Success

UpdateWebExperienceResponse required