Skip to content

KnowledgeBaseData

Source code in docs_src/capo_qconnect/types/knowledge_base_data.py
class KnowledgeBaseData(TypedDict, closed=True):
    knowledge_base_id: "capo_qconnect.types.uuid.Uuid"
    """<p>The identifier of the knowledge base.</p>"""
    knowledge_base_arn: "capo_qconnect.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    name: "capo_qconnect.types.name.Name"
    """<p>The name of the knowledge base.</p>"""
    knowledge_base_type: "capo_qconnect.types.knowledge_base_type.KnowledgeBaseType"
    """<p>The type of knowledge base.</p>"""
    status: "capo_qconnect.types.knowledge_base_status.KnowledgeBaseStatus"
    """<p>The status of the knowledge base.</p>"""
    last_content_modification_time: NotRequired["datetime.datetime"]
    """<p>An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.</p>"""
    vector_ingestion_configuration: NotRequired[
        "capo_qconnect.types.vector_ingestion_configuration.VectorIngestionConfiguration"
    ]
    """<p>Contains details about how to ingest the documents in a data source.</p>"""
    source_configuration: NotRequired[
        "capo_qconnect.types.source_configuration.SourceConfiguration"
    ]
    """<p>Source configuration information about the knowledge base.</p>"""
    rendering_configuration: NotRequired[
        "capo_qconnect.types.rendering_configuration.RenderingConfiguration"
    ]
    """<p>Information about how to render the content.</p>"""
    server_side_encryption_configuration: NotRequired[
        "capo_qconnect.types.server_side_encryption_configuration.ServerSideEncryptionConfiguration"
    ]
    """<p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>"""
    description: NotRequired["capo_qconnect.types.description.Description"]
    """<p>The description.</p>"""
    tags: NotRequired["capo_qconnect.types.tags.Tags"]
    """<p>The tags used to organize, track, or control access for this resource.</p>"""
    ingestion_status: NotRequired["capo_qconnect.types.sync_status.SyncStatus"]
    """<p>Status of ingestion on data source.</p>"""
    ingestion_failure_reasons: NotRequired[
        "capo_qconnect.types.failure_reason.FailureReason"
    ]
    """<p>List of failure reasons on ingestion per file.</p>"""

description instance-attribute

description: NotRequired[Description]

The description.

ingestion_failure_reasons instance-attribute

ingestion_failure_reasons: NotRequired[FailureReason]

List of failure reasons on ingestion per file.

ingestion_status instance-attribute

ingestion_status: NotRequired[SyncStatus]

Status of ingestion on data source.

knowledge_base_arn instance-attribute

knowledge_base_arn: Arn

The Amazon Resource Name (ARN) of the knowledge base.

knowledge_base_id instance-attribute

knowledge_base_id: Uuid

The identifier of the knowledge base.

knowledge_base_type instance-attribute

knowledge_base_type: KnowledgeBaseType

The type of knowledge base.

last_content_modification_time instance-attribute

last_content_modification_time: NotRequired[datetime]

An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.

name instance-attribute

name: Name

The name of the knowledge base.

rendering_configuration instance-attribute

rendering_configuration: NotRequired[RenderingConfiguration]

Information about how to render the content.

server_side_encryption_configuration instance-attribute

server_side_encryption_configuration: NotRequired[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, and kms: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.

source_configuration instance-attribute

source_configuration: NotRequired[SourceConfiguration]

Source configuration information about the knowledge base.

status instance-attribute

The status of the knowledge base.

tags instance-attribute

tags: NotRequired[Tags]

The tags used to organize, track, or control access for this resource.

vector_ingestion_configuration instance-attribute

vector_ingestion_configuration: NotRequired[VectorIngestionConfiguration]

Contains details about how to ingest the documents in a data source.