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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass WorkDocsConfiguration data as a hash:

{
  organization_id: "OrganizationId", # required
  crawl_comments: false,
  use_change_log: false,
  inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_commentsBoolean

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)


14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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

#exclusion_patternsArray<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>)


14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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

#field_mappingsArray<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.



14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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

#inclusion_patternsArray<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>)


14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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

#organization_idString

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.

Returns:

  • (String)


14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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

#use_change_logBoolean

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)


14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 14674

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