本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
資料來源範本架構
以下是支援範本之資料來源的範本結構描述。
主題
- Adobe Experience Manager模板架構
- Amazon FSx (視窗) 範本結構
- Amazon FSx (NetApp ONTAP) 範本結構描述
- Alfresco模板架構
- Aurora (MySQL) 模板架構
- Aurora 模板模板架構
- Amazon RDS （Microsoft SQL 服務器）模板架構
- Amazon RDS (MySQL) 模板架構
- Amazon RDS (甲骨文) 樣板綱要
- Amazon RDS 模板模板架構
- Amazon S3 模板架構
- Amazon Kendra 網路爬蟲範本結構描述
- 匯流模板架構
- 模板架構
- Drupal 的模板架構
- GitHub 模板架構
- 模板架構
- 谷歌驅動器模板架構
- 模板架構
- Microsoft 交易所模板架構
- Microsoft OneDrive 模板架構
- Microsoft SharePoint 模板架構
- Microsoft SQL 服務器模板架構
- Microsoft 團隊模板架構
- Microsoft 模板架構
- MySQL 板架構
- Oracle 資料庫範本綱要
- PostgreSQL 架構
- 銷售力範本結構描述
- ServiceNow 模板架構
- 鬆弛模板架構
- ZENDESK 模板架構
Adobe Experience Manager模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供Adobe
Experience Manager主機 URL、驗證類型，以及是否將 Adobe Experience Manager (AEM) 用作雲端服務還是 AEM 內部部署作為連線組態或存放庫端點詳細資料的一部分。此外，請將資料來源類型指定為AEM、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。如需詳細資訊，請參閱 Adobe Experience Manager結構定義。
下表說明 AEM JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| AEMURL | Adobe Experience Manager主持人網址。例如，如果您使用 AEM 內部部署，則會包含主機名稱和連接埠:。https://hostname:port或者，如果您使用 AEM 做為雲端服務，您可以使用作者 URL: https://author-xxxxxx-xxxxxxx.adobeaemcloud.com。 |
| authType | 您使用的驗證類型，無論是Basic或OAuth2。 |
| deploymentType | 您使用Adobe Experience Manager的類型，CLOUD或ON_PREMISE。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將Adobe Experience Manager頁面和資產的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| timeZoneId |
如果您使用 AEM 內部部署，且伺服器的時區與 AEM 連接器或索引的時區不同，則可以指定要與 Amazon Kendra AEM 連接器或索引對齊的伺服器時區。 AEM 內部部署的預設時區是 Amazon Kendra AEM 連接器或索引的時區。AEM 做為雲端服務的預設時區是格林威治標準時間。 |
|
頁面和資產的根路徑清單。例如，一個頁面的根路徑可以是 /內容/sub 和一個資產的根路徑可以是 /內容/sub/asset1。 |
| 爬行資產 | true以編目資產。 |
| 抓取頁面 | true抓取頁面。 |
|
規則運算式模式清單，可在資Adobe Experience Manager料來源中包含特定頁面和資產。與模式匹配的頁面和資產都包含在索引中。不符合模式的頁面和資產會從索引中排除。如果頁面或資產同時符合包含模式和排除模式，則排除模式優先，而且內容不會包含在索引中。 |
|
用於排除資Adobe Experience Manager料來源中某些頁面和資產的規則運算式模式清單。符合模式的頁面和資產會從索引中排除。不符合模式的頁面和資產會包含在索引中。如果頁面或資產同時符合包含模式和排除模式，則排除模式優先，而且內容不會包含在索引中。 |
| 頁面組件 | 您要索引之特定頁面元件的名稱清單。 |
| contentFragmentVariations | 您要建立索引之Adobe Experience Manager內容片段之特定儲存變體的名稱清單。 |
| type | 資料來源的類型。指定AEM為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | AWS Secrets Manager 密碼的 Amazon 資源名稱 (ARN)，其中包含連接到 Adobe 體驗管理器所需的鍵值對。如需這些機碼值配對的詳細資訊，請參閱 Adobe 體驗管理員的連線指示。 |
| 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 (視窗) 範本結構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供檔案系統 ID 做為連線組態或存放庫端點詳細資料的一部分。您也必須將資料來源類型指定為FSX、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon FSx (視窗) 結構定義。
下表說明 Amazon FSx (視窗) JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| fileSystemId | Amazon FSx 檔案系統的識別碼。您可以在 Amazon FSx 主控台的 [檔案系統] 儀表板上找到您的檔案系統 ID。 |
| fileSystemType | Amazon FSx 檔案系統類型。若要用Windows File
Server作您的檔案系統類型，請指定WINDOWS。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
| 全部 | 將 Amazon FSx 資料來源中檔案的屬性或欄位名稱對映至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 會指定使用者和群組可存取的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| 包含模式 | 在 Amazon FSx 資料來源中包含某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| 排除模式 | 用於排除 Amazon FSx 資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 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物件的一部分。您可以提供檔案系統識別碼和儲存區虛擬機器 (SVM) 做為連線組態或存放庫端點詳細資料的一部分。您也必須將資料來源類型指定為FSXONTAP、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon FSx JSON 結構定義 NetApp 。
下表說明 Amazon FSx (NetApp ONTAP) JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| fileSystemId | Amazon FSx 檔案系統的識別碼。您可以在 Amazon FSx 主控台的 [檔案系統] 儀表板上找到您的檔案系統 ID。如需如何在 Amazon FSx 主控台中為 NetApp ONTAP 建立檔案系統的詳細資訊，請參閱使FSx for ONTAP 用者指南中的 NetApp 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指南。 |
| 通訊協定型態 | 您是否使用 Windows 的通用網際網路檔案系統 (CIFS) 通訊協定，還是使用 Linux 的網路檔案系統 (NFS) 通訊協定。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
| file | 將 Amazon FSx 資料來源中檔案的屬性或欄位名稱對映至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。資料來源欄位名稱必須存在於檔案自訂中繼資料中。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| 克劳拉克 | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 會指定使用者和群組可存取的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| 包含模式 | 在 Amazon FSx 資料來源中包含某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| 排除模式 | 用於排除 Amazon FSx 資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
| type | 資料來源的類型。對於NetApp ONTAP檔案系統資料來源，請指定FSXONTAP。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 |
AWS Secrets Manager 密碼的 Amazon 資源名稱 (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、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Alfresco結構定義。
下表說明露天 JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 網站 ID | 露天網站的標識符。 |
| 回味 | Alfresco儲存庫的網址。您可以向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。例如，使用者介面網址可以是 https://example.com。 |
| repositoryAdditionalProperties | 與儲存庫/資料來源端點連線的其他內容。 |
| authType | 您使用的驗證類型，無論是OAuth2或Basic。 |
| 類型 (部署) | 您使用Alfresco的類型，無論是PAAS或ON-PREM。 |
| 爬行型 | 您要搜索的內容類型，無論是ASPECT（在中標有「面向」的內容Alfresco），SITE_ID（特定Alfresco網站內的內容）還是ALL_SITES（您所有網Alfresco站上的內容）。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Alfresco 文檔的屬性或字段名稱和注釋映射到 Amazon Kendra 索引字段名稱的對象列表。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| 方面名稱 |
您要索引的特定「方面」的名稱。 |
| 方面屬性 |
您要索引的特定「縱橫」內容屬性的列表。 |
| enableFineGrained控制 |
|
| isCrawlComment |
|
|
在Alfresco資料來源中包含某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
|
用於排除Alfresco資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
| type | 資料來源的類型。指定ALFRESCO為您的資料來源類型。 |
| 秘书 |
Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到. Alfresco 私密必須包含具有下列索引鍵的 JSON 結構： 如果使用基本驗證：
如果使用 OAuth 2.0 身份驗證：
|
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 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) 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為mysql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Aurora (MySQL) 結構描述。
下表說明 Aurora (MySQL) JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 模板模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為postgresql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Aurora JSON 結構描述。
下表說明 Aurora (PostgreSQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 服務器）模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為sqlserver、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon RDS （Microsoft SQL 服務器）JSON 模式。
下表說明 Amazon RDS (Microsoft SQL 伺服器) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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) 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為mysql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon RDS (MySQL) 結構描述。
下表說明 Amazon RDS (MySQL) JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 (甲骨文) 樣板綱要
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為oracle、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon RDS （甲骨文）JSON 模式。
下表說明 Amazon RDS (Oracle) JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 模板模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為postgresql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Amazon RDS JSON 結構描述。
下表說明 Amazon RDS (PostgreSQL) JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱JSON 結構描述。
下表說明 Amazon S3 JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| BucketName | Amazon S3 儲存貯體的名稱。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
| 附加屬性 | 資料來源中內容的其他設定選項 |
|
要在 Amazon S3 資料來源中包含或排除特定檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| aclConfigurationFile路徑 | 控制 Amazon Kendra 索引中文件存取的檔案路徑。 |
| metadataFilesPrefix | 值區中繼資料檔案的位置。 |
| 同步模式 |
指定資料來源內容變更時 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 網路爬蟲範本結構描述
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。
您可以提供種子或起點 URL，或者提供 Sitemap URL，做為連線組態或存放庫端點詳細資料的一部分。除了手動列出所有 URL 之外，您還可以提供儲存貯體的路徑，該儲存 Amazon S3 貯體存放種子 URL 清單或 Sitemap XML 檔案清單的文字檔案，您可以將這些檔案集合在 S3 中的 ZIP 檔案中。
您也可以將資料來源的類型指定為WEBCRAWLERV2、網站驗證憑證和驗證類型 (如果您的網站需要驗證)，以及其他必要的設定。
然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
重要
不支援建立 Web 爬行者程式 v2.0 連接器。 AWS CloudFormation如果您需 AWS CloudFormation 要支援，請使用網路爬行者程式 v1.0 連接器。
選取要索引的網站時，您必須遵守 Amazon 可接受的使用政策
您可以使用本開發人員指南中提供的模板。請參閱Amazon Kendra 網路爬蟲結構描述。
下表說明 Amazon Kendra 網路爬行者程式 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| siteMapUrls | 您要檢索之網站的網站地圖 URL 清單。您最多可以列出三個網站地圖 URL。 |
| S3 SeedUrl | 存放種子或起點 URL 清單的文字檔案的 S3 路徑。例如 s3://bucket-name/directory/。文字檔案中的每個 URL 都必須以個別的行格式化。您最多可以在一個檔案中列出 100 個種子 URL。 |
| S3 SiteMapUrl | 網站地圖 XML 檔案的 S3 路徑。例如 s3://bucket-name/directory/。您最多可以列出三個網站地圖 XML 檔案。您可以將多個 Sitemap 檔案合併為一個 ZIP 檔案，並將 ZIP 檔案儲存在 Amazon S3 值區中。 |
| seedUrlConnections | 您要檢索之網站的種子或起點 URL 清單。您最多可以列出 100 個種子 URL。 |
| 種子網址 | 種子或起點 URL。 |
| 驗證 | 驗證類型（如果您的網站需要相同的驗證），否則請指定NoAuthentication。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將網頁和網頁檔案的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。例如，HTML 網頁標題標籤可以對應至索_document_title引欄位。如需詳細資訊，請參閱映射資料來源欄位。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| 速率限制 | 每分鐘每個網站主機網路爬取的 URL 數目上限。 |
| maxFileSize | 要編目的網頁或附件的大小上限 (MB)。 |
| 爬行深度 | 要編目之種子 URL 的層級數目。例如，種子 URL 頁面是深度 1，而此頁面上也經過探索的任何超連結都是深度 2。 |
| maxLinksPer网址 | 檢索網站時，網頁上要包含的 URL 數目上限。這個數字是每個網頁。當網站的網頁被抓取時，網頁鏈接到的所有 URL 也會被抓取。網頁上的 URL 會依外觀順序進行檢索。 |
| crawlSubDomain | true抓取具有子域的網站域。例如，如果種子 URL 是 "abc.example.com"，則也會探索 "b.abc.example.com" 和 ""。a.abc.example.com如果您未設定crawlSubDomain或設crawlAllDomain定true，則 Amazon Kendra 只會檢索您要檢索之網站的網域。 |
| crawlAllDomain | true抓取具有子域和網頁鏈接到的其他域的網站域。如果您未設定crawlSubDomain或設crawlAllDomain定true，則 Amazon Kendra 只會檢索您要檢索之網站的網域。 |
| 榮譽機器人 | true尊重您要抓取的網站的 robots.txt 指令。這些指令會控制 Amazon Kendra 網頁爬行者程式搜索網站的方式，是否只 Amazon Kendra 能編目特定內容或不編目任何內容。 |
| 爬網附件 | true抓取網頁鏈接到的文件。 |
|
規則運算式模式清單，其中包括檢索特定 URL，並為這些 URL 網頁上的任何超連結建立索引。符合模式的 URL 會包括在索引中。不符合模式的 URL 會從索引中排除。如果 URL 同時符合包含和排除模式，則排除模式優先，並且 URL /網站的網頁不包含在索引中。 |
|
規則運算式模式清單，可排除檢索特定 URL，並為這些 URL 網頁上的任何超連結建立索引。符合模式的 URL 會從索引中排除。不符合模式的 URL 會包括在索引中。如果 URL 同時符合包含和排除模式，則排除模式優先，並且 URL /網站的網頁不包含在索引中。 |
| inclusionFileIndex模式 | 包含特定網頁檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
| exclusionFileIndex模式 | 要排除特定網頁檔案的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
| proxy | 透過 Web 代理連線到內部網站所需的組態資訊。 |
| 託管 | 您要用來連線至內部網站的 Proxy 伺服器主機名稱。例如，的主機名稱https://a.example.com/page1.html是 "a.example.com"。 |
| port | 您要用來連線到內部網站的 Proxy 伺服器連接埠號碼。例如，443 是 HTTPS 的標準連接埠。 |
| 秘书 (代理) | 如果需要 Web Proxy 憑證才能連線到網站主機，您可以建立儲存認證的 AWS Secrets Manager 密碼。提供 Amazon 資源名稱（ARN）的秘密。 |
| type | 資料來源的類型。指定WEBCRAWLERV2為您的資料來源類型。 |
| 秘书 |
如果您的網站需要身份驗證才能訪問網站，則使用該 AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN）。您可以將網站的驗證認證儲存在包含 JSON 金鑰值配對的密碼中。 如果您使用基本或 NTML/Kerberos，請輸入使用者名稱和密碼。密碼中的 JSON 金鑰必須是 如果您使用 SAML 或表單驗證，請輸入使用者名稱和密碼、使用者名稱欄位的 XPath (如果使用 SAML，則輸入使用者名稱按鈕)、密碼欄位和按鈕的 XPath，以及登入頁面 URL。密碼中的 JSON 金鑰必須是 Amazon Kendra 還會檢查密碼中包含的端點資訊 (種子 URL) 是否與資料來源端點組態詳細資料中指定的端點資訊相同。 |
| 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 } } } }, "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" ] }
匯流模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供 Confluence 主機 URL、主控方法和驗證類型，做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為CONFLUENCEV2、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱匯流模式。
下表說明匯合 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 主机网址 | 您的匯流執行個體的 URL。例如：https://example.confluence.com。 |
| type | 您的匯流執行個體的託管方法，無論是否SAAS為和。ON_PREM |
| authType | 您的匯流執行個體的驗證方法，無論是BasicOAuth2、或。Personal-token |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Confluence 空間、頁面、部落格、註解和附件的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。Confluence 資料來源欄位名稱必須存在於您的 Confluence 自訂中繼資料中。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 會指定使用者和群組可存取的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUser識別碼 | 指定是email否要使用使用者電子郵件作為使用者 ID。 email依預設會使用，而且是目前唯一受支援的使用者 ID 類型。 |
|
要包含和/或排除 Confluence 資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| 代理宿主 | 您使用的 Web Proxy 主機的主機名稱 (不含http://或https://通訊協定)。 |
|
代理端口 |
主機 URL 傳輸通訊協定所使用的連接埠號碼。必須是介於 0 到 65535 之間的數值。 |
|
true在您的 Confluence 個人空間，頁面，博客，頁面評論，頁面附件，博客評論和博客附件中抓取文件。 |
| maxFileSizeInMegaBytes | 指定 Amazon Kendra 可編目的檔案大小限制 (MB)。 Amazon Kendra 只會探索您定義的大小限制內的檔案。預設檔案大小為 50MB。檔案大小上限應該大於 0MB 且小於或等於 50MB。 |
| type | 資料來源的類型。指定CONFLUENCEV2為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 | 指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到您的匯流所需的鍵值對。有關這些鍵值對的信息，請參閱匯合的連接說明。 |
| 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" ] }
模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您提供 Dropbox 應用程式金鑰、應用程式密鑰和存取權杖，做為儲存驗證憑證的密碼的一部分。還將數據源的類型指定為DROPBOX，要使用的訪問令牌的類型（臨時或永久）以及其他必要的配置。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱結構描述。
下表說明 JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源未在中指定端點repositoryEndpointMetadata。相反地，連線資訊會包含在您提供的 AWS Secrets Manager 密碼中secretArn。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
對應 Dropbox 檔案屬性或欄位名稱的物件清單、Dropbox Paper，以及 Amazon Kendra 索引欄位名稱的捷徑。如需詳細資訊，請參閱映射資料來源欄位。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 密鑰，其中包含連接到 Dropbox 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 會指定使用者和群組可存取的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
|
規則運算式模式清單，可在 Dropbox 資料來源中包含特定檔案名稱和類型。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
排除 Dropbox 資料來源中特定檔案名稱和類型的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
|
true抓取儲存在 Dropbox 中的檔案、Paper 文件、Dropbox Paper 範本，以及網頁捷徑。 |
| type | 資料來源的類型。指定DROPBOX為您的資料來源類型。 |
| 令牌類型 | 指定您的訪問令牌類型：永久或臨時訪問令牌。建議您建立一個永遠不會在 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 的模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您提供 Drupal 主機 URL 和身份驗證類型作為連接配置或存儲庫端點詳細信息的一部分。還將數據源的類型指定為 DRUPAL，身份驗證憑據的秘密以及其他必要的配置。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱JSON 模式。
下表描述了 Drupal 的 JSON 模式的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 主机网址 | 您的 Drupal 網站的主機網址。例如，HTTPS：///<hostname><drupalsitename>。 |
| 儲存庫組態 | 資料來源內容的組態資訊。 |
|
映射 Drupal 文件的屬性或字段名稱的對象列表。如需詳細資訊，請參閱映射資料來源欄位。Drupal 數據源字段名稱必須存在於您的 Drupal 自定義元數據中。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
|
正則表達式模式列表，以包含 Drupal 數據源中的某些文件。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
正則表達式模式列表，以排除 Drupal 數據源中的某些文件。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
內容定義
|
指定要編目的內容類型，以及是否要編目所選內容類型的註解和附件。 |
| type | 資料來源的類型。指定DRUPAL為您的資料來源類型。 |
| authType | 您使用的驗證類型，無論是BASIC-AUTH或OAUTH2。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到 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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供 GitHub 主機 URL、組織名稱，以及是否使用 GitHub 雲端或 GitHub 內部部署做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為GITHUB、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱GitHub 結構定義。
下表說明 GitHub JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| type | 將類型指定為SAAS或ON_PREMISE。 |
| 主机网址 | 主 GitHub 機網址。例如，如果您使用 GitHub SaaS /企業雲端：。https://api.github.com或者，如果您使用 GitHub內部部署/企業伺服器：。https://on-prem-host-url/api/v3/ |
| 組織名稱 | 您可以在登入 GitHub 桌面時找到您的組織名稱，然後前往您的個人資料圖片下拉式清單下的「您的組織」。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 GitHub 內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| isCrawlAcl | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 指定使用者和群組可以存取和搜尋的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUser識別碼 | 指定您要用於 ACL 探索的使用者識別碼類型。指定是email否要使用使用者電子郵件作為使用者 ID，或是username要使用使用者名稱作為使用者 ID。如果您沒有指定選項，則email默認使用。 |
| 儲存庫過濾器 | 您要索引的特定存儲庫和分支名稱的名稱列表。 |
| 爬行存儲庫 | true抓取存儲庫。 |
| crawlRepositoryDocuments | true編目儲存庫文件。 |
| 克勞利蘇 | true抓取問題。 |
| crawlIssueComment | true抓取問題評論。 |
| crawlIssueComment附件 | true抓取問題評論附件。 |
| crawlPullRequest | true以編目提取請求。 |
| crawlPullRequest评论 | true抓取提取請求註釋。 |
| crawlPullRequestCommentAttachment | true抓取提取請求評論附件。 |
|
在 GitHub資料來源中包含特定內容的規則運算式模式清單。符合模式的內容會包含在索引中。與模式不匹配的內容會從索引中排除。如果有任何內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
|
用於排除 GitHub資料來源中某些內容的規則運算式模式清單。符合模式的內容會從索引中排除。與模式不匹配的內容包含在索引中。如果有任何內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
| type | 資料來源的類型。指定GITHUB為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 |
Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到. 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" ] }
模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源類型指定為GMAIL、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱結構描述。
下表說明 Gmail JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源未在中指定端點repositoryEndpointMetadata。相反地，連線資訊會包含在您提供的 AWS Secrets Manager 密碼中secretArn。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
將 Gmail 郵件和附件的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
|
規則運算式模式清單，可在 Gmail 資料來源中包含或排除具有特定主旨名稱的郵件。符合模式的檔案會包括在索引中。如果檔案同時符合包含檔案和排除模式，則排除模式優先，且該檔案不會包含在索引中。 |
| beforeDateFilter | 指定在特定日期之前要包含的郵件和附件。 |
| afterDateFilter | 指定在特定日期之後要包含的郵件和附件。 |
| isCrawlAttachment | Boolean 值，用來選擇是否要編目附件。訊息會自動編目。 |
| type | 資料來源的類型。指定GMAIL為您的資料來源類型。 |
| shouldCrawlDraft訊息 | Boolean 值，用來選擇是否要編目草稿郵件。 |
| 同步模式 | 指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
重要由於沒有 API 可以更新永久刪除的 Gmail 郵件，因此任何新的，修改或刪除的內容同步：
若要將 Gmail 資料來源標籤變更和永久刪除的電子郵件訊息同步至 Amazon Kendra 索引，您必須定期執行完整檢索。 |
| 秘书 | 秘 Secrets Manager 秘密的 Amazon 資源名稱（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" ] }
谷歌驅動器模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源類型指定為GOOGLEDRIVE2、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱谷歌雲端硬盤 JSON 模式。
下表描述了谷歌雲端硬盤 JSON 模式的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源未指定端點。您可以選擇驗證類型：serviceAccount和OAuth2。連線資訊會包含在您提供的 AWS Secrets Manager 密碼中secretArn。 |
| authType | OAuth2根據您的使用案例在serviceAccount和之間進行選擇。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Google 雲端硬盤的屬性或字段名稱映射到 Amazon Kendra 索引字段名稱的對象列表。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他設定選項 |
|
指定 Amazon Kendra 應編目的檔案大小限制 (以 MB 為單位)。 |
|
true在您的 Google 雲端硬盤數據源中抓取評論。 |
|
true在您的 Google 雲端硬盤數據源中抓取 MyDrive 和共享「與我的驅動器」。 |
|
true在您的 Google 雲端硬盤數據源中抓取共享雲端硬盤。 |
| isCrawlAcl | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 指定使用者和群組可以存取和搜尋的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
|
正則表達式模式列表，用於排除 Google 雲端硬盤數據源中的某些文件。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且該檔案不會包含在索引中。 |
|
正則表達式模式列表，用於在 Google 雲端硬盤數據源中包含某些文件。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
| type | 資料來源的類型。指定GOOOGLEDRIVEV2為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 一個 AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN），其中包含連接到 Google 雲端硬盤所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構： 如果使用 Google 服務帳戶身份驗證：
如果使用 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" ] }
模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為db2、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱JSON 結構描述。
下表說明 IBM DB2 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 交易所模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您提供承租人識別碼做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為MSEXCHANGE、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Microsoft 交易所 JSON 架構。
下表說明 Microsoft 交換 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 特南蒂 | Microsoft 365 租戶識別碼。您可以在 Azure 作用中目錄入口網站的內容或 OAuth 應用程式中找到您的租用戶識別碼。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Microsoft Exchange 資料來源的屬性或欄位名稱對應至 Amazon Kendra 索引欄位的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項 |
| 包含模式 | 規則運算式模式清單，以包含您的 Microsoft Exchange 資料來源中的某些檔案。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| 排除模式 | 規則運算式模式清單，可排除您的 Microsoft Exchange 資料來源中的某些檔案。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
|
規則運算式模式清單，可將特定使用者和使用者檔案包含在您的 Microsofot 交換資料來源中。符合模式的使用者會包含在索引中。不符合模式的使用者會從索引中排除。如果使用者同時符合包含和排除模式，則排除模式優先，且使用者不會包含在索引中。 |
|
規則運算式模式清單，可排除 Microsoft Exchange 資料來源中的某些使用者和使用者檔案。符合模式的使用者會從索引中排除。不符合模式的使用者會包含在索引中。如果使用者同時符合排除和包含模式，則排除模式優先，且使用者不會包含在索引中。 |
| S3 儲存格名稱 | 您的 S3 儲存貯體的名稱 (如果您要使用)。 |
|
true編目這些類型的內容和存取控制資訊您的 Microsoft Exchange 資料來源。 |
| startCalendarDate時間 | 您可以為行事曆內容設定特定的開始日期-時間。 |
| endCalendarDate時間 | 您可以為行事曆內容設定特定的結束日期-時間。 |
| subject | 您可以設定郵件內容的特定主旨行。 |
| 電子郵件從 | 您可以為「寄件者」或寄件者郵件內容設定特定的電子郵件。 |
| 電子郵件至 | 您可以為「收件者」或收件者郵件內容設定特定的電子郵件。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| type | 資料來源的類型。指定MSEXCHANGE為您的資料來源類型。 |
| 秘书 | AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN），其中包含連接到 Microsoft 交換所需的鍵值對。這包括您的用戶端識別碼，以及您在 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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供承租人識別碼做為連線組態或存放庫端點詳細資料的一部分。此外，請將資料來源的類型指定為ONEDRIVEV2，以及驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Microsoft OneDrive 模式。
下表說明 Microsoft OneDrive JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 特南蒂 | Microsoft 365 租戶識別碼。您可以在 Azure 作用中目錄入口網站的內容或 OAuth 應用程式中找到您的租用戶識別碼。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
| file | 將 Microsoft OneDrive 檔案的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他設定選項 |
|
您可以選擇索引特定檔案、 OneNote 區段、 OneNote 頁面，並依使用者名稱進行篩選。 |
| isUserNameOnS3 | true提供儲存在的檔案中的使用者名稱清單 Amazon S3。 |
| type | 資料來源的類型。指定ONEDRIVEV2為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| type | 資料來源的類型。指定ONEDRIVEV2為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到 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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以視需要提供 SharePoint 網站 URL/URL、網域以及承租人識別碼，做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為SHAREPOINTV2、驗證認證的密碼，以及其他必要的組態。然後您在呼叫時指定TEMPLATE為 Type CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱SharePoint 結構定義。
下表說明 Microsoft SharePoint JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊 |
| repositoryEndpointMetadata | 資料來源的端點資訊 |
| 特南蒂 | 您帳戶的租用 SharePoint 戶識別碼。 |
| domain | 您 SharePoint 帳戶的網域。 |
| 网站网址 | 您 SharePoint 帳戶的主機 URL。 |
| repositoryAdditionalProperties | 與儲存庫/資料來源端點連線的其他內容。 |
| S3 儲存格名稱 | 儲存您 Azure AD 自我簽署 X.509 憑證的 Amazon S3 值區名稱。 |
| S3 認證名稱 | 儲存在值區中之 Azure AD 自我簽署 X.509 憑證的 Amazon S3 名稱。 |
| authType | 您使用的驗證類型OAuth2，無論是OAuth2CertificateOAuth2App、Basic、OAuth2_RefreshToken、NTLM、或Kerberos。 |
| version | 您使用的 SharePoint 版本 (無論是Server或) Online。 |
| onPremVersion | 您使用的 SharePoint 伺服器版本 (無論是201320162019、或) SubscriptionEdition。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 SharePoint內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
|
要在 SharePoint 資料來源中包含/排除某些內容的規則運算式模式清單。符合包含模式的內容項目會包含在索引中。不符合包含模式的內容項目會從索引中排除。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
|
true來編目這些類型的內容。 |
| 克劳拉克 | true以編目文件的存取控制清單 (ACL) 資訊，如果您有 ACL，並且想要將其用於存取控制。ACL 指定使用者和群組可以存取和搜尋的文件。ACL 資訊可用來根據使用者或使用者對文件的群組存取權來篩選搜尋結果。如需詳細資訊，請參閱使用者內容篩選。 |
| fieldForUser識別碼 | 指定是email否要使用使用者電子郵件作為使用者 ID，或是userPrincipalName要使用使用者名稱作為使用者 ID。如果您沒有指定選項，則email默認使用。 |
| ACL 組態 | 指定ACLWithLDAPEmailFmtACLWithManualEmailFmt、或ACLWithUsernameFmtM。 |
| 電子郵件域 | 電子郵件的網域。例如，"亞馬遜"。 |
|
true以編目群組對應資訊。 |
| 代理宿主 | 您使用的網頁代理伺服器的主機名稱，而不使用 http://或 https://通訊協定。 |
| 代理端口 | 主機 URL 傳輸通訊協定所使用的連接埠號碼。必須是介於 0 到 65535 之間的數值。 |
| type | 指定SHAREPOINTV2為您的資料來源類型 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到. SharePoint 如需這些機碼值配對的詳細資訊，請參閱線上與 SharePoint伺服器的連 SharePoint 線指示。 |
| 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 服務器模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為sqlserver、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Microsoft SQL 服務器模式。
下表說明微型 SQL 伺服器 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 團隊模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供承租人識別碼做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為MSTEAMS、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱Microsoft 團隊結構描述。
下表說明 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 特南蒂 | Microsoft 365 租戶識別碼。您可以在 Azure 作用中目錄入口網站的內容或 OAuth 應用程式中找到您的租用戶識別碼。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Microsoft Teams 內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| 付款模式 | 指定要搭配 Microsoft Teams 資料來源使用的付款模式類型。Model A 付款模式僅限於需要符合安全性規範的授權和付款模式。B 型付款模式適用於不需要安全性合規的授權和付款模式。 |
|
在 Microsoft Teams 資料來源中包含特定內容的規則運算式模式清單。符合模式的內容會包含在索引中。與模式不匹配的內容會從索引中排除。如果內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
|
用來排除 Microsoft Teams 資料來源中某些內容的規則運算式模式清單。符合模式的內容會從索引中排除。與模式不匹配的內容包含在索引中。如果內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
|
true以在您的 Microsoft 團隊資料來源中編目這些類型的內容。 |
| startCalendarDate時間 | 您可以為行事曆內容設定特定的開始日期-時間。 |
| endCalendarDate時間 | 您可以為行事曆內容設定特定的結束日期-時間。 |
| type | 資料來源的類型。指定MSTEAMS為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN），其中包含連接到您的 Microsoft 團隊所需的鍵值對。這包括您在 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" ] } }, "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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源類型指定為YAMMER、驗證認證的密碼，以及其他必要的組態。然後您在呼叫時指定TEMPLATE為 Type CreateDataSource。
您可以使用本開發人員指南中提供的模板。
下表說明 Microsoft 的 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。此資料來源未在中指定端點repositoryEndpointMetadata。相反地，連線資訊會包含在您提供的 AWS Secrets Manager 密碼中secretArn。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Microsoft Yammer 內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他設定選項 |
| 包含模式 | 規則運算式模式清單，以包含 Microsoft Yammer 資料來源中的某些檔案。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
| 排除模式 | 規則運算式模式清單，可排除 Microsoft Yammer 資料來源中的某些檔案。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
| 自最新 | 您可以選擇設定sinceDate參數，以便 Microsoft Yammer 連接器根據特定內容進行編目。sinceDate |
| communityNameFilter | 您可以選擇索引特定的社群內容。 |
|
true抓取郵件、郵件附件和私人訊息。 |
| type | 指定YAMMER為您的資料來源類型。 |
| 秘书 | AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN），其中包含連接到 Microsoft Yammer 所需的鍵值對。這包括您的 Microsoft Yammer 使用者名稱和密碼，以及當您在 Azure 入口網站中建立 OAuth 應用程式時所產生的用戶端識別碼和用戶端密碼。 |
| useChangeLog | true使用 Microsoft Yammer 變更記錄檔來判斷哪些文件需要在索引中更新。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
{ "$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 板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為mysql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱結構定義。
下表說明 MySQL JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 資料庫範本綱要
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為oracle、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱甲骨文数据库模式。
下表說明 Oracle 資料庫 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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 架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。將資料來源的類型指定為JDBC、資料庫類型為postgresql、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱PostgreSQL 構。
下表說明 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 連線資料來源所需的組態資訊。
|
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。指定資料來源的類型和秘密 ARN。 |
|
文件 |
將資料庫內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 附加屬性 | 資料來源中內容的其他組態選項。用於在資料庫資料來源中包含或排除特定內容。 |
| 主要金鑰 | 提供資料庫表格的主索引鍵。這標識數據庫中的一個表。 |
| 標題欄 | 提供資料庫表格中文件標題欄的名稱。 |
| 身體專欄 | 提供資料庫表格中文件標題欄的名稱。 |
| sqlQuery | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| 時間戳記列 | 輸入包含時間戳記的列的名稱。 Amazon Kendra 使用時間戳記資訊偵測內容中的變更，並僅同步變更的內容。 |
| 時間戳記格式 | 輸入包含時間戳記格式的資料欄名稱，可用來偵測內容變更並重新同步處理內容。 |
| timezone | 輸入包含要探索之內容之時區的資料欄名稱。 |
| changeDetectingColumns | 輸入 Amazon Kendra 將用來偵測內容變更的欄名稱。 Amazon Kendra 當這些列中的任何一個更改時，將重新索引內容 |
| allowedUsersColumns | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| allowedGroupsColumn | 輸入包含允許存取內容之使用者 ID 的欄名稱。 |
| 來源尿酸氧胺 | 輸入包含要編製索引之來源 URL 的資料欄名稱。 |
| isSslEnabled | 輸入 SQL 查詢語句，如選擇和連接操作。SQL 查詢必須小於 32 KB。 Amazon Kendra 會編目符合您查詢的所有資料庫內容。 |
| type | 資料來源的類型。指定JDBC為您的資料來源類型。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | 秘密 Secrets Manager 密碼的 Amazon 資源名稱 (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" ] }
銷售力範本結構描述
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以在連線組態或存放庫端點詳細資料中提供 Salesforce 主機 URL。同時將資料來源類型指定為SALESFORCEV2、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱銷售部隊 JSON 結構描述。
下表說明 JSON 結構描述的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 主机网址 | 要編製索引之 Salesforce 執行個體的 URL。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Salesforce 實體的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 秘书 | AWS Secrets Manager 密碼的 Amazon 資源名稱 (ARN)，其中包含連接到 Salesforce 所需的鍵值對。私密必須包含具有下列索引鍵的 JSON 結構：
|
| 附加屬性 | 資料來源中內容的其他設定選項 |
|
字串集合，指定要篩選哪些實體。 |
包含模式
|
在 Salesforce 資料來源中包含特定檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
排除模式
|
用來排除 Salesforce 資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會從索引中排除。與模式不匹配的文件包含在索引中。如果檔案同時符合排除和包含模式，則排除模式優先，且檔案不會包含在索引中。 |
|
true以在您的 Salesforce 帳戶中檢索這些類型的檔案。 |
| type | 資料來源的類型。指定SALESFORCEV2為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 |
指定資料來源內容變更時 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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供 ServiceNow 主機 URL、驗證類型和執行個體版本，做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為SERVICENOWV2、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱ServiceNow 結構定義。
下表說明 ServiceNow JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 主机网址 | ServiceNow 主持人網址。例如，您的域. 服務現在 .com。 |
| authType | 您使用的驗證類型，無論是basicAuth或OAuth2。 |
| servicenowInstanceVersion | 您使用的 ServiceNow 版本。您可以選擇TokyoSandiego、Rome、和Others。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 ServiceNow知識文章、附件、服務目錄和事件的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。資 ServiceNow 料來源欄位名稱必須存在於您的 ServiceNow 自訂中繼資料中。 |
| 其他屬性 | 資料來源中內容的其他組態選項。 |
| maxFileSizeInMegaBytes | 指定 Amazon Kendra 將抓取的檔案大小限制 (以 MB 為單位)。Amazon Kendra 只會抓取您定義的大小限制內的檔案。預設檔案大小為 50MB。檔案大小上限應該大於 0MB 且小於或等於 50MB。 |
|
要包含和/或排除 ServiceNow 資料來源中某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包括模式和排除模式，則以排除模式為優先，且該項目不會包括在索引中。 |
|
true編目 ServiceNow 知識文章、服務目錄、事件和附件。 |
| type | 資料來源的類型。指定SERVICENOWV2為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 同步模式 | 指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| 秘书 | Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到. 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" ] }
鬆弛模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供主機 URL 做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為SLACK、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱鬆弛結構定義。
下表說明 Slack JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 團隊 ID | 您從 Slack 主頁網址複製的 Slack 團隊 ID。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
| 全部 | 將Slack內容的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。 |
| 附加屬性 | 資料來源中內容的其他組態選項。 |
| 包含模式 | 在Slack資料來源中包含特定內容的規則運算式模式清單。符合模式的內容會包含在索引中。與模式不匹配的內容會從索引中排除。如果有任何內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
| 排除模式 | 用於排除Slack資料來源中特定內容的規則運算式模式清單。符合模式的內容會從索引中排除。不符合模式的內容會包含在索引中。如果有任何內容同時符合包含和排除模式，則排除模式優先，且內容不會包含在索引中。 |
| crawlBotMessages | true抓取機器人消息。 |
| 排除已存檔 | true以排除已存檔訊息的探索。 |
| 對話類型 | 您要索引的交談類型是否PUBLIC_CHANNELPRIVATE_CHANNEL、GROUP_MESSAGE和DIRECT_MESSAGE。 |
| 頻道篩選 | 您要索引是否為private_channel或的通道類型public_channel。 |
| 自最新 | 您可以選擇設定sinceDate參數，以便Slack連接器根據特定sinceDate內容編目。 |
| 回顧 | 您可以選擇設定lookBack參數，讓連接器在上次Slack連接器同步之前的指定小時內搜索更新或刪除的內容。 |
| 同步模式 |
指定資料來源內容變更時 Amazon Kendra 應如何更新索引。您可以選擇：
|
| type | 資料來源的類型。指定SLACK為您的資料來源類型。 |
| enableIdentityCrawler | true，以使用 Amazon Kendra的身分識別爬行者程式來同步使用者和群組的身分識別/主體資訊，以存取特定文件。如果關閉身分搜索器，則可以公開搜索所有文檔。如果您想要對文件使用存取控制，且身分識別編目程式已關閉，您也可以使用 PutPrincipalMappingAPI 來上傳使用者和群組存取資訊。 |
| 秘书 |
Amazon 資源名稱（ARN）的 AWS Secrets Manager 秘密，其中包含連接到. 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 模板架構
您可以將包含資料來源結構描述的 JSON 納入為TemplateConfiguration物件的一部分。您可以提供主機 URL 做為連線組態或存放庫端點詳細資料的一部分。同時將資料來源類型指定為ZENDESK、驗證認證的密碼，以及其他必要的組態。然後，您將指定TEMPLATE為呼叫Type時CreateDataSource。
您可以使用本開發人員指南中提供的模板。請參閱天台 JSON 架構。
下表說明 Zendesk JSON 結構定義的參數。
| 組態 | 描述 |
|---|---|
| 連線組態 | 資料來源端點的組態資訊。 |
| repositoryEndpointMetadata | 資料來源的端點資訊。 |
| 主机网址 | Zendesk 主機網址。例如：https://yoursubdomain.zendesk.com。 |
| 儲存庫組態 | 資料來源內容的組態資訊。例如，配置特定類型的內容和欄位對應。 |
|
將 Zendesk 票證的屬性或欄位名稱對應至 Amazon Kendra 索引欄位名稱的物件清單。如需詳細資訊，請參閱映射資料來源欄位。 |
| 秘书 | AWS Secrets Manager 秘密的 Amazon 資源名稱（ARN），其中包含連接到 Zendesk 所需的鍵值對。密碼必須包含具有下列金鑰的 JSON 結構：主機 URL、用戶端 ID、用戶端密碼、使用者名稱和密碼。 |
| 附加屬性 | 資料來源中內容的其他設定選項 |
| organizationNameFilter | 您可以選擇索引存在於特定組織內的工單。 |
| 自最新 | 您可以選擇配置sinceDate參數，以便 Zendesk 連接器根據特定內容進行編目。sinceDate |
| 包含模式 | 在 Zendesk 資料來源中包含某些檔案的規則運算式模式清單。符合模式的檔案會包括在索引中。不符合模式的檔案會從索引中排除。如果檔案同時符合包含模式和排除模式，則排除模式優先，且檔案不會包含在索引中。 |
| 排除模式 | 用於排除 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" ] }
