本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
以下是支持模板的数据来源的模板架构。
主题
Adobe Experience Manager 模板架构
您将包含包含数据源架构的 JSON 作为其中的一部分 TemplateConfiguration对象。你提供 Adobe
Experience Manager 主机 URL、身份验证类型以及是否使用 Adobe Experience Manager (AEM) 作为云服务或 AEM 本地部署，作为连接配置或存储库端点详细信息的一部分。此外，请将数据来源的类型指定为 AEM、身份验证凭证的密钥以及其他必要的配置。然后，您可以指定TEMPLATE为 “Type何时拨打电话” CreateDataSource.
您可以使用本开发者指南中提供的模板。有关更多信息，请参阅 Adobe Experience Manager JSON 架构。
下表描述了 AEM JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| aemUrl | 这些区域有：Adobe Experience Manager 主机网址。例如，如果您使用 AEM On-Premise，则需要包括主机名和端口：https://hostname:port。 或者，如果您将 AEM 用作云服务，则可以使用作者 URL：https://author-xxxxxx-xxxxxxx.adobeaemcloud.com. |
| authType | 您使用的身份验证类型，可以是 Basic 或 OAuth2。 |
| deploymentType | 的类型 Adobe Experience Manager 你使用的那个，要CLOUD么是ON_PREMISE。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
映射您的属性或字段名称的对象列表 Adobe Experience Manager 用于 Amazon Kendra 索引字段名称的页面和资产。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| timeZoneId |
如果您使用 AEM 本地部署，并且服务器的时区与 AEM 连接器或索引的时区不同，则可以指定与 Amazon Kendra AEM 连接器或索引对齐的服务器时区。 AEM 本地部署的默认时区是 AE Amazon Kendra M 连接器或索引的时区。AEM 即云服务的默认时区是格林威治标准时间。 |
|
页面和资产的根路径列表。例如，页面的根路径可以是 /content/sub，而资源的根路径可以是 /1。content/sub/asset |
| crawlAssets | 为 true 则爬取资产。 |
| crawlPages | 为 true 则爬取页面。 |
|
包含特定页面和资源的正则表达式模式列表 Adobe Experience Manager 数据源。与模式匹配的页面和资产将包含在索引中。与模式不匹配的页面和资产将从索引中排除。如果页面或资产同时匹配包含和排除模式，则排除模式优先，也就是说，内容不会包含在索引中。 |
|
用于排除您中的某些页面和资源的正则表达式模式列表 Adobe Experience Manager 数据源。与模式匹配的页面和资产将从索引中排除。与模式不匹配的页面和资产将包含在索引中。如果页面或资产同时匹配包含和排除模式，则排除模式优先，也就是说，内容不会包含在索引中。 |
| pageComponents | 您想要编入索引的特定页面组件的名称的列表。 |
| contentFragmentVariations | 已保存的特定变体的名称列表 Adobe Experience Manager 要索引的内容片段。 |
| type | 数据来源的类型。指定 AEM 作为数据来源类型。 |
| syncMode |
指定在数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 包含连接到 Adobe Experience Man AWS Secrets Manager ager 所需的键值对的密钥的亚马逊资源名称 (ARN)。有关这些键值对的信息，请参阅 Adobe Experience Manager 的连接说明。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties":
{
"connectionConfiguration": {
"type": "object",
"properties":
{
"repositoryEndpointMetadata":
{
"type": "object",
"properties":
{
"aemUrl":
{
"type": "string",
"pattern": "https:.*"
},
"authType": {
"type": "string",
"enum": ["Basic", "OAuth2"]
},
"deploymentType": {
"type": "string",
"enum": ["CLOUD","ON_PREMISE"]
}
},
"required":
[
"aemUrl",
"authType",
"deploymentType"
]
}
},
"required":
[
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties":
{
"page":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"asset":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties":
{
"timeZoneId": {
"type": "string",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/ComodRivadavia",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Atka",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Buenos_Aires",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Ensenada",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Jujuy",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Knox_IN",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Louisville",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montreal",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Acre",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Rosario",
"America/Santa_Isabel",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Shiprock",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Virgin",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/South_Pole",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Ashkhabad",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Calcutta",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Colombo",
"Asia/Dacca",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Harbin",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kashgar",
"Asia/Kathmandu",
"Asia/Katmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macao",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Saigon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Tel_Aviv",
"Asia/Thimbu",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ujung_Pandang",
"Asia/Ulaanbaatar",
"Asia/Ulan_Bator",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faeroe",
"Atlantic/Faroe",
"Atlantic/Jan_Mayen",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/ACT",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Canberra",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/LHI",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/NSW",
"Australia/North",
"Australia/Perth",
"Australia/Queensland",
"Australia/South",
"Australia/Sydney",
"Australia/Tasmania",
"Australia/Victoria",
"Australia/West",
"Australia/Yancowinna",
"Brazil/Acre",
"Brazil/DeNoronha",
"Brazil/East",
"Brazil/West",
"CET",
"CST6CDT",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Canada/Saskatchewan",
"Canada/Yukon",
"Chile/Continental",
"Chile/EasterIsland",
"Cuba",
"EET",
"EST5EDT",
"Egypt",
"Eire",
"Etc/GMT",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT-0",
"Etc/GMT-1",
"Etc/GMT-10",
"Etc/GMT-11",
"Etc/GMT-12",
"Etc/GMT-13",
"Etc/GMT-14",
"Etc/GMT-2",
"Etc/GMT-3",
"Etc/GMT-4",
"Etc/GMT-5",
"Etc/GMT-6",
"Etc/GMT-7",
"Etc/GMT-8",
"Etc/GMT-9",
"Etc/GMT0",
"Etc/Greenwich",
"Etc/UCT",
"Etc/UTC",
"Etc/Universal",
"Etc/Zulu",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belfast",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Nicosia",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Tiraspol",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GB",
"GB-Eire",
"GMT",
"GMT0",
"Greenwich",
"Hongkong",
"Iceland",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Iran",
"Israel",
"Jamaica",
"Japan",
"Kwajalein",
"Libya",
"MET",
"MST7MDT",
"Mexico/BajaNorte",
"Mexico/BajaSur",
"Mexico/General",
"NZ",
"NZ-CHAT",
"Navajo",
"PRC",
"PST8PDT",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Ponape",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Samoa",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Truk",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Yap",
"Poland",
"Portugal",
"ROK",
"Singapore",
"SystemV/AST4",
"SystemV/AST4ADT",
"SystemV/CST6",
"SystemV/CST6CDT",
"SystemV/EST5",
"SystemV/EST5EDT",
"SystemV/HST10",
"SystemV/MST7",
"SystemV/MST7MDT",
"SystemV/PST8",
"SystemV/PST8PDT",
"SystemV/YST9",
"SystemV/YST9YDT",
"Turkey",
"UCT",
"US/Alaska",
"US/Aleutian",
"US/Arizona",
"US/Central",
"US/East-Indiana",
"US/Eastern",
"US/Hawaii",
"US/Indiana-Starke",
"US/Michigan",
"US/Mountain",
"US/Pacific",
"US/Samoa",
"UTC",
"Universal",
"W-SU",
"WET",
"Zulu",
"EST",
"HST",
"MST",
"ACT",
"AET",
"AGT",
"ART",
"AST",
"BET",
"BST",
"CAT",
"CNT",
"CST",
"CTT",
"EAT",
"ECT",
"IET",
"IST",
"JST",
"MIT",
"NET",
"NST",
"PLT",
"PNT",
"PRT",
"PST",
"SST",
"VST"
]
},
"pageRootPaths":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetRootPaths":
{
"type": "array",
"items":
{
"type": "string"
}
},
"crawlAssets":
{
"type": "boolean"
},
"crawlPages":
{
"type": "boolean"
},
"pagePathInclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"pagePathExclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"pageNameInclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"pageNameExclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetPathInclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetPathExclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetTypeInclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetTypeExclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetNameInclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"assetNameExclusionPatterns":
{
"type": "array",
"items":
{
"type": "string"
}
},
"pageComponents": {
"type": "array",
"items": {
"type": "object"
}
},
"contentFragmentVariations": {
"type": "array",
"items": {
"type": "object"
}
},
"cugExemptedPrincipals": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required":
[]
},
"type": {
"type": "string",
"pattern": "AEM"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}Amazon FSx (Windows) 模板架构
您将包含包含数据源架构的 JSON 作为其中的一部分 TemplateConfiguration对象。您可以在连接配置或存储库端点详细信息中提供文件系统 ID。您还必须将数据源的类型指定为FSX、身份验证凭证的密钥以及其他必要的配置。然后，您可以指定TEMPLATE为 “Type何时拨打电话” CreateDataSource.
您可以使用本开发者指南中提供的模板。请参阅 Amazon FSx (Windows) JSON 架构。
下表描述了 Amazon FSx (Windows) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| fileSystemId | Amazon FSx 文件系统的标识符。您可以在控制台的 “文件系统” Amazon FSx 控制面板上找到您的文件系统 ID。 |
| fileSystemType | Amazon FSx 文件系统类型。要将 Windows File
Server 作为您的文件系统类型，请指定WINDOWS。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
| 全部 | 将 Amazon FSx 数据源中文件的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| isCrawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定用户和群组可以访问哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
| inclusionPatterns | 用于在 Amazon FSx 数据源中包含某些文件的正则表达式模式列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionPatterns | 用于排除 Amazon FSx 数据源中某些文件的正则表达式模式列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定在数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| type | 数据来源的类型。对于 Windows 文件系统数据源，请指定FSX。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"fileSystemId": {
"type": "string",
"pattern": "fs-.*"
},
"fileSystemType": {
"type": "string",
"pattern": "WINDOWS"
}
},
"required": ["fileSystemId", "fileSystemType"]
}
}
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"All": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": ["fieldMappings"]
}
},
"required": ["All"]
},
"additionalProperties": {
"type": "object",
"properties": {
"isCrawlAcl": {
"type": "boolean"
},
"exclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"type" : {
"type" : "string",
"pattern": "FSX"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"enableIdentityCrawler",
"additionalProperties",
"type"
]
}Amazon FSx (NetApp ONTAP) 模板架构
您将包含包含数据源架构的 JSON 作为其中的一部分 TemplateConfiguration对象。您可以在连接配置或存储库端点详细信息中提供文件系统 ID 和存储虚拟机 (SVM)。您还必须将数据源的类型指定为FSXONTAP、身份验证凭证的密钥以及其他必要的配置。然后，您可以指定TEMPLATE为 “Type何时拨打电话” CreateDataSource.
您可以使用本开发者指南中提供的模板。请参阅 Amazon FSx (NetApp ONTAP) JSON 架构。
下表描述了 Amazon FSx (NetApp ONTAP) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| 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，请参阅《FSx for ONTAP 用户指南》中的 NetApp ONTAP 入门指南。 |
| 协议类型 | 无论你使用适用于 Windows 的通用互联网文件系统 (CIFS) 协议，还是使用适用于 Linux 的网络文件系统 (NFS) 协议。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
| 文件 | 将 Amazon FSx 数据源中文件的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。数据源字段名称必须存在于您的文件自定义元数据中。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| crawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定用户和群组可以访问哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
| inclusionPatterns | 用于在 Amazon FSx 数据源中包含某些文件的正则表达式模式列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionPatterns | 用于排除 Amazon FSx 数据源中某些文件的正则表达式模式列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
| type | 数据来源的类型。对于 NetApp ONTAP 文件系统数据源，请指定FSXONTAP。 |
| syncMode |
指定在数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn |
包含连接到您的文件系统所需的键值对的 AWS Secrets Manager 密钥的 Amazon 资源名称 (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 架构。
下表描述了 Alfresco JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| siteId | Alfresco 站点的标识符。 |
| repoUrl | 你的网址 Alfresco 存储库。你可以从你那里获取存储库 URL Alfresco 管理员。例如，如果你使用 Alfresco 云端 (PaaS)，存储库的网址可能是 https://company.alfrescocloud.com。 或者，如果你使用 Alfresco 在本地，存储库 URL 可能是 https://company-alfresco-instance.company-domain.suffix:port. |
| webAppUrl | 你的网址 Alfresco 用户界面。你可以得到 Alfresco 来自你的用户界面 URL Alfresco 管理员。例如，用户界面 URL 可能是https://example.com。 |
| repositoryAdditionalProperties | 用于连接存储库/数据来源端点的其他属性。 |
| authType | 您使用的身份验证类型，可以是 OAuth2 或 Basic。 |
| type (deployment) | 的类型 Alfresco 你使用的，PAAS无论是ON-PREM。 |
| crawlType | 您要抓取的内容类型，是否ASPECT（标有 “Aspects” 的内容） Alfresco)、SITE_ID（特定内容中的内容 Alfresco 网站），或ALL_SITES（你所有内容中的内容 Alfresco 网站）。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将您的 Alfresco 文档和注释的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| aspectName |
要编制索引的特定“方面”的名称。 |
| aspectProperties |
要编制索引的特定“方面”内容属性的列表。 |
| enableFineGrained控件 |
如果为 |
| isCrawlComment |
|
|
包含某些文件的正则表达式模式列表 Alfresco 数据源。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
用于排除您中某些文件的正则表达式模式列表 Alfresco 数据源。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| type | 数据来源的类型。指定 ALFRESCO 作为数据来源类型。 |
| secretArn |
密钥的 Amazon 资源名称 (ARN)，其中包含连接到您的 AWS Secrets Manager 密钥所需的键值对 Alfresco。 密钥必须包含带有以下密钥的 JSON 结构： 如果使用基本身份验证： 如果使用 OAuth 2.0 身份验证： |
| syncMode |
指定在数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"siteId": {
"type": "string"
},
"repoUrl": {
"type": "string"
},
"webAppUrl": {
"type": "string"
},
"repositoryAdditionalProperties": {
"type": "object",
"properties": {
"authType": {
"type": "string",
"enum": [
"OAuth2",
"Basic"
]
},
"type": {
"type": "string",
"enum": [
"PAAS",
"ON_PREM"
]
},
"crawlType": {
"type": "string",
"enum": [
"ASPECT",
"SITE_ID",
"ALL_SITES"
]
}
}
}
}
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"aspectName": {
"type": "string"
},
"aspectProperties": {
"type": "array"
},
"enableFineGrainedControl": {
"type": "boolean"
},
"isCrawlComment": {
"type": "boolean"
},
"inclusionFileNamePatterns": {
"type": "array"
},
"exclusionFileNamePatterns": {
"type": "array"
},
"inclusionFileTypePatterns": {
"type": "array"
},
"exclusionFileTypePatterns": {
"type": "array"
},
"inclusionFilePathPatterns": {
"type": "array"
},
"exclusionFilePathPatterns": {
"type": "array"
}
}
},
"type": {
"type": "string",
"pattern": "ALFRESCO"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"type",
"secretArn"
]
}Aurora (MySQL) 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、mysql 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Aurora (MySQL) JSON 架构。
下表描述了 Aurora (MySQL) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 (PostgreSQL) 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、postgresql 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Aurora (PostgreSQL) JSON 架构。
下表描述了 (PostgreSQL Aurora ) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 （微软 SQL Server）模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、sqlserver 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Amazon RDS （微软 SQL Server）JSON 架构。
下表描述了 Amazon RDS （微软 SQL Server）JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Amazon RDS (MySQL) JSON 架构。
下表描述了 Amazon RDS (MySQL) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Amazon RDS (甲骨文) JSON 架构。
下表描述了 Amazon RDS (Oracle) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 (PostgreSQL) 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、postgresql 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Amazon RDS (PostgreSQL) JSON 架构。
下表描述了 (PostgreSQL Amazon RDS ) JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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，以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 S3 JSON 架构。
下表描述了 Amazon S3 JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| BucketName | 您的 Amazon S3 存储桶的名称。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
|
用于在 Amazon S3 数据源中包含或排除特定文件的正则表达式模式列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| aclConfigurationFile路径 | 控制对 Amazon Kendra 索引中文档的访问权限的文件路径。 |
| metadataFilesPrefix | 存储桶中存放元数据文件的位置。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| type | 数据来源的类型。指定 S3 作为数据来源类型。 |
| version | 支持的模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"BucketName": {
"type": "string"
}
},
"required": [
"BucketName"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"document": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING"
]
},
"dataSourceFieldName": {
"type": "string"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": [
"document"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionPatterns": {
"type": "array"
},
"exclusionPatterns": {
"type": "array"
},
"inclusionPrefixes": {
"type": "array"
},
"exclusionPrefixes": {
"type": "array"
},
"aclConfigurationFilePath": {
"type": "string"
},
"metadataFilesPrefix": {
"type": "string"
}
}
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL"
]
},
"type": {
"type": "string",
"pattern": "S3"
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"required": [
"connectionConfiguration",
"type",
"syncMode",
"repositoryConfigurations"
]
}Amazon Kendra Web Crawler 模板架构
您将包含包含数据源架构的 JSON 作为其中的一部分 TemplateConfiguration对象。
您可以提供种子或起点 URLs，也可以提供站点地图 URLs，作为连接配置或存储库端点详细信息的一部分。您可以提供存储种子 URLs 或站点地图 XML 文件列表的文本文件的 Amazon S3 存储桶路径，您可以在 S3 中将这些文件组合成一个 ZIP 文件，而不必手动列出所有文件。 URLs
您还可以将数据源的类型指定为WEBCRAWLERV2、网站身份验证凭证和身份验证类型（如果您的网站需要身份验证）以及其他必要的配置。
然后，您可以指定TEMPLATE为 “Type何时拨打电话” CreateDataSource.
重要
不支持 Web Crawler v2.0 连接器的创建。 AWS CloudFormation如果需要 AWS CloudFormation 支持，请使用 Web Crawler v1.0 连接器。
当选择要编制索引的网站时，您必须遵守 Amazon 可接受使用政策
您可以使用本开发者指南中提供的模板。请参阅 Amazon Kendra 网络爬虫 JSON 架构。
下表描述了 Amazon Kendra Web Crawler JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| siteMapUrls | 您要抓 URLs 取的网站的站点地图列表。您最多可以列出三个站点地图 URLs。 |
| s3 SeedUrl | 存储种子列表或起点列表的文本文件的 S3 路径 URLs。例如，s3://bucket-name/directory/。 文本文件中的每个 URL 都必须使用单独的行进行格式化。一个文件中最多可以列出 100 URLs 个种子。 |
| s3 SiteMapUrl | 站点地图 XML 文件的 S3 路径。例如，s3://bucket-name/directory/。 您最多可以列出三个站点地图 XML 文件。您可以将多个站点地图文件组合成一个 ZIP 文件，然后将 ZIP 文件存储在存储 Amazon S3 桶中。 |
| seedUrlConnections | 您要抓取的网站的种子列表或起点 URLs 列表。您最多可以列出 100 个种子。 URLs |
| seedUrl | 种子或起点 URL。 |
| 身份验证 | 如果您的网站需要相同的身份验证，则为身份验证类型，否则指定 NoAuthentication。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将网页和网页文件的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。例如，HTML 网页标题标签可以映射到 _document_title 索引字段。有关更多信息，请参阅映射数据来源字段。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| additionalProperties | 数据来源中内容的其他配置选项。 |
| rateLimit | 每位网站主机每分钟的最大 URLs 抓取次数。 |
| maxFileSize | 要爬取的网页或附件的最大大小（以 MB 为单位）。 |
| crawlDepth | 从种子 URL 爬取的层数。例如，种子 URL 页面的深度为 1，在该页面上同时爬取的所有超链接的深度都是 2。 |
| maxLinksPer网址 | 抓取网站时，网页 URLs 上要包含的最大数量。每个网页都有一个数字。当网站的网页被抓取时，网页链接到 URLs 的任何网页也会被抓取。 URLs 在网页上按出现顺序进行抓取。 |
| crawlSubDomain | true，爬取包含子域的网站域。例如，如果种子 URL 是”abc.example.com“，那么”a.abc.example.com" 和 "b.abc.example.com“也被爬行了。如果您未设置crawlSubDomain或 crawlAllDomaintrue，则 Amazon Kendra 只会抓取您要抓取的网站的域名。 |
| crawlAllDomain | true，爬取有子域的网站域和网页链接到的其他域。如果您未设置crawlSubDomain或 crawlAllDomaintrue，则 Amazon Kendra 只会抓取您要抓取的网站的域名。 |
| honorRobots | true，遵循您想要爬取的网站的 robots.txt 指令。这些指令控制 Amazon Kendra Web Crawler 如何抓取网站，无论是 Amazon Kendra 只能抓取特定内容还是不能抓取任何内容。 |
| crawlAttachments | true，爬取网页链接到的文件。 |
|
正则表达式模式列表，包括抓取这些 URL 网页上的某些超链接 URLs 和索引任何超链接。 URLs 与模式相匹配的包含在索引中。 URLs 与模式不匹配的将从索引中排除。如果 URL 同时匹配包含和排除模式，则以排除模式为优先，并且该 URL/网站的网页不会包含在索引中。 |
|
正则表达式模式列表，用于排除抓取这些 URL 网页上的某些超链接 URLs 和索引任何超链接。 URLs 与模式匹配的将从索引中排除。 URLs 与模式不匹配的包含在索引中。如果 URL 同时匹配包含和排除模式，则以排除模式为优先，并且该 URL/网站的网页不会包含在索引中。 |
| inclusionFileIndex图案 | 正则表达式模式的列表，用于包含某些网页文件。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionFileIndex图案 | 正则表达式模式的列表，用于排除某些网页文件。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| proxy | 通过 Web 代理连接到内部网站所需的配置信息。 |
| host | 您想要通过用于连接内部网站的代理服务器的主机名。例如，的主机名 https://a.example.com/page1.html是”a.example.com". |
| 端口 | 您想要用于连接内部网站的代理服务器的端口号。例如，443 是 HTTPS 的标准端口。 |
| secretArn（代理） | 如果需要网络代理凭据才能连接到网站主机，则可以创建一个存储凭据的 AWS Secrets Manager 密钥。为密钥提供 Amazon 资源名称（ARN）。 |
| type | 数据来源的类型。指定 WEBCRAWLERV2 作为数据来源类型。 |
| secretArn |
您的网站需要身份验证才能访问网站时使用的 AWS Secrets Manager 密钥的 Amazon 资源名称 (ARN)。网站的身份验证凭证存储在包含 JSON 键值对的密钥中。 如果您使用基本或 NTML/Kerberos 身份验证，请输入用户名和密码。密钥中的 JSON 键必须是 如果您使用 SAML 或表单身份验证，请输入用户名和密码、 XPath用户名字段（如果使用 SAML 则输入用户名按钮）、 XPaths 密码字段和按钮以及登录页面 URL。密钥中的 JSON 键必须是 Amazon Kendra 还会检查密钥中包含的端点信息（种子 URLs）是否与数据源终端节点配置详细信息中指定的端点信息相同。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"siteMapUrls": {
"type": "array",
"items":{
"type": "string",
"pattern": "https://.*"
}
},
"s3SeedUrl": {
"type": "string",
"pattern": "s3:.*"
},
"s3SiteMapUrl": {
"type": "string",
"pattern": "s3:.*"
},
"seedUrlConnections": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"seedUrl":{
"type": "string",
"pattern": "https://.*"
}
},
"required": [
"seedUrl"
]
}
]
},
"authentication": {
"type": "string",
"enum": [
"NoAuthentication",
"BasicAuth",
"NTLM_Kerberos",
"Form",
"SAML"
]
}
}
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"webPage": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"rateLimit": {
"type": "string",
"default": "300"
},
"maxFileSize": {
"type": "string",
"default": "50"
},
"crawlDepth": {
"type": "string",
"default": "2"
},
"maxLinksPerUrl": {
"type": "string",
"default": "100"
},
"crawlSubDomain": {
"type": "boolean",
"default": false
},
"crawlAllDomain": {
"type": "boolean",
"default": false
},
"honorRobots": {
"type": "boolean",
"default": false
},
"crawlAttachments": {
"type": "boolean",
"default": false
},
"inclusionURLCrawlPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionURLCrawlPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionURLIndexPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionURLIndexPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileIndexPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileIndexPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"proxy": {
"type": "object",
"properties": {
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
}
}
},
"required": [
"rateLimit",
"maxFileSize",
"crawlDepth",
"crawlSubDomain",
"crawlAllDomain",
"maxLinksPerUrl",
"honorRobots"
]
},
"type": {
"type": "string",
"pattern": "WEBCRAWLERV2"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"type",
"additionalProperties"
]
}Confluence 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以在连接配置或存储库端点详细信息中提供 Confluence 主机 URL、托管方法和身份验证类型。还要将数据来源的类型指定为 CONFLUENCEV2、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Confluence JSON 架构。
下表描述了 Confluence JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| hostUrl | 您的 Confluence 实例的 URL。例如，https://example.confluence.com。 |
| type | 您的 Confluence 实例的托管方法，可以是 SAAS 和 ON_PREM。 |
| authType | 您的 Confluence 实例的身份验证方法，可以是 Basic、OAuth2 或 Personal-token。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将您的 Confluence 空间、页面、博客、评论和附件的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。您的 Confluence 自定义元数据中必须有 Confluence 数据来源字段名称。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| isCrawlAcl | 如果您有 ACL true 并想将其用于访问控制，请将其配置为抓取文档的访问控制列表 (ACL) 信息。请注意，ACL 指定了用户和群组可以访问哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。这意味着，isCrawlACL如果将其关闭，则可以公开搜索文档。有关更多信息，请参阅用户上下文筛选。 |
| fieldForUser我是 | 指定email是否要使用用户电子邮件作为用户 ID。 email默认使用，并且是目前唯一支持的用户 ID 类型。 |
|
用于在 Confluence 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| proxyHost | 您使用的 Web 代理的主机名，不带http://或https://协议。 |
|
proxyPort |
主机 URL 传输协议使用的端口号。必须是介于 0 和 65535 之间的数值。 |
|
true抓取 Confluence 个人空间、页面、博客、页面评论、页面附件、博客评论和博客附件中的文件。 |
| maxFileSizeInMegaBytes | 在中指定 Amazon Kendra 可以爬 MBs 行的文件大小限制。 Amazon Kendra 仅抓取您定义的大小限制内的文件。默认文件大小为 50 MB。最大文件大小应大于 0 MB 且小于或等于 50 MB。 |
| type | 数据来源的类型。指定 CONFLUENCEV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode | 指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretARN | 包含连接您的 Confluence 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。有关这些键值对的信息，请参阅 Confluence 的连接说明。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "https:.*"
},
"type": {
"type": "string",
"enum": [
"SAAS",
"ON_PREM"
]
},
"authType": {
"type": "string",
"enum": [
"Basic",
"OAuth2",
"Personal-token"
]
}
},
"required": [
"hostUrl",
"type",
"authType"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"space": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"page": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"blog": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"usersAclS3FilePath": {
"type": "string"
},
"isCrawlAcl": {
"type": "boolean"
},
"fieldForUserId": {
"type": "string"
},
"inclusionSpaceKeyFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionSpaceKeyFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"pageTitleRegEX": {
"type": "array",
"items": {
"type": "string"
}
},
"blogTitleRegEX": {
"type": "array",
"items": {
"type": "string"
}
},
"commentTitleRegEX": {
"type": "array",
"items": {
"type": "string"
}
},
"attachmentTitleRegEX": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlPersonalSpace": {
"type": "boolean"
},
"isCrawlArchivedSpace": {
"type": "boolean"
},
"isCrawlArchivedPage": {
"type": "boolean"
},
"isCrawlPage": {
"type": "boolean"
},
"isCrawlBlog": {
"type": "boolean"
},
"isCrawlPageComment": {
"type": "boolean"
},
"isCrawlPageAttachment": {
"type": "boolean"
},
"isCrawlBlogComment": {
"type": "boolean"
},
"isCrawlBlogAttachment": {
"type": "boolean"
},
"maxFileSizeInMegaBytes": {
"type":"string"
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUrlPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionUrlPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"proxyHost": {
"type": "string"
},
"proxyPort": {
"type": "string"
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "CONFLUENCEV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}Dropbox 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您提供 Dropbox 应用程序键、应用程序密钥和访问令牌作为存储身份验证凭证的密钥的一部分。还要将数据来源的类型指定为 DROPBOX、要使用的访问令牌的类型（临时或永久）以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Dropbox JSON 模式。
下表描述了 Dropbox JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。此数据来源未在 repositoryEndpointMetadata 中指定端点。相反，连接信息包含在您提供的 AWS Secrets Manager 密钥中secretArn。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
映射您的 Dropbox 文件、Dropbox Paper 的属性或字段名称的对象列表，以及 Amazon Kendra 索引字段名称的快捷方式。有关更多信息，请参阅映射数据来源字段。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| secretARN | 包含连接您的 Dropbox 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须包含具有以下键的 JSON 结构： |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| isCrawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定用户和群组可以访问哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
|
用于在 Dropbox 数据来源中包含某些文件名和类型的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
用于在 Dropbox 数据来源中排除某些文件名和类型的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
true抓取 Dropbox、Dropbox Paper 文档、Dropbox Paper 模板和存储在 Dropbox 中的网页快捷方式中的文件。 |
| type | 数据来源的类型。指定 DROPBOX 作为数据来源类型。 |
| tokenType | 指定您的访问令牌类型：永久或临时访问令牌。建议您创建在 Dropbox 中永不过期的刷新访问令牌，而不是依赖在 4 小时后过期的一次性访问令牌。您可以在 Dropbox 开发者控制台中创建应用程序和刷新访问令牌，并在密钥中提供访问令牌。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
}
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"file": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"LONG",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"paper": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"LONG",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"papert": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"LONG",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"shortcut": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"LONG",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"secretArn": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"isCrawlAcl": {
"type": "boolean"
},
"inclusionFileNamePatterns": {
"type": "array"
},
"exclusionFileNamePatterns": {
"type": "array"
},
"inclusionFileTypePatterns": {
"type": "array"
},
"exclusionFileTypePatterns": {
"type": "array"
},
"crawlFile": {
"type": "boolean"
},
"crawlPaper": {
"type": "boolean"
},
"crawlPapert": {
"type": "boolean"
},
"crawlShortcut": {
"type": "boolean"
}
}
},
"type": {
"type": "string",
"pattern": "DROPBOX"
},
"tokenType": {
"type": "string",
"enum": [
"PERMANENT",
"TEMPORARY"
]
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"additionalProperties": false,
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"syncMode",
"enableIdentityCrawler",
"secretArn",
"type",
"tokenType"
]
}Drupal 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以在连接配置或存储库端点详细信息中提供 Drupal 主机 URL 和身份验证类型。还要将数据来源的类型指定为 DRUPAL、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Drupal JSON 架构。
下表描述了 Drupal JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| hostUrl | 您的 Drupal 网站的主机 URL。例如，https://<hostname>/<drupalsitename>。 |
| repositoryConfigurations | 数据来源内容的配置信息。 |
|
映射 Drupal 文件的属性或字段名称的对象的列表。有关更多信息，请参阅映射数据来源字段。您的 Drupal 自定义元数据中必须有 Drupal 数据来源字段名称。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
|
用于在 Drupal 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
用于在 Drupal 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
contentDefinitions
|
指定要爬取的内容类型以及是否爬取所选内容类型的评论和附件。 |
| type | 数据来源的类型。指定 DRUPAL 作为数据来源类型。 |
| authType | 您使用的身份验证类型，可以是 BASIC-AUTH 或 OAUTH2。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| secretARN | 包含连接您的 Drupal 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须包含具有以下键的 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、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 GitHub JSON 模式。
下表描述了 GitHub JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| type | 将类型指定为SAAS或ON_PREMISE。 |
| hostUrl | GitHub 主机网址。例如，如果您使用 GitHub SaaS/企业云：https://api.github.com。 或者，如果您使用 GitHub本地/企业服务器：https://on-prem-host-url/api/v3/. |
| organizationName | 登录到 GitHub 桌面并转到个人资料图片下拉列表下的 “您的组织” 时，可以找到您的组织名称。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 GitHub 内容的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| isCrawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定了用户和群组可以访问和搜索哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
| fieldForUser我是 | 指定要用于 ACL 搜索的用户 ID 的类型。指定是email要使用用户电子邮件作为用户 ID，还是username要使用用户名作为用户 ID。如果您未指定选项，email则默认使用该选项。 |
| repositoryFilter | 要编制索引的特定存储库和分支名称的列表。 |
| 抓取存储库 | true抓取存储库。 |
| crawlRepositoryDocuments | true以抓取存储库文档。 |
| crawlisSu | true抓取问题。 |
| crawlIssueComment | true搜寻问题评论。 |
| crawlIssueComment附件 | true搜寻议题评论附件。 |
| crawlPullRequest | true抓取拉取请求。 |
| crawlPullRequest评论 | true抓取拉取请求评论。 |
| crawlPullRequestCommentAttachment | true抓取拉取请求评论附件。 |
|
用于在 GitHub数据源中包含某些内容的正则表达式模式列表。与模式匹配的内容将包含在索引中。与模式不匹配的内容将从索引中排除。如果任何内容同时匹配包含和排除模式，则排除模式优先，该内容不会包含在索引中。 |
|
用于排除 GitHub数据源中某些内容的正则表达式模式列表。与模式匹配的内容将从索引中排除。与模式不匹配的内容将包含在索引中。如果任何内容同时匹配包含和排除模式，则排除模式优先，该内容不会包含在索引中。 |
| type | 数据来源的类型。指定 GITHUB 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn |
AWS Secrets Manager 密钥的 Amazon 资源名称 (ARN)，其中包含连接到您的所需的键值对。 GitHub密钥必须包含具有以下键的 JSON 结构： |
| version | 当前支持的此模板的版本。 |
以下是 GitHub JSON 架构：
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"hostUrl": {
"type": "string",
"pattern": "https://.*"
},
"organizationName": {
"type": "string"
}
},
"required": [
"type",
"hostUrl",
"organizationName"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"ghRepository": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghCommit": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueDocument": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghIssueAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRDocument": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"ghPRAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"isCrawlAcl": {
"type": "boolean"
},
"fieldForUserId": {
"type": "string"
},
"crawlRepository": {
"type": "boolean"
},
"crawlRepositoryDocuments": {
"type": "boolean"
},
"crawlIssue": {
"type": "boolean"
},
"crawlIssueComment": {
"type": "boolean"
},
"crawlIssueCommentAttachment": {
"type": "boolean"
},
"crawlPullRequest": {
"type": "boolean"
},
"crawlPullRequestComment": {
"type": "boolean"
},
"crawlPullRequestCommentAttachment": {
"type": "boolean"
},
"repositoryFilter": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"repositoryName": {
"type": "string"
},
"branchNameList": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"inclusionFolderNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFolderNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "GITHUB"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"enableIdentityCrawler"
]
}Gmail 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 GMAIL、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Gmail JSON 架构。
下表描述了 Gmail JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。此数据来源未在 repositoryEndpointMetadata 中指定端点。相反，连接信息包含在您提供的 AWS Secrets Manager 密钥中secretArn。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
将您的 Gmail 邮件和附件的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
|
用于在 Gmail 数据来源中包含或排除特定主题名称的正则表达式模式的列表。与模式匹配的文件将包含在索引中。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| beforeDateFilter | 指定包含特定日期之前的邮件和附件。 |
| afterDateFilter | 指定包含特定日期之后的邮件和附件。 |
| isCrawlAttachment | 一个布尔值，用于选择是否要爬取附件。自动爬取邮件。 |
| type | 数据来源的类型。指定 GMAIL 作为数据来源类型。 |
| shouldCrawlDraft 消息 | 一个布尔值，用于选择是否要爬取邮件草稿。 |
| syncMode | 指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
重要由于没有用于更新永久删除的 Gmail 邮件的 API，因此任何新的、修改过的或删除的内容都会同步：
要将您的 Gmail 数据源标签更改和永久删除的电子邮件同步到您的 Amazon Kendra 索引，您必须定期进行全面抓取。 |
| secretARN | 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"
]
}Google Drive 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 GOOGLEDRIVE2、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Google Drive JSON 架构。
下表描述了 Google 云端硬盘 JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 数据来源的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。此数据来源未指定端点。您可以选择身份验证类型：serviceAccount 和 OAuth2。连接信息包含在您提供的 AWS Secrets Manager 密钥中secretArn。 |
| authType | 根据您的使用案例，选择 serviceAccount 或 OAuth2。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 Google Drive 的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象的列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
|
在中指定 Amazon Kendra 应爬 MBs 行的文件大小限制。 |
|
true抓取您的 Google 云端硬盘数据源中的评论。 |
|
true在您的 Google 云端硬盘数据源中抓取 MyDrive 并与我共享云端硬盘。 |
|
true在您的 Google 云端硬盘数据源中抓取共享云端硬盘。 |
| isCrawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定了用户和群组可以访问和搜索哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
|
用于在 Google Drive 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
用于在 Google Drive 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| type | 数据来源的类型。指定 GOOOGLEDRIVEV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretARN | 包含连接您的 Google 云端硬盘所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须包含具有以下键的 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"
]
}IBM DB2 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、db2 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 IBM DB2 杰森架构。
下表描述了 IBM DB2 JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 Exchange 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以将租户 ID 作为连接配置或存储库端点详细信息的一部分提供。还要将数据来源的类型指定为 MSEXCHANGE、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Microsoft Exchange JSON 架构。
下表描述了微软 Exchange JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| tenantId | Microsoft 365 租户 ID。你可以在 Azure Active Directory 门户的属性或 OAuth 应用程序中找到你的租户 ID。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将你的 Microsoft Exchange 数据源的属性或字段名称映射到 Amazon Kendra 索引字段的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
| inclusionPatterns | 用于在 Microsoft Exchange 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionPatterns | 用于在 Microsoft Exchange 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
用于在 Microsoft Exchange 数据来源中包含某些用户的正则表达式模式的列表。与模式匹配的用户将包含在索引中。与模式不匹配的用户将从索引中排除。如果用户同时匹配包含和排除模式，则以排除模式为优先，该用户不会包含在索引中。 |
|
用于在 Microsoft Exchange 数据来源中排除某些用户和用户文件的正则表达式模式的列表。与模式匹配的用户将从索引中排除。与模式不匹配的用户将包含在索引中。如果用户同时匹配排除和包含模式，则以排除模式为优先，该用户不会包含在索引中。 |
| s3bucketName | S3 存储桶的名称（如果要使用）。 |
|
true抓取这些类型的内容和访问控制信息你的 Microsoft Exchange 数据源。 |
| startCalendarDate时间 | 您可以为日历内容配置特定的开始日期时间。 |
| endCalendarDate时间 | 您可以为日历内容配置特定的结束日期时间。 |
| subject | 您可以为邮件内容配置特定的主题行。 |
| emailFrom | 您可以为“发件人”或发件人邮件内容配置特定的电子邮件。 |
| emailTo | 您可以为“收件人”或收件人邮件内容配置特定的电子邮件。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| type | 数据来源的类型。指定 MSEXCHANGE 作为数据来源类型。 |
| secretARN | 包含连接微软 Exchange 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。这包括你的客户端 ID 和在 Azure 门户中创建 OAuth应用程序时生成的客户端密钥。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
"required": ["tenantId"]
}
}
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"email": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "DATE","LONG"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"calendar": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"contacts": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"notes": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
},
"required": ["email"
]
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionPatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUsersList": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"exclusionUsersList": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"s3bucketName": {
"type": "string"
},
"inclusionUsersFileName": {
"type": "string"
},
"exclusionUsersFileName": {
"type": "string"
},
"inclusionDomainUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionDomainUsers": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlCalendar": {
"type": "boolean"
},
"crawlNotes": {
"type": "boolean"
},
"crawlContacts": {
"type": "boolean"
},
"crawlFolderAcl": {
"type": "boolean"
},
"startCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"endCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"subject": {
"type": "array",
"items": {
"type": "string"
}
},
"emailFrom": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
},
"emailTo": {
"type": "array",
"items": {
"type": "string",
"format": "email"
}
}
},
"required": [
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"type" : {
"type" : "string",
"pattern": "MSEXCHANGE"
},
"secretArn": {
"type": "string"
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
微软 OneDrive 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以将 租户 ID 作为连接配置或存储库端点详细信息的一部分提供。还要将数据来源的类型指定为 ONEDRIVEV2、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 微软 OneDrive JSON 架构。
下表描述了微软 OneDrive JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| tenantId | Microsoft 365 租户 ID。你可以在 Azure Active Directory 门户的属性或 OAuth 应用程序中找到你的租户 ID。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
| 文件 | 将你的 Microsoft OneDrive 文件的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
|
您可以选择为特定文件、 OneNote 章节、 OneNote 页面编制索引，并按用户名进行筛选。 |
| isUserNameonS3 | true 提供存储在 Amazon S3的文件中的用户名列表。 |
| type | 数据来源的类型。指定 ONEDRIVEV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| type | 数据来源的类型。指定 ONEDRIVEV2 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretARN | 包含连接微软所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。 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"
]
}微软 SharePoint 模板架构
您将包含包含数据源架构的 JSON 作为TemplateConfiguration对象的一部分。在连接配置或存储库端点URLs详细信息中，您可以提供 SharePoint 站点 URL/、域以及租户 ID（如果需要）。还要将数据来源的类型指定为 SHAREPOINTV2、身份验证凭证的密钥以及其他必要的配置。然后在呼叫时指定TEMPLATE为 “类型” CreateDataSource。
您可以使用本开发者指南中提供的模板。请参阅 SharePoint JSON 模式。
下表描述了微软 SharePoint JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息 |
| repositoryEndpointMetadata | 数据来源的端点信息 |
| tenantId | 您 SharePoint 账户的租户 ID。 |
| 域 | 您 SharePoint 账户的域名。 |
| siteUrls | 您的 SharePoint 账户 URLs 的主机。 |
| repositoryAdditionalProperties | 用于连接存储库/数据来源端点的其他属性。 |
| s3bucketName | 存储 Azure AD 自签名 X.509 证书的 Amazon S3 存储桶的名称。 |
| s3certificateName | 存储在存储桶中的 Azure AD 自签名 X.509 证书的名称。 Amazon S3 |
| authType | 您使用的身份验证类型，是OAuth2、OAuth2Certificate、OAuth2App、Basic、OAuth2_RefreshTokenNTLM、或Kerberos。 |
| version | 您使用的 SharePoint 版本，Server无论是Online。 |
| onPremVersion | 您使用的 SharePoint 服务器版本，是201320162019、或SubscriptionEdition。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 SharePoint内容的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
|
用于在 SharePoint 数据源中包含/排除某些内容的正则表达式模式列表。与包含模式相匹配的内容项目包含在索引中。与包含模式不匹配的内容项将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
true来抓取这些类型的内容。 |
| crawlAcl | true如果您有 ACL 并想将其用于访问控制，则可以抓取文档的访问控制列表 (ACL) 信息。ACL 指定了用户和群组可以访问和搜索哪些文档。ACL 信息用于根据用户或用户组对文档的访问权限来筛选搜索结果。有关更多信息，请参阅用户上下文筛选。 |
| fieldForUser我是 | 指定是email要使用用户电子邮件作为用户 ID，还是userPrincipalName要使用用户名作为用户 ID。如果您未指定选项，email则默认使用该选项。 |
| aclConfiguration | 指定ACLWithLDAPEmailFmtACLWithManualEmailFmt、或ACLWithUsernameFmtM。 |
| emailDomain | 电子邮件的域名。例如，“amazon.com”。 |
|
true以搜寻群组映射信息。 |
| proxyHost | 您使用的网络代理的主机名，不带 http://或 https://协议。 |
| proxyPort | 主机 URL 传输协议使用的端口号。必须是介于 0 和 65535 之间的数值。 |
| type | 指定 SHAREPOINTV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretARN | AWS Secrets Manager 密钥的 Amazon 资源名称 (ARN)，其中包含连接到您的所需的键值对。 SharePoint有关这些键值对的信息，请参阅 On SharePoint line 和 SharePoint Server 的连接说明。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
},
"domain": {
"type": "string"
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"pattern": "https://.*"
}
},
"repositoryAdditionalProperties": {
"type": "object",
"properties": {
"s3bucketName": {
"type": "string"
},
"s3certificateName": {
"type": "string"
},
"authType": {
"type": "string",
"enum": [
"OAuth2",
"OAuth2Certificate",
"OAuth2App",
"Basic",
"OAuth2_RefreshToken",
"NTLM",
"Kerberos"
]
},
"version": {
"type": "string",
"enum": [
"Server",
"Online"
]
},
"onPremVersion": {
"type": "string",
"enum": [
"",
"2013",
"2016",
"2019",
"SubscriptionEdition"
]
}
},
"required": [
"authType",
"version"
]
}
},
"required": [
"siteUrls",
"domain",
"repositoryAdditionalProperties"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"page": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"file": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"link": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"comment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"eventTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"pageTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"linkTitleFilterRegEx": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFilePath": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFilePath": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"crawlFiles": {
"type": "boolean"
},
"crawlPages": {
"type": "boolean"
},
"crawlEvents": {
"type": "boolean"
},
"crawlComments": {
"type": "boolean"
},
"crawlLinks": {
"type": "boolean"
},
"crawlAttachments": {
"type": "boolean"
},
"crawlListData": {
"type": "boolean"
},
"crawlAcl": {
"type": "boolean"
},
"fieldForUserId": {
"type": "string"
},
"aclConfiguration": {
"type": "string",
"enum": [
"ACLWithLDAPEmailFmt",
"ACLWithManualEmailFmt",
"ACLWithUsernameFmt"
]
},
"emailDomain": {
"type": "string"
},
"isCrawlLocalGroupMapping": {
"type": "boolean"
},
"isCrawlAdGroupMapping": {
"type": "boolean"
},
"proxyHost": {
"type": "string"
},
"proxyPort": {
"type": "string"
}
},
"required": [
]
},
"type": {
"type": "string",
"pattern": "SHAREPOINTV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"enableIdentityCrawler",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}Microsoft SQL Server 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、sqlserver 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Microsoft SQL Server JSON 架构。
下表描述了 Micorosft SQL Server JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 Teams 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以将租户 ID 作为连接配置或存储库端点详细信息的一部分提供。还要将数据来源的类型指定为 MSTEAMS、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Microsoft Teams JSON 架构。
下表描述了微软 Teams JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| tenantId | Microsoft 365 租户 ID。你可以在 Azure Active Directory 门户的属性或 OAuth 应用程序中找到你的租户 ID。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将你的 Microsoft Teams 内容的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| paymentModel | 指定用于您的 Microsoft Teams 数据来源的支付模式类型。A 型支付模式仅限于需要安全合规的许可和支付模式。B 型支付模式适用于不需要安全合规的许可和支付模式。 |
|
用于在 Microsoft Teams 数据来源中包含某些内容的正则表达式模式的列表。与模式匹配的内容将包含在索引中。与模式不匹配的内容将从索引中排除。如果内容同时匹配包含和排除模式，则以排除模式为优先，该内容不会包含在索引中。 |
|
用于在 Microsoft Teams 数据来源中排除某些内容的正则表达式模式的列表。与模式匹配的内容将从索引中排除。与模式不匹配的内容将包含在索引中。如果内容同时匹配包含和排除模式，则以排除模式为优先，该内容不会包含在索引中。 |
|
true在你的 Microsoft Teams 数据源中抓取这些类型的内容。 |
| startCalendarDate时间 | 您可以为日历内容配置特定的开始日期时间。 |
| endCalendarDate时间 | 您可以为日历内容配置特定的结束日期时间。 |
| type | 数据来源的类型。指定 MSTEAMS 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)，其中包含连接你的 Microsoft Teams 所需的键值对。这包括你在 Azure 门户中创建 OAuth 应用程序时生成的客户端 ID 和客户端密钥。 |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"tenantId": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"minLength": 36,
"maxLength": 36
}
},
"required": [
"tenantId"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"chatMessage": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"chatAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelPost": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelWiki": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"channelAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingChat": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingFile": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"LONG"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"meetingNote": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"calendarMeeting": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"paymentModel": {
"type": "string",
"enum": [
"A",
"B",
"Evaluation Mode"
]
},
"inclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionTeamNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionChannelNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionUserEmailFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNoteSectionNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionOneNotePageNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlChatMessage": {
"type": "boolean"
},
"isCrawlChatAttachment": {
"type": "boolean"
},
"isCrawlChannelPost": {
"type": "boolean"
},
"isCrawlChannelAttachment": {
"type": "boolean"
},
"isCrawlChannelWiki": {
"type": "boolean"
},
"isCrawlCalendarMeeting": {
"type": "boolean"
},
"isCrawlMeetingChat": {
"type": "boolean"
},
"isCrawlMeetingFile": {
"type": "boolean"
},
"isCrawlMeetingNote": {
"type": "boolean"
},
"startCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
},
"endCalendarDateTime": {
"anyOf": [
{
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
},
{
"type": "string",
"pattern": ""
}
]
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "MSTEAMS"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}Microsoft Yammer 模板架构
您将包含包含数据源架构的 JSON 作为TemplateConfiguration对象的一部分。将数据来源的类型指定为 YAMMER、身份验证凭证的密钥以及其他必要的配置。然后在呼叫时指定TEMPLATE为 “类型” CreateDataSource。
您可以使用本开发者指南中提供的模板。
下表描述了微软 Yammer JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 数据来源的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。此数据来源未在 repositoryEndpointMetadata 中指定端点。相反，连接信息包含在您提供的 AWS Secrets Manager 密钥中secretArn。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 Microsoft Yammer 内容的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象的列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
| inclusionPatterns | 用于在 Microsoft Yammer 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionPatterns | 用于在 Microsoft Yammer 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
| sinceDate | 您可以选择配置一个 sinceDate 参数，以便 Microsoft Yammer 连接器根据特定的 sinceDate 爬取内容。 |
| communityNameFilter | 您可以选择将特定的社区内容编入索引。 |
|
true抓取消息、邮件附件和私人消息。 |
| type | 指定 YAMMER 作为数据来源类型。 |
| secretARN | AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)，其中包含连接你的 Microsoft Yammer 所需的键值对。这包括你的 Microsoft Yammer 用户名和密码，以及在 Azure 门户中创建 OAuth 应用程序时生成的客户端 ID 和客户端密钥。 |
| useChangeLog | true使用 Microsoft Yammer 更改日志来确定索引中哪些文档需要更新。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
}
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"community": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"user": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"message": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"inclusionPatterns": {
"type": "array"
},
"exclusionPatterns": {
"type": "array"
},
"sinceDate": {
"type": "string",
"pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$"
},
"communityNameFilter": {
"type": "array",
"items": {
"type": "string"
}
},
"isCrawlMessage": {
"type": "boolean"
},
"isCrawlAttachment": {
"type": "boolean"
},
"isCrawlPrivateMessage": {
"type": "boolean"
}
},
"required": [
"sinceDate"
]
},
"type": {
"type": "string",
"pattern": "YAMMER"
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
},
"useChangeLog": {
"type": "string",
"enum": [
"true",
"false"
]
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL",
"CHANGE_LOG"
]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
}
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"type",
"secretArn",
"syncMode"
]
}MySQL 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、mysql 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 MySQL JSON 架构。
下表描述了 MySQL JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 Database 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。将数据来源的类型指定为 JDBC、oracle 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Oracle Database JSON 架构。
下表介绍了 Oracle 数据库 JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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 的数据库类型、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 PostgreSQL JSON 架构。
下表描述了 PostgreSQL JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 连接数据来源所需的配置信息。
|
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。指定数据来源的类型和密钥 ARN。 |
|
文档 |
将数据库内容的属性或字段名映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| additionalProperties | 数据来源中内容的其他配置选项。用于在数据库数据来源中包含或排除特定内容。 |
| primaryKey | 提供数据库表的主键。这将标识数据库中的表。 |
| titleColumn | 提供数据库表中文档标题列的名称。 |
| bodyColumn | 提供数据库表中文档标题列的名称。 |
| sqlQuery | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| timestampColumn | 输入包含时间戳的列的名称。 Amazon Kendra 使用时间戳信息来检测内容的变化并仅同步已更改的内容。 |
| timestampFormat | 输入列的名称，该列包含用于检测内容更改和重新同步内容的时间戳格式。 |
| timezone | 输入列的名称，该列包含要搜索的内容的时区。 |
| changeDetectingColumns | 输入 Amazon Kendra 将用于检测内容更改的列的名称。 Amazon Kendra 当其中任何一列发生变化时，将重新索引内容 |
| allowedUsersColumns | 输入包含允许用户访问内容 IDs 的列的名称。 |
| allowedGroupsColumn | 输入包含允许用户访问内容 IDs 的列的名称。 |
| 来源 URIColumn | 输入包含要编制索引的来源 URLs 的列的名称。 |
| isSslEnabled | 输入 SQL 查询语句，例如 SELECT 和 JOIN 操作。SQL 查询必须小于 32KB。 Amazon Kendra 将抓取与您的查询相匹配的所有数据库内容。 |
| type | 数据来源的类型。指定 JDBC 作为数据来源类型。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretArn | 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"
]
}Salesforce 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以将 Salesforc 主机 URL 作为连接配置或存储库端点详细信息的一部分提供。还要将数据来源的类型指定为 SALESFORCEV2、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Salesforce JSON 架构。
下表描述了 Salesforce JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| hostUrl | 要编制索引的 Salesforce 实例的 URL。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将您的 Salesforce 实体的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象列表。有关更多信息，请参阅映射数据来源字段。 |
| secretARN | 包含连接您的 Salesforce 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须包含具有以下键的 JSON 结构： |
| additionalProperties | 数据来源中内容的其他配置选项 |
|
一组字符串，用于指定要筛选的实体。 |
inclusionPatterns
|
用于在 Salesforce 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
exclusionPatterns
|
用于在 Salesforce 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
true在你的 Salesforce 账户中抓取这些类型的文件。 |
| type | 数据来源的类型。指定 SALESFORCEV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties":
{
"connectionConfiguration": {
"type": "object",
"properties":
{
"repositoryEndpointMetadata":
{
"type": "object",
"properties":
{
"hostUrl":
{
"type": "string",
"pattern": "https:.*"
}
},
"required":
[
"hostUrl"
]
}
},
"required":
[
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties":
{
"account":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"contact":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"campaign":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"case":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"product":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"lead":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"contract":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"partner":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"profile":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"idea":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"pricebook":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"task":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"solution":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"attachment":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"user":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"document":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"knowledgeArticles":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"group":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"opportunity":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE",
"LONG"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"chatter":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
},
"customEntity":
{
"type": "object",
"properties":
{
"fieldMappings":
{
"type": "array",
"items":
[
{
"type": "object",
"properties":
{
"indexFieldName":
{
"type": "string"
},
"indexFieldType":
{
"type": "string",
"enum":
[
"STRING",
"STRING_LIST",
"DATE"
]
},
"dataSourceFieldName":
{
"type": "string"
},
"dateFieldFormat":
{
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required":
[
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required":
[
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties":
{
"accountFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"contactFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"caseFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"campaignFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"contractFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"groupFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"leadFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"productFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"opportunityFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"partnerFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"pricebookFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"ideaFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"profileFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"taskFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"solutionFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"userFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"chatterFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"documentFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"knowledgeArticleFilter":{
"type": "array",
"items":
{
"type": "string"
}
},
"customEntities":{
"type": "array",
"items":
{
"type": "string"
}
},
"isCrawlAccount": {
"type": "boolean"
},
"isCrawlContact": {
"type": "boolean"
},
"isCrawlCase": {
"type": "boolean"
},
"isCrawlCampaign": {
"type": "boolean"
},
"isCrawlProduct": {
"type": "boolean"
},
"isCrawlLead": {
"type": "boolean"
},
"isCrawlContract": {
"type": "boolean"
},
"isCrawlPartner": {
"type": "boolean"
},
"isCrawlProfile": {
"type": "boolean"
},
"isCrawlIdea": {
"type": "boolean"
},
"isCrawlPricebook": {
"type": "boolean"
},
"isCrawlDocument": {
"type": "boolean"
},
"crawlSharedDocument": {
"type": "boolean"
},
"isCrawlGroup": {
"type": "boolean"
},
"isCrawlOpportunity": {
"type": "boolean"
},
"isCrawlChatter": {
"type": "boolean"
},
"isCrawlUser": {
"type": "boolean"
},
"isCrawlSolution":{
"type": "boolean"
},
"isCrawlTask":{
"type": "boolean"
},
"isCrawlAccountAttachments": {
"type": "boolean"
},
"isCrawlContactAttachments": {
"type": "boolean"
},
"isCrawlCaseAttachments": {
"type": "boolean"
},
"isCrawlCampaignAttachments": {
"type": "boolean"
},
"isCrawlLeadAttachments": {
"type": "boolean"
},
"isCrawlContractAttachments": {
"type": "boolean"
},
"isCrawlGroupAttachments": {
"type": "boolean"
},
"isCrawlOpportunityAttachments": {
"type": "boolean"
},
"isCrawlChatterAttachments": {
"type": "boolean"
},
"isCrawlSolutionAttachments":{
"type": "boolean"
},
"isCrawlTaskAttachments":{
"type": "boolean"
},
"isCrawlCustomEntityAttachments":{
"type": "boolean"
},
"isCrawlKnowledgeArticles": {
"type": "object",
"properties":
{
"isCrawlDraft": {
"type": "boolean"
},
"isCrawlPublish": {
"type": "boolean"
},
"isCrawlArchived": {
"type": "boolean"
}
}
},
"inclusionDocumentFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionDocumentFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionDocumentFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionDocumentFileNamePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionAccountFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionAccountFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionAccountFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionAccountFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCampaignFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCampaignFileTypePatterns": {
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCampaignFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCampaignFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCaseFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCaseFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCaseFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCaseFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContactFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContactFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContactFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContactFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContractFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContractFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionContractFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionContractFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionLeadFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionLeadFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionLeadFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionLeadFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionOpportunityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionOpportunityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionOpportunityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionOpportunityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionSolutionFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionSolutionFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionSolutionFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionSolutionFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionTaskFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionTaskFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionTaskFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionTaskFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionGroupFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionGroupFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionGroupFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionGroupFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionChatterFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionChatterFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionChatterFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionChatterFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCustomEntityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCustomEntityFileTypePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"inclusionCustomEntityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
},
"exclusionCustomEntityFileNamePatterns":{
"type": "array",
"items":
{
"type": "string"
}
}
},
"required":
[]
},
"enableIdentityCrawler": {
"type": "boolean"
},
"type": {
"type": "string",
"pattern": "SALESFORCEV2"
},
"syncMode": {
"type": "string",
"enum": [
"FULL_CRAWL",
"FORCED_FULL_CRAWL",
"CHANGE_LOG"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}ServiceNow 模板架构
您可以将包含数据来源架构的 JSON 作为 TemplateConfiguration 对象的一部分。您可以在连接配置或存储库端点详细信息中提供 ServiceNow 主机 URL、身份验证类型和实例版本。还要将数据来源的类型指定为 SERVICENOWV2、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 ServiceNow JSON 模式。
下表描述了 ServiceNow JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| hostUrl | ServiceNow 主机网址。例如，your-domain.service-now.com。 |
| authType | 您使用的身份验证类型，可以是 basicAuth 或 OAuth2。 |
| servicenowInstanceVersion | 您使用的 ServiceNow 版本。您可以在Tokyo、SandiegoRome、和之间进行选择Others。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 ServiceNow知识文章、附件、服务目录和事件的属性或字段名称映射到 Amazon Kendra 索引字段名的对象列表。有关更多信息，请参阅映射数据来源字段。 ServiceNow 数据源字段名称必须存在于您的 ServiceNow 自定义元数据中。 |
| 其他属性 | 数据来源中内容的其他配置选项。 |
| maxFileSizeInMegaBytes | 指定 Amazon Kendra 将抓取的文件大小限制。 MBs Amazon Kendra 只会抓取您定义的大小限制范围内的文件。默认文件大小为 50 MB。最大文件大小应大于 0 MB 且小于或等于 50 MB。 |
|
用于在 ServiceNow 数据源中包含和/或排除某些文件的正则表达式模式列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
true搜寻 ServiceNow 知识文章、服务目录、事件和附件。 |
| type | 数据来源的类型。指定 SERVICENOWV2 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| syncMode | 指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| secretARN | AWS Secrets Manager 密钥的 Amazon 资源名称 (ARN)，其中包含连接到您的所需的键值对。 ServiceNow密钥必须包含具有以下键的 JSON 结构： |
| version | 当前支持的此模板的版本。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$",
"minLength": 1,
"maxLength": 2048
},
"authType": {
"type": "string",
"enum": [
"basicAuth",
"OAuth2"
]
},
"servicenowInstanceVersion": {
"type": "string",
"enum": [
"Tokyo",
"Sandiego",
"Rome",
"Others"
]
}
},
"required": [
"hostUrl",
"authType",
"servicenowInstanceVersion"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"knowledgeArticle": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"attachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"LONG",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"serviceCatalog": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
},
"incident": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": [
"STRING",
"DATE",
"STRING_LIST"
]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
},
"required": [
"fieldMappings"
]
}
}
},
"additionalProperties": {
"type": "object",
"properties": {
"maxFileSizeInMegaBytes": {
"type": "string"
},
"isCrawlKnowledgeArticle": {
"type": "boolean"
},
"isCrawlKnowledgeArticleAttachment": {
"type": "boolean"
},
"includePublicArticlesOnly": {
"type": "boolean"
},
"knowledgeArticleFilter": {
"type": "string"
},
"incidentQueryFilter": {
"type": "string"
},
"serviceCatalogQueryFilter": {
"type": "string"
},
"isCrawlServiceCatalog": {
"type": "boolean"
},
"isCrawlServiceCatalogAttachment": {
"type": "boolean"
},
"isCrawlActiveServiceCatalog": {
"type": "boolean"
},
"isCrawlInactiveServiceCatalog": {
"type": "boolean"
},
"isCrawlIncident": {
"type": "boolean"
},
"isCrawlIncidentAttachment": {
"type": "boolean"
},
"isCrawlActiveIncident": {
"type": "boolean"
},
"isCrawlInactiveIncident": {
"type": "boolean"
},
"applyACLForKnowledgeArticle": {
"type": "boolean"
},
"applyACLForServiceCatalog": {
"type": "boolean"
},
"applyACLForIncident": {
"type": "boolean"
},
"incidentStateType": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Open",
"Open - Unassigned",
"Resolved",
"All"
]
}
},
"knowledgeArticleTitleRegExp": {
"type": "string"
},
"serviceCatalogTitleRegExp": {
"type": "string"
},
"incidentTitleRegExp": {
"type": "string"
},
"inclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileTypePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"inclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
},
"exclusionFileNamePatterns": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": []
},
"type": {
"type": "string",
"pattern": "SERVICENOWV2"
},
"enableIdentityCrawler": {
"type": "boolean"
},
"syncMode": {
"type": "string",
"enum": [
"FORCED_FULL_CRAWL",
"FULL_CRAWL"
]
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"syncMode",
"additionalProperties",
"secretArn",
"type"
]
}
Slack 模板架构
您将包含包含数据源架构的 JSON 作为TemplateConfiguration对象的一部分。您可以将主机 URL 作为连接配置或存储库端点详细信息的一部分提供。还要将数据来源的类型指定为 SLACK、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 松弛 JSON 架构。
下表描述了 Slack JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| teamID | 你从 Slack 主页网址中复制的 Slack 团队编号。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
| 全部 | 映射您的属性或字段名称的对象列表 Slack Amazon Kendra 索引字段名称的内容。 |
| additionalProperties | 数据来源中内容的其他配置选项。 |
| inclusionPatterns | 包含特定内容的正则表达式模式列表 Slack 数据源。与模式匹配的内容将包含在索引中。与模式不匹配的内容将从索引中排除。如果任何内容同时匹配包含和排除模式，则排除模式优先，该内容不会包含在索引中。 |
| exclusionPatterns | 用于排除您的特定内容的正则表达式模式列表 Slack 数据源。与模式匹配的内容将从索引中排除。与模式不匹配的内容包含在索引中。如果任何内容同时匹配包含和排除模式，则排除模式优先，该内容不会包含在索引中。 |
| crawlBotMessages | true抓取机器人消息。 |
| 排除已存档 | true以排除对存档邮件的抓取。 |
| 对话类型 | 您要索引的对话类型PUBLIC_CHANNEL，是否为PRIVATE_CHANNEL、GROUP_MESSAGE和DIRECT_MESSAGE。 |
| 频道过滤器 | 您要编制索引的通道的类型，可以为 private_channel 或 public_channel。 |
| sinceDate | 您可以选择配置sinceDate参数，以便 Slack 连接器根据特定sinceDate内容抓取内容。 |
| 回顾 | 您可以选择配置lookBack参数，以便 Slack 连接器会在连接器上次同步之前的指定小时数内抓取已更新或已删除的内容。 |
| syncMode |
指定数据源内容发生变化时 Amazon Kendra 应如何更新索引。您可以选择：
|
| type | 数据来源的类型。指定 SLACK 作为数据来源类型。 |
| enableIdentityCrawler | true使用 Amazon Kendra身份搜寻器同步有权访问某些文档的用户和群组的身份/主体信息。如果身份搜寻器已关闭，则可以公开搜索所有文档。如果您想对文档使用访问控制并且身份搜寻器已关闭，则可以使用 PutPrincipalMapping用于上传用户和群组访问信息的 API。 |
| secretArn |
密钥的亚马逊资源名称 (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、身份验证凭证的密钥以及其他必要的配置。然后，当您 CreateDataSource 时，您可以将 TEMPLATE 指定为 Type。
您可以使用本开发者指南中提供的模板。请参阅 Zendesk JSON 架构。
下表描述了 Zendesk JSON 架构的参数。
| 配置 | 描述 |
|---|---|
| connectionConfiguration | 有关数据来源端点的配置信息。 |
| repositoryEndpointMetadata | 数据来源的端点信息。 |
| hostURL | Zendesk 主机 URL。例如，https://yoursubdomain.zendesk.com。 |
| repositoryConfigurations | 数据来源内容的配置信息。例如，配置特定类型的内容和字段映射。 |
|
将 Zendesk 工单的属性或字段名称映射到 Amazon Kendra 索引字段名称的对象的列表。有关更多信息，请参阅映射数据来源字段。 |
| secretARN | 包含连接到 Zendesk 所需的键值对的 AWS Secrets Manager 密钥的亚马逊资源名称 (ARN)。密钥必须包含具有以下键的 JSON 结构：主机 URL、客户端 ID、客户端密钥、用户名和密码。 |
| additionalProperties | 数据来源中内容的其他配置选项 |
| organizationNameFilter | 您可以选择为特定组织中存在的工单编制索引。 |
| sinceDate | 您可以选择配置一个 sinceDate 参数，以便 Zendesk 连接器根据特定的 sinceDate 爬取内容。 |
| inclusionPatterns | 用于在 Zendesk 数据来源中包含某些文件的正则表达式模式的列表。与模式匹配的文件将包含在索引中。与模式不匹配的文件将从索引中排除。如果文件同时匹配包含和排除模式，则以排除模式为优先，该文件不会包含在索引中。 |
| exclusionPatterns | 用于在 Zendesk 数据来源中排除某些文件的正则表达式模式的列表。与模式匹配的文件将从索引中排除。与模式不匹配的文件将包含在索引中。如果文件同时匹配排除和包含模式，则以排除模式为优先，该文件不会包含在索引中。 |
|
输入 “true” 可抓取这些类型的内容。 |
| type | 指定 ZENDESK 作为数据来源类型。 |
| useChangeLog | 输入 “true” 以使用 Zendesk 更改日志来确定索引中哪些文档需要更新。根据更改日志的大小，在 Zendesk 中扫描文档可能会更快。如果您是首次将 Zendesk 数据来源与索引同步，则会扫描所有文档。 |
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"connectionConfiguration": {
"type": "object",
"properties": {
"repositoryEndpointMetadata": {
"type": "object",
"properties": {
"hostUrl": {
"type": "string",
"pattern": "https:.*"
}
},
"required": [
"hostUrl"
]
}
},
"required": [
"repositoryEndpointMetadata"
]
},
"repositoryConfigurations": {
"type": "object",
"properties": {
"ticket": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"ticketComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"ticketCommentAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"article": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"communityPostComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"articleComment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"articleAttachment": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
},
"communityTopic": {
"type": "object",
"properties": {
"fieldMappings": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"indexFieldName": {
"type": "string"
},
"indexFieldType": {
"type": "string",
"enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
},
"dataSourceFieldName": {
"type": "string"
},
"dateFieldFormat": {
"type": "string",
"pattern": "dd-MM-yyyy HH:mm:ss"
}
},
"required": [
"indexFieldName",
"indexFieldType",
"dataSourceFieldName"
]
}
]
}
}
},
"required": [
"fieldMappings"
]
}
}
},
"secretArn": {
"type": "string",
"minLength": 20,
"maxLength": 2048
},
"additionalProperties": {
"type": "object",
"properties": {
"organizationNameFilter": {
"type": "array"
},
"sinceDate": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
},
"inclusionPatterns": {
"type": "array"
},
"exclusionPatterns": {
"type": "array"
},
"isCrawTicket": {
"type": "string"
},
"isCrawTicketComment": {
"type": "string"
},
"isCrawTicketCommentAttachment": {
"type": "string"
},
"isCrawlArticle": {
"type": "string"
},
"isCrawlArticleAttachment": {
"type": "string"
},
"isCrawlArticleComment": {
"type": "string"
},
"isCrawlCommunityTopic": {
"type": "string"
},
"isCrawlCommunityPost": {
"type": "string"
},
"isCrawlCommunityPostComment": {
"type": "string"
}
}
},
"type": {
"type": "string",
"pattern": "ZENDESK"
},
"useChangeLog": {
"type": "string",
"enum": ["true", "false"]
}
},
"version": {
"type": "string",
"anyOf": [
{
"pattern": "1.0.0"
}
]
},
"additionalProperties": false,
"required": [
"connectionConfiguration",
"repositoryConfigurations",
"additionalProperties",
"useChangeLog",
"secretArn",
"type"
]
}