KnowledgeBase
Contains information about a knowledge base.
Contents
- createdAt
-
The time at which the knowledge base was created.
Type: Timestamp
Required: Yes
- knowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
^arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+$Required: Yes
- knowledgeBaseConfiguration
-
Contains details about the embeddings configuration of the knowledge base.
Type: KnowledgeBaseConfiguration object
Required: Yes
- knowledgeBaseId
-
The unique identifier of the knowledge base.
Type: String
Pattern:
^[0-9a-zA-Z]{10}$Required: Yes
- name
-
The name of the knowledge base.
Type: String
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$Required: Yes
- roleArn
-
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$Required: Yes
- status
-
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | UPDATING | FAILED | DELETE_UNSUCCESSFULRequired: Yes
-
- storageConfiguration
-
Contains details about the storage configuration of the knowledge base.
Type: StorageConfiguration object
Required: Yes
- updatedAt
-
The time at which the knowledge base was last updated.
Type: Timestamp
Required: Yes
- description
-
The description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
- failureReasons
-
A list of reasons that the API operation on the knowledge base failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
