CreateWebExperience
Creates an Amazon Q Business web experience.
Request Syntax
POST /applications/applicationId
/experiences HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"roleArn": "string
",
"samplePromptsControlMode": "string
",
"subtitle": "string
",
"tags": [
{
"key": "string
",
"value": "string
"
}
],
"title": "string
",
"welcomeMessage": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the Amazon Q Business web experience.
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A token you provide to identify a request to create an Amazon Q Business web experience.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- roleArn
-
The Amazon Resource Name (ARN) of the service role attached to your web experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1284.
Pattern:
^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
Required: No
- samplePromptsControlMode
-
Determines whether sample prompts are enabled in the web experience for an end user.
Type: String
Valid Values:
ENABLED | DISABLED
Required: No
- subtitle
-
A subtitle to personalize your Amazon Q Business web experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
^\P{C}*$
Required: No
-
A list of key-value pairs that identify or categorize your Amazon Q Business web experience. You can also use tags to help control access to the web experience. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
- title
-
The title for your Amazon Q Business web experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
^\P{C}*$
Required: No
- welcomeMessage
-
The customized welcome message for end users of an Amazon Q Business web experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"webExperienceArn": "string",
"webExperienceId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- webExperienceArn
-
The Amazon Resource Name (ARN) of an Amazon Q Business web experience.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1284.
Pattern:
^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$
- webExperienceId
-
The identifier of the Amazon Q Business web experience.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- ConflictException
-
You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistences with your resources and try again.
HTTP Status Code: 409
- InternalServerException
-
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support
for help. HTTP Status Code: 500
- ResourceNotFoundException
-
The resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
You have exceeded the set limits for your Amazon Q Business service.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: