ConfluenceAttachmentToIndexFieldMapping - Amazon Kendra API Reference

ConfluenceAttachmentToIndexFieldMapping

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 Confuence data source field names must exist in your Confluence custom metadata.

Contents

DataSourceFieldName

The name of the field in the data source.

You must first create the index field using the UpdateIndex API.

Type: String

Valid Values: AUTHOR | CONTENT_TYPE | CREATED_DATE | DISPLAY_URL | FILE_SIZE | ITEM_TYPE | PARENT_ID | SPACE_KEY | SPACE_NAME | URL | VERSION

Required: No

DateFieldFormat

The format for date fields in the data source. If the field specified in DataSourceFieldName is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 40.

Pattern: ^(?!\s).*(?<!\s)$

Required: No

IndexFieldName

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 30.

Pattern: ^\P{C}*$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: