View a markdown version of this page

Schémas de modèles de sources de données - Amazon Kendra
Adobe Experience Manager schéma de modèleAmazon FSx Schéma modèle (Windows)Amazon FSx Schéma modèle (NetApp ONTAP)Alfresco schéma de modèleAurora Schéma de modèle (MySQL)Aurora Schéma de modèle (PostgreSQL)Amazon RDS Schéma modèle (Microsoft SQL Server)Amazon RDS Schéma de modèle (MySQL)Amazon RDS Schéma modèle (Oracle)Amazon RDS Schéma de modèle (PostgreSQL)Amazon S3 schéma de modèleAmazon Kendra Schéma de modèle de Web CrawlerSchéma du modèle ConfluenceSchéma du modèle DropboxSchéma de modèle DrupalGitHub schéma de modèleSchéma de modèle GmailSchéma de modèle Google DriveSchéma de modèle IBM DB2Modèle de schéma Microsoft ExchangeSchéma OneDrive de modèle MicrosoftSchéma SharePoint de modèle MicrosoftSchéma modèle Microsoft SQL ServerModèle de schéma Microsoft TeamsSchéma de modèle Microsoft YammerSchéma de modèle MySQLSchéma du modèle de base de données OracleSchéma de modèle PostgreSQLSchéma de modèle SalesforceServiceNow schéma de modèleSchéma de modèle SlackSchéma de modèle Zendesk

Amazon Kendra n'est plus ouvert aux nouveaux clients. Pour des fonctionnalités similaires à Amazon Kendra, explorez les bases de connaissances Amazon Bedrock. En savoir plus.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Schémas de modèles de sources de données

Vous trouverez ci-dessous des modèles de schémas pour les sources de données dans lesquelles les modèles sont pris en charge.

Adobe Experience Manager schéma de modèle

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous indiquez l'URL de l'Adobe Experience Managerhôte, le type d'authentification et indiquez si vous utilisez Adobe Experience Manager (AEM) en tant que service cloud ou AEM dans le On-Premise cadre de la configuration de la connexion ou des détails de point de terminaison du référentiel. Spécifiez également le type de source de donnéesAEM, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Pour de plus amples informations, veuillez consulter Adobe Experience Manager Schéma JSON.

Le tableau suivant décrit les paramètres du schéma AEM JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
URL AEM URL de l’hôte Adobe Experience Manager. Par exemple, si vous utilisez AEM On-Premise, vous incluez le nom d'hôte et le port :. https://hostname:port Ou, si vous utilisez AEM as a Cloud Service, vous pouvez utiliser l’URL de l’auteur : https://author-xxxxxx-xxxxxxx.adobeaemcloud.com.
authType Le type d’authentification que vous utilisez, Basic ou OAuth2.
deploymentType Le type d’Adobe Experience Manager que vous utilisez, CLOUD ou ON_PREMISE.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • page

  • asset

 Liste d'objets qui mappent les attributs ou les noms de champs de vos Adobe Experience Manager pages et actifs pour Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
heure ZoneId

Si vous utilisez AEM On-Premise et que le fuseau horaire de votre serveur est différent de celui du connecteur ou de l'index Amazon Kendra AEM, vous pouvez spécifier le fuseau horaire du serveur afin de l'aligner sur le connecteur ou l'index AEM.

Le fuseau horaire par défaut pour AEM On-Premise est le fuseau horaire du connecteur ou de l' Amazon Kendra index AEM. Le fuseau horaire par défaut pour AEM as a Cloud Service est Greenwich Mean Time.

  • page RootPaths

  • actif RootPaths

 Liste des chemins racines pour les pages et les ressources. Par exemple, le chemin racine d'une page peut être/content/subet le chemin racine d'un actif peut être/content/sub/asset1.
Ensembles Crawlas truepour explorer les actifs.
CrawlPages truepour explorer les pages.

  • page PathInclusionPatterns

  • page NameInclusionPatterns

  • actif PathInclusionPatterns

  • actif TypeInclusionPatterns

  • actif NameInclusionPatterns

 Une liste des modèles d’expression régulière pour inclure certaines pages et ressources dans votre source de données Adobe Experience Manager. Les pages et ressources qui correspondent aux modèles sont incluses dans l’index. Les pages et ressources qui ne correspondent pas aux modèles sont exclues de l’index. Si une page ou une ressource correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.

  • page PathExclusionPatterns

  • page NameExclusionPatterns

  • actif PathExclusionPatterns

  • actif TypeInclusionPatterns

  • actif NameInclusionPatterns

 Une liste des modèles d’expression régulière pour exclure certaines pages et ressources de votre source de données Adobe Experience Manager. Les pages et ressources qui correspondent aux modèles sont exclues de l’index. Les pages et ressources qui ne correspondent pas aux modèles sont incluses dans l’index. Si une page ou une ressource correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.
Composantes de page Liste des noms pour les composants de page spécifiques que vous souhaitez indexer.
contenu FragmentVariations Liste des noms des variantes enregistrées spécifiques des fragments de contenu Adobe Experience Manager que vous souhaitez indexer.
type Type de la source de données. Spécifiez AEM comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Adobe Experience Manager. Pour plus d'informations sur ces paires clé-valeur, voir Instructions de connexion pour Adobe Experience Manager.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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 Schéma modèle (Windows)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'ID du système de fichiers dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Vous devez également spécifier le type de source de donnéesFSX, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon FSx Schéma JSON (Windows).

Le tableau suivant décrit les paramètres du schéma JSON Amazon FSx (Windows).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
fichier SystemId Identifiant du système de Amazon FSx fichiers. L'ID de votre système de fichiers se trouve sur le tableau de bord des systèmes de fichiers de la Amazon FSx console.
fichier SystemType Type de système de Amazon FSx fichiers. À utiliser Windows File Server comme type de système de fichiers, spécifiezWINDOWS.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.
Tous Liste d'objets qui mappent les attributs ou les noms de champs de vos fichiers dans votre source de Amazon FSx données afin d' Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
est CrawlAcl truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.
Modèles d'inclusion Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de Amazon FSx données. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Schémas d'exclusion Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de Amazon FSx données. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
type Type de la source de données. Pour les sources de données du système de fichiers Windows, spécifiezFSX. 
{
  "$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 Schéma modèle (NetApp ONTAP)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'ID du système de fichiers et la machine virtuelle de stockage (SVM) dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Vous devez également spécifier le type de source de donnéesFSXONTAP, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon FSx Schéma JSON (NetApp ONTAP).

Le tableau suivant décrit les paramètres du schéma JSON Amazon FSx (NetApp ONTAP).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
fichier SystemId Identifiant du système de Amazon FSx fichiers. L'ID de votre système de fichiers se trouve sur le tableau de bord des systèmes de fichiers de la Amazon FSx console. Pour plus d'informations sur la création d'un système de fichiers dans la Amazon FSx console pour NetApp ONTAP, consultez le Guide de démarrage pour NetApp ONTAP dans le Guide de l'FSx for ONTAP utilisateur.
fichier SystemType Type de système de Amazon FSx fichiers. À utiliser NetApp ONTAP comme type de système de fichiers, spécifiezONTAP.
SVMid Identifiant de la machine virtuelle de stockage (SVM) utilisé avec votre système de Amazon FSx fichiers pourNetApp ONTAP. Vous pouvez trouver votre identifiant SVM en accédant au tableau de bord des systèmes de fichiers de la Amazon FSx console, en sélectionnant l'ID de votre système de fichiers, puis en sélectionnant Machines virtuelles de stockage. Pour plus d'informations sur la création d'un système de fichiers dans la Amazon FSx console pourNetApp ONTAP, consultez le Guide de démarrage pour NetApp ONTAP dans le Guide de l'FSx for ONTAP utilisateur.
Type de protocole Que vous utilisiez le protocole CIFS (Common Internet File System) pour Windows ou le protocole NFS (Network File System) pour Linux.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.
dans le fichier Liste d'objets qui mappent les attributs ou les noms de champs de vos fichiers dans votre source de Amazon FSx données afin d' Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données. Les noms des champs de source de données doivent figurer dans les métadonnées personnalisées de vos fichiers.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
Crawla CL truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.
Modèles d'inclusion Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de Amazon FSx données. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Schémas d'exclusion Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de Amazon FSx données. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
type Type de la source de données. Pour les sources de données du système de NetApp ONTAP fichiers, spécifiezFSXONTAP.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn

Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre système de Amazon FSx fichiers. Le secret doit contenir une structure JSON avec les clés suivantes :

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

Si vous utilisez le protocole NFS pour votre système de Amazon FSx fichiers, le secret est stocké dans une structure JSON avec les clés suivantes :

{
    "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 schéma de modèle

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous indiquez l'ID du Alfresco site, l'URL du référentiel, l'URL de l'interface utilisateur, le type d'authentification, si vous utilisez le cloud ou sur site, et le type de contenu que vous souhaitez analyser. Vous les fournissez dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesALFRESCO, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Alfresco Schéma JSON.

Le tableau suivant décrit les paramètres du schéma JSON Alfresco.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
ID du site L'identifiant du site Alfresco.
URL de référence L’URL de votre référentiel Alfresco. Vous pouvez obtenir l’URL du référentiel auprès de votre administrateur Alfresco. Par exemple, si vous utilisez Alfresco Cloud (PaaS), l’URL du référentiel peut être https://company.alfrescocloud.com. Ou, si vous l'utilisez Alfresco On-Premises, l'URL du référentiel peut être https://company-alfresco-instance.company-domain.suffix:port.
web AppUrl L’URL de votre interface utilisateur Alfresco. Vous pouvez obtenir l’URL de l’interface utilisateur Alfresco auprès de votre administrateur Alfresco. Par exemple, l’URL de l’interface utilisateur peut être https://example.com.
référentiel AdditionalProperties Propriétés supplémentaires pour se connecter au point de terminaison repository/data source.
authType Le type d’authentification que vous utilisez, OAuth2 ou Basic.
type (déploiement) Le type d’Alfresco que vous utilisez, PAAS ou ON-PREM.
Type de crawl Le type de contenu que vous souhaitez indexer, ASPECT (contenu marqué avec « Aspects » dans Alfresco), SITE_ID (contenu d’un site Alfresco spécifique) ou ALL_SITES (contenu de tous vos sites Alfresco).
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • document

  • comment

 Une liste d'objets qui mappent les attributs ou les noms de champs de vos documents Alfresco et les commentaires pour Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
Nom de l'aspect

Le nom d'un « Aspect » spécifique que vous souhaitez indexer.
Propriétés de l'aspect

Liste des propriétés de contenu « Aspect » spécifiques que vous souhaitez indexer.
activer FineGrainedControl

true pour indexer « Aspects ».
est CrawlComment

truepour explorer les commentaires.

  • inclusion FileNamePatterns

  • inclusion FileTypePatterns

  • inclusion FilePathPatterns

 Une liste des modèles d’expression régulière pour inclure certains fichiers dans votre source de données Alfresco. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • exclusion FileNamePatterns

  • exclusion FileTypePatterns

  • exclusion FilePathPatterns

 Une liste des modèles d’expression régulière pour exclure certains fichiers de votre source de données Alfresco. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
type Type de la source de données. Spécifiez ALFRESCO comme type de source de données.
secretArn

Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre. Alfresco Le secret doit contenir une structure JSON avec les clés suivantes :

Si vous utilisez l’authentification basique :

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

Si vous utilisez l’authentification OAuth 2.0 :

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

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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 Schéma de modèle (MySQL)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesmysql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Aurora Schéma JSON (MySQL).

Le tableau suivant décrit les paramètres du schéma JSON Aurora (MySQL).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 Schéma de modèle (PostgreSQL)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéespostgresql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Aurora Schéma JSON (PostgreSQL).

Le tableau suivant décrit les paramètres du schéma JSON Aurora (PostgreSQL).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 Schéma modèle (Microsoft SQL Server)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéessqlserver, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon RDS Schéma JSON (Microsoft SQL Server).

Le tableau suivant décrit les paramètres du schéma JSON Amazon RDS (Microsoft SQL Server).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 Schéma de modèle (MySQL)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesmysql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon RDS Schéma JSON (MySQL).

Le tableau suivant décrit les paramètres du schéma JSON Amazon RDS (MySQL).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 Schéma modèle (Oracle)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesoracle, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon RDS Schéma JSON (Oracle).

Le tableau suivant décrit les paramètres du schéma JSON Amazon RDS (Oracle).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 Schéma de modèle (PostgreSQL)

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéespostgresql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon RDS Schéma JSON (PostgreSQL).

Le tableau suivant décrit les paramètres du schéma JSON Amazon RDS (PostgreSQL).

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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 schéma de modèle

Vous incluez un JSON contenant le schéma de la source de données dans le cadre de la configuration du modèle. Vous fournissez le nom du compartiment S3 dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de S3 données et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON S3.

Le tableau suivant décrit les paramètres du schéma Amazon S3 JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
BucketName Le nom de votre Amazon S3 seau.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données

  • Modèles d'inclusion

  • Schémas d'exclusion

  • Préfixes d'inclusion

  • Préfixes d'exclusion

 Liste de modèles d'expressions régulières permettant d'inclure ou d'exclure des fichiers spécifiques dans votre source de Amazon S3 données. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
acl ConfigurationFilePath Le chemin du fichier qui contrôle l'accès aux documents d'un Amazon Kendra index.
métadonnées FilesPrefix Emplacement des fichiers de métadonnées dans votre compartiment.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
type Type de la source de données. Spécifiez S3 comme type de source de données.
version Version du modèle prise en charge. 
{
  "$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 Schéma de modèle de Web Crawler

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet.

Vous fournissez les URL de départ ou de départ, ou vous pouvez fournir les URL du plan du site, dans le cadre de la configuration de la connexion ou des détails des points de terminaison du référentiel. Au lieu de répertorier manuellement toutes vos URL, vous pouvez indiquer le chemin d'accès au Amazon S3 compartiment qui contient un fichier texte pour votre liste d'URL de départ ou des fichiers XML de plan de site, que vous pouvez regrouper dans un fichier ZIP dans S3.

Vous spécifiez également le type de source de donnéesWEBCRAWLERV2, les informations d'authentification du site Web et le type d'authentification si vos sites Web nécessitent une authentification, ainsi que les autres configurations nécessaires.

Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Important

La création de connecteurs Web Crawler v2.0 n'est pas prise en charge par. CloudFormation Utilisez le connecteur Web Crawler v1.0 si vous avez besoin d' CloudFormation assistance.

Lorsque vous sélectionnez des sites web à indexer, vous devez respecter les Politiques d'Amazon en matière d'utilisation acceptable et toutes les autres conditions d'Amazon. N'oubliez pas que vous ne devez utiliser Amazon Kendra Web Crawler que pour indexer vos propres pages Web ou les pages Web que vous êtes autorisé à indexer. Pour savoir comment empêcher Amazon Kendra Web Crawler d'indexer vos sites Web, consultez. Configuration du robots.txt fichier pour Amazon Kendra Web Crawler

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Amazon Kendra Schéma JSON du robot d’indexation.

Le tableau suivant décrit les paramètres du schéma JSON du Amazon Kendra Web Crawler.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
site MapUrls La liste des URL de plan de site des sites Web que vous souhaitez indexer. Vous pouvez répertorier jusqu’à trois URL de plan de site.
s3 SeedUrl Le chemin S3 vers le fichier texte qui contient la liste des URL d’origine ou de point de départ. Par exemple, s3://bucket-name/directory/. Chaque URL du fichier texte doit être mise en forme sur une ligne distincte. Vous pouvez répertorier jusqu’à 100 URL d’origine dans un fichier.
s3 SiteMapUrl Le chemin S3 vers les fichiers XML du plan du site. Par exemple, s3://bucket-name/directory/. Vous pouvez répertorier jusqu’à trois fichiers XML de plan de site. Vous pouvez regrouper plusieurs fichiers de plan de site dans un fichier ZIP et stocker le fichier ZIP dans votre Amazon S3 bucket.
graine UrlConnections La liste des URL de départ ou de point de départ des sites Web que vous souhaitez explorer. Vous pouvez répertorier jusqu'à 100 URL de départ.
Voir URL URL de départ ou de départ.
authentification Le type d'authentification si vos sites Web nécessitent la même authentification, sinon spécifiez-leNoAuthentication.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • Page Web

  • attachment

 Liste d'objets qui mappent les attributs ou les noms de champs de vos pages Web et de vos fichiers de pages Web pour Amazon Kendra indexer les noms de champs. Par exemple, la balise de titre de page Web HTML peut être mappée au champ d'_document_titleindex. Pour plus d’informations, consultez Mappage des champs de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
Limite de taux Le nombre maximal d’URL indexées par hôte de site web et par minute.
max FileSize Taille maximale (en Mo) d'une page Web ou d'une pièce jointe à explorer.
Profondeur du crawl Nombre de niveaux à partir de l’URL d’origine à indexer. Par exemple, la page URL d’amorçage est de profondeur 1 et tous les liens hypertexte de cette page qui sont également explorés ont une profondeur de 2.
max LinksPerUrl Le nombre maximum d'URL d'une page Web à inclure lors de l'exploration d'un site Web. Ce numéro est indiqué par page Web. Lorsque les pages Web d'un site Web sont explorées, toutes les URL vers lesquelles les pages Web renvoient sont également explorées. Les URL d'une page Web sont explorées par ordre d'apparition.
ramper SubDomain truepour explorer les domaines du site Web comportant des sous-domaines. Par exemple, si l'URL de départ est abc.example.com « », « a.abc.example.com » et « b.abc.example.com » sont également explorés. Si vous ne définissez pas crawlSubDomain ou crawlAllDomain surtrue, Amazon Kendra seuls les domaines des sites Web que vous souhaitez explorer sont explorés.
ramper AllDomain truepour explorer les domaines du site Web comportant des sous-domaines et d'autres domaines vers lesquels les pages Web renvoient. Si vous ne définissez pas crawlSubDomain ou crawlAllDomain surtrue, Amazon Kendra seuls les domaines des sites Web que vous souhaitez explorer sont explorés.
Honor Robots true pour respecter les directives robots.txt des sites Web que vous souhaitez indexer. Ces directives contrôlent la façon dont Amazon Kendra Web Crawler explore les sites Web, s'il Amazon Kendra peut explorer uniquement un contenu spécifique ou ne pas explorer de contenu.
Accessoires Crawl truepour analyser les fichiers vers lesquels les pages Web renvoient.

  • inclusion URLCrawlPatterns

  • inclusion URLIndexPatterns

 Une liste de modèles d'expressions régulières incluant l'exploration de certaines URL et l'indexation de tous les liens hypertextes sur ces pages Web URL. Les URL qui correspondent aux modèles sont incluses dans l’index. Les URL qui ne correspondent pas aux modèles sont exclues de l’index. Si une URL correspond à la fois à un modèle d'inclusion et à un modèle d'exclusion, le modèle d'exclusion est prioritaire et les pages Web URL/website de cette URL ne sont pas incluses dans l'index.

  • exclusion URLCrawlPatterns

  • exclusion URLIndexPatterns

 Une liste de modèles d'expressions régulières pour exclure l'exploration de certaines URL et l'indexation de tout lien hypertexte sur ces pages Web URL. Les URL qui correspondent aux modèles sont exclues de l’index. Les URL qui ne correspondent pas aux modèles sont incluses dans l’index. Si une URL correspond à la fois à un modèle d'inclusion et à un modèle d'exclusion, le modèle d'exclusion est prioritaire et les pages Web URL/website de cette URL ne sont pas incluses dans l'index.
inclusion FileIndexPatterns Une liste de modèles d’expression régulière pour inclure certains fichiers de page Web. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
exclusion FileIndexPatterns Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de pages Web. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
implicite WaitDuration

implicit WaitDuration spécifie combien de temps le connecteur attendra, en secondes, avant d'explorer une page Web.

Plage : 0-10

par exemple. « implicite WaitDuration » : « 5 »
proxy Informations de configuration requises pour se connecter à vos sites web internes via un proxy web.
hôte Le nom d'hôte du serveur proxy que vous souhaitez utiliser pour vous connecter aux sites Web internes. Par exemple, le nom d'hôte de https://a.example.com/page1.html est « a.example.com ».
port Numéro de port du serveur proxy que vous souhaitez utiliser pour vous connecter aux sites Web internes. Par exemple, 443 est le port standard pour HTTPS.
SecretArn (mandataire) Si des informations d'identification du proxy Web sont requises pour se connecter à un hôte de site Web, vous pouvez créer un AWS Secrets Manager secret qui stocke les informations d'identification. Indiquez l’Amazon Resource Name (ARN) du secret.
type Type de la source de données. Spécifiez WEBCRAWLERV2 comme type de source de données.
secretArn

Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret utilisé si vos sites Web nécessitent une authentification pour accéder aux sites Web. Vous stockez les informations d’identification d’authentification du site Web dans le secret qui contient les paires clé-valeur JSON.

Si vous utilisez la version basique NTML/Kerberos, ou entrez le nom d'utilisateur et le mot de passe. Les clés JSON du secret doivent être userName et password. Le protocole d’authentification NTLM inclut le hachage des mots de passe, tandis que le protocole d’authentification Kerberos inclut le chiffrement des mots de passe.

Si vous utilisez l'authentification SAML ou par formulaire, entrez le nom d'utilisateur et le mot de passe, XPath pour le champ du nom d'utilisateur (et le bouton du nom d'utilisateur si vous utilisez SAML), XPaths pour le champ et le bouton du mot de passe et l'URL de la page de connexion. Les clés JSON du secret doivent être userName, password, userNameFieldXpath, userNameButtonXpath, passwordFieldXpath, passwordButtonXpath et loginPageUrl. Vous pouvez trouver les XPath (langage de chemin XML) des éléments à l’aide des outils de développement de votre navigateur Web. Les XPath respectent généralement ce format : //tagname[@Attribute='Value'].

Amazon Kendra vérifie également si les informations de point de terminaison (URL de départ) incluses dans le secret sont identiques à celles spécifiées dans les détails de configuration de votre point de terminaison de source de données.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma du modèle Confluence

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'URL de l'hôte Confluence, la méthode d'hébergement et le type d'authentification dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesCONFLUENCEV2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Confluence.

Le tableau suivant décrit les paramètres du schéma JSON Confluence.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
hostUrl URL de votre instance Confluence. Par exemple, https://example.confluence.com.
type La méthode d'hébergement de votre instance Confluence, si oui ou nonSAAS. ON_PREM
authType La méthode d'authentification de votre instance Confluence, que ce soit BasicOAuth2, ouPersonal-token.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • espace

  • page

  • bloguer

  • comment

  • attachment

 Liste d'objets qui mappent les attributs ou les noms de champs de vos espaces, pages, blogs, commentaires et pièces jointes Confluence pour Amazon Kendra indexer les noms des champs. Pour plus d'informations, veuillez consulter la rubrique Mappage des champs de source de données. Les noms des champs de source de données Confluence doivent figurer dans vos métadonnées personnalisées Confluence.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
est CrawlAcl Configurez true pour analyser les informations de la liste de contrôle d'accès (ACL) pour vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. Notez que l'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Cela signifie que si cette isCrawlACL option est désactivée, les documents peuvent être recherchés publiquement. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.
champ ForUserId Indiquez email si vous souhaitez utiliser l'adresse e-mail de l'utilisateur comme identifiant utilisateur. emailest utilisé par défaut et est actuellement le seul type d'ID utilisateur pris en charge.

  • inclusion SpaceKeyFilter

  • exclusion SpaceKeyFilter

  • page TitleReg EX

  • blogue TitleReg EX

  • commentaire TitleReg EX

  • pièce jointe TitleReg EX

  • inclusion FileTypePatterns

  • exclusion FileTypePatterns

  • inclusion UrlPatterns

  • exclusion UrlPatterns

 Une liste de modèles d'expressions régulières à inclure et à and/or exclure certains fichiers dans votre source de données Confluence. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Hôte proxy Le nom d'hôte du proxy Web que vous utilisez, sans le https:// protocole http:// or.

Port proxy

 Numéro de port utilisé par le protocole de transport d'URL hôte. Il doit s'agir d'une valeur numérique comprise entre 0 et 65535.

  • est CrawlPersonalSpace

  • est CrawlArchivedSpace

  • est CrawlArchivedPage

  • est CrawlPage

  • est CrawlBlog

  • est CrawlPageComment

  • est CrawlPageAttachment

  • est CrawlBlogComment

  • est CrawlBlogAttachment

 truepour explorer les fichiers de vos espaces personnels Confluence, de vos pages, de vos blogs, de vos commentaires de page, de vos pièces jointes, de vos commentaires de blog et de vos pièces jointes de blog.
max FileSizeInMegaBytes Spécifiez la limite de taille de fichier en Mo Amazon Kendra pouvant être explorée. Amazon Kendra explore uniquement les fichiers dont la taille est limitée. La taille de fichier par défaut est de 50 Mo. La taille de fichier maximale doit être supérieure à 0 Mo et inférieure ou égale à 50 Mo.
type Type de la source de données. Spécifiez CONFLUENCEV2 comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Confluence. Pour plus d'informations sur ces paires clé-valeur, consultez la section Instructions de connexion pour Confluence.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma du modèle Dropbox

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez la clé de l'application Dropbox, le secret de l'application et le jeton d'accès dans le cadre de votre secret qui stocke vos informations d'authentification. Spécifiez également le type de source de donnéesDROPBOX, le type de jeton d'accès que vous souhaitez utiliser (temporaire ou permanent) et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Dropbox.

Le tableau suivant décrit les paramètres du schéma JSON Dropbox.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données. Cette source de données ne spécifie pas de point de terminaison dansrepositoryEndpointMetadata. Les informations de connexion sont plutôt incluses dans un AWS Secrets Manager secret que vous fournissez ausecretArn.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • dans le fichier

  • papier

  • papert

  • raccourci

 Liste d'objets qui mappent les attributs ou les noms de champs de vos fichiers Dropbox, Dropbox Paper, ainsi que des raccourcis permettant d' Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Dropbox. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "appKey": "Dropbox app key",
    "appSecret": "Dropbox app secret",
    "accesstoken": "temporary access token or refresh access token"
}
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
est CrawlAcl truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.

  • inclusion FileNamePatterns

  • inclusion FileTypePatterns

 Liste de modèles d'expressions régulières permettant d'inclure certains noms et types de fichiers dans votre source de données Dropbox. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • exclusion FileNamePatterns

  • exclusion FileTypePatterns

 Liste de modèles d'expressions régulières permettant d'exclure certains noms et types de fichiers de votre source de données Dropbox. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • Fichier Crawl

  • Papier Crawl

  • Crawlpaper

  • Raccourci Crawl

 truepour explorer les fichiers de votre Dropbox, les documents Dropbox Paper, les modèles Dropbox Paper et les raccourcis de pages Web stockés dans votre Dropbox.
type Type de la source de données. Spécifiez DROPBOX comme type de source de données.
Type de jeton Spécifiez votre type de jeton d'accès : jeton d'accès permanent ou temporaire. Il est recommandé de créer un jeton d'accès d'actualisation qui n'expire jamais dans Dropbox plutôt que de vous fier à un jeton d'accès à usage unique expirant au bout de 4 heures. Vous créez une application et un jeton d'accès d'actualisation dans la console développeur Dropbox, puis vous saisissez le jeton d'accès dans votre code secret.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Drupal

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'URL de l'hôte Drupal et le type d'authentification dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de données DRUPAL, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Drupal.

Le tableau suivant décrit les paramètres du schéma Drupal JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
hostUrl L'URL de l'hôte de votre site Web Drupal. Par exemple, https://<hostname>/<drupalsitename>.
repositoryConfigurations Informations de configuration pour le contenu de la source de données.

  • content

  • comment

  • attachment

 Une liste d’objets qui mappent les attributs ou les noms de champs de vos fichiers Drupal. Pour plus d’informations, consultez Mappage des champs de source de données. Les noms des champs de source de données Drupal doivent figurer dans vos métadonnées personnalisées Drupal.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.

  • inclusion FileNamePatterns

  • article TitleInclusionPatterns

  • page TitleInclusionPatterns

  • personnalisé ContentTitleInclusionPatterns

  • de base BlockTitleInclusionPatterns

  • personnalisé BlockTitleInclusionPatterns

 Une liste des modèles d’expression régulière pour inclure certains fichiers dans votre source de données Drupal. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • exclusion FileNamePatterns

  • article TitleExclusionPatterns

  • page TitleExclusionPatterns

  • personnalisé ContentTitleExclusionPatterns

  • de base BlockTitleExclusionPatterns

  • personnalisé BlockTitleExclusionPatterns

 Une liste des modèles d’expression régulière pour exclure certains fichiers de votre source de données Drupal. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
contentDefinitions

  • contentType

  • fieldDefinition

  • est CrawlComments

  • est CrawlFiles

  • est CrawlArticle

  • est CrawlBasicPage

  • est CrawlBasicBlock

  • est CrawlCustomContentTypesList

 Spécifiez les types de contenu à indexer et indiquez si vous souhaitez indexer les commentaires et les pièces jointes pour les types de contenu que vous avez sélectionnés.
type Type de la source de données. Spécifiez DRUPAL comme type de source de données.
authType Le type d’authentification que vous utilisez, BASIC-AUTH ou OAUTH2.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Drupal. Le secret doit contenir une structure JSON avec les clés suivantes :

Si vous utilisez l’authentification basique :

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

Si vous utilisez l’authentification OAuth 2.0 :

{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
version La version de ce modèle qui est actuellement prise en charge. 
{
	"$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 schéma de modèle

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous indiquez l'URL de l' GitHub hôte, le nom de l'organisation et indiquez si vous utilisez le GitHub GitHub cloud ou sur site dans le cadre de la configuration de la connexion ou des détails des points de terminaison du référentiel. Spécifiez également le type de source de donnéesGITHUB, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez GitHub Schéma JSON.

Le tableau suivant décrit les paramètres du schéma GitHub JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
type Spécifiez le type comme suit : SAAS ouON_PREMISE.
hostUrl URL de l' GitHub hôte. Par exemple, si vous utilisez GitHub SaaS/Enterprise Cloud : https://api.github.com. Ou, si vous utilisez GitHub premises/Enterprise on-Server : https://on-prem-host-url/api/v3/.
organizationName Vous pouvez trouver le nom de votre organisation lorsque vous vous connectez à votre GitHub ordinateur et accédez à Vos organisations dans la liste déroulante de votre photo de profil.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • Référentiel GH

  • Commettre GH

  • gh IssueDocument

  • gh IssueComment

  • gh IssueAttachment

  • Document GHPR

  • Commentaire GHPR

  • Accessoire GHPR

 Liste d'objets qui mappent les attributs ou les noms de champs de votre GitHub contenu pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
est CrawlAcl truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder et rechercher. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.
champ ForUserId Spécifiez le type d'ID utilisateur que vous souhaitez utiliser pour l'analyse des ACL. Spécifiez email si vous souhaitez utiliser l'adresse e-mail de l'utilisateur pour l'ID utilisateur ou username si vous souhaitez utiliser le nom d'utilisateur pour l'ID utilisateur. Si vous ne spécifiez aucune option, elle email est utilisée par défaut.
repositoryFilter Liste des noms des référentiels et noms de branches spécifiques que vous souhaitez indexer.
Référentiel Crawl truepour explorer les référentiels.
ramper RepositoryDocuments truepour explorer les documents du référentiel.
Numéro Crawl truepour explorer les problèmes.
ramper IssueComment truepour explorer les commentaires des problèmes.
ramper IssueCommentAttachment truepour explorer les pièces jointes aux commentaires des problèmes.
ramper PullRequest truepour explorer les pull requests.
ramper PullRequestComment truepour explorer les commentaires des pull request.
ramper PullRequestCommentAttachment truepour explorer les pièces jointes aux commentaires des demandes d'extraction.

  • inclusion FolderNamePatterns

  • inclusion FileTypePatterns

  • inclusion FileNamePatterns

 Liste de modèles d'expressions régulières permettant d'inclure certains contenus dans votre source de GitHub données. Le contenu qui correspond aux modèles est inclus dans l’index. Le contenu qui ne correspond pas aux modèles est exclu de l’index. Si un contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.

  • exclusion FolderNamePatterns

  • exclusion FileTypePatterns

  • exclusion FileNamePatterns

 Liste de modèles d'expressions régulières permettant d'exclure certains contenus de votre source de GitHub données. Le contenu qui correspond aux modèles est exclu de l’index. Le contenu qui ne correspond pas aux modèles est inclus dans l’index. Si un contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.
type Type de la source de données. Spécifiez GITHUB comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn

Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour vous connecter à votre. GitHub Le secret doit contenir une structure JSON avec les clés suivantes :

{
    "personalToken": "token"
}
version La version de ce modèle actuellement prise en charge.

Le schéma GitHub JSON est le suivant :

{
    "$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"
    ]
}

Schéma de modèle Gmail

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesGMAIL, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Gmail.

Le tableau suivant décrit les paramètres du schéma JSON de Gmail.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données. Cette source de données ne spécifie pas de point de terminaison dansrepositoryEndpointMetadata. Les informations de connexion sont plutôt incluses dans un AWS Secrets Manager secret que vous fournissez ausecretArn.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

  • message

  • attachments

 Liste d'objets qui mappent les attributs ou les noms de champs de vos messages et pièces jointes Gmail pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.

  • inclusion LabelNamePatterns

  • exclusion LabelNamePatterns

  • inclusion AttachmentTypePatterns

  • exclusion AttachmentTypePatterns

  • inclusion AttachmentNamePatterns

  • exclusion AttachmentNamePatterns

  • inclusion SubjectFilter

  • exclusion SubjectFilter

  • est SubjectAnd

  • inclusion FromFilter

  • exclusion FromFilter

  • inclusion ToFilter

  • exclusion ToFilter

  • inclusion CcFilter

  • exclusion CcFilter

  • inclusion BccFilter

  • exclusion BccFilter

 Liste de modèles d'expressions régulières permettant d'inclure ou d'exclure des messages portant un nom d'objet spécifique dans votre source de données Gmail. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
avant DateFilter Spécifiez les messages et les pièces jointes à inclure avant une certaine date.
après DateFilter Spécifiez les messages et les pièces jointes à inclure après une certaine date.
est CrawlAttachment Valeur booléenne permettant de choisir si vous souhaitez indexer les pièces jointes. Les messages sont automatiquement indexés.
type Type de la source de données. Spécifiez GMAIL comme type de source de données.
devrait CrawlDraftMessages Valeur booléenne permettant de choisir si vous souhaitez indexer les brouillons de messages.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

Important

Comme il n'existe pas d'API permettant de mettre à jour les messages Gmail supprimés définitivement, tout contenu nouveau, modifié ou supprimé est synchronisé :

  • Les messages supprimés définitivement de Gmail ne seront pas supprimés de votre Amazon Kendra index

  • Les modifications apportées aux libellés des e-mails Gmail ne seront pas synchronisées

Pour synchroniser les modifications apportées à l'étiquette de votre source de données Gmail et les e-mails supprimés définitivement avec votre Amazon Kendra index, vous devez effectuer régulièrement des analyses complètes.
secretARN Le nom de ressource Amazon (ARN) d'un secret Secrets Manager qui contient les paires clé-valeur requises pour se connecter à votre compte Gmail. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Google Drive

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesGOOGLEDRIVE2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Google Drive.

Le tableau suivant décrit les paramètres du schéma JSON de Google Drive.

Configuration Description
connectionConfiguration Informations de configuration pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données. Cette source de données ne spécifie pas de point de terminaison. Vous choisissez votre type d’authentification : serviceAccount et OAuth2. Les informations de connexion sont incluses dans un AWS Secrets Manager secret que vous fournissez ausecretArn.
authType Choisissez entre serviceAccount et OAuth2 en fonction de votre cas d'utilisation.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • dans le fichier

  • comment

 Liste d'objets qui mappent les attributs ou les noms de champs de votre Google Drive pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données

  • max FileSizeInMegaBytes

 Spécifiez une limite de taille de fichier en Mo qui Amazon Kendra doit être explorée.

  • Commentaire IsCrawl

 truepour explorer les commentaires de votre source de données Google Drive.

  • est CrawlMyDriveAndSharedWithMe

 truepour explorer MyDrive et partager avec moi les lecteurs de votre source de données Google Drive.

  • est CrawlSharedDrives

 truepour explorer les disques partagés dans votre source de données Google Drive.
est CrawlAcl truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder et rechercher. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.

  • exclure UserAccounts

  • exclure SharedDrives

  • exclure MimeTypes

  • exclusion FileTypePatterns

  • exclusion FileNamePatterns

  • exclusion FilePathFilter

 Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de données Google Drive. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • inclure UserAccounts

  • inclure SharedDrives

  • inclure MimeTypes

  • inclusion FileTypePatterns

  • inclusion FileNamePatterns

  • inclusion FilePathFilter

 Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de données Google Drive. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
type Type de la source de données. Spécifiez GOOOGLEDRIVEV2 comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Google Drive. Le secret doit contenir une structure JSON avec les clés suivantes :

Si vous utilisez l'authentification du compte de service Google :

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

Si vous utilisez l'authentification OAuth 2.0 :

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle IBM DB2

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesdb2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON IBM DB2.

Le tableau suivant décrit les paramètres du schéma JSON IBM DB2.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Modèle de schéma Microsoft Exchange

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'ID du locataire dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesMSEXCHANGE, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Microsoft Exchange.

Le tableau suivant décrit les paramètres du schéma Microsoft Exchange JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
Identifiant du locataire ID de locataire Microsoft 365. Vous trouverez votre ID de locataire dans les propriétés de votre portail Azure Active Directory ou dans votre application OAuth.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • e-mail

  • attachment

  • calendrier

  • contacts

  • notes

 Liste d'objets qui mappent les attributs ou les noms de champs de votre source de données Microsoft Exchange pour Amazon Kendra indexer les champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour le contenu dans votre source de données
Modèles d'inclusion Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de données Microsoft Exchange. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Schémas d'exclusion Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de données Microsoft Exchange. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • inclusion UsersList

  • inclusion UsersFileName

  • inclusion DomainUsers

 Liste de modèles d'expressions régulières permettant d'inclure certains utilisateurs et fichiers utilisateur dans votre source de données Microsoft Exchange. Les utilisateurs qui correspondent aux modèles sont inclus dans l'index. Les utilisateurs qui ne correspondent pas aux modèles sont exclus de l'index. Si un utilisateur correspond à la fois à un modèle d'inclusion et à un modèle d'exclusion, le modèle d'exclusion est prioritaire et l'utilisateur n'est pas inclus dans l'index.

  • exclusion UsersList

  • exclusion UsersFileName

  • exclusion DomainUsers

 Liste de modèles d'expressions régulières permettant d'exclure certains utilisateurs et fichiers utilisateur de votre source de données Microsoft Exchange. Les utilisateurs qui correspondent aux modèles sont exclus de l'index. Les utilisateurs qui ne correspondent pas aux modèles sont inclus dans l'index. Si un utilisateur correspond à la fois à un modèle d'exclusion et à un modèle d'inclusion, le modèle d'exclusion est prioritaire et l'utilisateur n'est pas inclus dans l'index.
Nom du bucket S3 Le nom de votre compartiment S3 si vous souhaitez l'utiliser.

  • Calendrier Crawl

  • Notes Crawl

  • Contacts Crawl

  • ramper FolderAcl

 truepour analyser ces types de contenu et les informations de contrôle d'accès à votre source de données Microsoft Exchange.
démarrer CalendarDateTime Vous pouvez configurer une date et une heure de début spécifiques pour le contenu de votre calendrier.
fin CalendarDateTime Vous pouvez configurer une date et une heure de fin spécifiques pour le contenu du calendrier.
subject Vous pouvez configurer une ligne d'objet spécifique pour le contenu de votre e-mail.
E-mail de Vous pouvez configurer un e-mail spécifique pour le contenu de votre e-mail « De » ou de l'expéditeur.
Envoyer un e-mail à Vous pouvez configurer un e-mail spécifique pour le contenu de votre e-mail « À » ou du destinataire.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
type Type de la source de données. Spécifiez MSEXCHANGE comme type de source de données.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Microsoft Exchange. Cela inclut votre ID client et votre secret client qui est généré lorsque vous créez une application OAuth sur le portail Azure.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma OneDrive de modèle Microsoft

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'ID du locataire dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de données et un secret pour vos informations d'authentification, ainsi que ONEDRIVEV2 les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma Microsoft OneDrive JSON.

Le tableau suivant décrit les paramètres du schéma Microsoft OneDrive JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
Identifiant du locataire ID de locataire Microsoft 365. Vous trouverez votre ID de locataire dans les propriétés de votre portail Azure Active Directory ou dans votre application OAuth.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.
dans le fichier Liste d'objets qui mappent les attributs ou les noms de champs de vos OneDrive fichiers Microsoft pour Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données

  • utilisateur NameFilter

  • utilisateur FilterPath

  • inclusion FileTypePatterns

  • exclusion FileTypePatterns

  • inclusion FileNamePatterns

  • exclusion FileNamePatterns

  • inclusion FilePathPatterns

  • exclusion FilePathPatterns

  • inclusion OneNoteSectionNamePatterns

  • exclusion OneNoteSectionNamePatterns

  • inclusion OneNotePageNamePatterns

  • exclusion OneNotepageNamePatterns

 Vous pouvez choisir d'indexer des fichiers, des OneNote sections et des OneNote pages spécifiques et de les filtrer par nom d'utilisateur.
est UserNameOnS3 true pour fournir une liste de noms d’utilisateur dans un fichier stocké dans un Amazon S3.
type Type de la source de données. Spécifiez ONEDRIVEV2 comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
type Type de la source de données. Spécifiez ONEDRIVEV2 comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Microsoft. OneDrive Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
version La version de ce modèle qui est actuellement prise en charge. 
{
	"$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"
	]
}

Schéma SharePoint de modèle Microsoft

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de TemplateConfiguration l'objet. Vous fournissez le SharePoint site URL/URLs, le domaine et également un ID de locataire si nécessaire dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesSHAREPOINTV2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type lorsque vous appelez CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez SharePoint Schéma JSON.

Le tableau suivant décrit les paramètres du schéma Microsoft SharePoint JSON.

Configuration Description
connectionConfiguration Informations de configuration pour le point de terminaison de la source de données
référentiel EndpointMetadata Les informations de point de terminaison pour la source de données
Identifiant du locataire L'identifiant du locataire de votre SharePoint compte.
domaine Le domaine de votre SharePoint compte.
URL du site URL de l'hôte de votre SharePoint compte.
référentiel AdditionalProperties Propriétés supplémentaires pour se connecter au point de terminaison repository/data source.
Nom du bucket S3 Nom du Amazon S3 compartiment qui stocke votre X.509 certificat auto-signé Azure AD.
Nom du certificat S3 Le nom du X.509 certificat auto-signé Azure AD stocké dans votre Amazon S3 compartiment.
authType Type d'authentification que vous utilisez, que ce soit OAuth2 OAuth2Certificate OAuth2AppBasic,OAuth2_RefreshToken,NTLM, ouKerberos.
version La SharePoint version que vous utilisez, que ce soit Server ou nonOnline.
sur PremVersion La version SharePoint du serveur que vous utilisez, que ce soit 2013 ou nonSubscriptionEdition.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • event

  • page

  • dans le fichier

  • lien

  • attachment

  • comment

 Liste d'objets qui mappent les attributs ou les noms de champs de votre SharePoint contenu pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.

  • événement TitleFilterRegEx

  • page TitleFilterRegEx

  • lien TitleFilterRegEx

  • inclusion FilePath

  • exclusion FilePath

  • inclusion FileTypePatterns

  • exclusion FileTypePatterns

  • inclusion FileNamePatterns

  • exclusion FileNamePatterns

  • inclusion OneNoteSectionNamePatterns

  • exclusion OneNoteSectionNamePatterns

  • inclusion OneNotePageNamePatterns

  • exclusion OneNotePageNamePatterns

 Liste de modèles d'expressions régulières associés à include/exclude certains contenus de votre source de SharePoint données. Les éléments de contenu qui correspondent aux modèles d'inclusion sont inclus dans l'index. Les éléments de contenu qui ne correspondent pas aux modèles d'inclusion sont exclus de l'index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • Fichiers Crawl

  • CrawlPages

  • Événements CRAW

  • Commentaires Crawl

  • Liens Crawl

  • Accessoires Crawl

 truepour explorer ces types de contenu.
Crawla CL truepour explorer les informations de la liste de contrôle d'accès (ACL) de vos documents, si vous possédez une ACL et souhaitez l'utiliser pour le contrôle d'accès. L'ACL spécifie les documents auxquels les utilisateurs et les groupes peuvent accéder et rechercher. Les informations ACL sont utilisées pour filtrer les résultats de recherche en fonction de l'accès de l'utilisateur ou de son groupe aux documents. Pour plus d'informations, consultez la section Filtrage contextuel des utilisateurs.
champ ForUserId Spécifiez email si vous souhaitez utiliser l'adresse e-mail de l'utilisateur pour l'ID utilisateur ou userPrincipalName si vous souhaitez utiliser un nom d'utilisateur pour l'ID utilisateur. Si vous ne spécifiez aucune option, elle email est utilisée par défaut.
Configuration de l'ACL Spécifiez soit ACLWithLDAPEmailFmtACLWithManualEmailFmt, soitACLWithUsernameFmtM.
Domaine de messagerie Le domaine de l'e-mail. Par exemple, « amazon.com ».

  • est CrawlLocalGroupMapping

  • est CrawlAdGroupMapping

 truepour explorer les informations de mappage des groupes.
Hôte proxy Le nom d'hôte du proxy Web que vous utilisez, sans le protocole http ://ou https ://.
Port proxy Numéro de port utilisé par le protocole de transport d'URL hôte. Il doit s'agir d'une valeur numérique comprise entre 0 et 65535.
type Spécifiez SHAREPOINTV2 comme type de source de données
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour vous connecter à votre. SharePoint Pour plus d'informations sur ces paires clé-valeur, consultez les instructions de connexion pour SharePoint Online et SharePoint Server.
version La version de ce modèle qui est actuellement prise en charge. 
{
	"$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"
	]
}

