Skip to content

DataSourceConfiguration

Source code in docs_src/capo_kendra/types/data_source_configuration.py
class DataSourceConfiguration(TypedDict, closed=True):
    s3_configuration: NotRequired[
        "capo_kendra.types.s3_data_source_configuration.S3DataSourceConfiguration"
    ]
    """<p>Provides the configuration information to connect to an Amazon S3 bucket as your data source.</p> <note> <p>Amazon Kendra now supports an upgraded Amazon S3 connector.</p> <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the <code>S3DataSourceConfiguration</code> object to configure your connector.</p> <p>Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.</p> <p>We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.</p> </note>"""
    share_point_configuration: NotRequired[
        "capo_kendra.types.share_point_configuration.SharePointConfiguration"
    ]
    """<p>Provides the configuration information to connect to Microsoft SharePoint as your data source.</p>"""
    database_configuration: NotRequired[
        "capo_kendra.types.database_configuration.DatabaseConfiguration"
    ]
    """<p>Provides the configuration information to connect to a database as your data source.</p>"""
    salesforce_configuration: NotRequired[
        "capo_kendra.types.salesforce_configuration.SalesforceConfiguration"
    ]
    """<p>Provides the configuration information to connect to Salesforce as your data source.</p>"""
    one_drive_configuration: NotRequired[
        "capo_kendra.types.one_drive_configuration.OneDriveConfiguration"
    ]
    """<p>Provides the configuration information to connect to Microsoft OneDrive as your data source.</p>"""
    service_now_configuration: NotRequired[
        "capo_kendra.types.service_now_configuration.ServiceNowConfiguration"
    ]
    """<p>Provides the configuration information to connect to ServiceNow as your data source.</p>"""
    confluence_configuration: NotRequired[
        "capo_kendra.types.confluence_configuration.ConfluenceConfiguration"
    ]
    """<p>Provides the configuration information to connect to Confluence as your data source.</p>"""
    google_drive_configuration: NotRequired[
        "capo_kendra.types.google_drive_configuration.GoogleDriveConfiguration"
    ]
    """<p>Provides the configuration information to connect to Google Drive as your data source.</p>"""
    web_crawler_configuration: NotRequired[
        "capo_kendra.types.web_crawler_configuration.WebCrawlerConfiguration"
    ]
    work_docs_configuration: NotRequired[
        "capo_kendra.types.work_docs_configuration.WorkDocsConfiguration"
    ]
    """<p>Provides the configuration information to connect to WorkDocs as your data source.</p>"""
    fsx_configuration: NotRequired[
        "capo_kendra.types.fsx_configuration.FsxConfiguration"
    ]
    """<p>Provides the configuration information to connect to Amazon FSx as your data source.</p> <note> <p>Amazon Kendra now supports an upgraded Amazon FSx Windows connector.</p> <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the <code>FsxConfiguration</code> object to configure your connector.</p> <p>Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.</p> <p>We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.</p> </note>"""
    slack_configuration: NotRequired[
        "capo_kendra.types.slack_configuration.SlackConfiguration"
    ]
    """<p>Provides the configuration information to connect to Slack as your data source.</p> <note> <p>Amazon Kendra now supports an upgraded Slack connector.</p> <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the <code>SlackConfiguration</code> object to configure your connector.</p> <p>Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.</p> <p>We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.</p> </note>"""
    box_configuration: NotRequired[
        "capo_kendra.types.box_configuration.BoxConfiguration"
    ]
    """<p>Provides the configuration information to connect to Box as your data source.</p>"""
    quip_configuration: NotRequired[
        "capo_kendra.types.quip_configuration.QuipConfiguration"
    ]
    """<p>Provides the configuration information to connect to Quip as your data source.</p>"""
    jira_configuration: NotRequired[
        "capo_kendra.types.jira_configuration.JiraConfiguration"
    ]
    """<p>Provides the configuration information to connect to Jira as your data source.</p>"""
    git_hub_configuration: NotRequired[
        "capo_kendra.types.git_hub_configuration.GitHubConfiguration"
    ]
    """<p>Provides the configuration information to connect to GitHub as your data source.</p> <note> <p>Amazon Kendra now supports an upgraded GitHub connector.</p> <p>You must now use the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> object instead of the <code>GitHubConfiguration</code> object to configure your connector.</p> <p>Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.</p> <p>We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.</p> </note>"""
    alfresco_configuration: NotRequired[
        "capo_kendra.types.alfresco_configuration.AlfrescoConfiguration"
    ]
    """<p>Provides the configuration information to connect to Alfresco as your data source.</p> <note> <p>Support for <code>AlfrescoConfiguration</code> ended May 2023. We recommend migrating to or using the Alfresco data source template schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a> API.</p> </note>"""
    template_configuration: NotRequired[
        "capo_kendra.types.template_configuration.TemplateConfiguration"
    ]
    """<p>Provides a template for the configuration information to connect to your data source.</p>"""

