Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Creates an Amazon Q Business web experience.

post/applications/{applicationId}/experiences

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business web experience.

Request body

titlestring

The title for your Amazon Q Business web experience.

subtitlestring

A subtitle to personalize your Amazon Q Business web experience.

welcomeMessagestring

The customized welcome message for end users of 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>Sets the website domain origins that are allowed to embed the Amazon Q Business web experience. The <i>domain origin</i> refers to the base URL for accessing a website including the protocol (<code>http/https</code>), the domain name, and the port number (if specified). </p> <note> <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> </note>
roleArnstring
<p>The Amazon Resource Name (ARN) of the service role attached to your web experience.</p> <note> <p>The <code>roleArn</code> parameter is required when your Amazon Q Business application is created with IAM Identity Center. It is not required for SAML-based applications.</p> </note>
clientTokenstring

A token you provide to identify a request to create an Amazon Q Business web experience.

Response

Success

webExperienceIdstring

The identifier of the Amazon Q Business web experience.

webExperienceArnstring

The Amazon Resource Name (ARN) of an Amazon Q Business web experience.