Schéma modèle Microsoft SQL Server

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéessqlserver, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Microsoft SQL Server.

Le tableau suivant décrit les paramètres du schéma JSON Microsoft SQL Server.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Modèle de schéma Microsoft Teams

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'ID du locataire dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesMSTEAMS, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Microsoft Teams.

Le tableau suivant décrit les paramètres du schéma JSON de Microsoft Teams.

Configuration Description
connectionConfiguration Informations de configuration pour un point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
Identifiant du locataire ID de locataire Microsoft 365. Vous trouverez votre ID de locataire dans les propriétés de votre portail Azure Active Directory ou dans votre application OAuth.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • Message de chat

  • Pièce jointe au chat

  • Post de la chaîne

  • Canal Wiki

  • Attachement à la chaîne

  • Chat de réunion

  • Dossier de réunion

  • Note de réunion

  • Réunion calendaire

 Liste d'objets qui mappent les attributs ou les noms de champs de votre contenu Microsoft Teams pour Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
Modèle de paiement Spécifie le type de modèle de paiement à utiliser avec votre source de données Microsoft Teams. Les modèles de paiement du modèle A sont limités aux modèles de licence et de paiement qui nécessitent une conformité en matière de sécurité. Les modèles de paiement du modèle B conviennent aux modèles de licence et de paiement qui ne nécessitent pas de conformité en matière de sécurité.

  • inclusion TeamNameFilter

  • inclusion ChannelNameFilter

  • inclusion FileNamePatterns

  • inclusion FileTypePatterns

  • inclusion UserEmailFilter

  • inclusion OneNoteSectionNamePatterns

  • inclusion OneNotePageNamePatterns

 Liste de modèles d'expressions régulières permettant d'inclure certains contenus dans votre source de données Microsoft Teams. Le contenu qui correspond aux modèles est inclus dans l’index. Le contenu qui ne correspond pas aux modèles est exclu de l’index. Si le contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.

  • exclusion TeamNameFilter

  • exclusion ChannelNameFilter

  • exclusion FileNamePatterns

  • exclusion FileTypePatterns

  • exclusion UserEmailFilter

  • exclusion OneNoteSectionNamePatterns

  • exclusion OneNotePageNamePatterns

 Liste de modèles d'expressions régulières permettant d'exclure certains contenus de votre source de données Microsoft Teams. Le contenu qui correspond aux modèles est exclu de l’index. Le contenu qui ne correspond pas aux modèles est inclus dans l’index. Si le contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.

  • est CrawlChatMessage

  • est CrawlChatAttachment

  • est CrawlChannelPost

  • est CrawlChannelAttachment

  • est CrawlChannelWiki

  • est CrawlCalendarMeeting

  • est CrawlMeetingChat

  • est CrawlMeetingFile

  • est CrawlMeetingNote

 truepour analyser ces types de contenu dans votre source de données Microsoft Teams.
