Skip to content

ConfluenceAttachmentConfiguration

Source code in docs_src/capo_kendra/types/confluence_attachment_configuration.py 
12
13
14
15
16
17
18
class ConfluenceAttachmentConfiguration(TypedDict, closed=True):
    crawl_attachments: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index attachments of pages and blogs in Confluence.</p>"""
    attachment_field_mappings: NotRequired[
        "capo_kendra.types.confluence_attachment_field_mappings_list.ConfluenceAttachmentFieldMappingsList"
    ]
    """<p>Maps attributes or field names of Confluence attachments 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>AttachentFieldMappings</code> parameter, you must specify at least one field mapping.</p>"""

attachment_field_mappings instance-attribute 

attachment_field_mappings: NotRequired[ConfluenceAttachmentFieldMappingsList]

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

crawl_attachments instance-attribute 

crawl_attachments: Boolean

TRUE to index attachments of pages and blogs in Confluence.