Skip to content

KnowledgeBase

Source code in docs_src/capo_quicksight/types/knowledge_base.py
class KnowledgeBase(TypedDict, closed=True):
    knowledge_base_arn: "capo_quicksight.types.knowledge_base_arn.KnowledgeBaseArn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    knowledge_base_id: "capo_quicksight.types.knowledge_base_id.KnowledgeBaseId"
    """<p>The unique identifier for the knowledge base.</p>"""
    name: "capo_quicksight.types.knowledge_base_name.KnowledgeBaseName"
    """<p>The name of the knowledge base.</p>"""
    status: "capo_quicksight.types.data_set_status.DataSetStatus"
    """<p>The status of the knowledge base.</p>"""
    data_source_arn: "capo_quicksight.types.data_source_arn.DataSourceArn"
    """<p>The ARN of the data source associated with the knowledge base.</p>"""
    knowledge_base_configuration: (
        "capo_quicksight.types.knowledge_base_configuration.KnowledgeBaseConfiguration"
    )
    """<p>The configuration settings for the knowledge base.</p>"""
    media_extraction_configuration: NotRequired[
        "capo_quicksight.types.media_extraction_configuration.MediaExtractionConfiguration"
    ]
    """<p>The media extraction configuration for the knowledge base.</p>"""
    access_control_configuration: NotRequired[
        "capo_quicksight.types.access_control_configuration.AccessControlConfiguration"
    ]
    """<p>The access control configuration for the knowledge base.</p>"""
    type: NotRequired["str"]
    """<p>The type of the knowledge base.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time that the knowledge base was created.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time that the knowledge base was last updated.</p>"""
    description: NotRequired[
        "capo_quicksight.types.knowledge_base_description.KnowledgeBaseDescription"
    ]
    """<p>The description of the knowledge base.</p>"""
    is_email_notification_opted_for_ingestion_failures: NotRequired[
        "capo_quicksight.types.boolean.Boolean"
    ]
    """<p>Specifies whether email notifications are enabled for ingestion failures.</p>"""
    first_completed_ingestion_summary: NotRequired[
        "capo_quicksight.types.knowledge_base_ingestion_summary.KnowledgeBaseIngestionSummary"
    ]
    """<p>A summary of the first completed ingestion for the knowledge base.</p>"""
    first_incomplete_ingestion_summary: NotRequired[
        "capo_quicksight.types.knowledge_base_ingestion_summary.KnowledgeBaseIngestionSummary"
    ]
    """<p>A summary of the first incomplete ingestion for the knowledge base.</p>"""
    latest_ingestion_summary: NotRequired[
        "capo_quicksight.types.knowledge_base_ingestion_summary.KnowledgeBaseIngestionSummary"
    ]
    """<p>A summary of the most recent ingestion for the knowledge base.</p>"""
    knowledge_base_size_bytes: NotRequired["capo_quicksight.types.long.Long"]
    """<p>The size of the knowledge base in bytes.</p>"""
    document_count: NotRequired["capo_quicksight.types.long.Long"]
    """<p>The number of documents in the knowledge base.</p>"""
    primary_owner_arn: NotRequired["capo_quicksight.types.string.String"]
    """<p>The ARN of the primary owner of the knowledge base.</p>"""
    primary_owner_username: NotRequired[
        "capo_quicksight.types.sensitive_string.SensitiveString"
    ]
    """<p>The username of the primary owner of the knowledge base.</p>"""

access_control_configuration instance-attribute

access_control_configuration: NotRequired[AccessControlConfiguration]

The access control configuration for the knowledge base.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time that the knowledge base was created.

data_source_arn instance-attribute

data_source_arn: DataSourceArn

The ARN of the data source associated with the knowledge base.

description instance-attribute

description: NotRequired[KnowledgeBaseDescription]

The description of the knowledge base.

document_count instance-attribute

document_count: NotRequired[Long]

The number of documents in the knowledge base.

first_completed_ingestion_summary instance-attribute

first_completed_ingestion_summary: NotRequired[KnowledgeBaseIngestionSummary]

A summary of the first completed ingestion for the knowledge base.

first_incomplete_ingestion_summary instance-attribute

first_incomplete_ingestion_summary: NotRequired[KnowledgeBaseIngestionSummary]

A summary of the first incomplete ingestion for the knowledge base.

is_email_notification_opted_for_ingestion_failures instance-attribute

is_email_notification_opted_for_ingestion_failures: NotRequired[Boolean]

Specifies whether email notifications are enabled for ingestion failures.

knowledge_base_arn instance-attribute

knowledge_base_arn: KnowledgeBaseArn

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

knowledge_base_configuration instance-attribute

knowledge_base_configuration: KnowledgeBaseConfiguration

The configuration settings for the knowledge base.

knowledge_base_id instance-attribute

knowledge_base_id: KnowledgeBaseId

The unique identifier for the knowledge base.

knowledge_base_size_bytes instance-attribute

knowledge_base_size_bytes: NotRequired[Long]

The size of the knowledge base in bytes.

latest_ingestion_summary instance-attribute

latest_ingestion_summary: NotRequired[KnowledgeBaseIngestionSummary]

A summary of the most recent ingestion for the knowledge base.

media_extraction_configuration instance-attribute

media_extraction_configuration: NotRequired[MediaExtractionConfiguration]

The media extraction configuration for the knowledge base.

name instance-attribute

The name of the knowledge base.

primary_owner_arn instance-attribute

primary_owner_arn: NotRequired[String]

The ARN of the primary owner of the knowledge base.

primary_owner_username instance-attribute

primary_owner_username: NotRequired[SensitiveString]

The username of the primary owner of the knowledge base.

status instance-attribute

status: DataSetStatus

The status of the knowledge base.

type instance-attribute

type: NotRequired[str]

The type of the knowledge base.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time that the knowledge base was last updated.