démarrer CalendarDateTime Vous pouvez configurer une date et une heure de début spécifiques pour le contenu de votre calendrier.
fin CalendarDateTime Vous pouvez configurer une date et une heure de fin spécifiques pour le contenu du calendrier.
type Type de la source de données. Spécifiez MSTEAMS comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à Microsoft Teams. Cela inclut votre ID client et votre code secret client générés lorsque vous créez une application OAuth sur le portail Azure.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Microsoft Yammer

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de TemplateConfiguration l'objet. Spécifiez le type de source de donnéesYAMMER, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type lorsque vous appelez CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur.

Le tableau suivant décrit les paramètres du schéma Microsoft Yammer JSON.

Configuration Description
connectionConfiguration Informations de configuration pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données. Cette source de données ne spécifie pas de point de terminaison dansrepositoryEndpointMetadata. Les informations de connexion sont plutôt incluses dans un AWS Secrets Manager secret que vous fournissez ausecretArn.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • communauté

  • user

  • message

  • attachment

 Liste d'objets qui font correspondre les attributs ou les noms de champs du contenu Microsoft Yammer aux noms des champs d'index Amazon Kendra. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données
Modèles d'inclusion Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de données Microsoft Yammer. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Schémas d'exclusion Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de données Microsoft Yammer. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Depuis la date Vous pouvez choisir de configurer un sinceDate paramètre pour que le connecteur Microsoft Yammer analyse le contenu en fonction d'un élément spécifique. sinceDate
communauté NameFilter Vous pouvez choisir d'indexer un contenu communautaire spécifique.

  • est CrawlMessage

  • est CrawlAttachment

  • est CrawlPrivateMessage

 truepour explorer les messages, les pièces jointes et les messages privés.
type Spécifiez YAMMER comme type de source de données.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Microsoft Yammer. Cela inclut votre nom d'utilisateur et votre mot de passe Microsoft Yammer, ainsi que votre ID client et votre code secret client générés lorsque vous créez une application OAuth sur le portail Azure.
utiliser ChangeLog truepour utiliser le journal des modifications de Microsoft Yammer afin de déterminer quels documents doivent être mis à jour dans l'index.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes. 
{
  "$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"
  ]
}

Schéma de modèle MySQL

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesmysql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON MySQL.

Le tableau suivant décrit les paramètres du schéma JSON MySQL.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma du modèle de base de données Oracle

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéesoracle, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON de base de données Oracle.

Le tableau suivant décrit les paramètres du schéma JSON de la base de données Oracle.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle PostgreSQL

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Spécifiez le type de source de donnéesJDBC, le type de base de donnéespostgresql, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON PostgreSQL.

Le tableau suivant décrit les paramètres du schéma JSON de PostgreSQL.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de configuration requises pour la connexion de votre source de données.

  • DbType : type de base de données Java que vous utilisez, que ce soit mysqldb2, postgresqloracle, ou. sqlserver

  • dbHost : nom d’hôte de la base de données.

  • dbPort : port de la base de données.

  • dbInstance : instance de la base de données.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs. Spécifiez le type de source de données et l’ARN secret.

document

 Liste d'objets qui mappent les attributs ou les noms de champs du contenu de votre base de données pour Amazon Kendra indexer les noms des champs. Pour plus d’informations, consultez Mappage des champs de source de données.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données. Utilisez ce champ pour inclure ou exclure du contenu spécifique dans la source de données de votre base de données.
primaryKey Indiquez la clé primaire pour la table de base de données. Cela identifie une table au sein de votre base de données.
titleColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
bodyColumn Indiquez le nom de la colonne de titre du document dans votre table de base de données.
sqlQuery Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
timestampColumn Entrez le nom de la colonne contenant les horodatages. Amazon Kendra utilise les informations d'horodatage pour détecter les modifications apportées à votre contenu et ne synchroniser que le contenu modifié.
timestampFormat Saisissez le nom de la colonne contenant les formats d’horodatage à utiliser pour détecter les modifications de contenu et resynchroniser votre contenu.
timezone Saisissez le nom de la colonne contenant les fuseaux horaires du contenu à indexer.
changement DetectingColumns Entrez le nom des colonnes qui Amazon Kendra seront utilisées pour détecter les modifications de contenu. Amazon Kendra réindexera le contenu en cas de modification de l'une de ces colonnes
autorisé UsersColumns Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
autorisé GroupsColumn Saisissez le nom de la colonne contenant les ID utilisateur autorisés à accéder au contenu.
sourceURIColumn Saisissez le nom de la colonne contenant les URL sources à indexer.
est SslEnabled Saisissez des instructions de requête SQL telles que les opérations SELECT et JOIN. La taille des requêtes SQL doit être inférieure à 32 Ko. Amazon Kendra explorera tout le contenu de la base de données correspondant à votre requête.
type Type de la source de données. Spécifiez JDBC comme type de source de données.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretArn L’Amazon Resource Name (ARN) d’un secret Secrets Manager qui contient le nom d’utilisateur et le mot de passe requis pour la connexion à votre base de données. Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "user name": "database user name",
    "password": "password"
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Salesforce

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'URL de l'hôte Salesforce dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesSALESFORCEV2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Salesforce.

