Skip to content

ConfluencePageConfiguration

Source code in docs_src/capo_kendra/types/confluence_page_configuration.py 
11
12
13
14
15
class ConfluencePageConfiguration(TypedDict, closed=True):
    page_field_mappings: NotRequired[
        "capo_kendra.types.confluence_page_field_mappings_list.ConfluencePageFieldMappingsList"
    ]
    """<p>Maps attributes or field names of Confluence pages 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>PageFieldMappings</code> parameter, you must specify at least one field mapping.</p>"""

page_field_mappings instance-attribute 

page_field_mappings: NotRequired[ConfluencePageFieldMappingsList]

Maps attributes or field names of Confluence pages 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 PageFieldMappings parameter, you must specify at least one field mapping.