KnowledgeBaseSummary
Summary information about the knowledge base.
Contents
- knowledgeBaseArn
-
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Pattern:
^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
- knowledgeBaseId
-
The identifier of the knowledge base.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- knowledgeBaseType
-
The type of knowledge base.
Type: String
Valid Values:
EXTERNAL | CUSTOM | QUICK_RESPONSES | MESSAGE_TEMPLATES | MANAGEDRequired: Yes
- name
-
The name of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: Yes
- status
-
The status of the knowledge base summary.
Type: String
Valid Values:
CREATE_IN_PROGRESS | CREATE_FAILED | ACTIVE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETEDRequired: Yes
- description
-
The description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: No
- renderingConfiguration
-
Information about how to render the content.
Type: RenderingConfiguration object
Required: No
- serverSideEncryptionConfiguration
-
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows
kms:CreateGrant,kms:DescribeKey,kms:Decrypt, andkms:GenerateDataKey*permissions to the IAM identity using the key to invoke Amazon Q in Connect.For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.
Type: ServerSideEncryptionConfiguration object
Required: No
- sourceConfiguration
-
Configuration information about the external data source.
Type: SourceConfiguration object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
-
The tags used to organize, track, or control access for this resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[a-zA-Z+-=._:/]+$Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
- vectorIngestionConfiguration
-
Contains details about how to ingest the documents in a data source.
Type: VectorIngestionConfiguration object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
