本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
資料來源範本結構描述
以下是支援範本之資料來源的範本結構描述。
主題
Adobe Experience Manager 範本結構描述
您包含 JSON，其中包含資料來源結構描述做為 TemplateConfiguration 物件的一部分。您可以提供Adobe Experience Manager主機 URL、身分驗證類型，以及是否使用 Adobe Experience Manager(AEM) 做為雲端服務或 AEM 現場部署做為連線組態或儲存庫端點詳細資訊的一部分。此外，請將資料來源的類型指定為 AEM、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 Type時，指定 TEMPLATE做為 CreateDataSource。
您可以使用本開發人員指南中提供的範本。如需詳細資訊，請參閱Adobe Experience Manager JSON 結構描述。
下表說明 AEM JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| aemUrl | Adobe Experience Manager 主機 URL。例如，如果您使用 AEM 現場部署，請包含主機名稱和連接埠：https://hostname:port。或者，如果您使用 AEM 做為雲端服務，您可以使用作者 URL：https://author-xxxxxx-xxxxxxx.adobeaemcloud.com。 |
| authType | 您使用的身分驗證類型，無論是 Basic或 OAuth2。 |
| deploymentType | 您使用Adobe Experience Manager的 類型，CLOUD或 ON_PREMISE。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將Adobe Experience Manager頁面和資產的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| timeZoneId |
如果您使用 AEM 現場部署，且伺服器的時區與 Amazon Kendra AEM 連接器或索引的時區不同，您可以指定要與 AEM 連接器或索引對齊的伺服器時區。 AEM 現場部署的預設時區是 Amazon Kendra AEM 連接器或索引的時區。AEM as a Cloud Service 的預設時區為格林威治標準時間。 |
|
頁面和資產的根路徑清單。例如，頁面的根路徑可以是 /content/sub，資產的根路徑可以是 /content/sub/asset1。 |
| crawlAssets | true 以爬取資產。 |
| crawlPages | true 以爬取頁面。 |
|
在Adobe Experience Manager資料來源中包含特定頁面和資產的規則表達式模式清單。符合模式的頁面和資產會包含在索引中。不符合模式的頁面和資產會從索引中排除。如果頁面或資產同時符合包含和排除模式，則排除模式為優先，且內容不包含在索引中。 |
|
規則表達式模式清單，用於排除Adobe Experience Manager資料來源中的特定頁面和資產。符合模式的頁面和資產會從索引中排除。不符合模式的頁面和資產會包含在索引中。如果頁面或資產同時符合包含和排除模式，則排除模式為優先，且內容不包含在索引中。 |
| pageComponents | 您要編製索引之特定頁面元件的名稱清單。 |
| contentFragmentVariations | 您要編製索引之Adobe Experience Manager內容片段特定儲存變化的名稱清單。 |
| type | 資料來源的類型。將 指定AEM為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 Adobe Experience Manager 所需的鍵/值對。如需這些鍵/值對的詳細資訊，請參閱 Adobe Experience Manager 的連線指示。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "aemUrl": { "type": "string", "pattern": "https:.*" }, "authType": { "type": "string", "enum": ["Basic", "OAuth2"] }, "deploymentType": { "type": "string", "enum": ["CLOUD","ON_PREMISE"] } }, "required": [ "aemUrl", "authType", "deploymentType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "asset": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "timeZoneId": { "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "GB", "GB-Eire", "GMT", "GMT0", "Greenwich", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROK", "Singapore", "SystemV/AST4", "SystemV/AST4ADT", "SystemV/CST6", "SystemV/CST6CDT", "SystemV/EST5", "SystemV/EST5EDT", "SystemV/HST10", "SystemV/MST7", "SystemV/MST7MDT", "SystemV/PST8", "SystemV/PST8PDT", "SystemV/YST9", "SystemV/YST9YDT", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu", "EST", "HST", "MST", "ACT", "AET", "AGT", "ART", "AST", "BET", "BST", "CAT", "CNT", "CST", "CTT", "EAT", "ECT", "IET", "IST", "JST", "MIT", "NET", "NST", "PLT", "PNT", "PRT", "PST", "SST", "VST" ] }, "pageRootPaths": { "type": "array", "items": { "type": "string" } }, "assetRootPaths": { "type": "array", "items": { "type": "string" } }, "crawlAssets": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "pagePathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pagePathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetPathExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetTypeExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "assetNameExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageComponents": { "type": "array", "items": { "type": "object" } }, "contentFragmentVariations": { "type": "array", "items": { "type": "object" } }, "cugExemptedPrincipals": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "AEM" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon FSx (Windows) 範本結構描述
您包含 JSON，其中包含資料來源結構描述做為 TemplateConfiguration 物件的一部分。您可以在連線組態或儲存庫端點詳細資訊中提供檔案系統 ID。您還必須將資料來源的類型指定為 FSX、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 Type時，指定 TEMPLATE做為 CreateDataSource。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon FSx (Windows) JSON 結構描述。
下表說明 Amazon FSx (Windows) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| fileSystemId | Amazon FSx 檔案系統的識別符。您可以在 Amazon FSx 主控台的檔案系統儀表板上找到您的檔案系統 ID。 |
| fileSystemType | Amazon FSx 檔案系統類型。若要使用 Windows File Server做為您的檔案系統類型，請指定 WINDOWS。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
| 全部 | 將 Amazon FSx 資料來源中檔案的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會為您的文件編目存取控制清單 (ACL) 資訊。ACL 指定使用者可以和群組存取哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| inclusionPatterns | 在 Amazon FSx 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| exclusionPatterns | 用於排除 Amazon FSx 資料來源中特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| type | 資料來源的類型。對於 Windows 檔案系統資料來源，指定 FSX。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "fs-.*" }, "fileSystemType": { "type": "string", "pattern": "WINDOWS" } }, "required": ["fileSystemId", "fileSystemType"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": ["fieldMappings"] } }, "required": ["All"] }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "type" : { "type" : "string", "pattern": "FSX" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "enableIdentityCrawler", "additionalProperties", "type" ] }
Amazon FSx (NetApp ONTAP) 範本結構描述
您會包含 JSON，其中包含資料來源結構描述做為 TemplateConfiguration 物件的一部分。您可以在連線組態或儲存庫端點詳細資訊中提供檔案系統 ID 和儲存虛擬機器 (SVM)。您還必須將資料來源的類型指定為 FSXONTAP、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 Type時，指定 TEMPLATE做為 CreateDataSource。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon FSx (NetApp ONTAP) JSON 結構描述。
下表說明 Amazon FSx (NetApp ONTAP) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| fileSystemId | Amazon FSx 檔案系統的識別符。您可以在 Amazon FSx 主控台的檔案系統儀表板上找到您的檔案系統 ID。如需如何在 Amazon FSx 主控台中為 NetApp ONTAP 建立檔案系統的詳細資訊，請參閱《 使用者指南》中的 NetApp ONTAP 入門FSx for ONTAP 指南。 |
| fileSystemType | Amazon FSx 檔案系統類型。若要使用 NetApp ONTAP做為您的檔案系統類型，請指定 ONTAP。 |
| svmId | 與 Amazon FSx 的檔案系統搭配使用的儲存虛擬機器 (SVM) 識別符NetApp ONTAP。您可以前往 Amazon FSx 主控台中的檔案系統儀表板，選取檔案系統 ID，然後選取儲存虛擬機器，以尋找 SVM ID。如需如何在 Amazon FSx 主控台中建立檔案系統的詳細資訊NetApp ONTAP，請參閱《 使用者指南》中的 NetApp ONTAP 入門FSx for ONTAP 指南。 |
| protocolType | 無論您是使用適用於 Windows 的通用網際網路檔案系統 (CIFS) 通訊協定，還是適用於 Linux 的網路檔案系統 (NFS) 通訊協定。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
| file | 將 Amazon FSx 資料來源中檔案的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。資料來源欄位名稱必須存在於您的檔案自訂中繼資料中。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| crawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會編目文件的存取控制清單 (ACL) 資訊。ACL 指定使用者可以和群組存取哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| inclusionPatterns | 在 Amazon FSx 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| exclusionPatterns | 用於排除 Amazon FSx 資料來源中特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
| type | 資料來源的類型。對於NetApp ONTAP檔案系統資料來源，指定 FSXONTAP。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn |
AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 Amazon FSx 檔案系統所需的鍵/值對。私密必須包含具有下列索引鍵的 JSON 結構：
如果您針對 Amazon FSx 檔案系統使用 NFS 通訊協定，秘密會存放在具有下列金鑰的 JSON 結構中：
|
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "fileSystemId": { "type": "string", "pattern": "^(fs-[0-9a-f]{8,21})$" }, "fileSystemType": { "type": "string", "enum": ["ONTAP"] }, "svmId": { "type": "string", "pattern": "^(svm-[0-9a-f]{17,21})$" }, "protocolType": { "type": "string", "enum": [ "CIFS", "NFS" ] } }, "required": [ "fileSystemId", "fileSystemType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string", "pattern": "^([a-zA-Z_]{1,20})$" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ], "maxItems": 50 } }, "required": [ "fieldMappings" ] } }, "required": [ "file" ] }, "additionalProperties": { "type": "object", "properties": { "crawlAcl": { "type": "boolean" }, "inclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 }, "exclusionPatterns": { "type": "array", "items": { "type": "string", "maxLength": 30 }, "maxItems": 100 } } }, "type": { "type": "string", "pattern": "FSXONTAP" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "pattern": "arn:aws:secretsmanager:.*" } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "secretArn", "type" ] }
Alfresco 範本結構描述
您包含 JSON，其中包含資料來源結構描述做為 TemplateConfiguration 物件的一部分。您可以提供Alfresco網站 ID、儲存庫 URL、使用者介面 URL、身分驗證類型、是否使用雲端或內部部署，以及您想要編目的內容類型。您可以在連線組態或儲存庫端點詳細資訊中提供此資訊。另請將資料來源的類型指定為 ALFRESCO、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 Type時，指定 TEMPLATE做為 CreateDataSource。
您可以使用本開發人員指南中提供的範本。請參閱 Alfresco JSON 結構描述。
下表說明 Alfresco JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| siteId | Alfresco 網站的識別符。 |
| repoUrl | 儲存Alfresco庫的 URL。您可以從Alfresco管理員取得儲存庫 URL。例如，如果您使用Alfresco雲端 (PaaS)，儲存庫 URL 可以是 https://company.alfrescocloud.com。或者，如果您使用Alfresco現場部署，儲存庫 URL 可以是 https://company-alfresco-instance.company-domain.suffix:port。 |
| webAppUrl | Alfresco 使用者介面的 URL。您可以從Alfresco管理員取得Alfresco使用者介面 URL。例如，使用者介面 URL 可以是 https://example.com。 |
| repositoryAdditionalProperties | 要與儲存庫/資料來源端點連線的其他屬性。 |
| authType | 您使用的身分驗證類型，無論是 OAuth2或 Basic。 |
| 類型 （部署） | 您使用Alfresco的 類型，無論是 PAAS或 ON-PREM。 |
| crawlType | 您要編目的內容類型，無論是 ASPECT（在 中標記為「Aspects」的內容Alfresco)、 SITE_ID（特定Alfresco網站中的內容） 或 ALL_SITES（所有Alfresco網站中的內容）。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Alfresco 文件的屬性或欄位名稱和註解映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| aspectName |
您要編製索引之特定 'Aspect' 的名稱。 |
| aspectProperties |
您要編製索引的特定 'Aspect' 內容屬性清單。 |
| enableFineGrainedControl |
|
| isCrawlComment |
|
|
在Alfresco資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
|
用於排除Alfresco資料來源中特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| type | 資料來源的類型。將 指定ALFRESCO為您的資料來源類型。 |
| secretArn |
AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連接到 所需的鍵/值對Alfresco。私密必須包含具有下列索引鍵的 JSON 結構： 如果使用基本身分驗證：
如果使用 OAuth 2.0 身分驗證：
|
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteId": { "type": "string" }, "repoUrl": { "type": "string" }, "webAppUrl": { "type": "string" }, "repositoryAdditionalProperties": { "type": "object", "properties": { "authType": { "type": "string", "enum": [ "OAuth2", "Basic" ] }, "type": { "type": "string", "enum": [ "PAAS", "ON_PREM" ] }, "crawlType": { "type": "string", "enum": [ "ASPECT", "SITE_ID", "ALL_SITES" ] } } } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "aspectName": { "type": "string" }, "aspectProperties": { "type": "array" }, "enableFineGrainedControl": { "type": "boolean" }, "isCrawlComment": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "inclusionFilePathPatterns": { "type": "array" }, "exclusionFilePathPatterns": { "type": "array" } } }, "type": { "type": "string", "pattern": "ALFRESCO" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn" ] }
Aurora (MySQL) 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。將資料來源的類型指定為 JDBC、資料庫類型指定為 mysql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Aurora (MySQL) JSON 結構描述。
下表說明 Aurora (MySQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Aurora (PostgreSQL) 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 postgresql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Aurora (PostgreSQL) JSON 結構描述。
下表說明 Aurora (PostgreSQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入包含時間戳記格式的資料欄名稱，以用於偵測內容變更並重新同步您的內容。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS (Microsoft SQL Server) 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 sqlserver、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon RDS (Microsoft SQL Server) JSON 結構描述。
下表說明 Amazon RDS (Microsoft SQL Server) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入包含時間戳記格式的資料欄名稱，以用於偵測內容變更並重新同步您的內容。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS (MySQL) 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 mysql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon RDS (MySQL) JSON 結構描述。
下表說明 Amazon RDS (MySQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入包含時間戳記格式的資料欄名稱，以用於偵測內容變更並重新同步您的內容。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS (Oracle) 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。將資料來源的類型指定為 JDBC、資料庫類型指定為 oracle、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon RDS ( Oracle) JSON 結構描述。
下表說明 Amazon RDS (Oracle) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon RDS (PostgreSQL) 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 postgresql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Amazon RDS (PostgreSQL) JSON 結構描述。
下表說明 Amazon RDS (PostgreSQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Amazon S3 範本結構描述
您可以在範本組態中包含包含資料來源結構描述的 JSON。您可以在連線組態或儲存庫端點詳細資訊中提供 S3 儲存貯體的名稱。同時將資料來源的類型指定為 S3，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 S3 JSON 結構描述。
下表說明 Amazon S3 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| BucketName | 儲存 Amazon S3 貯體的名稱。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
|
在 Amazon S3 資料來源中包含或排除特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| aclConfigurationFilePath | 控制 索引中 Amazon Kendra 文件存取的檔案路徑。 |
| metadataFilesPrefix | 中繼資料檔案的儲存貯體內位置。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| type | 資料來源的類型。將 指定S3為您的資料來源類型。 |
| version | 支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "BucketName": { "type": "string" } }, "required": [ "BucketName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING" ] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ "document" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "inclusionPrefixes": { "type": "array" }, "exclusionPrefixes": { "type": "array" }, "aclConfigurationFilePath": { "type": "string" }, "metadataFilesPrefix": { "type": "string" } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "type": { "type": "string", "pattern": "S3" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "type", "syncMode", "repositoryConfigurations" ] }
Amazon Kendra Web 爬蟲程式範本結構描述
您包含 JSON，其中包含資料來源結構描述做為 TemplateConfiguration 物件的一部分。
您可以提供種子或起點 URLs，也可以提供網站地圖 URLs，做為連線組態或儲存庫端點詳細資訊的一部分。您可以提供儲存種子 URLs 或網站地圖 XML 檔案清單之文字檔案的 Amazon S3 儲存貯體路徑，而不需要手動列出所有 URLs，而這些檔案可在 S3 的 ZIP 檔案中合併。
如果您的網站需要身分驗證WEBCRAWLERV2，您也可以將資料來源的類型指定為 、網站身分驗證憑證和身分驗證類型，以及其他必要的組態。
然後，當您呼叫 Type時，指定 TEMPLATE做為 CreateDataSource。
重要
不支援建立 Web Crawler v2.0 連接器。 AWS CloudFormation如果您需要 AWS CloudFormation 支援，請使用 Web Crawler v1.0 連接器。
選取要索引的網站時，您必須遵守 Amazon 可接受的使用政策
您可以使用本開發人員指南中提供的範本。請參閱 Amazon Kendra Web 爬蟲程式 JSON 結構描述。
下表說明 Amazon Kendra Web Crawler JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| siteMapUrls | 您要抓取之網站的網站地圖 URLs 清單。您最多可以列出三個網站地圖 URL。 |
| s3SeedUrl | 存放種子或起點 URLs 清單的文字檔案的 S3 路徑。例如 s3://bucket-name/directory/。文字檔案中的每個 URL 都必須在單獨的一行上格式化。一個檔案中最多可列出 100 URLs。 |
| s3SiteMapUrl | 網站地圖 XML 檔案的 S3 路徑。例如 s3://bucket-name/directory/。您最多可以列出三個網站地圖 XML 檔案。您可以將多個網站地圖檔案合併到 ZIP 檔案中，並將 ZIP 檔案存放在您的 Amazon S3 儲存貯體中。 |
| seedUrlConnections | 您要抓取之網站的種子或起點 URLs 清單。您最多可以列出 100 URLs。 |
| seedUrl | 種子或起點 URL。 |
| 驗證 | 如果您的網站需要相同的身分驗證，則為身分驗證類型，否則請指定 NoAuthentication。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將網頁和網頁檔案的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。例如，HTML 網頁標題標籤可以映射到_document_title索引欄位。如需詳細資訊，請參閱映射資料來源欄位。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| additionalProperties | 資料來源中內容的其他組態選項。 |
| rateLimit | 每分鐘每個網站主機網路爬取的 URL 數目上限。 |
| maxFileSize | 要爬取之網頁或附件的大小上限 （以 MB 為單位）。 |
| crawlDepth | 要爬取之種子 URL 的關卡數量。例如，種子 URL 頁面為深度 1，而且此頁面上也爬取的任何超連結為深度 2。 |
| maxLinksPerUrl | 編目網站時，網頁上要包含URLs 數目上限。此號碼是每個網頁。隨著網站的網頁被編目，網頁連結至的任何 URLs 也會被編目。網頁上的 URLs會依顯示順序編目。 |
| crawlSubDomain | true 使用子網域編目網站網域。例如，如果種子 URL 是「abc.example.com」，則「a.abc.example.com」和「b.abc.example.com」也會爬取。如果您未將 crawlSubDomain或 crawlAllDomain設定為 true，則 Amazon Kendra 只會編目要編目的網站網域。 |
| crawlAllDomain | true 使用網頁連結的子網域和其他網域來編目網站網域。如果您未將 crawlSubDomain或 crawlAllDomain設定為 true，則 Amazon Kendra 只會編目要編目的網站網域。 |
| honorRobots | true 以遵守您要抓取之網站的 robots.txt 指令。這些指令會控制 Amazon Kendra Web 爬蟲程式如何編目網站，無論 Amazon Kendra 是否只能編目特定內容，或不編目任何內容。 |
| crawlAttachments | true 以編目網頁連結的檔案。 |
|
規則表達式模式的清單，其中包含編目特定 URLs和索引這些 URL 網頁上的任何超連結。符合模式的 URL 會包括在索引中。不符合模式的 URL 會從索引中排除。如果 URL 同時符合包含和排除模式，則排除模式為優先，且 URL/網站網頁不包含在索引中。 |
|
規則表達式模式的清單，可排除編目特定 URLs並對這些 URL 網頁上的任何超連結編製索引。符合模式的 URL 會從索引中排除。不符合模式的 URL 會包括在索引中。如果 URL 同時符合包含和排除模式，則排除模式為優先，且 URL/網站網頁不包含在索引中。 |
| inclusionFileIndexPatterns | 包含特定網頁檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| exclusionFileIndexPatterns | 排除特定網頁檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| implicitWaitDuration |
implicitWaitDuration 指定在爬取網頁之前，連接器將等待多久，以秒為單位。 範圍：0-10 例如 "implicitWaitDuration"： "5" |
| proxy | 透過 Web 代理連線到內部網站所需的組態資訊。 |
| 託管 | 您要用來連線至內部網站的代理伺服器主機名稱。例如， 的主機名稱https://a.example.com/page1.html為 "a.example.com"。 |
| port | 您要用來連線至內部網站的代理伺服器連接埠號碼。例如，443 是 HTTPS 的標準連接埠。 |
| secretArn （代理） | 如果需要 Web 代理登入資料才能連線到網站主機，您可以建立存放登入資料的 AWS Secrets Manager 秘密。提供秘密的 Amazon Resource Name (ARN)。 |
| type | 資料來源的類型。將 指定WEBCRAWLERV2為您的資料來源類型。 |
| secretArn |
如果您的網站需要身分驗證才能存取網站，則會使用 AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)。您可以將網站的身分驗證憑證存放在包含 JSON 鍵/值對的秘密中。 如果您使用基本 或 NTML/Kerberos，請輸入使用者名稱和密碼。秘密中的 JSON 金鑰必須是 如果您使用 SAML 或表單身分驗證，請輸入使用者名稱和密碼、使用者名稱欄位的 XPath （以及使用 SAML 的使用者名稱按鈕）、密碼欄位和按鈕XPaths，以及登入頁面 URL。秘密中的 JSON 金鑰必須是 Amazon Kendra 也會檢查秘密中包含的端點資訊 （種子 URLs) 是否與資料來源端點組態詳細資訊中指定的端點資訊相同。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "siteMapUrls": { "type": "array", "items":{ "type": "string", "pattern": "https://.*" } }, "s3SeedUrl": { "type": "string", "pattern": "s3:.*" }, "s3SiteMapUrl": { "type": "string", "pattern": "s3:.*" }, "seedUrlConnections": { "type": "array", "items": [ { "type": "object", "properties": { "seedUrl":{ "type": "string", "pattern": "https://.*" } }, "required": [ "seedUrl" ] } ] }, "authentication": { "type": "string", "enum": [ "NoAuthentication", "BasicAuth", "NTLM_Kerberos", "Form", "SAML" ] } } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "webPage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "additionalProperties": { "type": "object", "properties": { "rateLimit": { "type": "string", "default": "300" }, "maxFileSize": { "type": "string", "default": "50" }, "crawlDepth": { "type": "string", "default": "2" }, "maxLinksPerUrl": { "type": "string", "default": "100" }, "crawlSubDomain": { "type": "boolean", "default": false }, "crawlAllDomain": { "type": "boolean", "default": false }, "honorRobots": { "type": "boolean", "default": false }, "crawlAttachments": { "type": "boolean", "default": false }, "inclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLCrawlPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionURLIndexPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileIndexPatterns": { "type": "array", "items": { "type": "string" } }, "proxy": { "type": "object", "properties": { "host": { "type": "string" }, "port": { "type": "string" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } } } }, "implicitWaitDuration": { "type":"object", "properties": { "innerNumber" : { "type": "number", "minimum": 0, "maximum": 10 } } }, "required": [ "rateLimit", "maxFileSize", "crawlDepth", "crawlSubDomain", "crawlAllDomain", "maxLinksPerUrl", "honorRobots" ] }, "type": { "type": "string", "pattern": "WEBCRAWLERV2" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "type", "additionalProperties" ] }
Confluence 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供 Confluence 主機 URL、託管方法和身分驗證類型。另請將資料來源的類型指定為 CONFLUENCEV2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Confluence JSON 結構描述。
下表說明 Confluence JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| hostUrl | Confluence 執行個體的 URL。例如，https：//https://example.confluence.com。 |
| type | Confluence 執行個體的託管方法，無論是 SAAS和 ON_PREM。 |
| authType | Confluence 執行個體的身分驗證方法，無論是 Basic、 OAuth2或 Personal-token。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Confluence 空間、頁面、部落格、註解和附件的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。Confluence 資料來源欄位名稱必須存在於您的 Confluence 自訂中繼資料中。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | 如果您有 ACL 並想要將其用於存取控制，請設定 true來編目文件的存取控制清單 (ACL) 資訊。請注意，ACL 會指定使用者可以和群組存取哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。這表示如果isCrawlACL關閉，則可公開搜尋文件。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUserId | 指定email您是否要使用使用者電子郵件做為使用者 ID。 預設會使用 email ，且 是目前唯一支援的使用者 ID 類型。 |
|
在 Confluence 資料來源中包含和/或排除特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| proxyHost | 您使用之 Web 代理的主機名稱，不含 http://或 https://通訊協定。 |
|
proxyPort |
主機 URL 傳輸通訊協定所使用的連接埠號碼。必須是介於 0 到 65535 之間的數值。 |
|
true 在您的 Confluence 個人空間、頁面、部落格、頁面評論、頁面附件、部落格評論和部落格附件中編目檔案。 |
| maxFileSizeInMegaBytes | 以 MBs為單位指定檔案大小限制， Amazon Kendra 該限制 Amazon Kendra 只能編目您定義的大小限制內的檔案。預設檔案大小為 50MB。檔案大小上限應大於 0MB 且小於或等於 50MB。 |
| type | 資料來源的類型。將 指定CONFLUENCEV2為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode | 指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連接到 Confluence 所需的鍵/值對。如需這些鍵/值對的詳細資訊，請參閱 Confluence 的連線指示。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" }, "type": { "type": "string", "enum": [ "SAAS", "ON_PREM" ] }, "authType": { "type": "string", "enum": [ "Basic", "OAuth2", "Personal-token" ] } }, "required": [ "hostUrl", "type", "authType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "space": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "blog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "usersAclS3FilePath": { "type": "string" }, "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "inclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSpaceKeyFilter": { "type": "array", "items": { "type": "string" } }, "pageTitleRegEX": { "type": "array", "items": { "type": "string" } }, "blogTitleRegEX": { "type": "array", "items": { "type": "string" } }, "commentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "attachmentTitleRegEX": { "type": "array", "items": { "type": "string" } }, "isCrawlPersonalSpace": { "type": "boolean" }, "isCrawlArchivedSpace": { "type": "boolean" }, "isCrawlArchivedPage": { "type": "boolean" }, "isCrawlPage": { "type": "boolean" }, "isCrawlBlog": { "type": "boolean" }, "isCrawlPageComment": { "type": "boolean" }, "isCrawlPageAttachment": { "type": "boolean" }, "isCrawlBlogComment": { "type": "boolean" }, "isCrawlBlogAttachment": { "type": "boolean" }, "maxFileSizeInMegaBytes": { "type":"string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionUrlPatterns": { "type": "array", "items": { "type": "string" } }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [] }, "type": { "type": "string", "pattern": "CONFLUENCEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Dropbox 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在存放身分驗證憑證的秘密中提供 Dropbox 應用程式金鑰、應用程式秘密和存取權杖。另請將資料來源的類型指定為 DROPBOX、您要使用的存取字符類型 （暫時或永久），以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Dropbox JSON 結構描述。
下表說明 Dropbox JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源不會在 中指定端點repositoryEndpointMetadata。相反地，連線資訊會包含在您提供 的 AWS Secrets Manager 秘密中secretArn。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Dropbox 檔案、Dropbox Paper 和捷徑的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Dropbox 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| additionalProperties | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會編目文件的存取控制清單 (ACL) 資訊。ACL 指定使用者可以和群組存取哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
|
在 Dropbox 資料來源中包含特定檔案名稱和類型的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
在 Dropbox 資料來源中排除特定檔案名稱和類型的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不包含在索引中。 |
|
true 在 Dropbox、Dropbox Paper 文件、Dropbox Paper 範本和存放在 Dropbox 中的網頁捷徑中爬取檔案。 |
| type | 資料來源的類型。將 指定DROPBOX為您的資料來源類型。 |
| tokenType | 指定您的存取權杖類型：永久或暫時存取權杖。建議您建立在 Dropbox 中永不過期的重新整理存取字符，而不是依賴 4 小時後過期的一次性存取字符。您可以在 Dropbox 開發人員主控台中建立應用程式和重新整理存取權杖，並在秘密中提供存取權杖。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "paper": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "papert": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "shortcut": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "LONG", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "inclusionFileNamePatterns": { "type": "array" }, "exclusionFileNamePatterns": { "type": "array" }, "inclusionFileTypePatterns": { "type": "array" }, "exclusionFileTypePatterns": { "type": "array" }, "crawlFile": { "type": "boolean" }, "crawlPaper": { "type": "boolean" }, "crawlPapert": { "type": "boolean" }, "crawlShortcut": { "type": "boolean" } } }, "type": { "type": "string", "pattern": "DROPBOX" }, "tokenType": { "type": "string", "enum": [ "PERMANENT", "TEMPORARY" ] }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "enableIdentityCrawler", "secretArn", "type", "tokenType" ] }
Drupal 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供 Drupal 主機 URL 和身分驗證類型。另請將資料來源的類型指定為 DRUPAL、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Drupal JSON 結構描述。
下表說明 Drupal JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| hostUrl | Drupal 網站的主機 URL。例如，https://<hostname>/<drupalsitename>。 |
| repositoryConfigurations | 資料來源內容的組態資訊。 |
|
映射 Drupal 檔案屬性或欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。Drupal 資料來源欄位名稱必須存在於 Drupal 自訂中繼資料中。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
|
在 Drupal 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
在 Drupal 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不包含在索引中。 |
contentDefinitions
|
指定要編目的內容類型，以及是否要編目所選內容類型的註解和附件。 |
| type | 資料來源的類型。將 指定DRUPAL為您的資料來源類型。 |
| authType | 您使用的身分驗證類型，無論是 BASIC-AUTH或 OAUTH2。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 Drupal 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構： 如果使用基本身分驗證：
如果使用 OAuth 2.0 身分驗證：
|
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "content": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlArticle": { "type": "boolean" }, "isCrawlBasicPage": { "type": "boolean" }, "isCrawlBasicBlock": { "type": "boolean" }, "crawlCustomContentTypesList": { "type": "array", "items": { "type": "string" } }, "crawlCustomBlockTypesList": { "type": "array", "items": { "type": "string" } }, "filePath": { "anyOf": [ { "type": "string", "pattern": "s3:.*" }, { "type": "string", "pattern": "" } ] }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "articleTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "pageTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customContentTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "basicBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleInclusionPatterns": { "type": "array", "items": { "type": "string" } }, "customBlockTitleExclusionPatterns": { "type": "array", "items": { "type": "string" } }, "contentDefinitions": { "type": "array", "items": { "properties": { "contentType": { "type": "string" }, "fieldDefinition": { "type": "array", "items": [ { "type": "object", "properties": { "machineName": { "type": "string" }, "type": { "type": "string" } }, "required": [ "machineName", "type" ] } ] }, "isCrawlComments": { "type": "boolean" }, "isCrawlFiles": { "type": "boolean" } } }, "required": [ "contentType", "fieldDefinition", "isCrawlComments", "isCrawlFiles" ] } }, "required": [] }, "type": { "type": "string", "pattern": "DRUPAL" }, "authType": { "type": "string", "enum": [ "BASIC-AUTH", "OAUTH2" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
GitHub 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以提供 GitHub 主機 URL、組織名稱，以及是否使用 GitHub 雲端或 GitHub 內部部署做為連線組態或儲存庫端點詳細資訊的一部分。另請將資料來源的類型指定為 GITHUB、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 GitHub JSON 結構描述。
下表說明 GitHub JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| type | 將類型指定為 SAAS或 ON_PREMISE。 |
| hostUrl | GitHub 主機 URL。例如，如果您使用 GitHub SaaS/Enterprise 雲端：https://api.github.com。或者，如果您使用 GitHub 內部部署/企業伺服器：https://on-prem-host-url/api/v3/。 |
| organizationName | 您可以在登入 GitHub 桌面時找到您的組織名稱，並在設定檔圖片下拉式清單下前往您的組織。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 GitHub 內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會編目文件的存取控制清單 (ACL) 資訊。ACL 指定使用者可以存取和搜尋哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUserId | 指定您要用於 ACL 爬取的使用者 ID 類型。email 如果您想要針對使用者 ID 使用使用者電子郵件，或username想要針對使用者 ID 使用使用者名稱，請指定 。如果您未指定 選項，則預設email會使用 。 |
| repositoryFilter | 您要編製索引的特定儲存庫和分支名稱清單。 |
| crawlRepository | true 以爬取儲存庫。 |
| crawlRepositoryDocuments | true 以編目儲存庫文件。 |
| crawlIssue | true 以爬取問題。 |
| crawlIssueComment | true 以編目問題註解。 |
| crawlIssueCommentAttachment | true 以編目問題註解附件。 |
| crawlPullRequest | true 以爬取提取請求。 |
| crawlPullRequestComment | true 以編目提取請求註解。 |
| crawlPullRequestCommentAttachment | true 以爬取提取請求註解附件。 |
|
GitHub 資料來源中包含特定內容的規則表達式模式清單。符合模式的內容會包含在索引中。不符合模式的內容會從索引中排除。如果任何內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
|
GitHub 資料來源中排除特定內容的規則表達式模式清單。符合模式的內容會從索引中排除。不符合模式的內容會包含在索引中。如果任何內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
| type | 資料來源的類型。將 指定GITHUB為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn |
AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連接到 GitHub 所需的鍵/值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的此範本版本。 |
以下是 GitHub JSON 結構描述：
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "type": { "type": "string" }, "hostUrl": { "type": "string", "pattern": "https://.*" }, "organizationName": { "type": "string" } }, "required": [ "type", "hostUrl", "organizationName" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ghRepository": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghCommit": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghIssueAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRDocument": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "ghPRAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "isCrawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "crawlRepository": { "type": "boolean" }, "crawlRepositoryDocuments": { "type": "boolean" }, "crawlIssue": { "type": "boolean" }, "crawlIssueComment": { "type": "boolean" }, "crawlIssueCommentAttachment": { "type": "boolean" }, "crawlPullRequest": { "type": "boolean" }, "crawlPullRequestComment": { "type": "boolean" }, "crawlPullRequestCommentAttachment": { "type": "boolean" }, "repositoryFilter": { "type": "array", "items": [ { "type": "object", "properties": { "repositoryName": { "type": "string" }, "branchNameList": { "type": "array", "items": { "type": "string" } } } } ] }, "inclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFolderNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "GITHUB" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "enableIdentityCrawler" ] }
Gmail 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。將資料來源的類型指定為 GMAIL、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Gmail JSON 結構描述。
下表說明 Gmail JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源不會在 中指定端點repositoryEndpointMetadata。反之，連線資訊會包含在您提供 的 AWS Secrets Manager 秘密中secretArn。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
將 Gmail 訊息和附件的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
|
在 Gmail 資料來源中包含或排除具有特定主旨名稱之訊息的規則表達式模式清單。符合模式的檔案會包括在索引中。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| beforeDateFilter | 指定在特定日期之前包含的訊息和附件。 |
| afterDateFilter | 指定特定日期之後要包含的訊息和附件。 |
| isCrawlAttachment | 布林值，用於選擇是否要編目附件。訊息會自動編目。 |
| type | 資料來源的類型。將 指定GMAIL為您的資料來源類型。 |
| shouldCrawlDraftMessages | 布林值，用於選擇是否要編目草稿訊息。 |
| syncMode | 指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
重要由於沒有 API 可更新永久刪除的 Gmail 訊息，因此任何新的、修改或刪除的內容同步：
若要將 Gmail 資料來源標籤變更和永久刪除的電子郵件訊息同步到您的 Amazon Kendra 索引，您必須定期執行完整網路爬取。 |
| secretARN | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Gmail 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { } }, "repositoryConfigurations": { "type": "object", "properties": { "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "attachments": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING"] }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } } }, "required": [] }, "additionalProperties": { "type": "object", "properties": { "inclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionLabelNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAttachmentNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "exclusionSubjectFilter": { "type": "array", "items": { "type": "string" } }, "isSubjectAnd": { "type": "boolean" }, "inclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "exclusionFromFilter": { "type": "array", "items": { "type": "string" } }, "inclusionToFilter": { "type": "array", "items": { "type": "string" } }, "exclusionToFilter": { "type": "array", "items": { "type": "string" } }, "inclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "exclusionCcFilter": { "type": "array", "items": { "type": "string" } }, "inclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "exclusionBccFilter": { "type": "array", "items": { "type": "string" } }, "beforeDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "afterDateFilter": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "isCrawlAttachment": { "type": "boolean" }, "shouldCrawlDraftMessages": { "type": "boolean" } }, "required": [ "isCrawlAttachment", "shouldCrawlDraftMessages" ] }, "type" : { "type" : "string", "pattern": "GMAIL" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "syncMode", "secretArn", "type" ] }
Google Drive 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 GOOGLEDRIVE2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Google Drive JSON 結構描述。
下表說明 Google Drive JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源不會指定端點。您可以選擇身分驗證類型： serviceAccount和 OAuth2。連線資訊會包含在您提供 的 AWS Secrets Manager 秘密中secretArn。 |
| authType | OAuth2 根據您的使用案例選擇 serviceAccount和 。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Google Drive 的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
|
以 MBs 為單位指定 Amazon Kendra 應該爬取的檔案大小限制。 |
|
true 在 Google Drive 資料來源中編目註解。 |
|
true 在 Google Drive 資料來源中爬取 MyDrive 並與我共用。 |
|
true 在 Google Drive 資料來源中爬取共用磁碟機。 |
| isCrawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會為您的文件編目存取控制清單 (ACL) 資訊。ACL 指定使用者可以存取和搜尋哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
|
在 Google Drive 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
|
在 Google Drive 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| type | 資料來源的類型。將 指定GOOOGLEDRIVEV2為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 Google Drive 所需的鍵/值對。私密必須包含具有下列索引鍵的 JSON 結構： 如果使用 Google Service 帳戶身分驗證：
如果使用 OAuth 2.0 身分驗證：
|
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "authType": { "type": "string", "enum": [ "serviceAccount", "OAuth2" ] } }, "required": [ "authType" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "maxFileSizeInMegaBytes": { "type": "string" }, "isCrawlComment": { "type": "boolean" }, "isCrawlMyDriveAndSharedWithMe": { "type": "boolean" }, "isCrawlSharedDrives": { "type": "boolean" }, "isCrawlAcl": { "type": "boolean" }, "excludeUserAccounts": { "type": "array", "items": { "type": "string" } }, "excludeSharedDrives": { "type": "array", "items": { "type": "string" } }, "excludeMimeTypes": { "type": "array", "items": { "type": "string" } }, "includeUserAccounts": { "type": "array", "items": { "type": "string" } }, "includeSharedDrives": { "type": "array", "items": { "type": "string" } }, "includeMimeTypes": { "type": "array", "items": { "type": "string" } }, "includeTargetAudienceGroup": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFilePathFilter": { "type": "array", "items": { "type": "string" } }, "exclusionFilePathFilter": { "type": "array", "items": { "type": "string" } } } }, "type": { "type": "string", "pattern": "GOOGLEDRIVEV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
IBM DB2 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。將資料來源的類型指定為 JDBC、資料庫類型指定為 db2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 IBM DB2 JSON 結構描述。
下表說明 IBM DB2 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft Exchange 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您提供租戶 ID 做為連線組態或儲存庫端點詳細資訊的一部分。另請將資料來源的類型指定為 MSEXCHANGE、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Microsoft Exchange JSON 結構描述。
下表說明 Microsoft Exchange JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| tenantId | Microsoft 365 租用戶 ID。您可以在 Azure Active Directory 入口網站的 屬性或 OAuth 應用程式中找到租用戶 ID。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Microsoft Exchange 資料來源的屬性或欄位名稱映射至 Amazon Kendra 索引欄位的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
| inclusionPatterns | 在 Microsoft Exchange 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| exclusionPatterns | 在 Microsoft Exchange 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
|
Microsofot Exchange 資料來源中包含特定使用者和使用者檔案的規則表達式模式清單。符合模式的使用者會包含在索引中。不符合模式的使用者會從索引中排除。如果使用者同時符合包含和排除模式，則排除模式為優先，且使用者不包含在索引中。 |
|
在 Microsoft Exchange 資料來源中排除特定使用者和使用者檔案的規則表達式模式清單。符合模式的使用者會從索引中排除。不符合模式的使用者會包含在索引中。如果使用者同時符合排除和包含模式，則排除模式為優先，且使用者不包含在索引中。 |
| s3bucketName | 如果您想要使用 S3 儲存貯體的名稱。 |
|
true 編目這些類型的內容和存取控制資訊，您的 Microsoft Exchange 資料來源。 |
| startCalendarDateTime | 您可以為行事曆內容設定特定的開始日期時間。 |
| endCalendarDateTime | 您可以為行事曆內容設定特定的結束日期時間。 |
| subject | 您可以為郵件內容設定特定主旨行。 |
| emailFrom | 您可以為「寄件者」或寄件者郵件內容設定特定電子郵件。 |
| emailTo | 您可以為「收件人」或收件人郵件內容設定特定電子郵件。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| type | 資料來源的類型。將 指定MSEXCHANGE為您的資料來源類型。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Microsoft Exchange 所需的鍵值對。這包括您的用戶端 ID 和您在 Azure 入口網站中建立 OAuth 應用程式時產生的用戶端秘密。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": ["tenantId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "email": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendar": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contacts": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "notes": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": ["email" ] }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "exclusionUsersList": { "type": "array", "items": { "type": "string", "format": "email" } }, "s3bucketName": { "type": "string" }, "inclusionUsersFileName": { "type": "string" }, "exclusionUsersFileName": { "type": "string" }, "inclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "exclusionDomainUsers": { "type": "array", "items": { "type": "string" } }, "crawlCalendar": { "type": "boolean" }, "crawlNotes": { "type": "boolean" }, "crawlContacts": { "type": "boolean" }, "crawlFolderAcl": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "subject": { "type": "array", "items": { "type": "string" } }, "emailFrom": { "type": "array", "items": { "type": "string", "format": "email" } }, "emailTo": { "type": "array", "items": { "type": "string", "format": "email" } } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "MSEXCHANGE" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft OneDrive 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供租戶 ID。另請將資料來源的類型指定為 ONEDRIVEV2，以及身分驗證登入資料的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Microsoft OneDrive JSON 結構描述。
下表說明 Microsoft OneDrive JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| tenantId | Microsoft 365 租用戶 ID。您可以在 Azure Active Directory 入口網站的 屬性或 OAuth 應用程式中找到租用戶 ID。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
| file | 將 Microsoft OneDrive 檔案的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
|
您可以選擇為特定檔案、OneNote 區段、OneNote 頁面編製索引，並依使用者名稱篩選。 |
| isUserNameOnS3 | true 提供存放在 的檔案中的使用者名稱清單 Amazon S3。 |
| type | 資料來源的類型。將 指定ONEDRIVEV2為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要針對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| type | 資料來源的類型。將 指定ONEDRIVEV2為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Microsoft OneDrive 所需的鍵/值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "userNameFilter": { "type": "array", "items": { "type": "string" } }, "userFilterPath": { "type": "string" }, "isUserNameOnS3": { "type": "boolean" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFilePathPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "ONEDRIVEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft SharePoint 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。您可以視需要提供 SharePoint 網站 URL/URLs、網域和租戶 ID，做為連線組態或儲存庫端點詳細資訊的一部分。另請將資料來源的類型指定為 SHAREPOINTV2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource 時，將 指定TEMPLATE為類型。
您可以使用本開發人員指南中提供的範本。請參閱 SharePoint JSON 結構描述。
下表說明 Microsoft SharePoint JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊 |
| repositoryEndpointMetadata | 資料來源的端點資訊 |
| tenantId | SharePoint SharePoint 帳戶的租戶 ID。 |
| domain | SharePoint 帳戶的網域。 |
| siteUrls | SharePoint 帳戶的主機 URLs。 |
| repositoryAdditionalProperties | 要與儲存庫/資料來源端點連線的其他屬性。 |
| s3bucketName | 儲存 Azure AD 自我簽署 X.509 憑證的 Amazon S3 儲存貯體名稱。 |
| s3certificateName | 存放在儲存 Amazon S3 貯體中的 Azure AD 自我簽署 X.509 憑證名稱。 |
| authType | 您使用的身分驗證類型，無論是 OAuth2、OAuth2Certificate、OAuth2App、BasicOAuth2_RefreshToken、NTLM、 或 Kerberos。 |
| version | 您使用的 SharePoint 版本，無論是 Server或 Online。 |
| onPremVersion | 您使用的 SharePoint Server 版本，無論是 2013、 2016 2019或 SubscriptionEdition。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 SharePoint 內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
|
在 SharePoint 資料來源中包含/排除特定內容的規則表達式模式清單。符合包含模式的內容主題會包含在索引中。不符合包含模式的內容項目會從索引中排除。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
|
true 來編目這些類型的內容。 |
| crawlAcl | true 如果您有 ACL 並想要將其用於存取控制，則 會編目文件的存取控制清單 (ACL) 資訊。ACL 指定使用者可以存取和搜尋哪些文件。ACL 資訊用於根據使用者或其群組對文件的存取來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUserId | email 如果您想要針對使用者 ID 使用使用者電子郵件，或userPrincipalName想要針對使用者 ID 使用使用者名稱，請指定 。如果您未指定 選項，則預設email會使用 。 |
| aclConfiguration | 指定 ACLWithLDAPEmailFmt、 ACLWithManualEmailFmt或 ACLWithUsernameFmtM。 |
| emailDomain | 電子郵件的網域。例如，「amazon.com」。 |
|
true 以編目群組映射資訊。 |
| proxyHost | 您使用之 Web 代理的主機名稱，不含 http：// 或 https：// 通訊協定。 |
| proxyPort | 主機 URL 傳輸通訊協定所使用的連接埠號碼。必須是介於 0 到 65535 之間的數值。 |
| type | 將 指定SHAREPOINTV2為您的資料來源類型 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 SharePoint 所需的鍵值對。如需這些鍵值對的詳細資訊，請參閱 SharePoint Online 和 SharePoint Server 的連線指示。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 }, "domain": { "type": "string" }, "siteUrls": { "type": "array", "items": { "type": "string", "pattern": "https://.*" } }, "repositoryAdditionalProperties": { "type": "object", "properties": { "s3bucketName": { "type": "string" }, "s3certificateName": { "type": "string" }, "authType": { "type": "string", "enum": [ "OAuth2", "OAuth2Certificate", "OAuth2App", "Basic", "OAuth2_RefreshToken", "NTLM", "Kerberos" ] }, "version": { "type": "string", "enum": [ "Server", "Online" ] }, "onPremVersion": { "type": "string", "enum": [ "", "2013", "2016", "2019", "SubscriptionEdition" ] } }, "required": [ "authType", "version" ] } }, "required": [ "siteUrls", "domain", "repositoryAdditionalProperties" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "event": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "page": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "file": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "link": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "comment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "eventTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "pageTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "linkTitleFilterRegEx": { "type": "array", "items": { "type": "string" } }, "inclusionFilePath": { "type": "array", "items": { "type": "string" } }, "exclusionFilePath": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "crawlFiles": { "type": "boolean" }, "crawlPages": { "type": "boolean" }, "crawlEvents": { "type": "boolean" }, "crawlComments": { "type": "boolean" }, "crawlLinks": { "type": "boolean" }, "crawlAttachments": { "type": "boolean" }, "crawlListData": { "type": "boolean" }, "crawlAcl": { "type": "boolean" }, "fieldForUserId": { "type": "string" }, "aclConfiguration": { "type": "string", "enum": [ "ACLWithLDAPEmailFmt", "ACLWithManualEmailFmt", "ACLWithUsernameFmt" ] }, "emailDomain": { "type": "string" }, "isCrawlLocalGroupMapping": { "type": "boolean" }, "isCrawlAdGroupMapping": { "type": "boolean" }, "proxyHost": { "type": "string" }, "proxyPort": { "type": "string" } }, "required": [ ] }, "type": { "type": "string", "pattern": "SHAREPOINTV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "enableIdentityCrawler", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft SQL Server 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 sqlserver、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Microsoft SQL Server JSON 結構描述。
下表說明 Micorosft SQL Server JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入包含時間戳記格式的資料欄名稱，以用於偵測內容變更並重新同步您的內容。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft Teams 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供租戶 ID。另請將資料來源的類型指定為 MSTEAMS、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Microsoft Teams JSON 結構描述。
下表說明 Microsoft Teams JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| tenantId | Microsoft 365 租用戶 ID。您可以在 Azure Active Directory 入口網站的 屬性或 OAuth 應用程式中找到租用戶 ID。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Microsoft Teams 內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| paymentModel | 指定要搭配 Microsoft Teams 資料來源使用的付款模型類型。模型 付款模型僅限於需要安全合規的授權和付款模型。B 模型付款模型適用於不需要安全合規的授權和付款模型。 |
|
在 Microsoft Teams 資料來源中包含特定內容的規則表達式模式清單。符合模式的內容會包含在索引中。不符合模式的內容會從索引中排除。如果內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
|
在 Microsoft Teams 資料來源中排除特定內容的規則表達式模式清單。符合模式的內容會從索引中排除。不符合模式的內容會包含在索引中。如果內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
|
true 在 Microsoft Teams 資料來源中編目這些類型的內容。 |
| startCalendarDateTime | 您可以為行事曆內容設定特定的開始日期時間。 |
| endCalendarDateTime | 您可以為行事曆內容設定特定的結束日期時間。 |
| type | 資料來源的類型。將 指定MSTEAMS為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要針對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretArn | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Microsoft Teams 所需的鍵/值對。這包括您在 Azure 入口網站中建立 OAuth 應用程式時產生的用戶端 ID 和用戶端秘密。 |
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "tenantId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", "minLength": 36, "maxLength": 36 } }, "required": [ "tenantId" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "chatMessage": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelPost": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelWiki": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "channelAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingChat": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingFile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "meetingNote": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "calendarMeeting": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "paymentModel": { "type": "string", "enum": [ "A", "B", "Evaluation Mode" ] }, "inclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionTeamNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "exclusionChannelNameFilter": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionUserEmailFilter": { "type": "array", "items": { "type": "string" } }, "inclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNoteSectionNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionOneNotePageNamePatterns": { "type": "array", "items": { "type": "string" } }, "isCrawlChatMessage": { "type": "boolean" }, "isCrawlChatAttachment": { "type": "boolean" }, "isCrawlChannelPost": { "type": "boolean" }, "isCrawlChannelAttachment": { "type": "boolean" }, "isCrawlChannelWiki": { "type": "boolean" }, "isCrawlCalendarMeeting": { "type": "boolean" }, "isCrawlMeetingChat": { "type": "boolean" }, "isCrawlMeetingFile": { "type": "boolean" }, "isCrawlMeetingNote": { "type": "boolean" }, "startCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "endCalendarDateTime": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] } }, "required": [] }, "type": { "type": "string", "pattern": "MSTEAMS" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Microsoft Yammer 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 YAMMER、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource 時，將 指定TEMPLATE為 類型。
您可以使用本開發人員指南中提供的範本。
下表說明 Microsoft Yammer JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源不會在 中指定端點repositoryEndpointMetadata。相反地，連線資訊會包含在您提供 的 AWS Secrets Manager 秘密中secretArn。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Microsoft Yammer 內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
| inclusionPatterns | 在 Microsoft Yammer 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| exclusionPatterns | 在 Microsoft Yammer 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
| sinceDate | 您可以選擇設定sinceDate參數，讓 Microsoft Yammer 連接器根據特定 編目內容sinceDate。 |
| communityNameFilter | 您可以選擇為特定社群內容編製索引。 |
|
true 以編目訊息、訊息附件和私有訊息。 |
| type | 將 指定YAMMER為您的資料來源類型。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線至 Microsoft Yammer 所需的鍵/值對。這包括您的 Microsoft Yammer 使用者名稱和密碼，以及當您在 Azure 入口網站中建立 OAuth 應用程式時產生的用戶端 ID 和用戶端秘密。 |
| useChangeLog | true 使用 Microsoft Yammer 變更日誌來判斷哪些文件需要在索引中更新。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { } } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "community": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "message": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$" }, "communityNameFilter": { "type": "array", "items": { "type": "string" } }, "isCrawlMessage": { "type": "boolean" }, "isCrawlAttachment": { "type": "boolean" }, "isCrawlPrivateMessage": { "type": "boolean" } }, "required": [ "sinceDate" ] }, "type": { "type": "string", "pattern": "YAMMER" }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "useChangeLog": { "type": "string", "enum": [ "true", "false" ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "enableIdentityCrawler": { "type": "boolean" }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] } }, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "type", "secretArn", "syncMode" ] }
MySQL 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 mysql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 MySQL JSON 結構描述。
下表說明 MySQL JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Oracle 資料庫範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。將資料來源的類型指定為 JDBC、資料庫類型指定為 oracle、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Oracle 資料庫 JSON 結構描述。
下表說明 Oracle Database JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
PostgreSQL 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。將資料來源的類型指定為 JDBC、資料庫類型指定為 postgresql、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 PostgreSQL JSON 結構描述。
下表說明 PostgreSQL JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連接資料來源所需的組態資訊。
|
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| additionalProperties | 資料來源中內容的其他組態選項。使用 在您的資料庫資料來源中包含或排除特定內容。 |
| primaryKey | 提供資料庫資料表的主索引鍵。這可識別資料庫中的資料表。 |
| titleColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| bodyColumn | 提供資料庫資料表中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| timestampColumn | 輸入包含 time stamps. Amazon Kendra uses 時間戳記資訊的資料欄名稱，以偵測內容的變更，並僅同步變更的內容。 |
| timestampFormat | 輸入資料欄的名稱，其中包含用於偵測內容變更和重新同步內容的時間戳記格式。 |
| timezone | 輸入資料欄的名稱，其中包含要編目內容的時區。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用於偵測內容變更的資料欄名稱。當任一資料欄發生變更時， Amazon Kendra 會重新索引內容 |
| allowedUsersColumns | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| allowedGroupsColumn | 輸入資料欄的名稱，其中包含允許存取內容的使用者 IDs。 |
| sourceURIColumn | 輸入資料欄的名稱，其中包含要編製索引URLs。 |
| isSslEnabled | 輸入 SQL 查詢陳述式，例如 SELECT 和 JOIN 操作。SQL 查詢必須小於 32KB。 Amazon Kendra 會編目符合查詢的所有資料庫內容。 |
| type | 資料來源的類型。將 指定JDBC為您的資料來源類型。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新您的索引。您可以選擇：
|
| secretArn | Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到資料庫所需的使用者名稱和密碼。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Salesforce 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供 Salesforce 主機 URL。另請將資料來源的類型指定為 SALESFORCEV2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Salesforce JSON 結構描述。
下表說明 Salesforce JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| hostUrl | 要編製索引之 Salesforce 執行個體的 URL。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Salesforce 實體的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 Salesforce 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| additionalProperties | 資料來源中內容的其他組態選項 |
|
字串集合，指定要篩選的實體。 |
inclusionPatterns
|
在 Salesforce 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
exclusionPatterns
|
在 Salesforce 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
|
true 在您的 Salesforce 帳戶中編目這些類型的檔案。 |
| type | 資料來源的類型。將 指定SALESFORCEV2為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "account": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contact": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "campaign": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "case": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "product": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "lead": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "contract": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "partner": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "profile": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "idea": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "pricebook": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "task": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "solution": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "user": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "knowledgeArticles": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "group": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "opportunity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE", "LONG" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "chatter": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "customEntity": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "STRING_LIST", "DATE" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "accountFilter":{ "type": "array", "items": { "type": "string" } }, "contactFilter":{ "type": "array", "items": { "type": "string" } }, "caseFilter":{ "type": "array", "items": { "type": "string" } }, "campaignFilter":{ "type": "array", "items": { "type": "string" } }, "contractFilter":{ "type": "array", "items": { "type": "string" } }, "groupFilter":{ "type": "array", "items": { "type": "string" } }, "leadFilter":{ "type": "array", "items": { "type": "string" } }, "productFilter":{ "type": "array", "items": { "type": "string" } }, "opportunityFilter":{ "type": "array", "items": { "type": "string" } }, "partnerFilter":{ "type": "array", "items": { "type": "string" } }, "pricebookFilter":{ "type": "array", "items": { "type": "string" } }, "ideaFilter":{ "type": "array", "items": { "type": "string" } }, "profileFilter":{ "type": "array", "items": { "type": "string" } }, "taskFilter":{ "type": "array", "items": { "type": "string" } }, "solutionFilter":{ "type": "array", "items": { "type": "string" } }, "userFilter":{ "type": "array", "items": { "type": "string" } }, "chatterFilter":{ "type": "array", "items": { "type": "string" } }, "documentFilter":{ "type": "array", "items": { "type": "string" } }, "knowledgeArticleFilter":{ "type": "array", "items": { "type": "string" } }, "customEntities":{ "type": "array", "items": { "type": "string" } }, "isCrawlAccount": { "type": "boolean" }, "isCrawlContact": { "type": "boolean" }, "isCrawlCase": { "type": "boolean" }, "isCrawlCampaign": { "type": "boolean" }, "isCrawlProduct": { "type": "boolean" }, "isCrawlLead": { "type": "boolean" }, "isCrawlContract": { "type": "boolean" }, "isCrawlPartner": { "type": "boolean" }, "isCrawlProfile": { "type": "boolean" }, "isCrawlIdea": { "type": "boolean" }, "isCrawlPricebook": { "type": "boolean" }, "isCrawlDocument": { "type": "boolean" }, "crawlSharedDocument": { "type": "boolean" }, "isCrawlGroup": { "type": "boolean" }, "isCrawlOpportunity": { "type": "boolean" }, "isCrawlChatter": { "type": "boolean" }, "isCrawlUser": { "type": "boolean" }, "isCrawlSolution":{ "type": "boolean" }, "isCrawlTask":{ "type": "boolean" }, "isCrawlAccountAttachments": { "type": "boolean" }, "isCrawlContactAttachments": { "type": "boolean" }, "isCrawlCaseAttachments": { "type": "boolean" }, "isCrawlCampaignAttachments": { "type": "boolean" }, "isCrawlLeadAttachments": { "type": "boolean" }, "isCrawlContractAttachments": { "type": "boolean" }, "isCrawlGroupAttachments": { "type": "boolean" }, "isCrawlOpportunityAttachments": { "type": "boolean" }, "isCrawlChatterAttachments": { "type": "boolean" }, "isCrawlSolutionAttachments":{ "type": "boolean" }, "isCrawlTaskAttachments":{ "type": "boolean" }, "isCrawlCustomEntityAttachments":{ "type": "boolean" }, "isCrawlKnowledgeArticles": { "type": "object", "properties": { "isCrawlDraft": { "type": "boolean" }, "isCrawlPublish": { "type": "boolean" }, "isCrawlArchived": { "type": "boolean" } } }, "inclusionDocumentFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionDocumentFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionDocumentFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionAccountFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionAccountFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCampaignFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCaseFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContactFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionContractFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionLeadFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionOpportunityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionSolutionFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionTaskFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionGroupFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionChatterFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileTypePatterns":{ "type": "array", "items": { "type": "string" } }, "inclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } }, "exclusionCustomEntityFileNamePatterns":{ "type": "array", "items": { "type": "string" } } }, "required": [] }, "enableIdentityCrawler": { "type": "boolean" }, "type": { "type": "string", "pattern": "SALESFORCEV2" }, "syncMode": { "type": "string", "enum": [ "FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
ServiceNow 範本結構描述
您可以在 TemplateConfiguration 物件中包含 JSON，其中包含資料來源結構描述。您可以在連線組態或儲存庫端點詳細資訊中提供 ServiceNow 主機 URL、身分驗證類型和執行個體版本。另請將資料來源的類型指定為 SERVICENOWV2、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 ServiceNow JSON 結構描述。
下表說明 ServiceNow JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| hostUrl | ServiceNow 主機 URL。例如，https：//your-domain.service-now.com。 |
| authType | 您使用的身分驗證類型，無論是 basicAuth或 OAuth2。 |
| servicenowInstanceVersion | 您使用的 ServiceNow 版本。您可以選擇 Tokyo、Rome、 Sandiego和 Others。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 ServiceNow 知識文章、附件、服務目錄和事件的屬性或欄位名稱映射到 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。ServiceNow 資料來源欄位名稱必須存在於您的 ServiceNow 自訂中繼資料中。 |
| 其他屬性 | 資料來源中內容的其他組態選項。 |
| maxFileSizeInMegaBytes | 指定 Amazon Kendra 將爬取的檔案大小限制，以 MBs 為單位。Amazon Kendra 只會編目您定義的大小限制內的檔案。預設檔案大小為 50MB。檔案大小上限應大於 0MB，且小於或等於 50MB。 |
|
在 ServiceNow 資料來源中包含和/或排除特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
true 編目 ServiceNow 知識文章、服務目錄、事件和附件。 |
| type | 資料來源的類型。將 指定SERVICENOWV2為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| syncMode | 指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連線到 ServiceNow 所需的鍵/值對。私密必須包含具有下列索引鍵的 JSON 結構：如果您使用 OAuth2 身分驗證，您的秘密必須包含具有下列金鑰的 JSON 結構：
|
| version | 目前支援的範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$", "minLength": 1, "maxLength": 2048 }, "authType": { "type": "string", "enum": [ "basicAuth", "OAuth2" ] }, "servicenowInstanceVersion": { "type": "string", "enum": [ "Tokyo", "Sandiego", "Rome", "Others" ] } }, "required": [ "hostUrl", "authType", "servicenowInstanceVersion" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "knowledgeArticle": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "attachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "LONG", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "serviceCatalog": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] }, "incident": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": [ "STRING", "DATE", "STRING_LIST" ] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } } }, "additionalProperties": { "type": "object", "properties": { "maxFileSizeInMegaBytes": { "type": "string" }, "isCrawlKnowledgeArticle": { "type": "boolean" }, "isCrawlKnowledgeArticleAttachment": { "type": "boolean" }, "includePublicArticlesOnly": { "type": "boolean" }, "knowledgeArticleFilter": { "type": "string" }, "incidentQueryFilter": { "type": "string" }, "serviceCatalogQueryFilter": { "type": "string" }, "isCrawlServiceCatalog": { "type": "boolean" }, "isCrawlServiceCatalogAttachment": { "type": "boolean" }, "isCrawlActiveServiceCatalog": { "type": "boolean" }, "isCrawlInactiveServiceCatalog": { "type": "boolean" }, "isCrawlIncident": { "type": "boolean" }, "isCrawlIncidentAttachment": { "type": "boolean" }, "isCrawlActiveIncident": { "type": "boolean" }, "isCrawlInactiveIncident": { "type": "boolean" }, "applyACLForKnowledgeArticle": { "type": "boolean" }, "applyACLForServiceCatalog": { "type": "boolean" }, "applyACLForIncident": { "type": "boolean" }, "incidentStateType": { "type": "array", "items": { "type": "string", "enum": [ "Open", "Open - Unassigned", "Resolved", "All" ] } }, "knowledgeArticleTitleRegExp": { "type": "string" }, "serviceCatalogTitleRegExp": { "type": "string" }, "incidentTitleRegExp": { "type": "string" }, "inclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileTypePatterns": { "type": "array", "items": { "type": "string" } }, "inclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } }, "exclusionFileNamePatterns": { "type": "array", "items": { "type": "string" } } }, "required": [] }, "type": { "type": "string", "pattern": "SERVICENOWV2" }, "enableIdentityCrawler": { "type": "boolean" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL" ] }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] }
Slack 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。您可以在連線組態或儲存庫端點詳細資訊中提供主機 URL。另請將資料來源的類型指定為 SLACK、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Slack JSON 結構描述。
下表說明 Slack JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| teamId | 您從 Slack 主頁面 URL 複製的 Slack 團隊 ID。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
| 全部 | 將Slack內容的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。 |
| additionalProperties | 資料來源中內容的其他組態選項。 |
| inclusionPatterns | 在Slack資料來源中包含特定內容的規則表達式模式清單。符合模式的內容會包含在索引中。不符合模式的內容會從索引中排除。如果任何內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
| exclusionPatterns | 規則表達式模式清單，用於排除Slack資料來源中的特定內容。符合模式的內容會從索引中排除。不符合模式的內容會包含在索引中。如果任何內容同時符合包含和排除模式，則排除模式為優先，並且內容不包含在索引中。 |
| crawlBotMessages | true 以爬取機器人訊息。 |
| excludeArchived | true 排除封存訊息的編目。 |
| conversationType | 您要為 PUBLIC_CHANNEL、 PRIVATE_CHANNELGROUP_MESSAGE和 編製索引的對話類型DIRECT_MESSAGE。 |
| channelFilter | 您要為 private_channel或 編製索引的頻道類型public_channel。 |
| sinceDate | 您可以選擇設定sinceDate參數，讓Slack連接器根據特定 編目內容sinceDate。 |
| lookBack | 您可以選擇設定lookBack參數，讓Slack連接器在上次連接器同步之前的指定小時數內爬取更新或刪除內容。 |
| syncMode |
指定 Amazon Kendra 如何在資料來源內容變更時更新索引。您可以選擇：
|
| type | 資料來源的類型。將 指定SLACK為您的資料來源類型。 |
| enableIdentityCrawler | true 使用 Amazon Kendra的身分爬蟲程式來同步可存取特定文件之使用者和群組的身分/主體資訊。如果身分爬蟲程式已關閉，則可公開搜尋所有文件。如果您想要對文件使用存取控制，且身分爬蟲程式已關閉，您也可以使用 PutPrincipalMapping API 上傳使用者和群組存取資訊。 |
| secretArn |
AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連接到 所需的鍵/值對Slack。私密必須包含具有下列索引鍵的 JSON 結構：
|
| version | 目前支援的此範本版本。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "teamId": { "type": "string" } }, "required": ["teamId"] } } }, "repositoryConfigurations": { "type": "object", "properties": { "All": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "DATE","LONG"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "exclusionPatterns": { "type": "array", "items": { "type": "string" } }, "inclusionPatterns": { "type": "array", "items": { "type": "string" } }, "crawlBotMessages": { "type": "boolean" }, "excludeArchived": { "type": "boolean" }, "conversationType": { "type": "array", "items": { "type": "string", "enum": [ "PUBLIC_CHANNEL", "PRIVATE_CHANNEL", "GROUP_MESSAGE", "DIRECT_MESSAGE" ] } }, "channelFilter": { "type": "object", "properties": { "private_channel": { "type": "array", "items": { "type": "string" } }, "public_channel": { "type": "array", "items": { "type": "string" } } } }, "channelIdFilter": { "type": "array", "items": { "type": "string" } }, "sinceDate": { "anyOf": [ { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$" }, { "type": "string", "pattern": "" } ] }, "lookBack": { "type": "string", "pattern": "^[0-9]*$" } }, "required": [ ] }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "type" : { "type" : "string", "pattern": "SLACK" }, "enableIdentityCrawler": { "type": "boolean" }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type", "enableIdentityCrawler" ] }
Zendesk 範本結構描述
您可以在 TemplateConfiguration 物件中包含包含資料來源結構描述的 JSON。您可以在連線組態或儲存庫端點詳細資訊中提供主機 URL。另請將資料來源的類型指定為 ZENDESK、身分驗證憑證的秘密，以及其他必要的組態。然後，當您呼叫 CreateDataSource Type時，將 指定TEMPLATE為 。
您可以使用本開發人員指南中提供的範本。請參閱 Zendesk JSON 結構描述。
下表說明 Zendesk JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| connectionConfiguration | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| hostURL | Zendesk 主機 URL。例如，https：//https://yoursubdomain.zendesk.com。 |
| repositoryConfigurations | 資料來源內容的組態資訊。例如，設定特定類型的內容和欄位映射。 |
|
將 Zendesk 票證的屬性或欄位名稱映射至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| secretARN | AWS Secrets Manager 秘密的 Amazon Resource Name (ARN)，其中包含連接到 Zendesk 所需的鍵值對。秘密必須包含具有下列金鑰的 JSON 結構：主機 URL、用戶端 ID、用戶端秘密、使用者名稱和密碼。 |
| additionalProperties | 資料來源中內容的其他組態選項 |
| organizationNameFilter | 您可以選擇針對特定組織中存在的票證編製索引。 |
| sinceDate | 您可以選擇設定sinceDate參數，讓 Zendesk 連接器根據特定 爬取內容sinceDate。 |
| inclusionPatterns | 在 Zendesk 資料來源中包含特定檔案的規則表達式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含和排除模式，則排除模式為優先，且檔案不包含在索引中。 |
| exclusionPatterns | 在 Zendesk 資料來源中排除特定檔案的規則表達式模式清單。符合模式的檔案會從索引中排除。不符合模式的檔案會包含在索引中。如果檔案同時符合排除和包含模式，則排除模式為優先，且檔案不包含在索引中。 |
|
輸入「true」來編目這些類型的內容。 |
| type | 將 指定ZENDESK為您的資料來源類型。 |
| useChangeLog | 輸入「true」以使用 Zendesk 變更日誌來判斷哪些文件需要在索引中更新。根據變更日誌的大小，在 Zendesk 中掃描文件的速度可能會更快。如果您是第一次將 Zendesk 資料來源與索引同步，則會掃描所有文件。 |
{ "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "hostUrl": { "type": "string", "pattern": "https:.*" } }, "required": [ "hostUrl" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "ticket": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "ticketCommentAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "article": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityPostComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleComment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "articleAttachment": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] }, "communityTopic": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string", "enum": ["STRING", "STRING_LIST", "LONG", "DATE"] }, "dataSourceFieldName": { "type": "string" }, "dateFieldFormat": { "type": "string", "pattern": "dd-MM-yyyy HH:mm:ss" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } } }, "required": [ "fieldMappings" ] } } }, "secretArn": { "type": "string", "minLength": 20, "maxLength": 2048 }, "additionalProperties": { "type": "object", "properties": { "organizationNameFilter": { "type": "array" }, "sinceDate": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$" }, "inclusionPatterns": { "type": "array" }, "exclusionPatterns": { "type": "array" }, "isCrawTicket": { "type": "string" }, "isCrawTicketComment": { "type": "string" }, "isCrawTicketCommentAttachment": { "type": "string" }, "isCrawlArticle": { "type": "string" }, "isCrawlArticleAttachment": { "type": "string" }, "isCrawlArticleComment": { "type": "string" }, "isCrawlCommunityTopic": { "type": "string" }, "isCrawlCommunityPost": { "type": "string" }, "isCrawlCommunityPostComment": { "type": "string" } } }, "type": { "type": "string", "pattern": "ZENDESK" }, "useChangeLog": { "type": "string", "enum": ["true", "false"] } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "additionalProperties": false, "required": [ "connectionConfiguration", "repositoryConfigurations", "additionalProperties", "useChangeLog", "secretArn", "type" ] }