alfresco_configuration instance-attribute

alfresco_configuration: NotRequired[AlfrescoConfiguration]

Provides the configuration information to connect to Alfresco as your data source.

Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration API.

box_configuration instance-attribute

box_configuration: NotRequired[BoxConfiguration]

Provides the configuration information to connect to Box as your data source.

confluence_configuration instance-attribute

confluence_configuration: NotRequired[ConfluenceConfiguration]

Provides the configuration information to connect to Confluence as your data source.

database_configuration instance-attribute

database_configuration: NotRequired[DatabaseConfiguration]

Provides the configuration information to connect to a database as your data source.

fsx_configuration instance-attribute

fsx_configuration: NotRequired[FsxConfiguration]

Provides the configuration information to connect to Amazon FSx as your data source.

Amazon Kendra now supports an upgraded Amazon FSx Windows connector.

You must now use the TemplateConfiguration object instead of the FsxConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

git_hub_configuration instance-attribute

git_hub_configuration: NotRequired[GitHubConfiguration]

Provides the configuration information to connect to GitHub as your data source.

Amazon Kendra now supports an upgraded GitHub connector.

You must now use the TemplateConfiguration object instead of the GitHubConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won’t be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

google_drive_configuration instance-attribute

google_drive_configuration: NotRequired[GoogleDriveConfiguration]

Provides the configuration information to connect to Google Drive as your data source.

jira_configuration instance-attribute

jira_configuration: NotRequired[JiraConfiguration]

Provides the configuration information to connect to Jira as your data source.

one_drive_configuration instance-attribute

one_drive_configuration: NotRequired[OneDriveConfiguration]

Provides the configuration information to connect to Microsoft OneDrive as your data source.

quip_configuration instance-attribute

quip_configuration: NotRequired[QuipConfiguration]

Provides the configuration information to connect to Quip as your data source.

s3_configuration instance-attribute

s3_configuration: NotRequired[S3DataSourceConfiguration]

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

salesforce_configuration instance-attribute

salesforce_configuration: NotRequired[SalesforceConfiguration]

Provides the configuration information to connect to Salesforce as your data source.

service_now_configuration instance-attribute

service_now_configuration: NotRequired[ServiceNowConfiguration]

Provides the configuration information to connect to ServiceNow as your data source.

share_point_configuration instance-attribute

share_point_configuration: NotRequired[SharePointConfiguration]

Provides the configuration information to connect to Microsoft SharePoint as your data source.

slack_configuration instance-attribute

slack_configuration: NotRequired[SlackConfiguration]

Provides the configuration information to connect to Slack as your data source.

Amazon Kendra now supports an upgraded Slack connector.

You must now use the TemplateConfiguration object instead of the SlackConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

template_configuration instance-attribute

template_configuration: NotRequired[TemplateConfiguration]

Provides a template for the configuration information to connect to your data source.

web_crawler_configuration instance-attribute

web_crawler_configuration: NotRequired[WebCrawlerConfiguration]

work_docs_configuration instance-attribute

work_docs_configuration: NotRequired[WorkDocsConfiguration]

Provides the configuration information to connect to WorkDocs as your data source.