Using an Amazon WorkDocs data source - Amazon Kendra

Using an Amazon WorkDocs data source

You can use your Amazon WorkDocs as a data source for Amazon Kendra. For a walk-through of how to use Amazon WorkDocs in the console, see Getting started with Amazon WorkDocs (console).

When you use Amazon Kendra to index documents in your Amazon WorkDocs site, choose the directory ID that corresponds with your Amazon WorkDocs site repository. You can specify regular expression patterns to include or exclude specific documents in your Amazon WorkDocs site.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

You need to create an index before you create the Amazon WorkDocs data source. For more information, see Creating an index. You provide the ID of the index when you create the data source.

To connect to an Amazon WorkDocs site, you specify connection and other information in the console or by using the WorkDocsConfiguration data type.

Provide the directory ID of the Amazon WorkDocs site you want to index.

You also need to provide the Amazon Resource Name (ARN) of an IAM role that gives permission to access your Amazon WorkDocs site. You provide the ARN of an IAM role using the CreateDataSource operation. For more permissions information, see IAM roles for Amazon WorkDocs data sources

You also can add the following optional information:

  • Whether Amazon Kendra should index the contents of comments of your documents. Each comment is indexed as a separate document.

  • Whether Amazon Kendra should use the Amazon WorkDocs change log mechanism to determine if a document needs to be updated in the index. Use the change log if you don't want Amazon Kendra to scan all of the site documents. If your change log is large, it may take Amazon Kendra less time to scan the documents in the Amazon WorkDocs site than to process the change log. If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned.

  • Inclusion or exclusion pattern: If you specify an inclusion pattern, any document with a file name that does not match the pattern is not indexed. If you specify an inclusion and exclusion pattern, documents that match the exclusion pattern are not indexed even if they match the inclusion pattern.

  • Field mappings that map your Amazon WorkDocs fields to Amazon Kendra index fields. For more information, see Mapping data source fields.