Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateWebExperience

Updates an Amazon Q Business web experience.

Request Syntax


PUT /applications/applicationId/experiences/webExperienceId HTTP/1.1
Content-type: application/json

{
   "authenticationConfiguration": { ... },
   "identityProviderConfiguration": { ... },
   "origins": [ "string" ],
   "roleArn": "string",
   "samplePromptsControlMode": "string",
   "subtitle": "string",
   "title": "string",
   "welcomeMessage": "string"
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

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

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

webExperienceId

The identifier of the Amazon Q Business web experience.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

authenticationConfiguration

This parameter has been deprecated.

The authentication configuration of the Amazon Q Business web experience.

Type: WebExperienceAuthConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

identityProviderConfiguration

Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.

Type: IdentityProviderConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

origins

Updates the website domain origins that are allowed to embed the Amazon Q Business web experience. The domain origin refers to the base URL for accessing a website including the protocol (http/https), the domain name, and the port number (if specified).

Note

Any values except null submitted as part of this update will replace all previous values.
You must only submit a base URL and not a full path. For example, https://docs.aws.amazon.com.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: (http://|https://)[a-zA-Z0-9-_.]+(?::[0-9]{1,5})?

Required: No

roleArn

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

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

The subtitle of the Amazon Q Business web experience.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: \P{C}*

Required: No

title

The title of the Amazon Q Business web experience.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: \P{C}*

Required: No

welcomeMessage

A customized welcome message for an end user in 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

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

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