UpdateKnowledgeBaseTemplateUri
Updates the template URI of a knowledge base. This is only supported for knowledge bases
of type EXTERNAL. Include a single variable in ${variable} format; this
interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce
article, it has an Id value, and you can set the template URI to
https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.
Request Syntax
POST /knowledgeBases/knowledgeBaseId/templateUri HTTP/1.1
Content-type: application/json
{
"templateUri": "string"
}URI Request Parameters
The request uses the following URI parameters.
- knowledgeBaseId
-
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. 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.
- templateUri
-
The template URI to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"knowledgeBase": {
"description": "string",
"ingestionFailureReasons": [ "string" ],
"ingestionStatus": "string",
"knowledgeBaseArn": "string",
"knowledgeBaseId": "string",
"knowledgeBaseType": "string",
"lastContentModificationTime": number,
"name": "string",
"renderingConfiguration": {
"templateUri": "string"
},
"serverSideEncryptionConfiguration": {
"kmsKeyId": "string"
},
"sourceConfiguration": { ... },
"status": "string",
"tags": {
"string" : "string"
},
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"parsingConfiguration": {
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "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.
- knowledgeBase
-
The knowledge base to update.
Type: KnowledgeBaseData 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
- 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:
