ConfluenceSpaceConfiguration
Configuration information for indexing Confluence spaces.
Contents
- CrawlArchivedSpaces
-
TRUE
to index archived spaces.Type: Boolean
Required: No
- CrawlPersonalSpaces
-
TRUE
to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.Type: Boolean
Required: No
- ExcludeSpaces
-
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the
ExcludeSpaces
and theIncludeSpaces
list, the space is excluded.Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^\P{C}*$
Required: No
- IncludeSpaces
-
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the
IncludeSpaces
and theExcludeSpaces
list, the space is excluded.Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^\P{C}*$
Required: No
- SpaceFieldMappings
-
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the
UpdateIndex
API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.If you specify the
SpaceFieldMappings
parameter, you must specify at least one field mapping.Type: Array of ConfluenceSpaceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: