View a markdown version of this page

Schemas für Datenquellenvorlagen - Amazon Kendra
Adobe Experience Manager VorlagenschemaAmazon FSx (Windows) VorlagenschemaAmazon FSx (NetApp ONTAP) -VorlagenschemaAlfresco VorlagenschemaAurora (MySQL) -VorlagenschemaAurora (PostgreSQL) -VorlagenschemaAmazon RDS (Microsoft SQL Server) -VorlagenschemaAmazon RDS (MySQL) VorlagenschemaAmazon RDS (Oracle) VorlagenschemaAmazon RDS (PostgreSQL) -VorlagenschemaAmazon S3 VorlagenschemaAmazon Kendra Web Crawler-VorlagenschemaConfluence-VorlagenschemaDropbox-VorlagenschemaDrupal-VorlagenschemaGitHub VorlagenschemaGmail-VorlagenschemaGoogle Drive-VorlagenschemaIBM DB2-VorlagenschemaMicrosoft Exchange-VorlagenschemaOneDrive Microsoft-VorlagenschemaSharePoint Microsoft-VorlagenschemaMicrosoft SQL Server-VorlagenschemaMicrosoft Teams-VorlagenschemaMicrosoft Yammer-VorlagenschemaMySQL-VorlagenschemaOracle-Datenbank-VorlagenschemaPostgreSQL-VorlagenschemaSalesforce-VorlagenschemaServiceNow VorlagenschemaSlack-VorlagenschemaZendesk-Vorlagenschema

Amazon Kendra ist nicht mehr offen für neue Kunden. In den Amazon Bedrock Knowledge Bases finden Sie ähnliche Funktionen wie. Amazon KendraWeitere Informationen.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Schemas für Datenquellenvorlagen

Im Folgenden finden Sie Vorlagenschemas für Datenquellen, für die Vorlagen unterstützt werden.

Adobe Experience Manager Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Adobe Experience Manager Host-URL und den Authentifizierungstyp an und geben an, ob Sie Adobe Experience Manager (AEM) als Cloud-Dienst oder AEM On-Premise als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails verwenden. Geben Sie außerdem den Typ der Datenquelle alsAEM, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Weitere Informationen finden Sie unter Adobe Experience Manager JSON-Schema.

In der folgenden Tabelle werden die Parameter des AEM-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
AEM-URL Die Adobe Experience Manager-Host-URL. Wenn Sie beispielsweise AEM verwenden, geben Sie den Hostnamen On-Premise und den Port: an. https://hostname:port Wenn Sie AEM als Cloud-Service verwenden, können Sie auch die Autoren-URL verwenden: https://author-xxxxxx-xxxxxxx.adobeaemcloud.com.
authType Der verwendete Authentifizierungstyp, ob Basic oder OAuth2.
deploymentType Der verwendete Typ von Adobe Experience Manager, entweder CLOUD oder ON_PREMISE.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • angezeigten

  • Komponente

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Adobe Experience Manager Seiten und Assets Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Zeit ZoneId

Wenn Sie AEM verwenden On-Premise und die Zeitzone Ihres Servers sich von der Zeitzone des Amazon Kendra AEM-Connectors oder -Index unterscheidet, können Sie die Serverzeitzone so angeben, dass sie mit dem AEM-Connector oder -Index übereinstimmt.

Die Standardzeitzone für AEM On-Premise ist die Zeitzone des Amazon Kendra AEM-Connectors oder -Index. Die Standardzeitzone für AEM as a Cloud Service ist Greenwich Mean Time.

  • Seite RootPaths

  • Vermögenswert RootPaths

 Eine Liste von Stammpfaden für Seiten und Assets. Beispielsweise könnte der Stammpfad für eine Seite/sein content/sub und der Stammpfad für ein Asset könnte/content/sub/asset1 lauten.
Assets durchforsten trueum Vermögenswerte zu crawlen.
Seiten crawlen trueum Seiten zu crawlen.

  • Seite PathInclusionPatterns

  • Seite NameInclusionPatterns

  • Vermögenswert PathInclusionPatterns

  • Vermögenswert TypeInclusionPatterns

  • Vermögenswert NameInclusionPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Seiten und Assets in Ihrer Adobe Experience Manager-Datenquelle einzuschließen. Seiten und Assets, die den Mustern entsprechen, werden in den Index eingeschlossen. Seiten und Assets, die den Mustern nicht entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Seite oder ein Asset sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.

  • Seite PathExclusionPatterns

  • Seite NameExclusionPatterns

  • Vermögenswert PathExclusionPatterns

  • Vermögenswert TypeInclusionPatterns

  • Vermögenswert NameInclusionPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Seiten und Assets in Ihrer Adobe Experience Manager-Datenquelle auszuschließen. Seiten und Assets, die den Mustern entsprechen, werden aus dem Index ausgeschlossen. Seiten und Assets, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Seite oder ein Asset sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.
Komponenten der Seite Eine Liste der Namen für die spezifischen Seitenkomponenten, die Sie indexieren möchten.
Inhalt FragmentVariations Eine Liste mit Namen für die spezifischen gespeicherten Varianten von Adobe Experience Manager-Inhaltsfragmenten, die Sie indexieren möchten.
type Der Typ der Datenquelle. Geben Sie AEM als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Secrets, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Adobe Experience Manager erforderlich sind. Informationen zu diesen Schlüssel-Wert-Paaren finden Sie unter Verbindungsanweisungen für Adobe Experience Manager.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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) Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Dateisystem-ID als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Sie müssen auch den Typ der Datenquelle alsFSX, ein Geheimnis für Ihre Anmeldeinformationen und andere notwendige Konfigurationen angeben. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon FSx (Windows) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon FSx (Windows-) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
datei SystemId Die Kennung des Amazon FSx Dateisystems. Sie finden Ihre Dateisystem-ID im Dateisystem-Dashboard in der Amazon FSx Konsole.
datei SystemType Der Amazon FSx Dateisystemtyp. Geben Sie Folgendes an, um es Windows File Server als Ihren Dateisystemtyp zu verwendenWINDOWS.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.
Alle Eine Liste von Objekten, die Attribute oder Feldnamen Ihrer Dateien in Ihrer Amazon FSx Datenquelle Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
ist CrawlAcl trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.
Einschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Amazon FSx Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Amazon FSx Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
type Der Typ der Datenquelle. Geben Sie für Windows-Dateisystem-Datenquellen anFSX. 
{
  "$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) -Vorlagenschema

Sie fügen ein JSON hinzu, das das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Dateisystem-ID und die virtuelle Speichermaschine (SVM) als Teil der Verbindungskonfiguration oder der Details zum Repository-Endpunkt an. Sie müssen auch den Typ der Datenquelle angeben alsFSXONTAP, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon FSx (NetApp ONTAP) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon FSx (NetApp ONTAP) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
datei SystemId Die Kennung des Amazon FSx Dateisystems. Sie finden Ihre Dateisystem-ID im Dateisystem-Dashboard in der Amazon FSx Konsole. Informationen zum Erstellen eines Dateisystems in der Amazon FSx Konsole für NetApp ONTAP finden Sie im Handbuch Erste Schritte für NetApp ONTAP im FSx for ONTAP Benutzerhandbuch.
datei SystemType Der Amazon FSx Dateisystemtyp. Geben Sie Folgendes an, um es NetApp ONTAP als Ihren Dateisystemtyp zu verwendenONTAP.
SvMid Die ID der virtuellen Speichermaschine (SVM), die mit Ihrem Amazon FSx Dateisystem für verwendet wird. NetApp ONTAP Sie finden Ihre SVM-ID, indem Sie in der Amazon FSx Konsole zum Dashboard Dateisysteme gehen, Ihre Dateisystem-ID und dann virtuelle Speichermaschinen auswählen. Informationen zum Erstellen eines Dateisystems in der Amazon FSx Konsole für NetApp ONTAP finden Sie im Handbuch Erste Schritte für NetApp ONTAP im FSx for ONTAP Benutzerhandbuch.
Protokolltyp Ob Sie das Common Internet File System (CIFS) -Protokoll für Windows oder das Network File System (NFS) -Protokoll für Linux verwenden.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.
file Eine Liste von Objekten, die Attribute oder Feldnamen Ihrer Dateien in Ihrer Amazon FSx Datenquelle Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern. Die Feldnamen der Datenquelle müssen in den benutzerdefinierten Metadaten Ihrer Dateien vorhanden sein.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Crawlac L trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.
Einschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Amazon FSx Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Amazon FSx Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
type Der Typ der Datenquelle. Geben NetApp ONTAP Sie für Dateisystem-Datenquellen anFSXONTAP.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn

Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Amazon FSx Dateisystem erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

{
    "username": "user@corp.example.com",
    "password": "password"
}

Wenn Sie das NFS-Protokoll für Ihr Amazon FSx Dateisystem verwenden, wird das Geheimnis in einer JSON-Struktur mit den folgenden Schlüsseln gespeichert:

{
    "leftId": "left ID",
    "rightId": "right ID",
    "preSharedKey": "pre-shared key"
}
 
{
  "$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 Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Alfresco Site-ID, die Repository-URL, die URL der Benutzeroberfläche, den Authentifizierungstyp an, unabhängig davon, ob Sie die Cloud oder lokal verwenden, und die Art der Inhalte, die Sie crawlen möchten. Sie geben dies als Teil der Verbindungskonfiguration oder der Details zum Repository-Endpunkt an. Geben Sie auch den Typ der Datenquelle alsALFRESCO, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Alfresco JSON-Schema.

In der folgenden Tabelle werden die Parameter des Alfresco JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Standort-ID Die Kennung der Alfresco-Site.
URL melden Die URL Ihres Alfresco-Repositorys. Sie können die Repository-URL von Ihrem Alfresco-Administrator erhalten. Wenn Sie beispielsweise Alfresco Cloud (PaaS) verwenden, könnte die Repository-URL https://company.alfrescocloud.com lauten. Oder, wenn Sie sie verwenden Alfresco On-Premises, könnte die Repository-URL lauten. https://company-alfresco-instance.company-domain.suffix:port
Web AppUrl Die URL Ihrer Alfresco-Benutzeroberfläche. Die URL der Alfresco-Benutzeroberfläche erhalten Sie von Ihrem Alfresco-Administrator. Die URL der Benutzeroberfläche könnte beispielsweise https://example.com sein.
Endlager AdditionalProperties Zusätzliche Eigenschaften für die Verbindung mit dem repository/data Quellendpunkt.
authType Der verwendete Authentifizierungstyp, ob OAuth2 oder Basic.
Typ (Bereitstellung) Der verwendete Typ von Alfresco, ob PAAS oder ON-PREM.
CrawlType Welche Art von Inhalten gecrawlt werden sollen, z. B. ASPECT (Inhalte, die in Alfresco mit „Aspekte“ gekennzeichnet sind) SITE_ID (Inhalte innerhalb einer bestimmten Alfresco-Site) oder ALL_SITES (Inhalte in allen Ihren Alfresco-Sites).
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • document

  • Kommentar

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Alfresco-Dokumente und Kommentare Indexfeldnamen zuordnen. Amazon Kendra Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
AspectName

Der Name eines bestimmten „Aspects“, den Sie indizieren möchten.
Aspect-Eigenschaften

Eine Liste spezifischer 'Aspect'-Inhaltseigenschaften, die Sie indizieren möchten.
aktivieren FineGrainedControl

true, um „Aspekte“ zu crawlen.
ist CrawlComment

trueum Kommentare zu crawlen.

  • Inklusion FileNamePatterns

  • Inklusion FileTypePatterns

  • Inklusion FilePathPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Alfresco-Datenquelle einzuschließen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Ausschluss FileNamePatterns

  • Ausschluss FileTypePatterns

  • Ausschluss FilePathPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Alfresco-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
type Der Typ der Datenquelle. Geben Sie ALFRESCO als Datenquellentyp an.
secretArn

Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung zu Ihrem erforderlich sind. Alfresco Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

Wenn Sie die grundlegende Authentifizierung verwenden:

{
    "username": "user name",
    "password": "password"
}

Wenn Sie die OAuth 2.0-Authentifizierung verwenden:

{
    "clientId": "client ID",
    "clientSecret": "client secret",
    "tokenUrl": "token URL"
}
syncMode

Geben Sie an, wie Ihr Index aktualisiert Amazon Kendra werden soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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) -Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsmysql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Aurora (MySQL) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Aurora (MySQL) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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) -Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alspostgresql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Aurora (PostgreSQL) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Aurora (PostgreSQL) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (Microsoft SQL Server) -Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alssqlserver, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon RDS (Microsoft SQL Server) JSON-Schema.

