GetKnowledgeBase
Gets information about a knowledge base.
Request Syntax
GET /knowledgebases/knowledgeBaseId HTTP/1.1 URI Request Parameters
The request uses the following URI parameters.
- knowledgeBaseId
-
The unique identifier of the knowledge base you want to get information on.
Pattern:
[0-9a-zA-Z]{10}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200 Content-type: application/json { "knowledgeBase": { "createdAt": "string", "description": "string", "failureReasons": [ "string" ], "knowledgeBaseArn": "string", "knowledgeBaseConfiguration": { "kendraKnowledgeBaseConfiguration": { "kendraIndexArn": "string" }, "sqlKnowledgeBaseConfiguration": { "redshiftConfiguration": { "queryEngineConfiguration": { "provisionedConfiguration": { "authConfiguration": { "databaseUser": "string", "type": "string", "usernamePasswordSecretArn": "string" }, "clusterIdentifier": "string" }, "serverlessConfiguration": { "authConfiguration": { "type": "string", "usernamePasswordSecretArn": "string" }, "workgroupArn": "string" }, "type": "string" }, "queryGenerationConfiguration": { "executionTimeoutSeconds": number, "generationContext": { "curatedQueries": [ { "naturalLanguage": "string", "sql": "string" } ], "tables": [ { "columns": [ { "description": "string", "inclusion": "string", "name": "string" } ], "description": "string", "inclusion": "string", "name": "string" } ] } }, "storageConfigurations": [ { "awsDataCatalogConfiguration": { "tableNames": [ "string" ] }, "redshiftConfiguration": { "databaseName": "string" }, "type": "string" } ] }, "type": "string" }, "type": "string", "vectorKnowledgeBaseConfiguration": { "embeddingModelArn": "string", "embeddingModelConfiguration": { "bedrockEmbeddingModelConfiguration": { "dimensions": number, "embeddingDataType": "string" } }, "supplementalDataStorageConfiguration": { "storageLocations": [ { "s3Location": { "uri": "string" }, "type": "string" } ] } } }, "knowledgeBaseId": "string", "name": "string", "roleArn": "string", "status": "string", "storageConfiguration": { "mongoDbAtlasConfiguration": { "collectionName": "string", "credentialsSecretArn": "string", "databaseName": "string", "endpoint": "string", "endpointServiceName": "string", "fieldMapping": { "metadataField": "string", "textField": "string", "vectorField": "string" }, "textIndexName": "string", "vectorIndexName": "string" }, "neptuneAnalyticsConfiguration": { "fieldMapping": { "metadataField": "string", "textField": "string" }, "graphArn": "string" }, "opensearchManagedClusterConfiguration": { "domainArn": "string", "domainEndpoint": "string", "fieldMapping": { "metadataField": "string", "textField": "string", "vectorField": "string" }, "vectorIndexName": "string" }, "opensearchServerlessConfiguration": { "collectionArn": "string", "fieldMapping": { "metadataField": "string", "textField": "string", "vectorField": "string" }, "vectorIndexName": "string" }, "pineconeConfiguration": { "connectionString": "string", "credentialsSecretArn": "string", "fieldMapping": { "metadataField": "string", "textField": "string" }, "namespace": "string" }, "rdsConfiguration": { "credentialsSecretArn": "string", "databaseName": "string", "fieldMapping": { "customMetadataField": "string", "metadataField": "string", "primaryKeyField": "string", "textField": "string", "vectorField": "string" }, "resourceArn": "string", "tableName": "string" }, "redisEnterpriseCloudConfiguration": { "credentialsSecretArn": "string", "endpoint": "string", "fieldMapping": { "metadataField": "string", "textField": "string", "vectorField": "string" }, "vectorIndexName": "string" }, "s3VectorsConfiguration": { "indexArn": "string", "indexName": "string", "vectorBucketArn": "string" }, "type": "string" }, "updatedAt": "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
-
Contains details about the knowledge base.
Type: KnowledgeBase object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions.
HTTP Status Code: 403
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
- fieldList
-
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: