UpdateAssistantAIAgent
Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Request Syntax
POST /assistants/assistantId/aiagentConfiguration HTTP/1.1
Content-type: application/json
{
"aiAgentType": "string",
"configuration": {
"aiAgentId": "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- assistantId
-
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- aiAgentType
-
The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
Type: String
Valid Values:
MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICERequired: Yes
- configuration
-
The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.
Type: AIAgentConfigurationData object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"assistant": {
"aiAgentConfiguration": {
"string" : {
"aiAgentId": "string"
}
},
"assistantArn": "string",
"assistantId": "string",
"capabilityConfiguration": {
"type": "string"
},
"description": "string",
"integrationConfiguration": {
"topicIntegrationArn": "string"
},
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyId": "string"
},
"status": "string",
"tags": {
"string" : "string"
},
"type": "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.
- assistant
-
The assistant data.
Type: AssistantData object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