In der folgenden Tabelle werden die Parameter des JSON-Schemas Amazon RDS (Microsoft SQL Server) beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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) Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsmysql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon RDS (MySQL) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon RDS (MySQL) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (Oracle) Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsoracle, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon RDS (Oracle) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon RDS (Oracle) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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) -Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alspostgresql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon RDS (PostgreSQL) JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon RDS (PostgreSQL) JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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 Vorlagenschema

Sie fügen ein JSON, das das Datenquellenschema enthält, als Teil der Vorlagenkonfiguration ein. Sie geben den Namen des S3-Buckets als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie auch den Typ der Datenquelle und andere erforderliche Konfigurationen an. S3 Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe S3-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Amazon S3 JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
BucketName Der Name Ihres Amazon S3 Eimers.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Einschlussmuster

  • Ausschlussmuster

  • Präfixe für Einschlüsse

  • Präfixe für Ausnahmen

 Eine Liste von Mustern für reguläre Ausdrücke, mit denen Sie bestimmte Dateien in Ihrer Amazon S3 Datenquelle ein- oder ausschließen können. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
acl ConfigurationFilePath Der Dateipfad, der den Zugriff auf Dokumente in einem Amazon Kendra Index steuert.
Metadaten FilesPrefix Der Speicherort in Ihrem Bucket für Metadatendateien.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
type Der Typ der Datenquelle. Geben Sie S3 als Datenquellentyp an.
version Die Version der Vorlage, die unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält.

Sie geben die Seed- oder Startpunkt-URLs an, oder Sie können die Sitemap-URLs als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails angeben. Anstatt alle Ihre URLs manuell aufzulisten, können Sie den Pfad zu dem Amazon S3 Bucket angeben, in dem eine Textdatei für Ihre Liste von Seed-URLs oder Sitemap-XML-Dateien gespeichert ist, die Sie in S3 in einer ZIP-Datei zusammenfassen können.

Sie geben auch den Typ der DatenquelleWEBCRAWLERV2, die Anmeldeinformationen für die Website-Authentifizierung und den Authentifizierungstyp an, falls Ihre Websites eine Authentifizierung erfordern, sowie andere notwendige Konfigurationen.

Sie geben dann TEMPLATE als den anType, wenn Sie anrufen CreateDataSource.

Wichtig

Die Erstellung von Web Crawler v2.0-Connectoren wird von nicht unterstützt. CloudFormation Verwenden Sie den Web Crawler v1.0 Connector, wenn Sie Unterstützung benötigen. CloudFormation

Bei der Auswahl der zu indizierenden Websites müssen Sie die Amazon Acceptable Use Policy (Richtlinie zur zulässigen Nutzung) und alle anderen Amazon-Bedingungen einhalten. Denken Sie daran, dass Sie Amazon Kendra Web Crawler nur verwenden dürfen, um Ihre eigenen Webseiten oder Webseiten, für deren Indizierung Sie berechtigt sind, zu indizieren. Informationen dazu, wie Sie verhindern können, dass Amazon Kendra Web Crawler Ihre Websites indexiert, finden Sie unter. Konfiguration der robots.txt Datei für Amazon Kendra Web Crawler

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Amazon Kendra JSON-Schema für Web Crawler.

In der folgenden Tabelle werden die Parameter des Amazon Kendra Web Crawler-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Standort MapUrls Die Liste der Sitemap-URLs für die Websites, die Sie crawlen möchten. Sie können bis zu drei Sitemap-URLs auflisten.
s3 SeedUrl Der S3-Pfad zu der Textdatei, in der die Liste der Seed- oder Startpunkt-URLs gespeichert ist. Beispiel, s3://bucket-name/directory/. Jede URL in der Textdatei muss in einer separaten Zeile formatiert sein. Sie können bis zu 100 Seed-URLs in einer Datei auflisten.
s3 SiteMapUrl Der S3-Pfad zu den Sitemap-XML-Dateien. Beispiel, s3://bucket-name/directory/. Sie können bis zu drei Sitemap-XML-Dateien auflisten. Sie können mehrere Sitemap-Dateien in einer ZIP-Datei zusammenfassen und die ZIP-Datei in Ihrem Amazon S3 Bucket speichern.
Samen UrlConnections Die Liste der Seed- oder Startpunkt-URLs für die Websites, die Sie crawlen möchten. Sie können bis zu 100 Seed-URLs auflisten.
Siehe URL Die Seed- oder Startpunkt-URL.
Authentifizierung Der Authentifizierungstyp, wenn Ihre Websites dieselbe Authentifizierung erfordern, andernfalls geben Sie anNoAuthentication.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Webseite

  • attachment

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Webseiten und Webseitendateien Amazon Kendra Indexfeldnamen zuordnen. Beispielsweise kann das HTML-Webseitentitel-Tag dem _document_title Indexfeld zugeordnet werden. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Rate/Limit Die maximale Anzahl an URLs, die pro Website-Host pro Minute gecrawlt werden.
maximal FileSize Die maximale Größe (in MB) einer Webseite oder eines Anhangs, die gecrawlt werden soll.
Tiefe des Crawlings Die Anzahl der Ebenen, die von der Seed-URL aus gecrawlt werden sollen. Die Seed-URL-Seite hat beispielsweise die Tiefe 1 und alle Hyperlinks auf dieser Seite, die ebenfalls gecrawlt werden, haben die Tiefe 2.
maximal LinksPerUrl Die maximale Anzahl von URLs auf einer Webseite, die beim Crawlen einer Website berücksichtigt werden sollen. Diese Zahl gilt pro Webseite. Wenn die Webseiten einer Website gecrawlt werden, werden auch alle URLs, auf die die Webseiten verlinken, gecrawlt. Die URLs auf einer Webseite werden in der Reihenfolge ihres Auftretens gecrawlt.
crawlen SubDomain trueum die Webseiten-Domains mit Subdomains zu crawlen. Lautet die Seed-URL beispielsweise "abc.example.com„, werden" "unda.abc.example.com" b.abc.example.com "ebenfalls gecrawlt. Wenn Sie „crawlSubDomainoder“ nicht festlegen crawlAllDomaintrue, werden Amazon Kendra nur die Domains der Websites gecrawlt, die Sie crawlen möchten.
crawlen AllDomain trueum die Website-Domains mit Subdomains und anderen Domains, auf die die Webseiten verlinken, zu crawlen. Wenn Sie diese Option nicht festlegen crawlSubDomaintrue, werden Amazon Kendra nur die Domains der Websites gecrawlt, die Sie crawlen möchten. crawlAllDomain
Honor Robots true, um die robots.txt-Anweisungen der Websites zu berücksichtigen, die Sie crawlen möchten. Diese Anweisungen steuern, wie Amazon Kendra Web Crawler die Websites crawlt, ob nur bestimmte Inhalte gecrawlt werden Amazon Kendra können oder keine Inhalte.
Crawlt Anlagen trueum Dateien zu crawlen, auf die die Webseiten verlinken.

  • Inklusion URLCrawlPatterns

  • Inklusion URLIndexPatterns

 Eine Liste von Mustern für reguläre Ausdrücke, die das Crawlen bestimmter URLs und das Indexieren von Hyperlinks auf diesen URL-Webseiten beinhaltet. URLs, die den Mustern entsprechen, werden in den Index eingeschlossen. URLs, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine URL sowohl einem Einschluss- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Webseiten URL/website der URL sind nicht im Index enthalten.

  • Ausschluss URLCrawlPatterns

  • Ausschluss URLIndexPatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um das Crawlen bestimmter URLs und die Indexierung von Hyperlinks auf diesen URL-Webseiten auszuschließen. URLs, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. URLs, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine URL sowohl einem Einschluss- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Webseiten URL/website der URL sind nicht im Index enthalten.
Inklusion FileIndexPatterns Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien der Webseite einzuschließen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschluss FileIndexPatterns Eine Liste von Mustern für reguläre Ausdrücke zum Ausschluss bestimmter Webseitendateien. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
implizit WaitDuration

implicit WaitDuration gibt an, wie lange der Connector in Sekunden wartet, bevor er eine Webseite crawlt.

Bereich: 0–10

z. B. „implizit WaitDuration „: „5"
Proxy Konfigurationsinformationen, die erforderlich sind, um über einen Webproxy eine Verbindung zu Ihren internen Websites herzustellen.
Host Der Hostname des Proxyservers, den Sie für die Verbindung zu internen Websites verwenden möchten. Der Hostname von https://a.example.com/page1.html lautet beispielsweise "a.example.com“.
port Die Portnummer des Proxyservers, den Sie für die Verbindung zu internen Websites verwenden möchten. Beispielsweise ist 443 der Standardport für HTTPS.
Sekretär (Proxy) Wenn Webproxy-Anmeldeinformationen für die Verbindung mit einem Website-Host erforderlich sind, können Sie ein AWS Secrets Manager Geheimnis erstellen, in dem die Anmeldeinformationen gespeichert werden. Stellen Sie den Amazon-Ressourcennamen (ARN) des Secrets bereit.
type Der Typ der Datenquelle. Geben Sie WEBCRAWLERV2 als Datenquellentyp an.
secretArn

Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das verwendet wird, wenn Ihre Websites für den Zugriff auf die Websites eine Authentifizierung benötigen. Sie speichern die Anmeldeinformationen für die Authentifizierung bei der Website in dem Secret, das die JSON-Schlüssel-Wert-Paare enthält.

Wenn Sie Basic oder verwenden NTML/Kerberos, geben Sie den Benutzernamen und das Passwort ein. Die JSON-Schlüssel im Secret müssen userName und password sein. Das NTLM-Authentifizierungsprotokoll beinhaltet das Passwort-Hashing und das Kerberos-Authentifizierungsprotokoll umfasst die Passwortverschlüsselung.

Wenn Sie die SAML- oder Formularauthentifizierung verwenden, geben Sie den Benutzernamen und das Passwort, XPath für das Benutzernamenfeld (und die Schaltfläche für den Benutzernamen, wenn Sie SAML verwenden), XPaths für das Passwortfeld und die Schaltfläche sowie die URL der Anmeldeseite ein. Die JSON-Schlüssel im Secret müssen userName, password, userNameFieldXpath, userNameButtonXpath, passwordFieldXpath, passwordButtonXpath und loginPageUrl sein. Sie finden die XPaths (XML Path Language) von Elementen mithilfe der Entwicklertools Ihres Webbrowsers. XPaths haben normalerweise dieses Format: //tagname[@Attribute='Value'].

Amazon Kendra prüft außerdem, ob die im Secret enthaltenen Endpunktinformationen (Seed-URLs) mit den Endpunktinformationen übereinstimmen, die in den Konfigurationsdetails Ihres Datenquellen-Endpunkts angegeben sind.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "siteMapUrls": {
              "type": "array",
              "items":{
                "type": "string",
                "pattern": "https://.*"
              }
            },
            "s3SeedUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "s3SiteMapUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "seedUrlConnections": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "seedUrl":{
                      "type": "string",
                      "pattern": "https://.*"
                    }
                  },
                  "required": [
                    "seedUrl"
                  ]
                }
              ]
            },
            "authentication": {
              "type": "string",
              "enum": [
                "NoAuthentication",
                "BasicAuth",
                "NTLM_Kerberos",
                "Form",
                "SAML"
              ]
            }
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "webPage": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "rateLimit": {
          "type": "string",
          "default": "300"
        },
        "maxFileSize": {
          "type": "string",
          "default": "50"
        },
        "crawlDepth": {
          "type": "string",
          "default": "2"
        },
        "maxLinksPerUrl": {
          "type": "string",
          "default": "100"
        },
        "crawlSubDomain": {
          "type": "boolean",
          "default": false
        },
        "crawlAllDomain": {
          "type": "boolean",
          "default": false
        },
        "honorRobots": {
          "type": "boolean",
          "default": false
        },
        "crawlAttachments": {
          "type": "boolean",
          "default": false
        },
        "inclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "proxy": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "secretArn": {
              "type": "string",
              "minLength": 20,
              "maxLength": 2048
            }
          }
        }
      },
      "implicitWaitDuration":  {
          "type":"object",
          "properties": {
            "innerNumber" : {
              "type": "number",
              "minimum": 0,
              "maximum": 10
            }
          }
        },
      "required": [
        "rateLimit",
        "maxFileSize",
        "crawlDepth",
        "crawlSubDomain",
        "crawlAllDomain",
        "maxLinksPerUrl",
        "honorRobots"
      ]
    },
    "type": {
      "type": "string",
      "pattern": "WEBCRAWLERV2"
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "type",
    "additionalProperties"
  ]
}

Confluence-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Du gibst die Confluence-Host-URL, die Hosting-Methode und den Authentifizierungstyp als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der Datenquelle alsCONFLUENCEV2, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Confluence-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Confluence-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
hostUrl Die URL für deine Confluence-Instanz. Beispiel, https://example.confluence.com.
type Die Hosting-Methode für Ihre Confluence-Instanz, ob und. SAAS ON_PREM
authType Die Authentifizierungsmethode für deine Confluence-Instanz, ob, oderBasic. OAuth2 Personal-token
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Bereich

  • angezeigten

  • Blog

  • Kommentar

  • attachment

 Eine Liste von Objekten, die die Attribute oder Feldnamen deiner Confluence-Spaces, -Seiten, Blogs, Kommentare und Anlagen Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern. Die Feldnamen der Confluence-Datenquelle müssen in Ihren benutzerdefinierten Confluence-Metadaten vorhanden sein.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
ist CrawlAcl Konfigurieren true Sie es so, dass die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente gecrawlt werden, wenn Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Beachten Sie, dass die ACL festlegt, auf welche Dokumente Benutzer und Gruppen zugreifen können. Die ACL-Informationen werden verwendet, um Suchergebnisse basierend auf dem Benutzer- oder Gruppenzugriff auf Dokumente zu filtern. Das bedeutet, dass Dokumente öffentlich durchsucht werden können, wenn sie deaktiviert isCrawlACL ist. Weitere Informationen finden Sie unter Benutzerkontextfilterung.
Feld ForUserId Geben Sie an, email ob Sie die Benutzer-E-Mail für die Benutzer-ID verwenden möchten. emailwird standardmäßig verwendet und ist derzeit der einzige unterstützte Benutzer-ID-Typ.

  • Inklusion SpaceKeyFilter

  • Ausschluss SpaceKeyFilter

  • Seite TitleReg EX

  • Blog TitleReg EX

  • Kommentar TitleReg EX

  • Anlage TitleReg EX

  • Inklusion FileTypePatterns

  • Ausschluss FileTypePatterns

  • Inklusion UrlPatterns

  • Ausschluss UrlPatterns

 Eine Liste von Mustern für reguläre Ausdrücke, die Sie in Ihre Confluence-Datenquelle aufnehmen und bestimmte Dateien and/or ausschließen können. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
ProxyHost Der Hostname des Webproxys, den Sie verwenden, ohne das http:// https:// OR-Protokoll.

Proxy-Port

 Die Portnummer, die vom Host-URL-Transportprotokoll verwendet wird. Muss ein numerischer Wert zwischen 0 und 65535 sein.

  • ist CrawlPersonalSpace

  • ist CrawlArchivedSpace

  • ist CrawlArchivedPage

  • ist CrawlPage

  • ist CrawlBlog

  • ist CrawlPageComment

  • ist CrawlPageAttachment

  • ist CrawlBlogComment

  • ist CrawlBlogAttachment

 trueum Dateien in Ihren persönlichen Confluence-Bereichen, Seiten, Blogs, Seitenkommentaren, Seitenanhängen, Blogkommentaren und Bloganhängen zu crawlen.
max FileSizeInMegaBytes Geben Sie die Dateigrößenbeschränkung in MB an, die gecrawlt Amazon Kendra werden kann. Amazon Kendra durchsucht nur die Dateien innerhalb der von Ihnen definierten Größenbeschränkung. Die Standarddateigröße beträgt 50 MB. Die maximale Dateigröße sollte größer als 0 MB und kleiner oder gleich 50 MB sein.
type Der Typ der Datenquelle. Geben Sie CONFLUENCEV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Secrets, das die Schlüssel-Wert-Paare enthält, die für die Verbindung zu Ihrem Confluence erforderlich sind. Informationen zu diesen Schlüssel-Wert-Paaren findest du unter Verbindungsanweisungen für Confluence. https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-confluence.html#data-source-procedure-v2-confluence
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben den Dropbox-App-Schlüssel, das App-Geheimnis und das Zugriffstoken als Teil Ihres Secrets an, in dem Ihre Authentifizierungsdaten gespeichert werden. Geben Sie außerdem den Typ der DatenquelleDROPBOX, den Typ des Zugriffstokens, den Sie verwenden möchten (temporär oder permanent), und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als den anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Dropbox-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Dropbox-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle. Diese Datenquelle gibt keinen Endpunkt in anrepositoryEndpointMetadata. Vielmehr sind die Verbindungsinformationen in einem AWS Secrets Manager Schlüssel enthalten, den Sie angebensecretArn.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • file

  • Papier

  • Papier

  • Abkürzung

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Dropbox-Dateien, Dropbox Paper und Verknüpfungen zu Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Secrets, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrer Dropbox erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "appKey": "Dropbox app key",
    "appSecret": "Dropbox app secret",
    "accesstoken": "temporary access token or refresh access token"
}
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
ist CrawlAcl trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

  • Inklusion FileNamePatterns

  • Inklusion FileTypePatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateinamen und -typen in Ihre Dropbox-Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Ausschluss FileNamePatterns

  • Ausschluss FileTypePatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateinamen und -typen in Ihrer Dropbox-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Datei crawlen

  • Papier durchforsten

  • Papier krabbeln

  • Shortcut zum Durchforsten

 trueum Dateien in Ihrer Dropbox, Dropbox Paper-Dokumente, Dropbox Paper-Vorlagen und Webseitenverknüpfungen, die in Ihrer Dropbox gespeichert sind, zu crawlen.
type Der Typ der Datenquelle. Geben Sie DROPBOX als Datenquellentyp an.
Token-Typ Geben Sie den Typ Ihres Zugriffstokens an: permanentes oder temporäres Zugriffstoken. Es wird empfohlen, in Dropbox ein Aktualisierungs-Zugriffstoken zu erstellen, das niemals abläuft, anstatt sich auf ein einmaliges Zugriffstoken zu verlassen, das nach 4 Stunden abläuft. Sie erstellen eine App und ein Aktualisierungs-Zugriffstoken in der Dropbox-Entwicklerkonsole und geben das Zugriffstoken in Ihrem Secret an.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Drupal-Host-URL und den Authentifizierungstyp als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem als Datenquellentyp DRUPAL an, geben Sie ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen. CreateDataSource

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Drupal-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Drupal-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
hostUrl Die Host-URL Ihrer Drupal-Website. Beispiel, https://<hostname>/<drupalsitename>.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle.

  • Inhalt

  • Kommentar

  • attachment

 Eine Liste von Objekten, die Ihren Drupal-Dateien Attribute oder Feldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern. Die Feldnamen der Drupal-Datenquelle müssen in Ihren benutzerdefinierten Drupal-Metadaten vorhanden sein.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Inklusion FileNamePatterns

  • artikel TitleInclusionPatterns

  • Seite TitleInclusionPatterns

  • benutzerdefiniert ContentTitleInclusionPatterns

  • grundlegend BlockTitleInclusionPatterns

  • benutzerdefiniert BlockTitleInclusionPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Drupal-Datenquelle einzuschließen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Ausschluss FileNamePatterns

  • artikel TitleExclusionPatterns

  • Seite TitleExclusionPatterns

  • benutzerdefiniert ContentTitleExclusionPatterns

  • grundlegend BlockTitleExclusionPatterns

  • benutzerdefiniert BlockTitleExclusionPatterns

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Drupal-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
contentDefinitions

  • contentType

  • fieldDefinition

  • ist CrawlComments

  • ist CrawlFiles

  • ist CrawlArticle

  • ist CrawlBasicPage

  • ist CrawlBasicBlock

  • ist CrawlCustomContentTypesList

 Geben Sie an, welche Inhaltstypen gecrawlt werden sollen, und ob Kommentare und Anhänge für die ausgewählten Inhaltstypen gecrawlt werden.
type Der Typ der Datenquelle. Geben Sie DRUPAL als Datenquellentyp an.
authType Der verwendete Authentifizierungstyp, ob BASIC-AUTH oder OAUTH2.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Secrets, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Drupal erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

Wenn Sie die grundlegende Authentifizierung verwenden:

{
    "username": "user name",
    "passwords": "password"
}

Wenn Sie die OAuth 2.0-Authentifizierung verwenden:

{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
	"$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 Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails geben Sie die GitHub Host-URL und den Namen der Organisation an und ob Sie die GitHub Cloud oder GitHub lokal verwenden. Geben Sie außerdem den Typ der DatenquelleGITHUB, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere erforderliche Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe GitHub JSON-Schema.

In der folgenden Tabelle werden die Parameter des GitHub JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
type Geben Sie den Typ entweder als SAAS oder anON_PREMISE.
hostUrl Die GitHub Host-URL. Zum Beispiel, wenn Sie GitHub SaaS/Enterprise Cloud verwenden: https://api.github.com. Oder, wenn Sie GitHub premises/Enterprise On-Server verwenden: https://on-prem-host-url/api/v3/.
organizationName Sie finden den Namen Ihrer Organisation, wenn Sie sich auf dem GitHub Desktop anmelden und in der Dropdownliste Ihres Profilbilds zu Ihren Organisationen wechseln.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • GH-Repository

  • ghCommit

  • gh IssueDocument

  • gh IssueComment

  • gh IssueAttachment

  • GHPR-Dokument

  • GHPR-Kommentar

  • GHPR-Anhang

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres GitHub Inhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
ist CrawlAcl trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen und diese durchsuchen können. Die ACL-Informationen werden verwendet, um die Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.
Feld ForUserId Geben Sie den Typ der Benutzer-ID an, die Sie für das ACL-Crawling verwenden möchten. Geben Sie entweder an, email ob Sie die Benutzer-E-Mail für die Benutzer-ID verwenden möchten, oder username ob Sie den Benutzernamen für die Benutzer-ID verwenden möchten. Wenn Sie keine Option angeben, email wird standardmäßig verwendet.
repositoryFilter Eine Liste der Namen der spezifischen Repositorys und der Branch-Namen, die Sie indexieren möchten.
Repository durchforsten trueum Repositorys zu crawlen.
kriechen RepositoryDocuments trueum Repository-Dokumente zu crawlen.
Problem crawlen trueum Probleme zu crawlen.
kriechen IssueComment trueum Problemkommentare zu crawlen.
kriechen IssueCommentAttachment trueum Anhänge von Problemkommentaren zu crawlen.
kriechen PullRequest trueum Pull-Requests zu crawlen.
kriechen PullRequestComment trueum Pull-Request-Kommentare zu crawlen.
kriechen PullRequestCommentAttachment trueum Anhänge von Pull-Request-Kommentaren zu crawlen.

  • Inklusion FolderNamePatterns

  • Inklusion FileTypePatterns

  • Inklusion FileNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihre GitHub Datenquelle aufzunehmen. Elemente, die den Mustern entsprechen, werden in den Index eingeschlossen. Inhalte, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.

  • Ausschluss FolderNamePatterns

  • Ausschluss FileTypePatterns

  • Ausschluss FileNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihrer GitHub Datenquelle auszuschließen. Inhalte, die den Mustern entsprechen, werden aus dem Index ausgeschlossen. Inhalte, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.
type Der Typ der Datenquelle. Geben Sie GITHUB als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn

Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem erforderlich sind. GitHub Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

{
    "personalToken": "token"
}
version Die Version dieser Vorlage, die derzeit unterstützt wird.

Das Folgende ist das GitHub JSON-Schema:

{
    "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsGMAIL, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Gmail-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Gmail-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle. Diese Datenquelle gibt keinen Endpunkt in anrepositoryEndpointMetadata. Vielmehr sind die Verbindungsinformationen in einem AWS Secrets Manager Schlüssel enthalten, den Sie angebensecretArn.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

  • Nachricht

  • attachments

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Gmail-Nachrichten und -Anlagen Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Inklusion LabelNamePatterns

  • Ausschluss LabelNamePatterns

  • Inklusion AttachmentTypePatterns

  • Ausschluss AttachmentTypePatterns

  • Inklusion AttachmentNamePatterns

  • Ausschluss AttachmentNamePatterns

  • Inklusion SubjectFilter

  • Ausschluss SubjectFilter

  • ist SubjectAnd

  • Inklusion FromFilter

  • Ausschluss FromFilter

  • Inklusion ToFilter

  • Ausschluss ToFilter

  • Inklusion CcFilter

  • Ausschluss CcFilter

  • Inklusion BccFilter

  • Ausschluss BccFilter

 Eine Liste mit Mustern für reguläre Ausdrücke, mit denen Sie Nachrichten mit bestimmten Betreffnamen in Ihre Gmail-Datenquelle ein- oder ausschließen können. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
vorher DateFilter Geben Sie Nachrichten und Anhänge an, die vor einem bestimmten Datum eingeschlossen werden sollen.
danach DateFilter Geben Sie Nachrichten und Anhänge an, die nach einem bestimmten Datum eingeschlossen werden sollen.
ist CrawlAttachment Ein boolescher Wert, mit dem Sie auswählen können, ob Sie Anhänge crawlen möchten. Nachrichten werden automatisch gecrawlt.
type Der Typ der Datenquelle. Geben Sie GMAIL als Datenquellentyp an.
sollte CrawlDraftMessages Ein boolescher Wert, mit dem Sie auswählen können, ob Sie Nachrichtenentwürfe crawlen möchten.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

Wichtig

Da es keine API zum Aktualisieren dauerhaft gelöschter Gmail-Nachrichten gibt, werden alle neuen, geänderten oder gelöschten Inhalte synchronisiert:

  • Nachrichten, die dauerhaft aus Gmail gelöscht wurden, werden nicht aus Ihrem Amazon Kendra Index entfernt

  • Synchronisiert keine Änderungen an den E-Mail-Labels von Gmail

Um Änderungen an der Bezeichnung Ihrer Gmail-Datenquelle und dauerhaft gelöschte E-Mail-Nachrichten mit Ihrem Amazon Kendra Index zu synchronisieren, müssen Sie in regelmäßigen Abständen vollständige Crawls durchführen.
secretARN Der Amazon-Ressourcenname (ARN) eines Secrets Manager-Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Gmail-Konto erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsGOOGLEDRIVE2, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Google Drive-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Google Drive-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle. Diese Datenquelle gibt keinen Endpunkt an. Sie wählen Ihren Authentifizierungstyp aus: serviceAccount undOAuth2. Die Verbindungsinformationen sind in einem AWS Secrets Manager Schlüssel enthalten, den Sie angebensecretArn.
authType Wählen Sie zwischen serviceAccount und OAuth2 basierend auf Ihrem Anwendungsfall.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • file

  • Kommentar

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Google Drive Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • max FileSizeInMegaBytes

 Geben Sie eine Dateigrößenbeschränkung in MB an, die gecrawlt Amazon Kendra werden soll.

  • Ich crawle einen Kommentar

 trueum Kommentare in Ihrer Google Drive-Datenquelle zu crawlen.

  • ist CrawlMyDriveAndSharedWithMe

 trueum Drives in Ihrer Google Drive-Datenquelle zu crawlen MyDrive und für mich freizugeben.

  • ist CrawlSharedDrives

 trueum Shared Drives in Ihrer Google Drive-Datenquelle zu crawlen.
ist CrawlAcl trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen und diese durchsuchen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.

  • ausschließen UserAccounts

  • ausschließen SharedDrives

  • ausschließen MimeTypes

  • Ausschluss FileTypePatterns

  • Ausschluss FileNamePatterns

  • Ausschluss FilePathFilter

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Google Drive-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • einschließen UserAccounts

  • einschließen SharedDrives

  • einschließen MimeTypes

  • Inklusion FileTypePatterns

  • Inklusion FileNamePatterns

  • Inklusion FilePathFilter

 Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Google Drive-Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
type Der Typ der Datenquelle. Geben Sie GOOOGLEDRIVEV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Google Drive erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

Wenn Sie die Google-Dienstkonto-Authentifizierung verwenden:

{
    "clientEmail": "user account email",
    "adminAccountEmail": "service account email",
    "privateKey": "private key"
}

Wenn Sie die OAuth 2.0-Authentifizierung verwenden:

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsdb2, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe IBM DB2-JSON-Schema.

In der folgenden Tabelle werden die Parameter des IBM DB2-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Tenant-ID als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der Datenquelle alsMSEXCHANGE, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Microsoft Exchange-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Microsoft Exchange-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Mieter-ID Die Microsoft 365-Mandanten-ID. Sie finden Ihre Mandanten-ID in den Eigenschaften Ihres Azure-Active-Directory-Portals oder in Ihrer OAuth-Anwendung.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • E-Mail

  • attachment

  • calendar

  • Kontakte

  • notes

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Microsoft Exchange-Datenquelle Amazon Kendra Indexfeldern zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Einschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Microsoft Exchange-Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Microsoft Exchange-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Aufnahme UsersList

  • Inklusion UsersFileName

  • Inklusion DomainUsers

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Benutzer und Benutzerdateien in Ihre Microsoft Exchange-Datenquelle aufzunehmen. Benutzer, die den Mustern entsprechen, werden in den Index aufgenommen. Benutzer, die den Mustern nicht entsprechen, werden aus dem Index ausgeschlossen. Wenn ein Benutzer sowohl einem Einschluss- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und der Benutzer wird nicht in den Index aufgenommen.

  • Ausschluss UsersList

  • Ausschluss UsersFileName

  • Ausschluss DomainUsers

 Eine Liste von Mustern für reguläre Ausdrücke zum Ausschluss bestimmter Benutzer und Benutzerdateien in Ihrer Microsoft Exchange-Datenquelle. Benutzer, die den Mustern entsprechen, werden aus dem Index ausgeschlossen. Benutzer, die den Mustern nicht entsprechen, werden in den Index aufgenommen. Wenn ein Benutzer sowohl einem Ausschluss- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und der Benutzer wird nicht in den Index aufgenommen.
S3-Bucket-Name Der Name Ihres S3-Buckets, falls Sie diesen verwenden möchten.

  • CrawlCalendar

  • Notizen zum Crawlen

  • Kontakte crawlen

  • kriechen FolderAcl

 trueum diese Arten von Inhalten und Zugriffskontrollinformationen in Ihrer Microsoft Exchange-Datenquelle zu durchsuchen.
starten CalendarDateTime Sie können ein bestimmtes Startdatum und eine bestimmte Startzeit für Ihren Kalenderinhalt konfigurieren.
Ende CalendarDateTime Sie können ein bestimmtes Enddatum und eine bestimmte Endzeit für Kalenderinhalte konfigurieren.
subject Sie können eine bestimmte Betreffzeile für Ihren E-Mail-Inhalt konfigurieren.
E-Mail von Sie können eine bestimmte E-Mail für den Inhalt Ihrer Absender- oder Absender-Mail konfigurieren.
E-Mail senden an Sie können eine bestimmte E-Mail für den Inhalt Ihrer An- oder Empfänger-Mail konfigurieren.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
type Der Typ der Datenquelle. Geben Sie MSEXCHANGE als Datenquellentyp an.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Microsoft Exchange erforderlich sind. Dazu gehören Ihre Client-ID und Ihr Client-Geheimnis, das generiert wird, wenn Sie eine OAuth-Anwendung im Azure-Portal erstellen.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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 Microsoft-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Mandanten-ID als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der Datenquelle an und geben Sie ein Geheimnis für Ihre Anmeldeinformationen und andere erforderliche Konfigurationen an. ONEDRIVEV2 Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Microsoft-JSON-Schema OneDrive.

In der folgenden Tabelle werden die Parameter des Microsoft OneDrive JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Mieter-ID Die Microsoft 365-Mandanten-ID. Sie finden Ihre Mandanten-ID in den Eigenschaften Ihres Azure-Active-Directory-Portals oder in Ihrer OAuth-Anwendung.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.
file Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer OneDrive Microsoft-Dateien Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Benutzer NameFilter

  • Nutzer FilterPath

  • Inklusion FileTypePatterns

  • Ausschluss FileTypePatterns

  • Inklusion FileNamePatterns

  • Ausschluss FileNamePatterns

  • Inklusion FilePathPatterns

  • Ausschluss FilePathPatterns

  • Inklusion OneNoteSectionNamePatterns

  • Ausschluss OneNoteSectionNamePatterns

  • Inklusion OneNotePageNamePatterns

  • Ausschluss OneNotepageNamePatterns

 Sie können wählen, bestimmte Dateien, OneNote Abschnitte, OneNote Seiten zu indizieren und nach Benutzernamen zu filtern.
ist UserNameOnS3 true, um eine Liste von Benutzernamen anzugeben, die in einer Datei in einem Amazon S3-Bucket gespeichert sind.
type Der Typ der Datenquelle. Geben Sie ONEDRIVEV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
type Der Typ der Datenquelle. Geben Sie ONEDRIVEV2 als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Microsoft erforderlich sind. OneDrive Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
	"$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 Microsoft-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil eines TemplateConfiguration Objekts enthält. Sie geben die SharePoint Site URL/URLs, die Domain und bei Bedarf auch eine Mandanten-ID als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der Datenquelle alsSHAREPOINTV2, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE den Typ an, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe SharePoint JSON-Schema.

In der folgenden Tabelle werden die Parameter des Microsoft SharePoint JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt der Datenquelle
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle
Mandanten-ID Die Mandanten-ID Ihres SharePoint Kontos.
Domain Die Domain Ihres SharePoint Kontos.
URLs der Website Die Host-URLs Ihres SharePoint Kontos.
Repositorium AdditionalProperties Zusätzliche Eigenschaften für die Verbindung mit dem repository/data Quellendpunkt.
S3-Bucket-Name Der Name des Amazon S3 Buckets, in dem Ihr selbstsigniertes Azure AD-Zertifikat gespeichert ist. X.509
Name des S3-Zertifikats Der Name des selbstsignierten Azure X.509 AD-Zertifikats, das in Ihrem Bucket gespeichert ist. Amazon S3
authType Die Art der Authentifizierung, die Sie verwenden, unabhängig davonOAuth2, ob OAuth2CertificateOAuth2App,Basic,, OAuth2_RefreshTokenNTLM, oderKerberos.
version Die SharePoint Version, die Sie verwenden, unabhängig davon, ob Server oderOnline.
auf PremVersion Die SharePoint Serverversion, die Sie verwenden, egal ob 2013 oderSubscriptionEdition.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • event

  • angezeigten

  • file

  • link

  • attachment

  • Kommentar

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres SharePoint Inhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Ereignis TitleFilterRegEx

  • Seite TitleFilterRegEx

  • Link TitleFilterRegEx

  • Inklusion FilePath

  • Ausschluss FilePath

  • Inklusion FileTypePatterns

  • Ausschluss FileTypePatterns

  • Inklusion FileNamePatterns

  • Ausschluss FileNamePatterns

  • Inklusion OneNoteSectionNamePatterns

  • Ausschluss OneNoteSectionNamePatterns

  • Inklusion OneNotePageNamePatterns

  • Ausschluss OneNotePageNamePatterns

 Eine Liste von Mustern regulärer Ausdrücke für include/exclude bestimmte Inhalte in Ihrer SharePoint Datenquelle. Inhaltselemente, die den Einschlussmustern entsprechen, sind im Index enthalten. Inhaltselemente, die nicht den Einschlussmustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • Dateien durchforsten

  • Seiten crawlen

  • Ereignisse crawlen

  • Kommentare crawlen

  • Links crawlen

  • Anhänge crawlen

 trueum diese Art von Inhalten zu crawlen.
Cl crawlen trueum die Informationen der Zugriffskontrollliste (ACL) für Ihre Dokumente zu durchsuchen, falls Sie eine ACL haben und diese für die Zugriffskontrolle verwenden möchten. Die ACL legt fest, auf welche Dokumente Benutzer und Gruppen zugreifen und diese durchsuchen können. Die ACL-Informationen werden verwendet, um Suchergebnisse nach dem Zugriff des Benutzers oder seiner Gruppe auf Dokumente zu filtern. Weitere Informationen finden Sie unter Benutzerkontextfilterung.
Feld ForUserId Geben Sie entweder an, email ob Sie die Benutzer-E-Mail für die Benutzer-ID verwenden möchten, oder userPrincipalName ob Sie einen Benutzernamen für die Benutzer-ID verwenden möchten. Wenn Sie keine Option angeben, email wird standardmäßig verwendet.
ACL-Konfiguration Geben Sie entweder ACLWithLDAPEmailFmtACLWithManualEmailFmt, oder an. ACLWithUsernameFmtM
E-Mail-Domäne Die Domain der E-Mail. Beispiel, „amazon.com“.

  • ist CrawlLocalGroupMapping

  • ist CrawlAdGroupMapping

 trueum Informationen zur Gruppenzuordnung zu crawlen.
ProxyHost Der Hostname des Webproxys, den Sie verwenden, ohne das http: //- oder https: //-Protokoll.
ProxyPort Die Portnummer, die vom Host-URL-Transportprotokoll verwendet wird. Muss ein numerischer Wert zwischen 0 und 65535 sein.
type Geben Sie SHAREPOINTV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem erforderlich sind. SharePoint Informationen zu diesen Schlüssel-Wert-Paaren finden Sie unter Verbindungsanweisungen für SharePoint Online und Server. SharePoint
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
	"$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",
										"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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alssqlserver, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Microsoft SQL Server-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Microsoft SQL Server-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Tenant-ID als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der DatenquelleMSTEAMS, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere erforderliche Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe JSON-Schema von Microsoft Teams.

In der folgenden Tabelle werden die Parameter des JSON-Schemas von Microsoft Teams beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Mieter-ID Die Microsoft 365-Mandanten-ID. Sie finden Ihre Mandanten-ID in den Eigenschaften Ihres Azure-Active-Directory-Portals oder in Ihrer OAuth-Anwendung.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Chat-Nachricht

  • Chat-Anhang

  • Beitrag des Kanals

  • KanalWiki

  • Kanal-Anhang

  • Besprechung/Chat

  • Besprechungsdatei

  • Notiz zur Besprechung

  • Kalender/Besprechung

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Microsoft Teams-Inhalte Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Zahlungsmodell Gibt an, welche Art von Zahlungsmodell für Ihre Microsoft Teams-Datenquelle verwendet werden soll. Die Zahlungsmodelle des Modells A sind auf Lizenz- und Zahlungsmodelle beschränkt, für die die Einhaltung der Sicherheitsvorschriften erforderlich ist. Die Zahlungsmodelle des Modells B eignen sich für Lizenz- und Zahlungsmodelle, für die keine Sicherheitsvorschriften erforderlich sind.

  • Inklusion TeamNameFilter

  • Inklusion ChannelNameFilter

  • Inklusion FileNamePatterns

  • Inklusion FileTypePatterns

  • Inklusion UserEmailFilter

  • Inklusion OneNoteSectionNamePatterns

  • Inklusion OneNotePageNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihre Microsoft Teams-Datenquelle aufzunehmen. Elemente, die den Mustern entsprechen, werden in den Index eingeschlossen. Inhalte, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.

  • Ausschluss TeamNameFilter

  • Ausschluss ChannelNameFilter

  • Ausschluss FileNamePatterns

  • Ausschluss FileTypePatterns

  • Ausschluss UserEmailFilter

  • Ausschluss OneNoteSectionNamePatterns

  • Ausschluss OneNotePageNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihrer Microsoft Teams-Datenquelle auszuschließen. Inhalte, die den Mustern entsprechen, werden aus dem Index ausgeschlossen. Inhalte, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.

  • ist CrawlChatMessage

  • ist CrawlChatAttachment

  • ist CrawlChannelPost

  • ist CrawlChannelAttachment

  • ist CrawlChannelWiki

  • ist CrawlCalendarMeeting

  • ist CrawlMeetingChat

  • ist CrawlMeetingFile

  • ist CrawlMeetingNote

 trueum diese Arten von Inhalten in Ihrer Microsoft Teams-Datenquelle zu crawlen.
starten CalendarDateTime Sie können ein bestimmtes Startdatum und eine bestimmte Startzeit für Ihren Kalenderinhalt konfigurieren.
Ende CalendarDateTime Sie können ein bestimmtes Enddatum und eine bestimmte Endzeit für Kalenderinhalte konfigurieren.
type Der Typ der Datenquelle. Geben Sie MSTEAMS als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihren Microsoft Teams erforderlich sind. Dazu gehören Ihre Client-ID und Ihr geheimes Client-Geheimnis, das generiert wird, wenn Sie eine OAuth-Anwendung im Azure-Portal erstellen.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil eines TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsYAMMER, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE den Typ an, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden.

In der folgenden Tabelle werden die Parameter des Microsoft Yammer-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle. Diese Datenquelle gibt keinen Endpunkt in anrepositoryEndpointMetadata. Vielmehr sind die Verbindungsinformationen in einem AWS Secrets Manager Schlüssel enthalten, den Sie angebensecretArn.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Gemeinschaft

  • user

  • Nachricht

  • attachment

 Eine Liste von Objekten, die Attribute oder Feldnamen von Microsoft Yammer-Inhalten Amazon Kendra-Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Einschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Microsoft Yammer-Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Microsoft Yammer-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Seit Datum Sie können einen sinceDate Parameter so konfigurieren, dass der Microsoft Yammer-Connector Inhalte auf der Grundlage eines bestimmten durchsucht. sinceDate
Gemeinschaft NameFilter Sie können sich dafür entscheiden, bestimmte Community-Inhalte zu indizieren.

  • ist CrawlMessage

  • ist CrawlAttachment

  • ist CrawlPrivateMessage

 trueum Nachrichten, Nachrichtenanhänge und private Nachrichten zu crawlen.
type Geben Sie YAMMER als Datenquellentyp an.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Microsoft Yammer erforderlich sind. Dazu gehören Ihr Microsoft Yammer-Benutzername und -Passwort sowie die Client-ID und das Client-Geheimnis, die generiert werden, wenn Sie eine OAuth-Anwendung im Azure-Portal erstellen.
verwenden ChangeLog trueum anhand des Microsoft Yammer-Änderungsprotokolls zu ermitteln, welche Dokumente im Index aktualisiert werden müssen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsmysql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe MySQL-JSON-Schema.

In der folgenden Tabelle werden die Parameter des MySQL-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Datenbank-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alsoracle, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe JSON-Schema der Oracle-Datenbank.

In der folgenden Tabelle werden die Parameter des Oracle Database-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Geben Sie den Typ der Datenquelle alsJDBC, den Datenbanktyp alspostgresql, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe PostgreSQL-JSON-Schema.

In der folgenden Tabelle werden die Parameter des PostgreSQL-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Erforderliche Konfigurationsinformationen für die Verbindung mit Ihrer Datenquelle.

  • dbType — Der Typ der Java-Datenbank, die Sie verwenden, unabhängig davonmysql, obdb2, postgresqloracle, oder. sqlserver

  • dbHost – Der Datenbank-Hostname.

  • dbPort – Der Datenbank-Port.

  • dbInstance – Die Datenbank-Instance.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen. Geben Sie den Typ der Datenquelle und den geheimen ARN an.

document

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihres Datenbankinhalts Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle. Wird verwendet, um bestimmte Inhalte in Ihrer Datenbankdatenquelle ein- oder auszuschließen.
primaryKey Geben Sie den Primärschlüssel für die Datenbanktabelle an. Dadurch wird eine Tabelle in Ihrer Datenbank identifiziert.
titleColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
bodyColumn Geben Sie den Namen der Titelspalte des Dokuments in Ihrer Datenbanktabelle ein.
sqlQuery Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
timestampColumn Geben Sie den Namen der Spalte ein, die Zeitstempel enthält. Amazon Kendra verwendet Zeitstempelinformationen, um Änderungen an Ihren Inhalten zu erkennen und nur geänderte Inhalte zu synchronisieren.
timestampFormat Geben Sie den Namen der Spalte ein, die Zeitstempelformate enthält, die verwendet werden sollen, um Inhaltsänderungen zu erkennen und Ihre Inhalte erneut zu synchronisieren.
timezone Geben Sie den Namen der Spalte ein, die Zeitzonen für den Inhalt enthält, der durchsucht werden soll.
ändern DetectingColumns Geben Sie die Namen der Spalten ein, anhand derer Inhaltsänderungen erkannt Amazon Kendra werden. Amazon Kendra indexiert den Inhalt neu, wenn sich eine dieser Spalten ändert
erlaubt UsersColumns Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
erlaubt GroupsColumn Geben Sie den Namen der Spalte ein, die Benutzer-IDs enthält, denen der Zugriff auf Inhalte gewährt werden soll.
sourceURIColumn Geben Sie den Namen der Spalte ein, die Quell-URLs enthält, die indexiert werden sollen.
ist SslEnabled Geben Sie SQL-Abfrageanweisungen wie SELECT- und JOIN-Operationen ein. SQL-Abfragen müssen weniger als 32 KB groß sein. Amazon Kendra crawlt den gesamten Datenbankinhalt, der Ihrer Abfrage entspricht.
type Der Typ der Datenquelle. Geben Sie JDBC als Datenquellentyp an.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretArn Der Amazon-Ressourcenname (ARN) eines Secrets-Manager-Secrets, das den Benutzernamen und das Passwort enthält, die für die Verbindung mit Ihrer Datenbank erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "user name": "database user name",
    "password": "password"
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die Salesforce-Host-URL als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie auch den Typ der Datenquelle alsSALESFORCEV2, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Salesforce-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Salesforce-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
hostUrl Die URL der Salesforce-Instanz, die indexiert werden soll.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Konto

  • contact

  • campaign

  • Fall

  • product

  • lead

  • Vertrag

  • Partner

  • Profil

  • Idee

  • Preisbuch

  • Aufgabe

  • Lösung

  • attachment

  • user

  • document

  • Wissensartikel

  • Gruppe

  • opportunity

  • schwatzen

  • Benutzerdefinierte Entität

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer Salesforce-Entitäten Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Salesforce erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

Für den Ablauf der Kundenanmeldedaten:

{
    "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
    "consumerKey": "Application public key generated when you created your Salesforce application",
    "consumerSecret": "Application private key generated when you created your Salesforce application"
}

Für Username-Password Flow:

{
    "authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
    "consumerKey": "Application public key generated when you created your Salesforce application",
    "consumerSecret": "Application private key generated when you created your Salesforce application",
    "password": "Password associated with the user logging in to the Salesforce instance",
    "securityToken": "Token associated with the user account logging in to the Salesforce instance",
    "username": "User name of the user logging in to the Salesforce instance"
}
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.

  • Konto-Filter

  • Kontaktfilter

  • Gehäusefilter

  • Kampagnenfilter

  • Filter für Verträge

  • Gruppenfilter

  • Bleifilter

  • Produktfilter

  • Opportunity-Filter

  • Filter für Partner

  • Preisbuchfilter

  • IdeaFilter

  • Profilfilter

  • Aufgabenfilter

  • Lösungsfilter

  • Benutzerfilter

  • ChatterFilter

  • Dokumentfilter

  • Wissen ArticleFilter

  • Benutzerdefinierte Entitäten

 Eine Sammlung von Zeichenfolgen, die angeben, welche Entitäten gefiltert werden sollen.

Einschlussmuster

  • Inklusion DocumentFileTypePatterns

  • Inklusion DocumentFileNamePatterns

  • Inklusion AccountFileTypePatterns

  • Inklusion CampaignFileTypePatterns

  • Inklusion DocumentFileNamePatterns

  • Inklusion CampaignFileNamePatterns

  • Inklusion CaseFileTypePatterns

  • Inklusion CaseFileNamePatterns

  • Inklusion ContactFileTypePatterns

  • Inklusion ContractFileNamePatterns

  • Inklusion LeadFileTypePatterns

  • Inklusion LeadFileNamePatterns

  • Inklusion OpportunityFileTypePatterns

  • Inklusion OpportunityFileNamePatterns

  • Inklusion SolutionFileTypePatterns

  • Inklusion SolutionFileNamePatterns

  • Inklusion TaskFileTypePatterns

  • Inklusion TaskFileNamePatterns

  • Inklusion GroupFileTypePatterns

  • Inklusion GroupFileNamePatterns

  • Inklusion ChatterFileTypePatterns

  • Inklusion ChatterFileNamePatterns

  • Inklusion CustomEntityFileTypePatterns

  • Inklusion CustomEntityFileNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihre Salesforce-Datenquelle aufzunehmen. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

Ausschlussmuster

  • Ausschluss DocumentFileTypePatterns

  • Ausschluss DocumentFileNamePatterns

  • Ausschluss AccountFileTypePatterns

  • Ausschluss CampaignFileTypePatterns

  • Ausschluss CampaignFileNamePatterns

  • Ausschluss CaseFileTypePatterns

  • Ausschluss CaseFileNamePatterns

  • Ausschluss ContactFileTypePatterns

  • Ausschluss ContractFileNamePatterns

  • Ausschluss LeadFileTypePatterns

  • Ausschluss LeadFileNamePatterns

  • Ausschluss OpportunityFileTypePatterns

  • Ausschluss OpportunityFileNamePatterns

  • Ausschluss SolutionFileTypePatterns

  • Ausschluss SolutionFileNamePatterns

  • Ausschluss TaskFileTypePatterns

  • Ausschluss TaskFileNamePatterns

  • Ausschluss GroupFileTypePatterns

  • Ausschluss GroupFileNamePatterns

  • Ausschluss ChatterFileTypePatterns

  • Ausschluss ChatterFileNamePatterns

  • Ausschluss CustomEntityFileTypePatterns

  • Ausschluss CustomEntityFileNamePatterns

 Eine Liste von Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Salesforce-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • ist CrawlAccount

  • ist CrawlContact

  • ist CrawlCase

  • ist CrawlCampaign

  • ist CrawlProduct

  • ist CrawlLead

  • ist CrawlContract

  • ist CrawlPartner

  • ist CrawlProfile

  • ist CrawlIdea

  • ist CrawlPricebook

  • ist CrawlDocument

  • kriechen SharedDocument

  • ist CrawlGroup

  • ist CrawlOpportunity

  • ist CrawlChatter

  • ist CrawlUser

  • ist CrawlSolution

  • ist CrawlTask

  • ist CrawlAccountAttachments

  • ist CrawlContactAttachments

  • ist CrawlCaseAttachments

  • ist CrawlCampaignAttachments

  • ist CrawlLeadAttachments

  • ist CrawlContractAttachments

  • ist CrawlGroupAttachments

  • ist CrawlOpportunityAttachments

  • ist CrawlChatterAttachments

  • ist CrawlSolutionAttachments

  • ist CrawlTaskAttachments

  • ist CrawlCustomEntityAttachments

  • ist CrawlKnowledgeArticles

    • ist CrawlDraft

    • ist CrawlPublish

    • ist CrawlArchived

 trueum diese Dateitypen in Ihrem Salesforce-Konto zu crawlen.
type Der Typ der Datenquelle. Geben Sie SALESFORCEV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties":
  {
    "connectionConfiguration": {
      "type": "object",
      "properties":
      {
        "repositoryEndpointMetadata":
        {
          "type": "object",
          "properties":
          {
            "hostUrl":
            {
              "type": "string",
              "pattern": "https:.*"
            },
            "authType":
            {
              "type": "string",
              "enum": [
                "clientCredentials",
                "usernamePassword"
              ]
            }
          },
          "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 Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil des TemplateConfiguration Objekts enthält. Sie geben die ServiceNow Host-URL, den Authentifizierungstyp und die Instanzversion als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der Datenquelle alsSERVICENOWV2, ein Geheimnis für Ihre Authentifizierungsdaten und andere notwendige Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe ServiceNow JSON-Schema.

In der folgenden Tabelle werden die Parameter des ServiceNow JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
hostUrl Die ServiceNow Host-URL. Beispiel, your-domain.service-now.com.
authType Der verwendete Authentifizierungstyp, ob basicAuth oder OAuth2.
Service jetzt InstanceVersion Die ServiceNow Version, die Sie verwenden. Sie können zwischenTokyo, SandiegoRome, und wählenOthers.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Artikel über Wissen

  • attachment

  • Servicekatalog

  • Vorfall

 Eine Liste von Objekten, die die Attribute oder Feldnamen Ihrer ServiceNow Wissensartikel, Anlagen, Servicekataloge und Incidents den Amazon Kendra Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern. Die Feldnamen der ServiceNow Datenquelle müssen in Ihren ServiceNow benutzerdefinierten Metadaten vorhanden sein.
zusätzliche Eigenschaften Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
max FileSizeInMegaBytes Geben Sie die Dateigrößenbeschränkung in MB an, die Amazon Kendra crawlen wird. Amazon Kendra crawlt nur die Dateien innerhalb der von Ihnen definierten Größenbeschränkung. Die Standarddateigröße beträgt 50 MB. Die maximale Dateigröße sollte größer als 0 MB und kleiner oder gleich 50 MB sein.

  • Wissen ArticleFilter

  • Vorfall QueryFilter

  • Dienst CatalogQueryFilter

  • Wissen ArticleTitleRegExp

  • Service CatalogTitleRegExp

  • Vorfall TitleRegExp

  • Inklusion FileTypePatterns

  • Ausschluss FileTypePatterns

  • Inklusion FileNamePatterns

  • Ausschluss FileNamePatterns

  • Vorfall StateType

 Eine Liste von Mustern für reguläre Ausdrücke, die Sie in Ihre ServiceNow Datenquelle aufnehmen und bestimmte Dateien and/or ausschließen können. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • ist CrawlKnowledgeArticle

  • ist CrawlKnowledgeArticleAttachment

  • einschließen PublicArticlesOnly

  • ist CrawlServiceCatalog

  • ist CrawlServiceCatalogAttachment

  • ist CrawlActiveServiceCatalog

  • ist CrawlInactiveServiceCatalog

  • ist CrawlIncident

  • ist CrawlIncidentAttachment

  • ist CrawlActiveIncident

  • ist CrawlInactiveIncident

  • bewerben ACLForKnowledgeArticle

  • bewerben ACLForServiceCatalog

  • bewerben ACLForIncident

 trueum ServiceNow Wissensartikel, Servicekataloge, Vorfälle und Anlagen zu crawlen.
type Der Typ der Datenquelle. Geben Sie SERVICENOWV2 als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
syncMode

Geben Sie an, wie Ihr Index aktualisiert werden Amazon Kendra soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem erforderlich sind. ServiceNow Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "username": "user name",
    "password": "password"
}
Wenn Sie die OAuth2-Authentifizierung verwenden, muss Ihr Secret eine JSON-Struktur mit den folgenden Schlüsseln enthalten: 
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"         
}
version Die Version der Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Du fügst ein JSON ein, das das Datenquellenschema als Teil eines TemplateConfiguration Objekts enthält. Sie geben die Host-URL als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der DatenquelleSLACK, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere erforderliche Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe JSON-Schema von Slack.

In der folgenden Tabelle werden die Parameter des Slack-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repositorium EndpointMetadata Die Endpunktinformationen für die Datenquelle.
teamId Die Slack-Team-ID, die du von der URL deiner Slack-Hauptseite kopiert hast.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.
Alle Eine Liste von Objekten, die die Attribute oder Feldnamen deiner Slack Inhalte Amazon Kendra Indexfeldnamen zuordnen.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Einschlussmuster Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihrer Slack-Datenquelle einzuschließen. Elemente, die den Mustern entsprechen, werden in den Index eingeschlossen. Inhalte, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Inhalte in Ihrer Slack-Datenquelle auszuschließen. Inhalte, die den Mustern entsprechen, werden aus dem Index ausgeschlossen. Inhalte, die nicht den Mustern entsprechen, sind im Index enthalten. Wenn Inhalte sowohl einem Ein- als auch einem Ausschlussmuster entsprechen, hat das Ausschlussmuster Vorrang und die Inhalte werden nicht in den Index eingeschlossen.
kriechen BotMessages trueum Bot-Nachrichten zu crawlen.
Archiviert ausschließen trueum das Crawlen archivierter Nachrichten auszuschließen.
Art der Konversation Die Art der Konversation, für die Sie indizieren möchtenPUBLIC_CHANNEL, obPRIVATE_CHANNEL, GROUP_MESSAGE und. DIRECT_MESSAGE
Kanalfilter Der Channel-Typ, den Sie indexieren möchten, ob private_channel oder public_channel.
Seit Datum Sie können den Parameter sinceDate so konfigurieren, dass der Slack-Konnektor Inhalte auf der Basis eines bestimmten Werts für sinceDate crawlt.
Schau zurück Sie können einen lookBack Parameter so konfigurieren, dass der Slack Connector aktualisierte oder gelöschte Inhalte bis zu einer bestimmten Anzahl von Stunden vor Ihrer letzten Connector-Synchronisierung crawlt.
syncMode

Geben Sie an, wie Ihr Index aktualisiert Amazon Kendra werden soll, wenn sich der Inhalt Ihrer Datenquelle ändert. Sie können wählen zwischen:

  • FORCED_FULL_CRAWLum alle Inhalte neu zu indizieren und vorhandene Inhalte jedes Mal zu ersetzen, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird.

  • FULL_CRAWLum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue, geänderte und gelöschte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.

  • CHANGE_LOGum jedes Mal, wenn Ihre Datenquelle mit Ihrem Index synchronisiert wird, nur neue und geänderte Inhalte zu indexieren. Amazon Kendra kann den Mechanismus Ihrer Datenquelle verwenden, um Inhaltsänderungen zu verfolgen und Inhalte zu indexieren, die sich seit der letzten Synchronisierung geändert haben.
type Der Typ der Datenquelle. Geben Sie SLACK als Datenquellentyp an.
aktivieren IdentityCrawler trueum den Identity Crawler zu verwenden Amazon Kendra, um identity/principal Informationen über Benutzer und Gruppen zu synchronisieren, die Zugriff auf bestimmte Dokumente haben. Wenn der Identity Crawler ausgeschaltet ist, können alle Dokumente öffentlich durchsucht werden. Wenn Sie die Zugriffskontrolle für Ihre Dokumente verwenden möchten und der Identity Crawler deaktiviert ist, können Sie alternativ die PutPrincipalMapping API verwenden, um Benutzer- und Gruppenzugriffsinformationen hochzuladen.
secretArn

Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Secrets, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem erforderlich sind. Slack Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten:

{
    "slackToken": "token"
}
version Die Version dieser Vorlage, die derzeit unterstützt wird. 
{
  "$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-Vorlagenschema

Sie fügen eine JSON-Datei hinzu, die das Datenquellenschema als Teil eines TemplateConfiguration Objekts enthält. Sie geben die Host-URL als Teil der Verbindungskonfiguration oder der Repository-Endpunktdetails an. Geben Sie außerdem den Typ der DatenquelleZENDESK, einen geheimen Schlüssel für Ihre Anmeldeinformationen und andere erforderliche Konfigurationen an. Sie geben dann TEMPLATE als anType, wenn Sie anrufen CreateDataSource.

Sie können die in diesem Entwicklerhandbuch bereitgestellte Vorlage verwenden. Siehe Zendesk-JSON-Schema.

In der folgenden Tabelle werden die Parameter des Zendesk-JSON-Schemas beschrieben.

Konfiguration Description
connectionConfiguration Konfigurationsinformationen für den Endpunkt für die Datenquelle.
Repository EndpointMetadata Die Endpunktinformationen für die Datenquelle.
Host-URL Die Zendesk-Host-URL. Beispiel, https://yoursubdomain.zendesk.com.
repositoryConfigurations Konfigurationsinformationen für den Inhalt der Datenquelle. Beispielsweise die Konfiguration bestimmter Inhaltstypen und Feldzuordnungen.

  • Fahrkarte

  • Ticket/Kommentar

  • Ticket CommentAttachment

  • article

  • Kommentar zum Artikel

  • Artikel als Anlage

  • Community-Thema

  • Gemeinschaft PostComment

 Eine Liste von Objekten, die Attribute oder Feldnamen von Zendesk-Tickets Amazon Kendra-Indexfeldnamen zuordnen. Weitere Informationen finden Sie unter Zuweisen von Datenquellenfeldern.
secretARN Der Amazon-Ressourcenname (ARN) eines AWS Secrets Manager Geheimnisses, das die Schlüssel-Wert-Paare enthält, die für die Verbindung mit Ihrem Zendesk erforderlich sind. Das Geheimnis muss eine JSON-Struktur mit den folgenden Schlüsseln enthalten: Host-URL, Client-ID, Client-Geheimnis, Benutzername und Passwort.
additionalProperties Zusätzliche Konfigurationsoptionen für die Inhalte in Ihrer Datenquelle.
Organisation NameFilter Sie können wählen, Tickets zu indexieren, die innerhalb einer bestimmten Organisation existieren.
Seit Datum Sie können einen sinceDate Parameter so konfigurieren, dass der Zendesk-Connector Inhalte auf der Grundlage eines bestimmten Crawls durchsucht. sinceDate
Einschlussmuster Eine Liste mit Mustern für reguläre Ausdrücke, mit denen Sie bestimmte Dateien in Ihre Zendesk-Datenquelle aufnehmen können. Dateien, die den Mustern entsprechen, werden in den Index eingeschlossen. Dateien, die nicht den Mustern entsprechen, werden aus dem Index ausgeschlossen. Wenn eine Datei sowohl einem Ein- als auch einem Ausschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.
Ausschlussmuster Eine Liste mit Mustern für reguläre Ausdrücke, um bestimmte Dateien in Ihrer Zendesk-Datenquelle auszuschließen. Dateien, die dem Muster entsprechen, werden aus dem Index ausgeschlossen. Dateien, die den Mustern nicht entsprechen, werden in den Index eingeschlossen. Wenn eine Datei sowohl einem Aus- als auch einem Einschlussmuster entspricht, hat das Ausschlussmuster Vorrang und die Datei wird nicht in den Index eingeschlossen.

  • ist CrawlTicket

  • ist CrawlTicketComment

  • ist CrawlTicketCommentAttachment

  • ist CrawlArticle

  • ist CrawlArticleComment

  • ist CrawlArticleAttachment

  • ist CrawlCommunityTopic

  • ist CrawlCommunityPost

  • ist CrawlCommunityPostComment

 Geben Sie "true" ein, um diese Arten von Inhalten zu crawlen.
type Geben Sie ZENDESK als Datenquellentyp an.
verwenden ChangeLog Geben Sie "true" ein, um anhand des Zendesk-Änderungsprotokolls zu ermitteln, welche Dokumente im Index aktualisiert werden müssen. Je nach Größe des Änderungsprotokolls kann es schneller sein, die Dokumente in Zendesk zu scannen. Wenn Sie Ihre Zendesk-Datenquelle zum ersten Mal mit Ihrem Index synchronisieren, werden alle Dokumente gescannt. 
{
  "$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"
  ]
}