Skip to content

DataSource

Source code in docs_src/capo_bedrock_agent/types/data_source.py
class DataSource(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the knowledge base to which the data source belongs.</p>"""
    data_source_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the data source.</p>"""
    name: "capo_bedrock_agent.types.name.Name"
    """<p>The name of the data source.</p>"""
    status: "capo_bedrock_agent.types.data_source_status.DataSourceStatus"
    """<p>The status of the data source. The following statuses are possible:</p> <ul> <li> <p>Available – The data source has been created and is ready for ingestion into the knowledge base.</p> </li> <li> <p>Deleting – The data source is being deleted.</p> </li> </ul>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>The description of the data source.</p>"""
    data_source_configuration: (
        "capo_bedrock_agent.types.data_source_configuration.DataSourceConfiguration"
    )
    """<p>The connection configuration for the data source.</p>"""
    server_side_encryption_configuration: NotRequired[
        "capo_bedrock_agent.types.server_side_encryption_configuration.ServerSideEncryptionConfiguration"
    ]
    """<p>Contains details about the configuration of the server-side encryption.</p>"""
    vector_ingestion_configuration: NotRequired[
        "capo_bedrock_agent.types.vector_ingestion_configuration.VectorIngestionConfiguration"
    ]
    """<p>Contains details about how to ingest the documents in the data source.</p>"""
    data_deletion_policy: NotRequired[
        "capo_bedrock_agent.types.data_deletion_policy.DataDeletionPolicy"
    ]
    """<p>The data deletion policy for the data source.</p>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the data source was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time at which the data source was last updated.</p>"""
    failure_reasons: NotRequired[
        "capo_bedrock_agent.types.failure_reasons.FailureReasons"
    ]
    """<p>The detailed reasons on the failure to delete a data source.</p>"""

created_at instance-attribute

created_at: DateTimestamp

The time at which the data source was created.

data_deletion_policy instance-attribute

data_deletion_policy: NotRequired[DataDeletionPolicy]

The data deletion policy for the data source.

data_source_configuration instance-attribute

data_source_configuration: DataSourceConfiguration

The connection configuration for the data source.

data_source_id instance-attribute

data_source_id: Id

The unique identifier of the data source.

description instance-attribute

description: NotRequired[Description]

The description of the data source.

failure_reasons instance-attribute

failure_reasons: NotRequired[FailureReasons]

The detailed reasons on the failure to delete a data source.

knowledge_base_id instance-attribute

knowledge_base_id: Id

The unique identifier of the knowledge base to which the data source belongs.

name instance-attribute

name: Name

The name of the data source.

server_side_encryption_configuration instance-attribute

server_side_encryption_configuration: NotRequired[ServerSideEncryptionConfiguration]

Contains details about the configuration of the server-side encryption.

status instance-attribute

The status of the data source. The following statuses are possible:

  • Available – The data source has been created and is ready for ingestion into the knowledge base.

  • Deleting – The data source is being deleted.

updated_at instance-attribute

updated_at: DateTimestamp

The time at which the data source was last updated.

vector_ingestion_configuration instance-attribute

vector_ingestion_configuration: NotRequired[VectorIngestionConfiguration]

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