Skip to content

ConfluenceSpaceConfiguration

Source code in docs_src/capo_kendra/types/confluence_space_configuration.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class ConfluenceSpaceConfiguration(TypedDict, closed=True):
    crawl_personal_spaces: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> 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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering on user context</a>.</p>"""
    crawl_archived_spaces: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index archived spaces.</p>"""
    include_spaces: NotRequired[
        "capo_kendra.types.confluence_space_list.ConfluenceSpaceList"
    ]
    """<p>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 <code>IncludeSpaces</code> and the <code>ExcludeSpaces</code> list, the space is excluded.</p>"""
    exclude_spaces: NotRequired[
        "capo_kendra.types.confluence_space_list.ConfluenceSpaceList"
    ]
    """<p>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 <code>ExcludeSpaces</code> and the <code>IncludeSpaces</code> list, the space is excluded.</p>"""
    space_field_mappings: NotRequired[
        "capo_kendra.types.confluence_space_field_mappings_list.ConfluenceSpaceFieldMappingsList"
    ]
    """<p>Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the <code>UpdateIndex</code> API before you map to Confluence fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>. The Confluence data source field names must exist in your Confluence custom metadata.</p> <p>If you specify the <code>SpaceFieldMappings</code> parameter, you must specify at least one field mapping.</p>"""

crawl_archived_spaces instance-attribute 

crawl_archived_spaces: Boolean

TRUE to index archived spaces.

crawl_personal_spaces instance-attribute 

crawl_personal_spaces: Boolean

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.

exclude_spaces instance-attribute 

exclude_spaces: NotRequired[ConfluenceSpaceList]

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 the IncludeSpaces list, the space is excluded.

include_spaces instance-attribute 

include_spaces: NotRequired[ConfluenceSpaceList]

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 the ExcludeSpaces list, the space is excluded.

space_field_mappings instance-attribute 

space_field_mappings: NotRequired[ConfluenceSpaceFieldMappingsList]

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.