Skip to content

DataSourceConfiguration

Source code in docs_src/capo_bedrock_agent/types/data_source_configuration.py
class DataSourceConfiguration(TypedDict, closed=True):
    type: "capo_bedrock_agent.types.data_source_type.DataSourceType"
    """<p>The type of data source.</p>"""
    managed_knowledge_base_connector_configuration: NotRequired[
        "capo_bedrock_agent.types.managed_knowledge_base_connector_configuration.ManagedKnowledgeBaseConnectorConfiguration"
    ]
    """<p>Contains the configuration for a data source that connects a managed knowledge base to a supported data source connector. Specify this object when the data source type is <code>MANAGED_KNOWLEDGE_BASE_CONNECTOR</code>.</p>"""
    s3_configuration: NotRequired[
        "capo_bedrock_agent.types.s3_data_source_configuration.S3DataSourceConfiguration"
    ]
    """<p>The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>.</p>"""
    web_configuration: NotRequired[
        "capo_bedrock_agent.types.web_data_source_configuration.WebDataSourceConfiguration"
    ]
    """<p>The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. Web crawler data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>"""
    confluence_configuration: NotRequired[
        "capo_bedrock_agent.types.confluence_data_source_configuration.ConfluenceDataSourceConfiguration"
    ]
    """<p>The configuration information to connect to Confluence as your data source for self-managed knowledge bases.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. Confluence data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>"""
    salesforce_configuration: NotRequired[
        "capo_bedrock_agent.types.salesforce_data_source_configuration.SalesforceDataSourceConfiguration"
    ]
    """<p>The configuration information to connect to Salesforce as your data source.</p> <note> <p>Salesforce data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>"""
    share_point_configuration: NotRequired[
        "capo_bedrock_agent.types.share_point_data_source_configuration.SharePointDataSourceConfiguration"
    ]
    """<p>The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.</p> <note> <p>To configure this data source for managed knowledge bases, use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ManagedKnowledgeBaseConnectorConfiguration.html">managedKnowledgeBaseConnectorConfiguration</a>. SharePoint data source connector for self-managed knowledge bases is in preview release and is subject to change.</p> </note>"""

confluence_configuration instance-attribute

confluence_configuration: NotRequired[ConfluenceDataSourceConfiguration]

The configuration information to connect to Confluence as your data source for self-managed knowledge bases.

To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. Confluence data source connector for self-managed knowledge bases is in preview release and is subject to change.

managed_knowledge_base_connector_configuration instance-attribute

managed_knowledge_base_connector_configuration: NotRequired[
    ManagedKnowledgeBaseConnectorConfiguration
]

Contains the configuration for a data source that connects a managed knowledge base to a supported data source connector. Specify this object when the data source type is MANAGED_KNOWLEDGE_BASE_CONNECTOR.

s3_configuration instance-attribute

s3_configuration: NotRequired[S3DataSourceConfiguration]

The configuration information to connect to Amazon S3 as your data source for self-managed knowledge bases. To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration.

salesforce_configuration instance-attribute

salesforce_configuration: NotRequired[SalesforceDataSourceConfiguration]

The configuration information to connect to Salesforce as your data source.

Salesforce data source connector for self-managed knowledge bases is in preview release and is subject to change.

share_point_configuration instance-attribute

share_point_configuration: NotRequired[SharePointDataSourceConfiguration]

The configuration information to connect to SharePoint as your data source for self-managed knowledge bases.

To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. SharePoint data source connector for self-managed knowledge bases is in preview release and is subject to change.

type instance-attribute

The type of data source.

web_configuration instance-attribute

web_configuration: NotRequired[WebDataSourceConfiguration]

The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.

To configure this data source for managed knowledge bases, use managedKnowledgeBaseConnectorConfiguration. Web crawler data source connector for self-managed knowledge bases is in preview release and is subject to change.