UpdateChatControlsConfiguration
Updates an set of chat controls configured for an existing Amazon Q Business application.
Request Syntax
PATCH /applications/applicationId
/chatcontrols HTTP/1.1
Content-type: application/json
{
"blockedPhrasesConfigurationUpdate": {
"blockedPhrasesToCreateOrUpdate": [ "string
" ],
"blockedPhrasesToDelete": [ "string
" ],
"systemMessageOverride": "string
"
},
"clientToken": "string
",
"creatorModeConfiguration": {
"creatorModeControl": "string
"
},
"responseScope": "string
",
"topicConfigurationsToCreateOrUpdate": [
{
"description": "string
",
"exampleChatMessages": [ "string
" ],
"name": "string
",
"rules": [
{
"excludedUsersAndGroups": {
"userGroups": [ "string
" ],
"userIds": [ "string
" ]
},
"includedUsersAndGroups": {
"userGroups": [ "string
" ],
"userIds": [ "string
" ]
},
"ruleConfiguration": { ... },
"ruleType": "string
"
}
]
}
],
"topicConfigurationsToDelete": [
{
"description": "string
",
"exampleChatMessages": [ "string
" ],
"name": "string
",
"rules": [
{
"excludedUsersAndGroups": {
"userGroups": [ "string
" ],
"userIds": [ "string
" ]
},
"includedUsersAndGroups": {
"userGroups": [ "string
" ],
"userIds": [ "string
" ]
},
"ruleConfiguration": { ... },
"ruleType": "string
"
}
]
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the application for which the chat controls are configured.
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.
- blockedPhrasesConfigurationUpdate
-
The phrases blocked from chat by your chat control configuration.
Type: BlockedPhrasesConfigurationUpdate object
Required: No
- clientToken
-
A token that you provide to identify the request to update a Amazon Q Business application chat configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
- creatorModeConfiguration
-
The configuration details for
CREATOR_MODE
.Type: CreatorModeConfiguration object
Required: No
- responseScope
-
The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.
Type: String
Valid Values:
ENTERPRISE_CONTENT_ONLY | EXTENDED_KNOWLEDGE_ENABLED
Required: No
- topicConfigurationsToCreateOrUpdate
-
The configured topic specific chat controls you want to update.
Type: Array of TopicConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
- topicConfigurationsToDelete
-
The configured topic specific chat controls you want to delete.
Type: Array of TopicConfiguration objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
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 inconsistencies 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 application or plugin 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: