data_sources

Creates, updates, deletes, gets or lists a data_sources resource.

Overview

Name	data_sources
Type	Resource
Id	aws.kendra.data_sources

Fields

The following fields are returned by SELECT queries:

describe_data_source

Name	Datatype	Description
configuration	object	Configuration details for the data source connector. This shows how the data source is configured. The configuration options for a data source depend on the data source provider.
created_at	string (date-time)	The Unix timestamp when the data source connector was created.
custom_document_enrichment_configuration	object	Configuration information for altering document metadata and content during the document ingestion process when you describe a data source. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
description	string	The description for the data source connector. (pattern: <code>^\P{C}*$</code>)
error_message	string	When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail. (pattern: <code>^\P{C}*$</code>)
id	string	The identifier of the data source connector. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
index_id	string	The identifier of the index used with the data source connector. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9-]*</code>)
language_code	string	The code for a language. This shows a supported language for all documents in the data source. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English. (pattern: <code>[a-zA-Z-]*</code>)
name	string	The name for the data source connector. (pattern: <code>[a-zA-Z0-9][a-zA-Z0-9_-]*</code>)
role_arn	string	The Amazon Resource Name (ARN) of the IAM role with permission to access the data source and required resources. (pattern: <code>arn:[a-z0-9-.]{1,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:[^/].{0,1023}</code>)
schedule	string	The schedule for Amazon Kendra to update the index.
status	string	The current status of the data source connector. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed. (CREATING, DELETING, FAILED, UPDATING, ACTIVE)
type	string	The type of the data source. For example, SHAREPOINT. (S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO, TEMPLATE)
updated_at	string (date-time)	The Unix timestamp when the data source connector was last updated.
vpc_configuration	object	Provides the configuration information to connect to an Amazon VPC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_data_source	select	region		Gets information about an Amazon Kendra data source connector.
create_data_source	insert	region, IndexId		Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
update_data_source	update	region, IndexId		Updates an Amazon Kendra data source connector.
delete_data_source	delete	region		Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources. Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
list_data_sources	exec	region, IndexId		Lists the data source connectors that you have created.
start_data_source_sync_job	exec	region, IndexId		Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
stop_data_source_sync_job	exec	region, IndexId		Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_data_source

Gets information about an Amazon Kendra data source connector.

SELECT
configuration,
created_at,
custom_document_enrichment_configuration,
description,
error_message,
id,
index_id,
language_code,
name,
role_arn,
schedule,
status,
type,
updated_at,
vpc_configuration
FROM aws.kendra.data_sources
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_data_source

Creates a data source connector that you want to use with an Amazon Kendra index. You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector. CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised. For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

INSERT INTO aws.kendra.data_sources (
Name,
IndexId,
Type,
Configuration,
VpcConfiguration,
Description,
Schedule,
RoleArn,
Tags,
ClientToken,
LanguageCode,
CustomDocumentEnrichmentConfiguration,
region
)
SELECT 
'{{ Name }}',
'{{ IndexId }}' /* required */,
'{{ Type }}',
'{{ Configuration }}',
'{{ VpcConfiguration }}',
'{{ Description }}',
'{{ Schedule }}',
'{{ RoleArn }}',
'{{ Tags }}',
'{{ ClientToken }}',
'{{ LanguageCode }}',
'{{ CustomDocumentEnrichmentConfiguration }}',
'{{ region }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: data_sources
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_sources resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      A name for the data source connector.
  - name: IndexId
    value: "{{ IndexId }}"
    description: |
      The identifier of the index you want to use with the data source connector.
  - name: Type
    value: "{{ Type }}"
    description: |
      The type of data source repository. For example, SHAREPOINT.
    valid_values: ['S3', 'SHAREPOINT', 'DATABASE', 'SALESFORCE', 'ONEDRIVE', 'SERVICENOW', 'CUSTOM', 'CONFLUENCE', 'GOOGLEDRIVE', 'WEBCRAWLER', 'WORKDOCS', 'FSX', 'SLACK', 'BOX', 'QUIP', 'JIRA', 'GITHUB', 'ALFRESCO', 'TEMPLATE']
  - name: Configuration
    description: |
      Configuration information to connect to your data source repository. You can't specify the Configuration parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception. The Configuration parameter is required for all other data sources.
    value:
      S3Configuration:
        BucketName: "{{ BucketName }}"
        InclusionPrefixes:
          - "{{ InclusionPrefixes }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        DocumentsMetadataConfiguration:
          S3Prefix: "{{ S3Prefix }}"
        AccessControlListConfiguration:
          KeyPath: "{{ KeyPath }}"
      SharePointConfiguration:
        SharePointVersion: "{{ SharePointVersion }}"
        Urls:
          - "{{ Urls }}"
        SecretArn: "{{ SecretArn }}"
        CrawlAttachments: {{ CrawlAttachments }}
        UseChangeLog: {{ UseChangeLog }}
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
        DisableLocalGroups: {{ DisableLocalGroups }}
        SslCertificateS3Path:
          Bucket: "{{ Bucket }}"
          Key: "{{ Key }}"
        AuthenticationType: "{{ AuthenticationType }}"
        ProxyConfiguration:
          Host: "{{ Host }}"
          Port: {{ Port }}
          Credentials: "{{ Credentials }}"
      DatabaseConfiguration:
        DatabaseEngineType: "{{ DatabaseEngineType }}"
        ConnectionConfiguration:
          DatabaseHost: "{{ DatabaseHost }}"
          DatabasePort: {{ DatabasePort }}
          DatabaseName: "{{ DatabaseName }}"
          TableName: "{{ TableName }}"
          SecretArn: "{{ SecretArn }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        ColumnConfiguration:
          DocumentIdColumnName: "{{ DocumentIdColumnName }}"
          DocumentDataColumnName: "{{ DocumentDataColumnName }}"
          DocumentTitleColumnName: "{{ DocumentTitleColumnName }}"
          FieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
          ChangeDetectingColumns:
            - "{{ ChangeDetectingColumns }}"
        AclConfiguration:
          AllowedGroupsColumnName: "{{ AllowedGroupsColumnName }}"
        SqlConfiguration:
          QueryIdentifiersEnclosingOption: "{{ QueryIdentifiersEnclosingOption }}"
      SalesforceConfiguration:
        ServerUrl: "{{ ServerUrl }}"
        SecretArn: "{{ SecretArn }}"
        StandardObjectConfigurations:
          - Name: "{{ Name }}"
            DocumentDataFieldName: "{{ DocumentDataFieldName }}"
            DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
            FieldMappings: "{{ FieldMappings }}"
        KnowledgeArticleConfiguration:
          IncludedStates:
            - "{{ IncludedStates }}"
          StandardKnowledgeArticleTypeConfiguration:
            DocumentDataFieldName: "{{ DocumentDataFieldName }}"
            DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
            FieldMappings:
              - DataSourceFieldName: "{{ DataSourceFieldName }}"
                DateFieldFormat: "{{ DateFieldFormat }}"
                IndexFieldName: "{{ IndexFieldName }}"
          CustomKnowledgeArticleTypeConfigurations:
            - Name: "{{ Name }}"
              DocumentDataFieldName: "{{ DocumentDataFieldName }}"
              DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
              FieldMappings: "{{ FieldMappings }}"
        ChatterFeedConfiguration:
          DocumentDataFieldName: "{{ DocumentDataFieldName }}"
          DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
          FieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
          IncludeFilterTypes:
            - "{{ IncludeFilterTypes }}"
        CrawlAttachments: {{ CrawlAttachments }}
        StandardObjectAttachmentConfiguration:
          DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
          FieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        IncludeAttachmentFilePatterns:
          - "{{ IncludeAttachmentFilePatterns }}"
        ExcludeAttachmentFilePatterns:
          - "{{ ExcludeAttachmentFilePatterns }}"
      OneDriveConfiguration:
        TenantDomain: "{{ TenantDomain }}"
        SecretArn: "{{ SecretArn }}"
        OneDriveUsers:
          OneDriveUserList:
            - "{{ OneDriveUserList }}"
          OneDriveUserS3Path:
            Bucket: "{{ Bucket }}"
            Key: "{{ Key }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        DisableLocalGroups: {{ DisableLocalGroups }}
      ServiceNowConfiguration:
        HostUrl: "{{ HostUrl }}"
        SecretArn: "{{ SecretArn }}"
        ServiceNowBuildVersion: "{{ ServiceNowBuildVersion }}"
        KnowledgeArticleConfiguration:
          CrawlAttachments: {{ CrawlAttachments }}
          IncludeAttachmentFilePatterns:
            - "{{ IncludeAttachmentFilePatterns }}"
          ExcludeAttachmentFilePatterns:
            - "{{ ExcludeAttachmentFilePatterns }}"
          DocumentDataFieldName: "{{ DocumentDataFieldName }}"
          DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
          FieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
          FilterQuery: "{{ FilterQuery }}"
        ServiceCatalogConfiguration:
          CrawlAttachments: {{ CrawlAttachments }}
          IncludeAttachmentFilePatterns:
            - "{{ IncludeAttachmentFilePatterns }}"
          ExcludeAttachmentFilePatterns:
            - "{{ ExcludeAttachmentFilePatterns }}"
          DocumentDataFieldName: "{{ DocumentDataFieldName }}"
          DocumentTitleFieldName: "{{ DocumentTitleFieldName }}"
          FieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        AuthenticationType: "{{ AuthenticationType }}"
      ConfluenceConfiguration:
        ServerUrl: "{{ ServerUrl }}"
        SecretArn: "{{ SecretArn }}"
        Version: "{{ Version }}"
        SpaceConfiguration:
          CrawlPersonalSpaces: {{ CrawlPersonalSpaces }}
          CrawlArchivedSpaces: {{ CrawlArchivedSpaces }}
          IncludeSpaces:
            - "{{ IncludeSpaces }}"
          ExcludeSpaces:
            - "{{ ExcludeSpaces }}"
          SpaceFieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        PageConfiguration:
          PageFieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        BlogConfiguration:
          BlogFieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        AttachmentConfiguration:
          CrawlAttachments: {{ CrawlAttachments }}
          AttachmentFieldMappings:
            - DataSourceFieldName: "{{ DataSourceFieldName }}"
              DateFieldFormat: "{{ DateFieldFormat }}"
              IndexFieldName: "{{ IndexFieldName }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        ProxyConfiguration:
          Host: "{{ Host }}"
          Port: {{ Port }}
          Credentials: "{{ Credentials }}"
        AuthenticationType: "{{ AuthenticationType }}"
      GoogleDriveConfiguration:
        SecretArn: "{{ SecretArn }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        ExcludeMimeTypes:
          - "{{ ExcludeMimeTypes }}"
        ExcludeUserAccounts:
          - "{{ ExcludeUserAccounts }}"
        ExcludeSharedDrives:
          - "{{ ExcludeSharedDrives }}"
      WebCrawlerConfiguration:
        Urls:
          SeedUrlConfiguration:
            SeedUrls:
              - "{{ SeedUrls }}"
            WebCrawlerMode: "{{ WebCrawlerMode }}"
          SiteMapsConfiguration:
            SiteMaps:
              - "{{ SiteMaps }}"
        CrawlDepth: {{ CrawlDepth }}
        MaxLinksPerPage: {{ MaxLinksPerPage }}
        MaxContentSizePerPageInMegaBytes: {{ MaxContentSizePerPageInMegaBytes }}
        MaxUrlsPerMinuteCrawlRate: {{ MaxUrlsPerMinuteCrawlRate }}
        UrlInclusionPatterns:
          - "{{ UrlInclusionPatterns }}"
        UrlExclusionPatterns:
          - "{{ UrlExclusionPatterns }}"
        ProxyConfiguration:
          Host: "{{ Host }}"
          Port: {{ Port }}
          Credentials: "{{ Credentials }}"
        AuthenticationConfiguration:
          BasicAuthentication:
            - Host: "{{ Host }}"
              Port: {{ Port }}
              Credentials: "{{ Credentials }}"
      WorkDocsConfiguration:
        OrganizationId: "{{ OrganizationId }}"
        CrawlComments: {{ CrawlComments }}
        UseChangeLog: {{ UseChangeLog }}
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
      FsxConfiguration:
        FileSystemId: "{{ FileSystemId }}"
        FileSystemType: "{{ FileSystemType }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        SecretArn: "{{ SecretArn }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
      SlackConfiguration:
        TeamId: "{{ TeamId }}"
        SecretArn: "{{ SecretArn }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        SlackEntityList:
          - "{{ SlackEntityList }}"
        UseChangeLog: {{ UseChangeLog }}
        CrawlBotMessage: {{ CrawlBotMessage }}
        ExcludeArchived: {{ ExcludeArchived }}
        SinceCrawlDate: "{{ SinceCrawlDate }}"
        LookBackPeriod: {{ LookBackPeriod }}
        PrivateChannelFilter:
          - "{{ PrivateChannelFilter }}"
        PublicChannelFilter:
          - "{{ PublicChannelFilter }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        FieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
      BoxConfiguration:
        EnterpriseId: "{{ EnterpriseId }}"
        SecretArn: "{{ SecretArn }}"
        UseChangeLog: {{ UseChangeLog }}
        CrawlComments: {{ CrawlComments }}
        CrawlTasks: {{ CrawlTasks }}
        CrawlWebLinks: {{ CrawlWebLinks }}
        FileFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        TaskFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        CommentFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        WebLinkFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
      QuipConfiguration:
        Domain: "{{ Domain }}"
        SecretArn: "{{ SecretArn }}"
        CrawlFileComments: {{ CrawlFileComments }}
        CrawlChatRooms: {{ CrawlChatRooms }}
        CrawlAttachments: {{ CrawlAttachments }}
        FolderIds:
          - "{{ FolderIds }}"
        ThreadFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        MessageFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        AttachmentFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
      JiraConfiguration:
        JiraAccountUrl: "{{ JiraAccountUrl }}"
        SecretArn: "{{ SecretArn }}"
        UseChangeLog: {{ UseChangeLog }}
        Project:
          - "{{ Project }}"
        IssueType:
          - "{{ IssueType }}"
        Status:
          - "{{ Status }}"
        IssueSubEntityFilter:
          - "{{ IssueSubEntityFilter }}"
        AttachmentFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        CommentFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        IssueFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        ProjectFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        WorkLogFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
      GitHubConfiguration:
        SaaSConfiguration:
          OrganizationName: "{{ OrganizationName }}"
          HostUrl: "{{ HostUrl }}"
        OnPremiseConfiguration:
          HostUrl: "{{ HostUrl }}"
          OrganizationName: "{{ OrganizationName }}"
          SslCertificateS3Path:
            Bucket: "{{ Bucket }}"
            Key: "{{ Key }}"
        Type: "{{ Type }}"
        SecretArn: "{{ SecretArn }}"
        UseChangeLog: {{ UseChangeLog }}
        GitHubDocumentCrawlProperties:
          CrawlRepositoryDocuments: {{ CrawlRepositoryDocuments }}
          CrawlIssue: {{ CrawlIssue }}
          CrawlIssueComment: {{ CrawlIssueComment }}
          CrawlIssueCommentAttachment: {{ CrawlIssueCommentAttachment }}
          CrawlPullRequest: {{ CrawlPullRequest }}
          CrawlPullRequestComment: {{ CrawlPullRequestComment }}
          CrawlPullRequestCommentAttachment: {{ CrawlPullRequestCommentAttachment }}
        RepositoryFilter:
          - "{{ RepositoryFilter }}"
        InclusionFolderNamePatterns:
          - "{{ InclusionFolderNamePatterns }}"
        InclusionFileTypePatterns:
          - "{{ InclusionFileTypePatterns }}"
        InclusionFileNamePatterns:
          - "{{ InclusionFileNamePatterns }}"
        ExclusionFolderNamePatterns:
          - "{{ ExclusionFolderNamePatterns }}"
        ExclusionFileTypePatterns:
          - "{{ ExclusionFileTypePatterns }}"
        ExclusionFileNamePatterns:
          - "{{ ExclusionFileNamePatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
        GitHubRepositoryConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubCommitConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubIssueDocumentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubIssueCommentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubIssueAttachmentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubPullRequestCommentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubPullRequestDocumentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        GitHubPullRequestDocumentAttachmentConfigurationFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
      AlfrescoConfiguration:
        SiteUrl: "{{ SiteUrl }}"
        SiteId: "{{ SiteId }}"
        SecretArn: "{{ SecretArn }}"
        SslCertificateS3Path:
          Bucket: "{{ Bucket }}"
          Key: "{{ Key }}"
        CrawlSystemFolders: {{ CrawlSystemFolders }}
        CrawlComments: {{ CrawlComments }}
        EntityFilter:
          - "{{ EntityFilter }}"
        DocumentLibraryFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        BlogFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        WikiFieldMappings:
          - DataSourceFieldName: "{{ DataSourceFieldName }}"
            DateFieldFormat: "{{ DateFieldFormat }}"
            IndexFieldName: "{{ IndexFieldName }}"
        InclusionPatterns:
          - "{{ InclusionPatterns }}"
        ExclusionPatterns:
          - "{{ ExclusionPatterns }}"
        VpcConfiguration:
          SubnetIds:
            - "{{ SubnetIds }}"
          SecurityGroupIds:
            - "{{ SecurityGroupIds }}"
      TemplateConfiguration:
        Template: "{{ Template }}"
  - name: VpcConfiguration
    description: |
      Provides the configuration information to connect to an Amazon VPC.
    value:
      SubnetIds:
        - "{{ SubnetIds }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the data source connector.
  - name: Schedule
    value: "{{ Schedule }}"
    description: |
      Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
  - name: RoleArn
    value: "{{ RoleArn }}"
    description: |
      The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra.. You can't specify the RoleArn parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception. The RoleArn parameter is required for all other data sources.
  - name: Tags
    description: |
      A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A token that you provide to identify the request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
  - name: LanguageCode
    value: "{{ LanguageCode }}"
    description: |
      The code for a language. This allows you to support a language for all documents when creating the data source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
  - name: CustomDocumentEnrichmentConfiguration
    description: |
      Configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.
    value:
      InlineConfigurations:
        - Condition:
            ConditionDocumentAttributeKey: "{{ ConditionDocumentAttributeKey }}"
            Operator: "{{ Operator }}"
            ConditionOnValue:
              StringValue: "{{ StringValue }}"
              StringListValue:
                - "{{ StringListValue }}"
              LongValue: {{ LongValue }}
              DateValue: "{{ DateValue }}"
          Target:
            TargetDocumentAttributeKey: "{{ TargetDocumentAttributeKey }}"
            TargetDocumentAttributeValueDeletion: {{ TargetDocumentAttributeValueDeletion }}
            TargetDocumentAttributeValue:
              StringValue: "{{ StringValue }}"
              StringListValue:
                - "{{ StringListValue }}"
              LongValue: {{ LongValue }}
              DateValue: "{{ DateValue }}"
          DocumentContentDeletion: {{ DocumentContentDeletion }}
      PreExtractionHookConfiguration:
        InvocationCondition:
          ConditionDocumentAttributeKey: "{{ ConditionDocumentAttributeKey }}"
          Operator: "{{ Operator }}"
          ConditionOnValue:
            StringValue: "{{ StringValue }}"
            StringListValue:
              - "{{ StringListValue }}"
            LongValue: {{ LongValue }}
            DateValue: "{{ DateValue }}"
        LambdaArn: "{{ LambdaArn }}"
        S3Bucket: "{{ S3Bucket }}"
      PostExtractionHookConfiguration:
        InvocationCondition:
          ConditionDocumentAttributeKey: "{{ ConditionDocumentAttributeKey }}"
          Operator: "{{ Operator }}"
          ConditionOnValue:
            StringValue: "{{ StringValue }}"
            StringListValue:
              - "{{ StringListValue }}"
            LongValue: {{ LongValue }}
            DateValue: "{{ DateValue }}"
        LambdaArn: "{{ LambdaArn }}"
        S3Bucket: "{{ S3Bucket }}"
      RoleArn: "{{ RoleArn }}"

UPDATE examples

update_data_source

Updates an Amazon Kendra data source connector.

UPDATE aws.kendra.data_sources
SET 
Id = '{{ Id }}',
Name = '{{ Name }}',
IndexId = '{{ IndexId }}',
Configuration = '{{ Configuration }}',
VpcConfiguration = '{{ VpcConfiguration }}',
Description = '{{ Description }}',
Schedule = '{{ Schedule }}',
RoleArn = '{{ RoleArn }}',
LanguageCode = '{{ LanguageCode }}',
CustomDocumentEnrichmentConfiguration = '{{ CustomDocumentEnrichmentConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND IndexId = '{{ IndexId }}' --required;

DELETE examples

delete_data_source

Deletes an Amazon Kendra data source connector. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource API is set to DELETING. For more information, see Deleting Data Sources. Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.

DELETE FROM aws.kendra.data_sources
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

list_data_sources

Lists the data source connectors that you have created.

EXEC aws.kendra.data_sources.list_data_sources 
@region='{{ region }}' --required 
@@json=
'{
"IndexId": "{{ IndexId }}", 
"NextToken": "{{ NextToken }}", 
"MaxResults": {{ MaxResults }}
}'
;

start_data_source_sync_job

Starts a synchronization job for a data source connector. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception. Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.

EXEC aws.kendra.data_sources.start_data_source_sync_job 
@region='{{ region }}' --required 
@@json=
'{
"Id": "{{ Id }}", 
"IndexId": "{{ IndexId }}"
}'
;

stop_data_source_sync_job

Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.

EXEC aws.kendra.data_sources.stop_data_source_sync_job 
@region='{{ region }}' --required 
@@json=
'{
"Id": "{{ Id }}", 
"IndexId": "{{ IndexId }}"
}'
;