Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data WorkDocsConfiguration = WorkDocsConfiguration' {}
- newWorkDocsConfiguration :: Text -> WorkDocsConfiguration
- workDocsConfiguration_crawlComments :: Lens' WorkDocsConfiguration (Maybe Bool)
- workDocsConfiguration_exclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text])
- workDocsConfiguration_fieldMappings :: Lens' WorkDocsConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- workDocsConfiguration_inclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text])
- workDocsConfiguration_useChangeLog :: Lens' WorkDocsConfiguration (Maybe Bool)
- workDocsConfiguration_organizationId :: Lens' WorkDocsConfiguration Text
Documentation
data WorkDocsConfiguration Source #
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: newWorkDocsConfiguration
smart constructor.
WorkDocsConfiguration' | |
|
Instances
newWorkDocsConfiguration Source #
Create a value of WorkDocsConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:crawlComments:WorkDocsConfiguration'
, workDocsConfiguration_crawlComments
- 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
.
$sel:exclusionPatterns:WorkDocsConfiguration'
, workDocsConfiguration_exclusionPatterns
- 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.
$sel:fieldMappings:WorkDocsConfiguration'
, workDocsConfiguration_fieldMappings
- 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.
$sel:inclusionPatterns:WorkDocsConfiguration'
, workDocsConfiguration_inclusionPatterns
- 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.
$sel:useChangeLog:WorkDocsConfiguration'
, workDocsConfiguration_useChangeLog
- 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.
$sel:organizationId:WorkDocsConfiguration'
, workDocsConfiguration_organizationId
- 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.
workDocsConfiguration_crawlComments :: Lens' WorkDocsConfiguration (Maybe Bool) Source #
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
.
workDocsConfiguration_exclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #
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.
workDocsConfiguration_fieldMappings :: Lens' WorkDocsConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #
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.
workDocsConfiguration_inclusionPatterns :: Lens' WorkDocsConfiguration (Maybe [Text]) Source #
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.
workDocsConfiguration_useChangeLog :: Lens' WorkDocsConfiguration (Maybe Bool) Source #
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.
workDocsConfiguration_organizationId :: Lens' WorkDocsConfiguration Text Source #
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.