Class: Aws::Kendra::Types::WorkDocsConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::WorkDocsConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

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

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #crawl_comments ⇒ Boolean

  ‘TRUE` to include comments on documents in your index.

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names.

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository.

• #organization_id ⇒ String

  The identifier of the directory corresponding to your Amazon WorkDocs site repository.

• #use_change_log ⇒ Boolean

  ‘TRUE` to use the Amazon WorkDocs change log to determine which documents require updating in the index.

Instance Attribute Details

#crawl_comments ⇒ Boolean

‘TRUE` to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to ‘FALSE`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Amazon WorkDocs fields. For more information, see [Mapping data source fields]. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don’t match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the [Directory Service] by going to **Active Directory**, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

[1]: console.aws.amazon.com/directoryservicev2/

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ Boolean

‘TRUE` to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

Returns:

• (Boolean)

# File 'lib/aws-sdk-kendra/types.rb', line 11340

class WorkDocsConfiguration < Struct.new(
  :organization_id,
  :crawl_comments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end