Le tableau suivant décrit les paramètres du schéma Salesforce JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
hostUrl URL de l'instance Salesforce à indexer.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • compte

  • contact

  • campaign

  • cas

  • product

  • lead

  • contrat

  • partenaire

  • profile

  • idée

  • catalogue de prix

  • tâche

  • solution

  • attachment

  • user

  • document

  • Articles sur les connaissances

  • groupe

  • opportunity

  • bavarder

  • Entité personnalisée

 Liste d'objets qui mappent les attributs ou les noms de champs de vos entités Salesforce pour Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Salesforce. Le secret doit contenir une structure JSON avec les clés suivantes :

Pour le flux d'informations d'identification des clients :

{
    "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"
}

Pour 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 Options de configuration supplémentaires pour votre contenu dans votre source de données

  • Filtre de compte

  • Filtre de contact

  • Filtre de boîtier

  • Filtre de campagne

  • Filtre de contrat

  • Filtre de groupe

  • Filtre au plomb

  • Filtre de produit

  • Filtre d'opportunités

  • Filtre partenaire

  • Filtre PriceBook

  • Filtre Idea

  • Filtre de profil

  • Filtre de tâches

  • Filtre de solution

  • Filtre utilisateur

  • Filtre Chatter

  • Filtre de documents

  • connaissances ArticleFilter

  • Entités personnalisées

 Collection de chaînes qui indique les entités à filtrer.

Modèles d'inclusion

  • inclusion DocumentFileTypePatterns

  • inclusion DocumentFileNamePatterns

  • inclusion AccountFileTypePatterns

  • inclusion CampaignFileTypePatterns

  • inclusion DocumentFileNamePatterns

  • inclusion CampaignFileNamePatterns

  • inclusion CaseFileTypePatterns

  • inclusion CaseFileNamePatterns

  • inclusion ContactFileTypePatterns

  • inclusion ContractFileNamePatterns

  • inclusion LeadFileTypePatterns

  • inclusion LeadFileNamePatterns

  • inclusion OpportunityFileTypePatterns

  • inclusion OpportunityFileNamePatterns

  • inclusion SolutionFileTypePatterns

  • inclusion SolutionFileNamePatterns

  • inclusion TaskFileTypePatterns

  • inclusion TaskFileNamePatterns

  • inclusion GroupFileTypePatterns

  • inclusion GroupFileNamePatterns

  • inclusion ChatterFileTypePatterns

  • inclusion ChatterFileNamePatterns

  • inclusion CustomEntityFileTypePatterns

  • inclusion CustomEntityFileNamePatterns

 Liste de modèles d'expressions régulières permettant d'inclure certains fichiers dans votre source de données Salesforce. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

Schémas d'exclusion

  • exclusion DocumentFileTypePatterns

  • exclusion DocumentFileNamePatterns

  • exclusion AccountFileTypePatterns

  • exclusion CampaignFileTypePatterns

  • exclusion CampaignFileNamePatterns

  • exclusion CaseFileTypePatterns

  • exclusion CaseFileNamePatterns

  • exclusion ContactFileTypePatterns

  • exclusion ContractFileNamePatterns

  • exclusion LeadFileTypePatterns

  • exclusion LeadFileNamePatterns

  • exclusion OpportunityFileTypePatterns

  • exclusion OpportunityFileNamePatterns

  • exclusion SolutionFileTypePatterns

  • exclusion SolutionFileNamePatterns

  • exclusion TaskFileTypePatterns

  • exclusion TaskFileNamePatterns

  • exclusion GroupFileTypePatterns

  • exclusion GroupFileNamePatterns

  • exclusion ChatterFileTypePatterns

  • exclusion ChatterFileNamePatterns

  • exclusion CustomEntityFileTypePatterns

  • exclusion CustomEntityFileNamePatterns

 Liste de modèles d'expressions régulières permettant d'exclure certains fichiers de votre source de données Salesforce. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • est CrawlAccount

  • est CrawlContact

  • est CrawlCase

  • est CrawlCampaign

  • est CrawlProduct

  • est CrawlLead

  • est CrawlContract

  • est CrawlPartner

  • est CrawlProfile

  • est CrawlIdea

  • est CrawlPricebook

  • est CrawlDocument

  • ramper SharedDocument

  • est CrawlGroup

  • est CrawlOpportunity

  • est CrawlChatter

  • est CrawlUser

  • est CrawlSolution

  • est CrawlTask

  • est CrawlAccountAttachments

  • est CrawlContactAttachments

  • est CrawlCaseAttachments

  • est CrawlCampaignAttachments

  • est CrawlLeadAttachments

  • est CrawlContractAttachments

  • est CrawlGroupAttachments

  • est CrawlOpportunityAttachments

  • est CrawlChatterAttachments

  • est CrawlSolutionAttachments

  • est CrawlTaskAttachments

  • est CrawlCustomEntityAttachments

  • est CrawlKnowledgeArticles

    • est CrawlDraft

    • est CrawlPublish

    • est CrawlArchived

 truepour explorer ces types de fichiers dans votre compte Salesforce.
type Type de la source de données. Spécifiez SALESFORCEV2 comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
version La version de ce modèle qui est actuellement prise en charge. 
{
  "$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 schéma de modèle

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de l'TemplateConfigurationobjet. Vous fournissez l'URL de l' ServiceNow hôte, le type d'authentification et la version de l'instance dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesSERVICENOWV2, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez ServiceNow Schéma JSON.

Le tableau suivant décrit les paramètres du schéma ServiceNow JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
hostUrl URL de l' ServiceNow hôte. Par exemple, your-domain.service-now.com.
authType Le type d’authentification que vous utilisez, basicAuth ou OAuth2.
service dès maintenant InstanceVersion La ServiceNow version que vous utilisez. Vous pouvez choisir entre TokyoSandiego,Rome, etOthers.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • Article sur les connaissances

  • attachment

  • Catalogue de services

  • incident

 Liste d'objets qui mappent les attributs ou les noms de champs de vos articles de ServiceNow connaissances, de vos pièces jointes, de votre catalogue de services et de vos incidents afin d' Amazon Kendra indexer les noms de champs. Pour plus d’informations, consultez Mappage des champs de source de données. Les noms des champs de source de ServiceNow données doivent figurer dans vos métadonnées ServiceNow personnalisées.
propriétés supplémentaires Options de configuration supplémentaires pour votre contenu dans votre source de données.
max FileSizeInMegaBytes Spécifiez la limite de taille de fichier en Mo qu'Amazon Kendra analysera. Amazon Kendra analysera uniquement les fichiers dont la taille ne dépasse pas la limite que vous avez définie. La taille de fichier par défaut est de 50 Mo. La taille de fichier maximale doit être supérieure à 0 Mo et inférieure ou égale à 50 Mo.

  • connaissances ArticleFilter

  • incident QueryFilter

  • service CatalogQueryFilter

  • connaissances ArticleTitleRegExp

  • service CatalogTitleRegExp

  • incident TitleRegExp

  • inclusion FileTypePatterns

  • exclusion FileTypePatterns

  • inclusion FileNamePatterns

  • exclusion FileNamePatterns

  • incident StateType

 Liste de modèles d'expressions régulières à inclure et à and/or exclure certains fichiers de votre source de ServiceNow données. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • est CrawlKnowledgeArticle

  • est CrawlKnowledgeArticleAttachment

  • inclure PublicArticlesOnly

  • est CrawlServiceCatalog

  • est CrawlServiceCatalogAttachment

  • est CrawlActiveServiceCatalog

  • est CrawlInactiveServiceCatalog

  • est CrawlIncident

  • est CrawlIncidentAttachment

  • est CrawlActiveIncident

  • est CrawlInactiveIncident

  • appliquer ACLForKnowledgeArticle

  • appliquer ACLForServiceCatalog

  • appliquer ACLForIncident

 truepour parcourir les articles de ServiceNow connaissances, les catalogues de services, les incidents et les pièces jointes.
type Type de la source de données. Spécifiez SERVICENOWV2 comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour vous connecter à votre. ServiceNow Le secret doit contenir une structure JSON avec les clés suivantes : 
{
    "username": "user name",
    "password": "password"
}
Si vous utilisez l’authentification OAuth2, votre secret doit contenir une structure JSON avec les clés suivantes : 
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"         
}
version La version du modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Slack

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de TemplateConfiguration l'objet. Vous fournissez l'URL de l'hôte dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesSLACK, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Slack.

Le tableau suivant décrit les paramètres du schéma JSON de Slack.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
teamId L'identifiant d'équipe Slack que vous avez copié depuis l'URL de votre page principale de Slack.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.
Tous Liste d'objets qui mappent les attributs ou les noms de champs de votre Slack contenu pour Amazon Kendra indexer les noms des champs.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données.
Modèles d'inclusion Vous pouvez utiliser des modèles d’expressions régulières pour inclure du contenu spécifique dans votre source de données Slack. Le contenu qui correspond aux modèles est inclus dans l’index. Le contenu qui ne correspond pas aux modèles est exclu de l’index. Si un contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.
Schémas d'exclusion Vous pouvez utiliser des modèles d’expressions régulières pour exclure du contenu spécifique dans votre source de données Slack. Le contenu qui correspond aux modèles est exclu de l’index. Le contenu qui ne correspond pas aux modèles est inclus dans l'index. Si un contenu correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le contenu n’est pas inclus dans l’index.
ramper BotMessages truepour explorer les messages des robots.
Exclure les fichiers archivés truepour exclure l'exploration des messages archivés.
Type de conversation Type de conversation que vous souhaitez indexer, que ce soit PUBLIC_CHANNELPRIVATE_CHANNEL, GROUP_MESSAGE etDIRECT_MESSAGE.
Filtre de canal Le type de canal que vous souhaitez indexer, private_channel ou public_channel.
Depuis la date Vous pouvez choisir de configurer un paramètre sinceDate afin que le connecteur Slack indexe le contenu en fonction d’un paramètre sinceDate spécifique.
Regardez en arrière Vous pouvez choisir de configurer un lookBack paramètre pour que le Slack connecteur analyse le contenu mis à jour ou supprimé jusqu'à un certain nombre d'heures avant la dernière synchronisation de votre connecteur.
syncMode

Spécifiez comment Amazon Kendra mettre à jour votre index lorsque le contenu de votre source de données change. Vous pouvez choisir entre :

  • FORCED_FULL_CRAWLpour indexer à nouveau tout le contenu, en remplaçant le contenu existant chaque fois que votre source de données est synchronisée avec votre index.

  • FULL_CRAWLpour indexer uniquement le contenu nouveau, modifié et supprimé chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.

  • CHANGE_LOGpour indexer uniquement le contenu nouveau et modifié chaque fois que votre source de données est synchronisée avec votre index. Amazon Kendra peut utiliser le mécanisme de votre source de données pour suivre les modifications de contenu et indexer le contenu modifié depuis la dernière synchronisation.
type Type de la source de données. Spécifiez SLACK comme type de source de données.
activer IdentityCrawler trued'utiliser Amazon Kendra le moteur d'exploration des identités pour synchroniser les identity/principal informations sur les utilisateurs et les groupes ayant accès à certains documents. Si le robot d'identification est désactivé, tous les documents peuvent faire l'objet d'une recherche publique. Si vous souhaitez utiliser le contrôle d'accès pour vos documents et que le robot d'identification est désactivé, vous pouvez également utiliser l'PutPrincipalMappingAPI pour télécharger les informations d'accès des utilisateurs et des groupes.
secretArn

Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre. Slack Le secret doit contenir une structure JSON avec les clés suivantes :

{
    "slackToken": "token"
}
version La version de ce modèle actuellement prise en charge. 
{
  "$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"
  ]
}

Schéma de modèle Zendesk

Vous incluez un JSON qui contient le schéma de la source de données dans le cadre de TemplateConfiguration l'objet. Vous fournissez l'URL de l'hôte dans le cadre de la configuration de la connexion ou des détails du point de terminaison du référentiel. Spécifiez également le type de source de donnéesZENDESK, un secret pour vos informations d'authentification et les autres configurations nécessaires. Vous spécifiez ensuite TEMPLATE comme Type date d'appel CreateDataSource.

Vous pouvez utiliser le modèle fourni dans ce guide du développeur. Consultez Schéma JSON Zendesk.

Le tableau suivant décrit les paramètres du schéma Zendesk JSON.

Configuration Description
connectionConfiguration Informations de configuration du point de terminaison pour la source de données.
référentiel EndpointMetadata Informations de point de terminaison pour la source de données.
URL de l'hôte URL de l'hôte Zendesk. Par exemple, https://yoursubdomain.zendesk.com.
repositoryConfigurations Informations de configuration pour le contenu de la source de données. Par exemple, configurer des types spécifiques de contenu et des mappages de champs.

  • ticket

  • Commentaire sur le ticket

  • billet CommentAttachment

  • article

  • Commentaire de l'article

  • Pièce jointe à l'article

  • Thème communautaire

  • communauté PostComment

 Liste d'objets qui font correspondre les attributs ou les noms de champs des tickets Zendesk aux noms des champs d'index Amazon Kendra. Pour plus d’informations, consultez Mappage des champs de source de données.
secretARN Le nom de ressource Amazon (ARN) d'un AWS Secrets Manager secret contenant les paires clé-valeur requises pour se connecter à votre Zendesk. Le secret doit contenir une structure JSON avec les clés suivantes : URL de l'hôte, ID client, secret client, nom d'utilisateur et mot de passe.
additionalProperties Options de configuration supplémentaires pour votre contenu dans votre source de données
organisation NameFilter Vous pouvez choisir d'indexer les tickets qui existent au sein d'une organisation spécifique.
Depuis la date Vous pouvez choisir de configurer un sinceDate paramètre pour que le connecteur Zendesk analyse le contenu en fonction d'un élément spécifique. sinceDate
Modèles d'inclusion Une liste de modèles d'expressions régulières pour inclure certains fichiers dans votre source de données Zendesk. Les fichiers qui correspondent aux modèles sont inclus dans l’index. Les fichiers qui ne correspondent pas aux modèles sont exclus de l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.
Schémas d'exclusion Une liste de modèles d'expressions régulières pour exclure certains fichiers de votre source de données Zendesk. Les fichiers qui correspondent aux modèles sont exclus de l’index. Les fichiers qui ne correspondent pas aux modèles sont inclus dans l’index. Si un fichier correspond à la fois à un modèle d’inclusion et d’exclusion, le modèle d’exclusion a la priorité et le fichier n’est pas inclus dans l’index.

  • est CrawlTicket

  • est CrawlTicketComment

  • est CrawlTicketCommentAttachment

  • est CrawlArticle

  • est CrawlArticleComment

  • est CrawlArticleAttachment

  • est CrawlCommunityTopic

  • est CrawlCommunityPost

  • est CrawlCommunityPostComment

 Entrez « true » pour explorer ces types de contenu.
type Spécifiez ZENDESK comme type de source de données.
utiliser ChangeLog Saisissez « true » pour utiliser le journal des modifications Zendesk afin de déterminer quels documents doivent être mis à jour dans l'index. Selon la taille du journal des modifications, il peut être plus rapide de numériser les documents dans Zendesk. Si vous synchronisez votre source de données Zendesk avec votre index pour la première fois, tous les documents sont numérisés. 
{
  "$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"
  ]
}