Esquemas de plantillas de origen de datos - Amazon Kendra
Esquema de plantilla de Adobe Experience ManagerAmazon FSx Esquema de plantillas (Windows)Amazon FSx Esquema de plantillas (NetApp ONTAP)Esquema de plantilla de AlfrescoAurora Esquema de plantillas (MySQL)Aurora Esquema de plantillas (PostgreSQL)Amazon RDS Esquema de plantillas (Microsoft SQL Server)Amazon RDS Esquema de plantillas (MySQL)Amazon RDS Esquema de plantillas (Oracle)Amazon RDS Esquema de plantillas (PostgreSQL)Amazon S3 esquema de plantillaAmazon Kendra Esquema de plantillas de Web CrawlerEsquema de plantilla de ConfluenceEsquema de plantilla de DropboxEsquema de plantilla de DrupalGitHub esquema de plantillaEsquema de plantilla de GmailEsquema de plantilla de Google DriveEsquema de plantilla de IBM DB2Esquema de plantilla de Microsoft ExchangeEsquema OneDrive de plantillas de MicrosoftEsquema SharePoint de plantillas de MicrosoftEsquema de plantilla de Microsoft SQL ServerEsquema de plantilla de Microsoft TeamsEsquema de plantilla de Microsoft YammerEsquema de plantilla de MySQLEsquema de plantilla de Oracle DatabaseEsquema de plantilla de PostgreSQLEsquema de plantilla de SalesforceServiceNow esquema de plantillaEsquema de plantillas de SlackEsquema de plantilla de Zendesk

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Esquemas de plantillas de origen de datos

Los siguientes son esquemas de plantillas para orígenes de datos en los que se admiten plantillas.

Esquema de plantilla de Adobe Experience Manager

Incluye un JSON que contiene el esquema del origen de datos como parte del objeto TemplateConfiguration. Debe proporcionar la URL del host de Adobe Experience Manager, el tipo de autenticación y si utiliza Adobe Experience Manager (AEM) as a Cloud Service o AEM On-Premise como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como AEM, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, especifique TEMPLATE como el Type cuando llame a CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Para obtener más información, consulte Esquema JSON de Adobe Experience Manager.

En la siguiente tabla se describen los parámetros del esquema JSON de AEM.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
aemUrl La URL del host de Adobe Experience Manager. Por ejemplo, si utiliza AEM On-Premise, debe incluir el nombre de host y el puerto: https://hostname:port. O bien, si usa AEM as a Cloud Service, puede usar la URL del autor: https://author-xxxxxx-xxxxxxx.adobeaemcloud.com.
authType El tipo de autenticación que utiliza, ya sea Basic o OAuth2.
deploymentType El tipo de Adobe Experience Manager que utiliza, ya sea CLOUD o ON_PREMISE.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • page

  • asset

 Una lista de objetos que asignan los atributos o los nombres de campo de sus Adobe Experience Manager páginas y activos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
timeZoneId

Si utiliza AEM On-Premise y la zona horaria del servidor es diferente a la zona horaria del conector o índice de Amazon Kendra AEM, puede especificar la zona horaria del servidor para alinearla con el conector o índice de AEM.

La zona horaria predeterminada de AEM On-Premise es la zona horaria del conector o índice de AEM. Amazon Kendra La zona horaria predeterminada de AEM as a Cloud Service es la hora media de Greenwich.

  • pageRootPaths

  • assetRootPaths

 Una lista de rutas raíz para páginas y recursos. Por ejemplo, la ruta raíz de una página podría ser /content/sub y la ruta raíz de un recurso podría ser /content/sub/asset1.
crawlAssets true para rastrear recursos.
crawlPages true para rastrear páginas.

  • pagePathInclusionPatrones

  • pageNameInclusionPatrones

  • assetPathInclusionPatrones

  • assetTypeInclusionPatrones

  • assetNameInclusionPatrones

 Una lista de patrones de expresión regular para incluir determinadas páginas y recursos en su origen de datos de Adobe Experience Manager. Las páginas y recursos que coinciden con los patrones se incluyen en el índice. Las páginas y recursos que no coinciden con los patrones se excluyen del índice. Si una página o recurso coinciden con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.

  • pagePathExclusionPatrones

  • pageNameExclusionPatrones

  • assetPathExclusionPatrones

  • assetTypeInclusionPatrones

  • assetNameInclusionPatrones

 Una lista de patrones de expresión regular para excluir determinadas páginas y recursos de su origen de datos de Adobe Experience Manager. Las páginas y recursos que coinciden con los patrones se excluyen del índice. Las páginas y recursos que no coinciden con los patrones se incluyen en el índice. Si una página o recurso coinciden con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.
pageComponents Una lista de nombres de componentes de página específicos que desea indexar.
contentFragmentVariations Una lista de nombres para las variantes guardadas específicas de los fragmentos de contenido de Adobe Experience Manager que desea indexar.
type El tipo del origen de datos. Especifica AEM como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Adobe Experience Manager. Para obtener información sobre estos pares clave-valor, consulte las instrucciones de conexión de Adobe Experience Manager.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (Windows)

Incluye un JSON que contiene el esquema del origen de datos como parte del objeto TemplateConfiguration. El identificador del sistema de archivos se proporciona como parte de la configuración de la conexión o de los detalles del punto final del repositorio. También debe especificar el tipo de fuente de datosFSX, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, especifique TEMPLATE como el Type cuando llame a CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon FSx Esquema JSON (Windows).

En la siguiente tabla se describen los parámetros del esquema JSON Amazon FSx (Windows).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
fileSystemId El identificador del sistema de Amazon FSx archivos. Puede encontrar el ID del sistema de archivos en el panel de sistemas de archivos de la Amazon FSx consola.
fileSystemType El tipo Amazon FSx de sistema de archivos. Para usarlo Windows File Server como tipo de sistema de archivos, especifiqueWINDOWS.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.
Todos Una lista de objetos que mapean los atributos o los nombres de campo de los archivos de la fuente de Amazon FSx datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
isCrawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.
inclusionPatterns Una lista de patrones de expresiones regulares para incluir determinados archivos en la fuente Amazon FSx de datos. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresiones regulares para excluir determinados archivos de la fuente Amazon FSx de datos. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
type El tipo del origen de datos. Para las fuentes de datos del sistema de archivos de Windows, especifiqueFSX. 
{
  "$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 Esquema de plantillas (NetApp ONTAP)

Incluye un JSON que contiene el esquema del origen de datos como parte del objeto TemplateConfiguration. Debe proporcionar el identificador del sistema de archivos y la máquina virtual de almacenamiento (SVM) como parte de la configuración de la conexión o de los detalles del punto final del repositorio. También debe especificar el tipo de fuente de datosFSXONTAP, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, especifique TEMPLATE como el Type cuando llame a CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon FSx (NetApp ONTAP) Esquema JSON.

En la siguiente tabla se describen los parámetros del esquema JSON Amazon FSx (NetApp ONTAP).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
fileSystemId El identificador del sistema de Amazon FSx archivos. Puede encontrar el ID del sistema de archivos en el panel de sistemas de archivos de la Amazon FSx consola. Para obtener información sobre cómo crear un sistema de archivos en la Amazon FSx consola de NetApp ONTAP, consulte la Guía de introducción a NetApp ONTAP en la Guía del FSx for ONTAP usuario.
fileSystemType El tipo de sistema Amazon FSx de archivos. Para usarlo NetApp ONTAP como tipo de sistema de archivos, especifiqueONTAP.
SVMid El identificador de la máquina virtual de almacenamiento (SVM) utilizada con el sistema de Amazon FSx archivos para. NetApp ONTAP Para encontrar su ID de SVM, vaya al panel de sistemas de archivos de la Amazon FSx consola, seleccione su ID de sistema de archivos y, a continuación, seleccione Máquinas virtuales de almacenamiento. Para obtener información sobre cómo crear un sistema de archivos en la Amazon FSx consolaNetApp ONTAP, consulte la Guía de introducción a NetApp ONTAP en la Guía del FSx for ONTAP usuario.
Tipo de protocolo Ya sea que utilice el protocolo CIFS (Common Internet File System) para Windows o el protocolo Network File System (NFS) para Linux.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.
archivo Una lista de objetos que mapean los atributos o los nombres de campo de los archivos de la fuente de Amazon FSx datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos. Los nombres de los campos de la fuente de datos deben estar en los metadatos personalizados de los archivos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
crawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.
inclusionPatterns Una lista de patrones de expresiones regulares para incluir determinados archivos en la fuente Amazon FSx de datos. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresiones regulares para excluir determinados archivos de la fuente Amazon FSx de datos. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
type El tipo del origen de datos. Para las fuentes de datos del sistema de NetApp ONTAP archivos, especifiqueFSXONTAP.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn

El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse al sistema de archivos. Amazon FSx El secreto debe contener una estructura JSON con las siguientes claves:

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

Si utiliza el protocolo NFS para su sistema de Amazon FSx archivos, el secreto se almacena en una estructura JSON con las siguientes claves:

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

Esquema de plantilla de Alfresco

Incluye un JSON que contiene el esquema del origen de datos como parte del objeto TemplateConfiguration. Debe proporcionar el ID del sitio de Alfresco, la URL del repositorio, la URL de la interfaz de usuario, el tipo de autenticación, si utiliza la nube o en las instalaciones y el tipo de contenido que desea rastrear. Debe proporcionarlos como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Especifique también el tipo de origen de datos como ALFRESCO, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, especifique TEMPLATE como el Type cuando llame a CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Alfresco.

En la siguiente tabla se describen los parámetros del esquema JSON de Alfresco.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
siteId El identificador del sitio de Alfresco.
repoUrl La URL de su repositorio de Alfresco. Puede obtener la URL del repositorio de su administrador de Alfresco. Por ejemplo, si utiliza Alfresco Cloud (PaaS), la URL del repositorio podría ser https://company.alfrescocloud.com. O bien, si utiliza Alfresco On-Premises, la URL del repositorio podría ser https://company-alfresco-instance.company-domain.suffix:port.
webAppUrl La URL de la interfaz de usuario de Alfresco. Puede obtener la URL de la interfaz de usuario de Alfresco de su administrador de Alfresco. Por ejemplo, la URL de la interfaz de usuario podría ser https://example.com.
repositoryAdditionalProperties Propiedades adicionales para conectarse con el punto de conexión del repositorio/origen de datos.
authType El tipo de autenticación que utiliza, ya sea OAuth2 o Basic.
type (implementación) El tipo de Alfresco que utiliza, ya sea PAAS o ON-PREM.
crawlType El tipo de contenido que quiere rastrear, ya sea ASPECT (contenido marcado con “Aspectos” en Alfresco), SITE_ID (contenido de un sitio de Alfresco específico) o ALL_SITES (contenido de todos sus sitios de Alfresco).
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • document

  • comentario

 Una lista de objetos que mapean los atributos o los nombres de campo de sus documentos y comentarios de Alfresco para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
aspectName

El nombre del “Aspecto” específico que desea indexar.
aspectProperties

Una lista de propiedades de contenido de “Aspecto” específicas que desea indexar.
enableFineGrainedControl

true para rastrear “Aspectos”.
isCrawlComment

truepara rastrear los comentarios.

  • inclusionFileNamePatrones

  • inclusionFileTypePatrones

  • inclusionFilePathPatrones

 Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Alfresco. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • exclusionFileNamePatrones

  • exclusionFileTypePatrones

  • exclusionFilePathPatrones

 Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Alfresco. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
type El tipo del origen de datos. Especifica ALFRESCO como el tipo de origen de datos.
secretArn

El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su. Alfresco El secreto debe contener una estructura JSON con las siguientes claves:

Si utiliza la autenticación básica:

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

Si utiliza la autenticación OAuth 2.0:

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

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (MySQL)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como mysql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Aurora Esquema JSON (MySQL).

En la siguiente tabla se describen los parámetros del esquema JSON Aurora (MySQL).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,db2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (PostgreSQL)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como postgresql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Aurora Esquema JSON (PostgreSQL).

En la siguiente tabla se describen los parámetros del esquema Aurora JSON (PostgreSQL).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya sea, mysqldb2, postgresql o. oracle sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (Microsoft SQL Server)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como sqlserver, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon RDS Esquema JSON (Microsoft SQL Server).

En la siguiente tabla se describen los parámetros del esquema JSON Amazon RDS (Microsoft SQL Server).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya sea mysqldb2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (MySQL)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como mysql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon RDS Esquema JSON (MySQL).

En la siguiente tabla se describen los parámetros del esquema JSON Amazon RDS (MySQL).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,db2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (Oracle)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como oracle, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon RDS (Oracle) Esquema JSON.

En la siguiente tabla se describen los parámetros del esquema JSON Amazon RDS (Oracle).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,db2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 Esquema de plantillas (PostgreSQL)

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como postgresql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon RDS Esquema JSON (PostgreSQL).

En la siguiente tabla se describen los parámetros del esquema Amazon RDS JSON (PostgreSQL).

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya sea, mysqldb2, postgresql o. oracle sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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 esquema de plantilla

Incluye un JSON que contiene el esquema del origen de datos como parte de la configuración de la plantilla. Debe proporcionar el nombre del bucket de S3 como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Especifique también el tipo de origen de datos como S3 y otras configuraciones necesarias. A continuación, especifique TEMPLATE como Type cuando llame CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de S3.

En la siguiente tabla se describen los parámetros del esquema Amazon S3 JSON.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
BucketName El nombre de tu Amazon S3 depósito.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos

  • inclusionPatterns

  • exclusionPatterns

  • inclusionPrefixes

  • exclusionPrefixes

 Una lista de patrones de expresiones regulares para incluir o excluir archivos específicos de la fuente Amazon S3 de datos. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
aclConfigurationFileRuta La ruta del archivo que controla el acceso a los documentos en un índice de Amazon Kendra .
metadataFilesPrefix La ubicación dentro del bucket para los archivos de metadatos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
type El tipo del origen de datos. Especifica S3 como el tipo de origen de datos.
versión La versión de la plantilla admitida. 
{
  "$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 Esquema de plantillas de Web Crawler

Incluye un JSON que contiene el esquema del origen de datos como parte del objeto TemplateConfiguration.

Debe proporcionar las URL semilla o de punto de partida, o puede proporcionar las URL del mapa del sitio, como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. En lugar de enumerar manualmente todas las URL, puede proporcionar la ruta al Amazon S3 depósito que almacena un archivo de texto para su lista de direcciones URL iniciales o archivos XML de mapa del sitio, que puede agrupar en un archivo ZIP en S3.

También puede especificar el tipo de fuente de datosWEBCRAWLERV2, las credenciales de autenticación del sitio web y el tipo de autenticación si sus sitios web requieren autenticación, además de otras configuraciones necesarias.

A continuación, especifique TEMPLATE como el Type cuando llame a CreateDataSource.

importante

La creación de conectores Web Crawler v2.0 no es compatible con. AWS CloudFormation Utilice el conector Web Crawler v1.0 si necesita asistencia. AWS CloudFormation

Al seleccionar los sitios web que se van a indexar, se debe respetar la Política de uso aceptable de Amazon y todas las demás condiciones de Amazon. Recuerde que solo debe usar Amazon Kendra Web Crawler para indexar sus propias páginas web o páginas web para las que tenga autorización para indexar. Para obtener información sobre cómo impedir que el rastreador web de Amazon Kendra indexe sus sitios web, consulte Configuración del archivo robots.txt para el rastreador web de Amazon Kendra.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Amazon Kendra Esquema JSON de Web Crawler.

En la siguiente tabla se describen los parámetros del esquema JSON del Amazon Kendra Web Crawler.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
siteMapUrls La lista de URL del mapa del sitio web de los sitios web que quiere rastrear. Puede enumerar hasta tres URL de mapa del sitio.
s3 SeedUrl La ruta de S3 al archivo de texto que almacena la lista de URL semilla o de punto de partida. Por ejemplo, s3://bucket-name/directory/. Cada URL del archivo de texto debe estar formateada en una línea independiente. Puede enumerar hasta 100 URL semilla en un archivo.
s3 SiteMapUrl La ruta S3 a los archivos XML de mapa del sitio. Por ejemplo, s3://bucket-name/directory/. Puede enumerar hasta tres archivos XML de mapa del sitio. Puedes agrupar varios archivos de mapa del sitio en un archivo ZIP y almacenar el archivo ZIP en tu Amazon S3 depósito.
seedUrlConnections La lista de URL semilla o de punto de partida de los sitios web que desea rastrear. Puede enumerar hasta 100 URL semilla.
seedUrl La URL semilla o de punto de partida.
authentication El tipo de autenticación si sus sitios web requieren la misma autenticación; en caso contrario, especifique NoAuthentication.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • webPage

  • attachment

 Una lista de objetos que mapean los atributos o los nombres de campo de sus páginas web y archivos de páginas web para Amazon Kendra indexar los nombres de los campos. Por ejemplo, la etiqueta de título de la página web HTML se puede asignar al campo de índice de _document_title. Para obtener más información, consulte Asignación de campos de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
rateLimit El número de direcciones URL rastreadas por host de sitio web por minuto.
maxFileSize Tamaño máximo (en MB) de una página web o un archivo adjunto que se van a rastrear.
crawlDepth El número de niveles desde la URL semilla que se va a rastrear. Por ejemplo, la página URL semilla tiene la profundidad 1 y todos los hipervínculos de esta página que también se rastreen tienen la profundidad 2.
maxLinksPerURL El número máximo de URL de una página web que se deben incluir al rastrear un sitio web. Este número es por página web. A medida que se rastrean las páginas web de un sitio web, también se rastrean las URL a las que enlazan las páginas web. Las URL de una página web se rastrean en orden de aparición.
crawlSubDomain true para rastrear los dominios del sitio web con subdominios. Por ejemplo, si la URL semilla es “abc.example.com”, también se rastrearán “a.abc.example.com” y “b.abc.example.com”. Si no lo configuras crawlSubDomain o crawlAllDomain no lo hacestrue, Amazon Kendra solo rastreará los dominios de los sitios web que quieras rastrear.
crawlAllDomain true para rastrear los dominios del sitio web con subdominios y otros dominios a los que enlazan las páginas web. Si no lo configuras crawlSubDomain ni crawlAllDomain lo hacestrue, Amazon Kendra solo rastreará los dominios de los sitios web que quieras rastrear.
honorRobots true para respetar las directivas de robots.txt de los sitios web que desea rastrear. Estas directivas controlan la forma en que Amazon Kendra Web Crawler rastrea los sitios web, ya sea que solo Amazon Kendra pueda rastrear contenido específico o no rastrear ningún contenido.
crawlAttachments true para rastrear los archivos a los que enlazan las páginas web.

  • URL de inclusión CrawlPatterns

  • URL de inclusión IndexPatterns

 Una lista de patrones de expresiones regulares para incluir el rastreo de determinadas URL y la indexación de los hipervínculos de estas páginas web con URL. Las URL que coinciden con los patrones se incluyen en el índice. Las URL que no coinciden con los patrones se excluyen del índice. Si una URL coincide con un patrón de exclusión y un patrón de inclusión, el patrón de exclusión tiene prioridad y la URL/páginas web del sitio web no se incluyen en el índice.

  • URL de exclusión CrawlPatterns

  • URL de exclusión IndexPatterns

 Una lista de patrones de expresiones regulares para excluir el rastreo de determinadas URL y la indexación de los hipervínculos de estas páginas web con URL. Las URL que coinciden con los patrones se excluyen del índice. Las URL que no coinciden con los patrones se incluyen en el índice. Si una URL coincide con un patrón de exclusión y un patrón de inclusión, el patrón de exclusión tiene prioridad y la URL/páginas web del sitio web no se incluyen en el índice.
inclusionFileIndexPatrones Una lista de patrones de expresión regular para incluir determinados archivos de página web. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionFileIndexPatrones Una lista de patrones de expresión regular para excluir determinados archivos de página web. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
proxy Información de configuración necesaria para conectarse a sus sitios web internos a través de un proxy web.
host El nombre del host del servidor proxy que desea utilizar para conectarse a sitios web internos. Por ejemplo, el nombre de host de https://a.example.com/page1.html es “a.example.com”.
port El número de puerto del servidor proxy que desea utilizar para conectarse a sitios web internos. Por ejemplo, 443 es el puerto estándar para HTTPS.
secretArn (proxy) Si se requieren credenciales de proxy web para conectarse a un servidor de sitios web, puede crear un AWS Secrets Manager secreto que almacene las credenciales. Proporciona el nombre de recurso de Amazon (ARN) del secreto.
type El tipo del origen de datos. Especifica WEBCRAWLERV2 como el tipo de origen de datos.
secretArn

El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que se utiliza si sus sitios web requieren autenticación para acceder a los sitios web. Las credenciales de autenticación del sitio web se almacenan en el secreto que contiene los pares clave-valor de JSON.

Si utiliza Basic o NTLM/Kerberos, introduzca el nombre de usuario y la contraseña. Las claves JSON del secreto deben ser userName y password. El protocolo de autenticación NTLM incluye el hash de contraseñas y el protocolo de autenticación de Kerberos incluye el cifrado de contraseñas.

Si utiliza la autenticación mediante SAML o mediante formulario, introduzca el nombre de usuario y la contraseña, XPath para el campo del nombre de usuario (y el botón del nombre de usuario si utiliza SAML), XPaths para el campo y el botón de la contraseña y la URL de la página de inicio de sesión. Las claves JSON del secreto deben ser userName, password, userNameFieldXpath, userNameButtonXpath, passwordFieldXpath, passwordButtonXpath y loginPageUrl. Puede encontrar los XPaths (lenguaje de rutas XML) de los elementos utilizando las herramientas para desarrolladores de su navegador web. Los XPaths suelen seguir este formato: //tagname[@Attribute='Value'].

Amazon Kendra también comprueba si la información de punto final (URL iniciales) incluida en el secreto es la misma que la información de punto final especificada en los detalles de configuración del punto final de la fuente de datos.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "siteMapUrls": {
              "type": "array",
              "items":{
                "type": "string",
                "pattern": "https://.*"
              }
            },
            "s3SeedUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "s3SiteMapUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "seedUrlConnections": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "seedUrl":{
                      "type": "string",
                      "pattern": "https://.*"
                    }
                  },
                  "required": [
                    "seedUrl"
                  ]
                }
              ]
            },
            "authentication": {
              "type": "string",
              "enum": [
                "NoAuthentication",
                "BasicAuth",
                "NTLM_Kerberos",
                "Form",
                "SAML"
              ]
            }
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "webPage": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "rateLimit": {
          "type": "string",
          "default": "300"
        },
        "maxFileSize": {
          "type": "string",
          "default": "50"
        },
        "crawlDepth": {
          "type": "string",
          "default": "2"
        },
        "maxLinksPerUrl": {
          "type": "string",
          "default": "100"
        },
        "crawlSubDomain": {
          "type": "boolean",
          "default": false
        },
        "crawlAllDomain": {
          "type": "boolean",
          "default": false
        },
        "honorRobots": {
          "type": "boolean",
          "default": false
        },
        "crawlAttachments": {
          "type": "boolean",
          "default": false
        },
        "inclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "proxy": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "secretArn": {
              "type": "string",
              "minLength": 20,
              "maxLength": 2048
            }
          }
        }
      },
      "required": [
        "rateLimit",
        "maxFileSize",
        "crawlDepth",
        "crawlSubDomain",
        "crawlAllDomain",
        "maxLinksPerUrl",
        "honorRobots"
      ]
    },
    "type": {
      "type": "string",
      "pattern": "WEBCRAWLERV2"
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "type",
    "additionalProperties"
  ]
}

Esquema de plantilla de Confluence

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Proporciona la URL del host de Confluence, el método de alojamiento y el tipo de autenticación como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como CONFLUENCEV2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Confluence.

En la siguiente tabla se describen los parámetros del esquema JSON de Confluence.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
hostUrl La dirección URL de la instancia de Confluence. Por ejemplo, https://example.confluence.com.
type El método de alojamiento de su instancia de Confluence, ya sea SAAS o ON_PREM.
authType El método de autenticación de su instancia de Confluence, ya sea Basic, OAuth2 o Personal-token.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • espacio

  • page

  • blog

  • comentario

  • attachment

 Una lista de objetos que mapean los atributos o los nombres de campo de tus espacios, páginas, blogs, comentarios y archivos adjuntos de Confluence para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Mapping data source fields (Asignación de campos de origen de datos). Los nombres de los campos del origen de datos de Confluence deben existir en sus metadatos personalizados de Confluence.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
isCrawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de tus documentos, si tienes una ACL y quieres usarla para el control de acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.
fieldForUserID Especifique email si desea utilizar el correo electrónico del usuario como ID de usuario. emailse usa de forma predeterminada y actualmente es el único tipo de ID de usuario compatible.

  • inclusionSpaceKeyFiltrar

  • exclusionSpaceKeyFiltro

  • pageTitleRegEX

  • blogTitleRegEX

  • commentTitleRegEX

  • attachmentTitleRegEX

  • inclusionFileTypePatrones

  • exclusionFileTypePatrones

  • inclusionUrlPatterns

  • exclusionUrlPatterns

 Una lista de patrones de expresión regular para incluir o excluir determinados archivos en su origen de datos de Confluence. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
proxyHost El nombre de host del proxy web que utilizas, sin el https:// protocolo http:// o.

proxyPort

 El número de puerto utilizado por el protocolo de transporte de URL del host. Debe ser un valor numérico entre 0 y 65535.

  • isCrawlPersonalEspacio

  • isCrawlArchivedEspacio

  • isCrawlArchivedPágina

  • isCrawlPage

  • isCrawlBlog

  • isCrawlPageComentario

  • isCrawlPageAdjunto

  • isCrawlBlogComentario

  • isCrawlBlogAdjunto

 truepara rastrear los archivos de tus espacios personales, páginas, blogs, comentarios de página, adjuntos de página, comentarios de blog y archivos adjuntos de blog de Confluence.
maxFileSizeInMegaBytes Especifica el límite de tamaño de los archivos en MB que se Amazon Kendra pueden rastrear. Amazon Kendra rastrea solo los archivos dentro del límite de tamaño que usted defina. El tamaño predeterminado del archivo es de 50 MB. El tamaño máximo del archivo debe ser superior a 0 MB e inferior o igual a 50 MB.
type El tipo del origen de datos. Especifica CONFLUENCEV2 como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Confluence. Para obtener información sobre estos pares clave-valor, consulta las instrucciones de conexión de Confluence.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Dropbox

Incluyes un JSON que contiene el esquema de la fuente de datos como parte del objeto. TemplateConfiguration Proporciona la clave de la aplicación, el secreto de la aplicación y el token de acceso de Dropbox como parte del secreto que almacena sus credenciales de autenticación. Especifica también el tipo de origen de datos como DROPBOX, el tipo de token de acceso que quiere usar (temporal o permanente) y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Dropbox.

En la siguiente tabla se describen los parámetros del esquema JSON de Dropbox.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos. Este origen de datos no especifica un punto de conexión en repositoryEndpointMetadata. Por el contrario, la información de conexión se incluye en un AWS Secrets Manager secreto que tú proporcionassecretArn.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • archivo

  • paper

  • papert

  • shortcut

 Una lista de objetos que mapean los atributos o los nombres de campo de tus archivos de Dropbox, Dropbox Paper y atajos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
syncMode

Especifica cómo Amazon Kendra debes actualizar tu índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a tu Dropbox. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "appKey": "Dropbox app key",
    "appSecret": "Dropbox app secret",
    "accesstoken": "temporary access token or refresh access token"
}
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
isCrawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de tus documentos, si tienes una ACL y quieres usarla para controlar el acceso. La ACL especifica a qué documentos pueden acceder los usuarios y los grupos. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

  • inclusionFileNamePatrones

  • inclusionFileTypePatrones

 Una lista de patrones de expresión regular para incluir determinados nombres y tipos de archivo en su origen de datos de Dropbox. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • exclusionFileNamePatrones

  • exclusionFileTypePatrones

 Una lista de patrones de expresión regular para excluir determinados nombres y tipos de archivo en su origen de datos de Dropbox. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • crawlFile

  • crawlPaper

  • crawlPapert

  • crawlShortcut

 truepara rastrear los archivos de tu Dropbox, los documentos de Dropbox Paper, las plantillas de Dropbox Paper y los atajos de páginas web almacenados en tu Dropbox.
type El tipo del origen de datos. Especifica DROPBOX como el tipo de origen de datos.
tokenType Especifica el tipo de token de acceso: token de acceso permanente o temporal. Se recomienda crear un token de acceso actualizado que no caduque nunca en Dropbox, en lugar de utilizar un token de acceso único que caduca a las 4 horas. Debe crear una aplicación y un token de acceso de actualización en la consola para desarrolladores de Dropbox y proporcionar el token de acceso en su secreto.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Drupal

Como parte del objeto, incluyes un JSON que contiene el esquema de la TemplateConfigurationfuente de datos. Debe proporcionar la URL del host de Drupal y el tipo de autenticación como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Especifique también el tipo de origen de datos como DRUPAL, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Drupal.

La siguiente tabla describe los parámetros del esquema JSON de Drupal.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
hostUrl La URL del host de su sitio web de Drupal. Por ejemplo, https://<hostname>/<drupalsitename>.
repositoryConfigurations Información de configuración del contenido del origen de datos.

  • content

  • comentario

  • attachment

 Una lista de objetos que asignan los atributos o los nombres de campo de sus archivos de Drupal. Para obtener más información, consulte Asignación de campos de origen de datos. Los nombres de los campos del origen de datos de Drupal deben existir en los metadatos personalizados de Drupal.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.

  • inclusionFileNamePatrones

  • articleTitleInclusionPatrones

  • pageTitleInclusionPatrones

  • customContentTitleInclusionPatterns

  • basicBlockTitleInclusionPatterns

  • customBlockTitleInclusionPatterns

 Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Drupal. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • exclusionFileNamePatrones

  • articleTitleExclusionPatrones

  • pageTitleExclusionPatrones

  • customContentTitleExclusionPatterns

  • basicBlockTitleExclusionPatterns

  • customBlockTitleExclusionPatterns

 Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Drupal. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
contentDefinitions

  • contentType

  • fieldDefinition

  • isCrawlComments

  • isCrawlFiles

  • isCrawlArticle

  • isCrawlBasicPágina

  • isCrawlBasicBloquear

  • isCrawlCustomContentTypesList

 Especifica los tipos de contenido que desea rastrear y si desea rastrear los comentarios y los archivos adjuntos de los tipos de contenido seleccionados.
type El tipo del origen de datos. Especifica DRUPAL como el tipo de origen de datos.
authType El tipo de autenticación que utiliza, ya sea BASIC-AUTH o OAUTH2.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a tu Drupal. El secreto debe contener una estructura JSON con las siguientes claves:

Si utiliza la autenticación básica:

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

Si utiliza la autenticación OAuth 2.0:

{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
versión La versión de esta plantilla que se admite actualmente. 
{
	"$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 esquema de plantilla

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar la URL del GitHub host, el nombre de la organización y si utiliza la GitHub GitHub nube o de forma local como parte de la configuración de la conexión o de los detalles del punto final del repositorio. Además, especifique el tipo de origen de datos como GITHUB, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE Type especifíquelo cuando llame CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte GitHub Esquema JSON.

En la siguiente tabla se describen los parámetros del esquema GitHub JSON.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
type Especifique el tipo como SAAS oON_PREMISE.
hostUrl La URL del GitHub host. Por ejemplo, si utiliza GitHub SaaS/Enterprise Cloud:. https://api.github.com O, si usa un servidor GitHub local o empresarial:. https://on-prem-host-url/api/v3/
organizationName Puede encontrar el nombre de su organización al iniciar sesión en el GitHub escritorio y ir a Sus organizaciones en el menú desplegable de su imagen de perfil.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • Repositorio GH

  • ghCommit

  • ghIssueDocument

  • ghIssueComment

  • ghIssueAttachment

  • Documento GHPR

  • Comentario GHPR

  • Adjunto GHPR

 Una lista de objetos que asignan los atributos o los nombres de campo del GitHub contenido para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
isCrawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica los documentos a los que los usuarios y los grupos pueden acceder y buscar. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.
fieldForUserID Especifique el tipo de ID de usuario que desea usar para el rastreo de las ACL. Especifique email si desea usar el correo electrónico del usuario como ID de usuario o username si desea usar el nombre de usuario como ID de usuario. Si no especifica ninguna opción, email se utiliza de forma predeterminada.
Filtro de repositorio Una lista de los nombres de los repositorios y ramas específicos que quieres indexar.
CrawlRepository truepara rastrear repositorios.
crawlRepositoryDocuments truepara rastrear los documentos del repositorio.
Problema de rastreo truea problemas de rastreo.
crawlIssueComment truepara rastrear los comentarios de los problemas.
crawlIssueCommentAdjunto truepara rastrear los archivos adjuntos a los comentarios de un problema.
crawlPullRequest truepara rastrear las solicitudes de incorporación de cambios.
crawlPullRequestComentario truepara rastrear los comentarios de las solicitudes de extracción.
crawlPullRequestCommentAttachment truepara rastrear los archivos adjuntos de los comentarios de las solicitudes de extracción.

  • inclusionFolderNamePatrones

  • inclusionFileTypePatrones

  • inclusionFileNamePatrones

 Una lista de patrones de expresiones regulares para incluir cierto contenido en la fuente GitHub de datos. El contenido que coincide con los patrones se incluye en el índice. El contenido que no coincide con los patrones se excluye del índice. Si algún contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.

  • exclusionFolderNamePatrones

  • exclusionFileTypePatrones

  • exclusionFileNamePatrones

 Una lista de patrones de expresiones regulares para excluir cierto contenido de la fuente GitHub de datos. El contenido que coincide con los patrones se excluye del índice. El contenido que no coincide con los patrones se incluye en el índice. Si algún contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.
type El tipo del origen de datos. Especifica GITHUB como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn

El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su. GitHub El secreto debe contener una estructura JSON con las siguientes claves:

{
    "personalToken": "token"
}
versión La versión de esta plantilla que se admite actualmente.

El siguiente es el esquema GitHub JSON:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "connectionConfiguration": {
            "type": "object",
            "properties": {
                "repositoryEndpointMetadata": {
                    "type": "object",
                    "properties": {
                        "type": {
                            "type": "string"
                        },
                        "hostUrl": {
                            "type": "string",
                            "pattern": "https://.*"
                        },
                        "organizationName": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "type",
                        "hostUrl",
                        "organizationName"
                    ]
                }
            },
            "required": [
                "repositoryEndpointMetadata"
            ]
        },
        "repositoryConfigurations": {
            "type": "object",
            "properties": {
                "ghRepository": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghCommit": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghIssueDocument": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghIssueComment": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghIssueAttachment": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghPRDocument": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghPRComment": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                },
                "ghPRAttachment": {
                    "type": "object",
                    "properties": {
                        "fieldMappings": {
                            "type": "array",
                            "items": [
                                {
                                    "type": "object",
                                    "properties": {
                                        "indexFieldName": {
                                            "type": "string"
                                        },
                                        "indexFieldType": {
                                            "type": "string",
                                            "enum": [
                                                "STRING",
                                                "STRING_LIST",
                                                "DATE"
                                            ]
                                        },
                                        "dataSourceFieldName": {
                                            "type": "string"
                                        },
                                        "dateFieldFormat": {
                                            "type": "string",
                                            "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                                        }
                                    },
                                    "required": [
                                        "indexFieldName",
                                        "indexFieldType",
                                        "dataSourceFieldName"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "fieldMappings"
                    ]
                }
            }
        },
        "additionalProperties": {
            "type": "object",
            "properties": {
                "isCrawlAcl": {
                    "type": "boolean"
                },
                "fieldForUserId": {
                    "type": "string"
                },
                "crawlRepository": {
                    "type": "boolean"
                },
                "crawlRepositoryDocuments": {
                    "type": "boolean"
                },
                "crawlIssue": {
                    "type": "boolean"
                },
                "crawlIssueComment": {
                    "type": "boolean"
                },
                "crawlIssueCommentAttachment": {
                    "type": "boolean"
                },
                "crawlPullRequest": {
                    "type": "boolean"
                },
                "crawlPullRequestComment": {
                    "type": "boolean"
                },
                "crawlPullRequestCommentAttachment": {
                    "type": "boolean"
                },
                "repositoryFilter": {
                    "type": "array",
                    "items": [
                        {
                            "type": "object",
                            "properties": {
                                "repositoryName": {
                                    "type": "string"
                                },
                                "branchNameList": {
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    ]
                },
                "inclusionFolderNamePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "inclusionFileTypePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "inclusionFileNamePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "exclusionFolderNamePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "exclusionFileTypePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                },
                "exclusionFileNamePatterns": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "required": []
        },
        "type": {
            "type": "string",
            "pattern": "GITHUB"
        },
        "syncMode": {
            "type": "string",
            "enum": [
                "FULL_CRAWL",
                "FORCED_FULL_CRAWL",
                "CHANGE_LOG"
            ]
        },
        "enableIdentityCrawler": {
            "type": "boolean"
        },
        "secretArn": {
            "type": "string",
            "minLength": 20,
            "maxLength": 2048
        }
    },
    "version": {
        "type": "string",
        "anyOf": [
            {
                "pattern": "1.0.0"
            }
        ]
    },
    "required": [
        "connectionConfiguration",
        "repositoryConfigurations",
        "syncMode",
        "additionalProperties",
        "enableIdentityCrawler"
    ]
}

Esquema de plantilla de Gmail

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como GMAIL, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Gmail.

En la siguiente tabla se describen los parámetros del esquema JSON de Gmail.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos. Este origen de datos no especifica un punto de conexión en repositoryEndpointMetadata. Por el contrario, la información de conexión se incluye en un AWS Secrets Manager secreto que usted proporcionasecretArn.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

  • message

  • attachments

 Una lista de objetos que asignan los atributos o los nombres de campo de tus mensajes y archivos adjuntos de Gmail para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.

  • inclusionLabelNamePatrones

  • exclusionLabelNamePatrones

  • inclusionAttachmentTypePatrones

  • exclusionAttachmentTypePatrones

  • inclusionAttachmentNamePatrones

  • exclusionAttachmentNamePatrones

  • inclusionSubjectFilter

  • exclusionSubjectFilter

  • isSubjectAnd

  • inclusionFromFilter

  • exclusionFromFilter

  • inclusionToFilter

  • exclusionToFilter

  • inclusionCcFilter

  • exclusionCcFilter

  • inclusionBccFilter

  • exclusionBccFilter

 Una lista de patrones de expresión regular para incluir o excluir mensajes con nombres de asuntos específicos en su origen de datos de Gmail. Los archivos que coinciden con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
beforeDateFilter Especifica los mensajes y archivos adjuntos que se incluirán antes de una fecha determinada.
afterDateFilter Especifica los mensajes y archivos adjuntos que se incluirán después de una fecha determinada.
isCrawlAttachment Un valor booleano para elegir si desea rastrear los archivos adjuntos. Los mensajes se rastrean automáticamente.
type El tipo del origen de datos. Especifica GMAIL como el tipo de origen de datos.
shouldCrawlDraftMensajes Un valor booleano para elegir si desea rastrear los borradores de mensajes.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

importante

Como no existe una API para actualizar los mensajes de Gmail eliminados permanentemente, cualquier contenido nuevo, modificado o eliminado se sincroniza:

  • No eliminará de tu Amazon Kendra índice los mensajes que se hayan eliminado permanentemente de Gmail

  • No sincronizará los cambios en las etiquetas de correo de Gmail

Para sincronizar los cambios en la etiqueta de la fuente de datos de Gmail y los mensajes de correo electrónico eliminados permanentemente con tu Amazon Kendra índice, debes realizar rastreos completos de forma periódica.
secretARN El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene los pares clave/valor necesarios para conectarse a su Gmail. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Google Drive

Incluyes un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como GOOGLEDRIVE2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Google Drive.

En la siguiente tabla se describen los parámetros del esquema JSON de Google Drive.

Configuración Descripción
connectionConfiguration Información de configuración del origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos. Este origen de datos no especifica un punto de conexión. Usted elige el tipo de autenticación: serviceAccount y OAuth2. La información de conexión se incluye en un AWS Secrets Manager secreto que usted proporcionasecretArn.
authType Elija entre serviceAccount y OAuth2 en función de su caso de uso.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • archivo

  • comentario

 Una lista de objetos que asignan los atributos o los nombres de campo de su Google Drive a los nombres de campo del índice de Amazon Kendra . Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos

  • maxFileSizeInMegaBytes

 Especifique un límite de tamaño de archivo en MB que Amazon Kendra debe rastrearse.

  • iscrawlComment

 truepara rastrear los comentarios de su fuente de datos de Google Drive.

  • isCrawlMyDriveAndSharedWithMe

 truepara rastrear MyDrive y compartir conmigo las unidades de tu fuente de datos de Google Drive.

  • isCrawlSharedUnidades

 truepara rastrear las unidades compartidas de tu fuente de datos de Google Drive.
isCrawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y quiere usarla para el control de acceso. La ACL especifica los documentos a los que los usuarios y los grupos pueden acceder y buscar. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.

  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • exclusionFileTypePatrones

  • exclusionFileNamePatrones

  • exclusionFilePathFiltro

 Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Google Drive. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • inclusionFileTypePatrones

  • inclusionFileNamePatrones

  • inclusionFilePathFiltro

 Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Google Drive. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
type El tipo del origen de datos. Especifica GOOOGLEDRIVEV2 como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Google Drive. El secreto debe contener una estructura JSON con las siguientes claves:

Si utiliza la autenticación de la cuenta de servicio de Google:

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

Si utiliza la autenticación OAuth 2.0:

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de IBM DB2

Incluyes un JSON que contiene el esquema de la fuente de datos como parte del objeto. TemplateConfiguration Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como db2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de IBM DB2.

La siguiente tabla describe los parámetros del esquema JSON de IBM DB2.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,, db2postgresql, oracle o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Microsoft Exchange

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar el ID de inquilino como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como MSEXCHANGE, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Microsoft Exchange.

En la siguiente tabla se describen los parámetros del esquema JSON de Microsoft Exchange.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
tenantId El ID de inquilino de Microsoft 365. Puede encontrar su ID de inquilino en las propiedades de su portal de Azure Active Directory o en su aplicación OAuth.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • email

  • attachment

  • calendar

  • contacts

  • notes

 Una lista de objetos que asignan los atributos o nombres de campo de la fuente de datos de Microsoft Exchange a los campos de Amazon Kendra indexación. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos
inclusionPatterns Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Microsoft Exchange. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Microsoft Exchange. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • inclusionUsersList

  • inclusionUsersFileNombre

  • inclusionDomainUsers

 Una lista de patrones de expresión regular para incluir determinados usuarios y archivos de usuario en su origen de datos de Microsoft Exchange. Los usuarios que coinciden con los patrones se incluyen en el índice. Los usuarios que no coinciden con los patrones se excluyen del índice. Si un usuario coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el usuario no se incluye en el índice.

  • exclusionUsersList

  • exclusionUsersFileNombre

  • exclusionDomainUsers

 Una lista de patrones de expresión regular para excluir determinados usuarios y archivos de usuario en su origen de datos de Microsoft Exchange. Los usuarios que coinciden con los patrones se excluyen del índice. Los usuarios que no coinciden con los patrones se incluyen en el índice. Si un usuario coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el usuario no se incluye en el índice.
s3bucketName El nombre del bucket de S3, si lo desea usar.

  • crawlCalendar

  • crawlNotes

  • crawlContacts

  • crawlFolderAcl

 truepara rastrear estos tipos de contenido e información de control de acceso a su fuente de datos de Microsoft Exchange.
startCalendarDateHora Puede configurar una fecha y hora de inicio específicas para el contenido de su calendario.
endCalendarDateHora Puede configurar una fecha y hora de finalización específicas para el contenido del calendario.
subject Puede configurar una línea de asunto específica para el contenido de su correo.
emailFrom Puede configurar un correo electrónico específico para el contenido del correo del remitente.
emailTo Puede configurar un correo electrónico específico para el contenido del correo del destinatario.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
type El tipo del origen de datos. Especifica MSEXCHANGE como el tipo de origen de datos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Microsoft Exchange. Esto incluye su ID de cliente y su secreto de cliente, que se genera al crear una aplicación OAuth en el portal de Azure.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema OneDrive de plantillas de Microsoft

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar el ID de inquilino como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Especifique también el tipo de origen de datos como ONEDRIVEV2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema OneDrive JSON de Microsoft.

En la siguiente tabla se describen los parámetros del esquema OneDrive JSON de Microsoft.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
tenantId El ID de inquilino de Microsoft 365. Puede encontrar su ID de inquilino en las propiedades de su portal de Azure Active Directory o en su aplicación OAuth.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.
archivo Una lista de objetos que asignan los atributos o los nombres de campo de los OneDrive archivos de Microsoft a los nombres de los campos de Amazon Kendra indexación. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos

  • userNameFilter

  • userFilterPath

  • inclusionFileTypePatrones

  • exclusionFileTypePatrones

  • inclusionFileNamePatrones

  • exclusionFileNamePatrones

  • inclusionFilePathPatrones

  • exclusionFilePathPatrones

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotepageNamePatterns

 Puede elegir indexar archivos, OneNote secciones y OneNote páginas específicos y filtrar por nombre de usuario.
isUserNameEn S3 true para proporcionar una lista de nombres de usuario en un archivo almacenado en un Amazon S3.
type El tipo del origen de datos. Especifica ONEDRIVEV2 como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
type El tipo del origen de datos. Especifica ONEDRIVEV2 como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Microsoft. OneDrive El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
versión La versión de esta plantilla que se admite actualmente. 
{
	"$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"
	]
}

Esquema SharePoint de plantillas de Microsoft

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Como parte de la configuración de la conexión o de los detalles del punto final del repositorio, debe proporcionar la dirección URL o las direcciones URL del SharePoint sitio, el dominio y, si es necesario, un ID de inquilino. Además, especifique el tipo de origen de datos como SHAREPOINTV2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE especifíquelo como tipo cuando llame. CreateDataSource

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte SharePoint Esquema JSON.

En la siguiente tabla se describen los parámetros del esquema SharePoint JSON de Microsoft.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos
repositoryEndpointMetadata La información del punto de conexión para el origen de datos
tenantId El identificador de inquilino de tu SharePoint cuenta.
Dominio El dominio de tu SharePoint cuenta.
siteUrls Las direcciones URL del servidor de tu SharePoint cuenta.
repositoryAdditionalProperties Propiedades adicionales para conectarse con el punto de conexión del repositorio/origen de datos.
s3bucketName El nombre del Amazon S3 depósito que almacena el certificado X.509 autofirmado de Azure AD.
s3certificateName El nombre del certificado X.509 autofirmado de Azure AD almacenado en el depósito. Amazon S3
authType El tipo de autenticación que usa,OAuth2,, OAuth2CertificateOAuth2App, Basic OAuth2_RefreshTokenNTLM, o. Kerberos
versión La SharePoint versión que utiliza, ya sea Server oOnline.
onPremVersion La versión SharePoint del servidor que utiliza, ya sea 2013 20162019, oSubscriptionEdition.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • evento

  • page

  • archivo

  • link

  • attachment

  • comentario

 Una lista de objetos que asignan los atributos o los nombres de campo del SharePoint contenido para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.

  • eventTitleFilterRegEx

  • pageTitleFilterRegEx

  • linkTitleFilterRegEx

  • inclusionFilePath

  • exclusionFilePath

  • inclusionFileTypePatrones

  • exclusionFileTypePatrones

  • inclusionFileNamePatrones

  • exclusionFileNamePatrones

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotePageNamePatterns

 Una lista de patrones de expresiones regulares para incluir/excluir cierto contenido de la fuente de SharePoint datos. Los elementos de contenido que coinciden con los patrones de inclusión se incluyen en el índice. Los elementos de contenido que no coinciden con los patrones de inclusión se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • crawlFiles

  • crawlPages

  • crawlEvents

  • crawlComments

  • crawlLinks

  • crawlAttachments

 truepara rastrear este tipo de contenido.
crawlAcl truepara rastrear la información de la lista de control de acceso (ACL) de sus documentos, si tiene una ACL y desea utilizarla para el control de acceso. La ACL especifica los documentos a los que los usuarios y los grupos pueden acceder y buscar. La información de la ACL se utiliza para filtrar los resultados de búsqueda en función del acceso del usuario o su grupo a los documentos. Para obtener más información, consulte Filtrado de contexto de usuario.
fieldForUserID Especifique email si desea usar el correo electrónico del usuario como ID de usuario o userPrincipalName si desea usar un nombre de usuario para el ID de usuario. Si no especifica ninguna opción, email se utiliza de forma predeterminada.
aclConfiguration Especifique una de ACLWithLDAPEmailFmt las dos ACLWithManualEmailFmt opciones: oACLWithUsernameFmtM.
emailDomain El dominio del correo electrónico. Por ejemplo, “amazon.com”.

  • isCrawlLocalGroupMapping

  • isCrawlAdGroupMapping

 truepara rastrear la información de mapeo de grupos.
proxyHost El nombre de host del proxy web que utiliza, sin el protocolo http://o https://.
proxyPort El número de puerto utilizado por el protocolo de transporte de URL del host. Debe ser un valor numérico entre 0 y 65535.
type Especifica SHAREPOINTV2 como el tipo de origen de datos
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su. SharePoint Para obtener información sobre estos pares clave-valor, consulte las instrucciones de conexión en línea y en servidor. SharePoint SharePoint
versión La versión de esta plantilla que se admite actualmente. 
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"connectionConfiguration": {
			"type": "object",
			"properties": {
				"repositoryEndpointMetadata": {
					"type": "object",
					"properties": {
						"tenantId": {
							"type": "string",
							"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
							"minLength": 36,
							"maxLength": 36
						},
						"domain": {
							"type": "string"
						},
						"siteUrls": {
							"type": "array",
							"items": {
								"type": "string",
								"pattern": "https://.*"
							}
						},
						"repositoryAdditionalProperties": {
							"type": "object",
							"properties": {
								"s3bucketName": {
									"type": "string"
								},
								"s3certificateName": {
									"type": "string"
								},
								"authType": {
									"type": "string",
									"enum": [
										"OAuth2",
										"OAuth2Certificate",
										"OAuth2App",
										"Basic",
										"OAuth2_RefreshToken",
										"NTLM",
										"Kerberos"
									]
								},
								"version": {
									"type": "string",
									"enum": [
										"Server",
										"Online"
									]
								},
								"onPremVersion": {
									"type": "string",
									"enum": [
										"",
										"2013",
										"2016",
										"2019",
										"SubscriptionEdition"
									]
								}
							},
							"required": [
								"authType",
								"version"
							]
						}
					},
					"required": [
						"siteUrls",
						"domain",
						"repositoryAdditionalProperties"
					]
				}
			},
			"required": [
				"repositoryEndpointMetadata"
			]
		},
		"repositoryConfigurations": {
			"type": "object",
			"properties": {
				"event": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"page": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE",
												"LONG"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"file": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE",
												"LONG"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"link": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"attachment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"comment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				}
			}
		},
		"additionalProperties": {
			"type": "object",
			"properties": {
				"eventTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"pageTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"linkTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFilePath": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFilePath": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"crawlFiles": {
					"type": "boolean"
				},
				"crawlPages": {
					"type": "boolean"
				},
				"crawlEvents": {
					"type": "boolean"
				},
				"crawlComments": {
					"type": "boolean"
				},
				"crawlLinks": {
					"type": "boolean"
				},
				"crawlAttachments": {
					"type": "boolean"
				},
				"crawlListData": {
					"type": "boolean"
				},
				"crawlAcl": {
					"type": "boolean"
				},
				"fieldForUserId": {
					"type": "string"
				},
				"aclConfiguration": {
					"type": "string",
					"enum": [
						"ACLWithLDAPEmailFmt",
						"ACLWithManualEmailFmt",
						"ACLWithUsernameFmt"
					]
				},
				"emailDomain": {
					"type": "string"
				},
				"isCrawlLocalGroupMapping": {
					"type": "boolean"
				},
				"isCrawlAdGroupMapping": {
					"type": "boolean"
				},
				"proxyHost": {
					"type": "string"
				},
				"proxyPort": {
					"type": "string"
				}
			},
			"required": [
			]
		},
		"type": {
			"type": "string",
			"pattern": "SHAREPOINTV2"
		},
		"enableIdentityCrawler": {
			"type": "boolean"
		},
		"syncMode": {
			"type": "string",
			"enum": [
				"FULL_CRAWL",
				"FORCED_FULL_CRAWL",
				"CHANGE_LOG"
			]
		},
		"secretArn": {
			"type": "string",
			"minLength": 20,
			"maxLength": 2048
		}
	},
	"version": {
		"type": "string",
		"anyOf": [
			{
				"pattern": "1.0.0"
			}
		]
	},
	"required": [
		"connectionConfiguration",
		"repositoryConfigurations",
		"enableIdentityCrawler",
		"syncMode",
		"additionalProperties",
		"secretArn",
		"type"
	]
}

Esquema de plantilla de Microsoft SQL Server

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como sqlserver, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Microsoft SQL Server.

En la siguiente tabla se describen los parámetros del esquema JSON de Microsoft SQL Server.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • DBType: el tipo de base de datos Java que utiliza, ya sea,mysql, db2 o. postgresql oracle sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Microsoft Teams

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar el ID de inquilino como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como MSTEAMS, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Microsoft Teams.

En la siguiente tabla se describen los parámetros del esquema JSON de Microsoft Teams.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
tenantId El ID de inquilino de Microsoft 365. Puede encontrar su ID de inquilino en las propiedades de su portal de Azure Active Directory o en su aplicación OAuth.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • chatMessage

  • chatAttachment

  • channelPost

  • channelWiki

  • channelAttachment

  • meetingChat

  • meetingFile

  • meetingNote

  • calendarMeeting

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de Microsoft Teams para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
paymentModel Especifica el tipo de modelo de pago que se debe utilizar con el origen de datos de Microsoft Teams. Los modelos de pago del modelo A están restringidos a los modelos de licencia y pago que requieren el cumplimiento de las normas de seguridad. Los modelos de pago del modelo B son adecuados para los modelos de licencia y pago que no requieren el cumplimiento de las normas de seguridad.

  • inclusionTeamNameFiltrar

  • inclusionChannelNameFiltro

  • inclusionFileNamePatrones

  • inclusionFileTypePatrones

  • inclusionUserEmailFiltro

  • inclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

 Una lista de patrones de expresión regular para incluir determinado contenido en su origen de datos de Microsoft Teams. El contenido que coincide con los patrones se incluye en el índice. El contenido que no coincide con los patrones se excluye del índice. Si el contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.

  • exclusionTeamNameFiltro

  • exclusionChannelNameFiltro

  • exclusionFileNamePatrones

  • exclusionFileTypePatrones

  • exclusionUserEmailFiltro

  • exclusionOneNoteSectionNamePatterns

  • exclusionOneNotePageNamePatterns

 Una lista de patrones de expresión regular para excluir determinado contenido en su origen de datos de Microsoft Teams. El contenido que coincide con los patrones se excluye del índice. El contenido que no coincide con los patrones se incluye en el índice. Si el contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.

  • isCrawlChatMensaje

  • isCrawlChatAdjunto

  • isCrawlChannelPublicar

  • isCrawlChannelAdjunto

  • isCrawlChannelWiki

  • isCrawlCalendarReunión

  • isCrawlMeetingCharla

  • isCrawlMeetingArchivo

  • isCrawlMeetingNota

 truepara rastrear este tipo de contenido en la fuente de datos de Microsoft Teams.
startCalendarDate¿Hora Puede configurar una fecha y hora de inicio específicas para el contenido de su calendario.
endCalendarDateHora Puede configurar una fecha y hora de finalización específicas para el contenido del calendario.
type El tipo del origen de datos. Especifica MSTEAMS como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Microsoft Teams. Esto incluye su ID de cliente y su secreto de cliente, que se genera al crear una aplicación OAuth en el portal de Azure.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Microsoft Yammer

Incluye un JSON que contiene el esquema de la fuente de datos como parte del objeto. TemplateConfiguration Especifique el tipo de origen de datos como YAMMER, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, especifíquelo TEMPLATE como Tipo cuando llame CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores.

En la siguiente tabla se describen los parámetros del esquema JSON de Microsoft Yammer.

Configuración Descripción
connectionConfiguration Información de configuración del origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos. Este origen de datos no especifica un punto de conexión en repositoryEndpointMetadata. Por el contrario, la información de conexión se incluye en un AWS Secrets Manager secreto que usted proporciona. secretArn
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • community

  • usuario

  • message

  • attachment

 Una lista de objetos que asignan atributos o nombres de campo de Microsoft Yammer a los nombres de campo del índice de Amazon Kendra. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos
inclusionPatterns Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Microsoft Yammer. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coinciden con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Microsoft Yammer. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
sinceDate Puede optar por configurar un parámetro sinceDate para que el conector de Microsoft Yammer rastree el contenido en función de una sinceDate específica.
communityNameFilter Puede elegir indexar contenido específico de la comunidad.

  • isCrawlMessage

  • isCrawlAttachment

  • isCrawlPrivateMensaje

 truepara rastrear mensajes, archivos adjuntos de mensajes y mensajes privados.
type Especifica YAMMER como el tipo de origen de datos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a Microsoft Yammer. Esto incluye su nombre de usuario y contraseña de Microsoft Yammer, su ID de cliente y su secreto de cliente, que se genera al crear una aplicación OAuth en el portal de Azure.
useChangeLog truepara usar el registro de cambios de Microsoft Yammer para determinar qué documentos del índice deben actualizarse.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos. 
{
  "$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"
  ]
}

Esquema de plantilla de MySQL

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como mysql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de MySQL.

En la siguiente tabla se describen los parámetros del esquema JSON de MySQL.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,db2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Oracle Database

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como oracle, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Oracle Database.

En la siguiente tabla se describen los parámetros del esquema JSON de Oracle Database.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya seamysql,db2, postgresqloracle, o. sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de PostgreSQL

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Especifique el tipo de origen de datos como JDBC, el tipo de base de datos como postgresql, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de PostgreSQL.

En la siguiente tabla se describen los parámetros del esquema JSON de PostgreSQL.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata Información de configuración necesaria para conectarse a su origen de datos.

  • dbType: el tipo de base de datos Java que utiliza, ya sea,, mysqldb2, postgresql o. oracle sqlserver

  • dbHost: el nombre del host de la base de datos.

  • dbPort: el puerto de la base de datos.

  • dbInstance: la instancia de base de datos.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos. Especifique el tipo de origen de datos y el ARN secreto.

revisión

 Una lista de objetos que asignan los atributos o los nombres de campo del contenido de la base de datos para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos. Se utiliza para incluir o excluir contenido específico en el origen de datos de la base de datos.
primaryKey Proporciona la clave principal de la tabla de la base de datos. Esto identifica una tabla dentro de la base de datos.
titleColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
bodyColumn Proporciona el nombre de la columna del título del documento en la tabla de la base de datos.
sqlQuery Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
timestampColumn Introduzca el nombre de la columna que contiene las marcas de tiempo. Amazon Kendra utiliza la información de la marca de tiempo para detectar cambios en el contenido y sincronizar solo el contenido modificado.
timestampFormat Introduce el nombre de la columna que contiene los formatos de marcas temporales que se deben utilizar para detectar cambios en el contenido y volver a sincronizar su contenido.
timezone Introduce el nombre de la columna que contiene las zonas horarias del contenido que se va a rastrear.
changeDetectingColumns Introduce los nombres de las columnas que Amazon Kendra se utilizarán para detectar cambios en el contenido. Amazon Kendra volverá a indexar el contenido cuando se produzca un cambio en alguna de estas columnas
allowedUsersColumns Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
allowedGroupsColumn Introduce el nombre de la columna que contiene los ID de usuario a los que se dará acceso al contenido.
sourceURIColumn Introduce el nombre de la columna que contiene las URL de origen que se van a indexar.
isSslEnabled Introduce instrucciones de consulta SQL, como las operaciones SELECT y JOIN. Las consultas SQL deben tener menos de 32 KB. Amazon Kendra rastreará todo el contenido de la base de datos que coincida con su consulta.
type El tipo del origen de datos. Especifica JDBC como el tipo de origen de datos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretArn El nombre de recurso de Amazon (ARN) de un secreto de Secrets Manager que contiene el nombre de usuario y la contraseña necesarios para conectarse a su base de datos. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "user name": "database user name",
    "password": "password"
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Salesforce

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar la URL del host de Salesforce como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como SALESFORCEV2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Salesforce.

En la siguiente tabla se describen los parámetros del esquema JSON de Salesforce.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
hostUrl La URL de la instancia de Salesforce que se va a indexar.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • cuenta

  • contact

  • campaña

  • caso

  • product

  • lead

  • contrato

  • partner

  • profile

  • idea

  • pricebook

  • tarea

  • solución

  • attachment

  • usuario

  • revisión

  • knowledgeArticles

  • grupo

  • opportunity

  • chatter

  • customEntity

 Una lista de objetos que mapean los atributos o los nombres de campo de sus entidades de Salesforce para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su Salesforce. El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "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 Opciones de configuración adicionales para el contenido del origen de datos

  • accountFilter

  • contactFilter

  • caseFilter

  • campaignFilter

  • contractFilter

  • groupFilter

  • leadFilter

  • productFilter

  • opportunityFilter

  • partnerFilter

  • pricebookFilter

  • ideaFilter

  • profileFilter

  • taskFilter

  • solutionFilter

  • userFilter

  • chatterFilter

  • documentFilter

  • knowledgeArticleFilter

  • customEntities

 Una colección de cadenas que especifica qué entidades filtrar.

inclusionPatterns

  • inclusionDocumentFileTypePatterns

  • inclusionDocumentFileNamePatterns

  • inclusionAccountFileTypePatterns

  • inclusionCampaignFileTypePatterns

  • inclusionDocumentFileNamePatterns

  • inclusionCampaignFileNamePatterns

  • inclusionCaseFileTypePatterns

  • inclusionCaseFileNamePatterns

  • inclusionContactFileTypePatterns

  • inclusionContractFileNamePatterns

  • inclusionLeadFileTypePatterns

  • inclusionLeadFileNamePatterns

  • inclusionOpportunityFileTypePatterns

  • inclusionOpportunityFileNamePatterns

  • inclusionSolutionFileTypePatterns

  • inclusionSolutionFileNamePatterns

  • inclusionTaskFileTypePatterns

  • inclusionTaskFileNamePatterns

  • inclusionGroupFileTypePatterns

  • inclusionGroupFileNamePatterns

  • inclusionChatterFileTypePatterns

  • inclusionChatterFileNamePatterns

  • inclusionCustomEntityFileTypePatterns

  • inclusionCustomEntityFileNamePatterns

 Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Salesforce. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

exclusionPatterns

  • exclusionDocumentFileTypePatterns

  • exclusionDocumentFileNamePatterns

  • exclusionAccountFileTypePatterns

  • exclusionCampaignFileTypePatterns

  • exclusionCampaignFileNamePatterns

  • exclusionCaseFileTypePatterns

  • exclusionCaseFileNamePatterns

  • exclusionContactFileTypePatterns

  • exclusionContractFileNamePatterns

  • exclusionLeadFileTypePatterns

  • exclusionLeadFileNamePatterns

  • exclusionOpportunityFileTypePatterns

  • exclusionOpportunityFileNamePatterns

  • exclusionSolutionFileTypePatterns

  • exclusionSolutionFileNamePatterns

  • exclusionTaskFileTypePatterns

  • exclusionTaskFileNamePatterns

  • exclusionGroupFileTypePatterns

  • exclusionGroupFileNamePatterns

  • exclusionChatterFileTypePatterns

  • exclusionChatterFileNamePatterns

  • exclusionCustomEntityFileTypePatterns

  • exclusionCustomEntityFileNamePatterns

 Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Salesforce. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • isCrawlAccount

  • isCrawlContact

  • isCrawlCase

  • isCrawlCampaign

  • isCrawlProduct

  • isCrawlLead

  • isCrawlContract

  • isCrawlPartner

  • isCrawlProfile

  • isCrawlIdea

  • isCrawlPricebook

  • isCrawlDocument

  • crawlSharedDocument

  • isCrawlGroup

  • isCrawlOpportunity

  • isCrawlChatter

  • isCrawlUser

  • isCrawlSolution

  • isCrawlTask

  • isCrawlAccountAdjuntos

  • isCrawlContactAdjuntos

  • isCrawlCaseAdjuntos

  • isCrawlCampaignAdjuntos

  • isCrawlLeadAdjuntos

  • isCrawlContractAdjuntos

  • isCrawlGroupAdjuntos

  • isCrawlOpportunityAdjuntos

  • isCrawlChatterAdjuntos

  • isCrawlSolutionAdjuntos

  • isCrawlTaskAdjuntos

  • isCrawlCustomEntityAttachments

  • isCrawlKnowledgeArtículos

    • isCrawlDraft

    • isCrawlPublish

    • isCrawlArchived

 truepara rastrear estos tipos de archivos en su cuenta de Salesforce.
type El tipo del origen de datos. Especifica SALESFORCEV2 como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
versión La versión de esta plantilla que se admite actualmente. 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties":
  {
    "connectionConfiguration": {
      "type": "object",
      "properties":
      {
        "repositoryEndpointMetadata":
        {
          "type": "object",
          "properties":
          {
            "hostUrl":
            {
              "type": "string",
              "pattern": "https:.*"
            }
          },
          "required":
          [
            "hostUrl"
          ]
        }
      },
      "required":
      [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties":
      {
        "account":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "contact":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "campaign":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "case":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "product":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "lead":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "contract":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "partner":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "profile":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "idea":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "pricebook":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "task":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "solution":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "attachment":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "user":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "document":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "knowledgeArticles":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "group":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "opportunity":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "chatter":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "customEntity":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties":
      {
        "accountFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "contactFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "caseFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "campaignFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "contractFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "groupFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "leadFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "productFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "opportunityFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "partnerFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pricebookFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "ideaFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "profileFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "taskFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "solutionFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "userFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "chatterFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "documentFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "knowledgeArticleFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "customEntities":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "isCrawlAccount": {
          "type": "boolean"
        },
        "isCrawlContact": {
          "type": "boolean"
        },
        "isCrawlCase": {
          "type": "boolean"
        },
        "isCrawlCampaign": {
          "type": "boolean"
        },
        "isCrawlProduct": {
          "type": "boolean"
        },
        "isCrawlLead": {
          "type": "boolean"
        },
        "isCrawlContract": {
          "type": "boolean"
        },
        "isCrawlPartner": {
          "type": "boolean"
        },
        "isCrawlProfile": {
          "type": "boolean"
        },
        "isCrawlIdea": {
          "type": "boolean"
        },
        "isCrawlPricebook": {
          "type": "boolean"
        },
        "isCrawlDocument": {
          "type": "boolean"
        },
        "crawlSharedDocument": {
          "type": "boolean"
        },
        "isCrawlGroup": {
          "type": "boolean"
        },
        "isCrawlOpportunity": {
          "type": "boolean"
        },
        "isCrawlChatter": {
          "type": "boolean"
        },
        "isCrawlUser": {
          "type": "boolean"
        },
        "isCrawlSolution":{
          "type": "boolean"
        },
        "isCrawlTask":{
          "type": "boolean"
        },

        "isCrawlAccountAttachments": {
          "type": "boolean"
        },
        "isCrawlContactAttachments": {
          "type": "boolean"
        },
        "isCrawlCaseAttachments": {
          "type": "boolean"
        },
        "isCrawlCampaignAttachments": {
          "type": "boolean"
        },
        "isCrawlLeadAttachments": {
          "type": "boolean"
        },
        "isCrawlContractAttachments": {
          "type": "boolean"
        },
        "isCrawlGroupAttachments": {
          "type": "boolean"
        },
        "isCrawlOpportunityAttachments": {
          "type": "boolean"
        },
        "isCrawlChatterAttachments": {
          "type": "boolean"
        },
        "isCrawlSolutionAttachments":{
          "type": "boolean"
        },
        "isCrawlTaskAttachments":{
          "type": "boolean"
        },
        "isCrawlCustomEntityAttachments":{
          "type": "boolean"
        },
        "isCrawlKnowledgeArticles": {
          "type": "object",
          "properties":
          {
            "isCrawlDraft": {
              "type": "boolean"
            },
            "isCrawlPublish": {
              "type": "boolean"
            },
            "isCrawlArchived": {
              "type": "boolean"
            }
          }
        },
        "inclusionDocumentFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionDocumentFileTypePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionDocumentFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionDocumentFileNamePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionAccountFileTypePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionAccountFileTypePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionAccountFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionAccountFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCampaignFileTypePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCampaignFileTypePatterns": {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCampaignFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCampaignFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCaseFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCaseFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCaseFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCaseFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionContactFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionContactFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionContactFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionContactFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionContractFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionContractFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionContractFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionContractFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionLeadFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionLeadFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionLeadFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionLeadFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionOpportunityFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionOpportunityFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionOpportunityFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionOpportunityFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionSolutionFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionSolutionFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionSolutionFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionSolutionFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionTaskFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionTaskFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionTaskFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionTaskFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionGroupFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionGroupFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionGroupFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionGroupFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionChatterFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionChatterFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionChatterFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionChatterFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCustomEntityFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCustomEntityFileTypePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "inclusionCustomEntityFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "exclusionCustomEntityFileNamePatterns":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        }
      },
      "required":
      []
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "type": {
      "type": "string",
      "pattern": "SALESFORCEV2"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FULL_CRAWL",
        "FORCED_FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

ServiceNow esquema de plantilla

Incluye un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar la URL del ServiceNow host, el tipo de autenticación y la versión de la instancia como parte de la configuración de la conexión o de los detalles del punto final del repositorio. Además, especifique el tipo de origen de datos como SERVICENOWV2, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, debe TEMPLATE especificarlo Type cuando llame CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte ServiceNow Esquema JSON.

En la siguiente tabla se describen los parámetros del esquema ServiceNow JSON.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
hostUrl La URL del ServiceNow host. Por ejemplo, your-domain.service-now.com.
authType El tipo de autenticación que utiliza, ya sea basicAuth o OAuth2.
servicenowInstanceVersion La ServiceNow versión que utilizas. Puede elegir entreTokyo, SandiegoRome, yOthers.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • knowledgeArticle

  • attachment

  • serviceCatalog

  • incident

 Una lista de objetos que mapean los atributos o nombres de campo de sus artículos de ServiceNow conocimiento, archivos adjuntos, catálogo de servicios e incidentes para Amazon Kendra indexar los nombres de los campos. Para obtener más información, consulte Asignación de campos de origen de datos. Los nombres de los campos de la fuente de ServiceNow datos deben estar en sus metadatos ServiceNow personalizados.
additional properties Opciones de configuración adicionales para el contenido del origen de datos.
maxFileSizeInMegaBytes Especifique el límite de tamaño del archivo en MB que Amazon Kendra rastreará. Amazon Kendra rastreará solo los archivos dentro del límite de tamaño que usted defina. El tamaño predeterminado del archivo es de 50 MB. El tamaño máximo del archivo debe ser superior a 0 MB e inferior o igual a 50 MB.

  • knowledgeArticleFilter

  • incidentQueryFilter

  • serviceCatalogQueryFiltro

  • knowledgeArticleTitleRegExp

  • serviceCatalogTitleRegExp

  • incidentTitleRegExp

  • inclusionFileTypePatrones

  • exclusionFileTypePatrones

  • inclusionFileNamePatrones

  • exclusionFileNamePatrones

  • incidentStateType

 Una lista de patrones de expresiones regulares para incluir o excluir determinados archivos de la fuente ServiceNow de datos. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • isCrawlKnowledgeArtículo

  • isCrawlKnowledgeArticleAttachment

  • includePublicArticlesSolo

  • isCrawlServiceCatálogo

  • isCrawlServiceCatalogAttachment

  • isCrawlActiveServiceCatalog

  • isCrawlInactiveServiceCatalog

  • isCrawlIncident

  • isCrawlIncidentAdjunto

  • isCrawlActiveIncidente

  • isCrawlInactiveIncidente

  • Aplicar una CL ForKnowledgeArticle

  • Aplicar una ACL ForServiceCatalog

  • Aplicar una ACL ForIncident

 truepara rastrear artículos de ServiceNow conocimiento, catálogos de servicios, incidentes y archivos adjuntos.
type El tipo del origen de datos. Especifica SERVICENOWV2 como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su. ServiceNow El secreto debe contener una estructura JSON con las siguientes claves: 
{
    "username": "user name",
    "password": "password"
}
Si utiliza la autenticación OAuth2, su secreto debe contener una estructura JSON con las siguientes claves: 
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"         
}
versión La versión de la plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantillas de Slack

Incluyes un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar la URL del host como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como SLACK, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Slack.

En la siguiente tabla se describen los parámetros del esquema JSON de Slack.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
ID de equipo El ID del equipo de Slack que copiaste de la URL de tu página principal de Slack.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.
Todos Una lista de objetos que mapean los atributos o los nombres de campo de tu Slack contenido para Amazon Kendra indexar los nombres de los campos.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos.
inclusionPatterns Una lista de patrones de expresiones regulares para incluir contenido específico desde su origen de datos de Slack. El contenido que coincide con los patrones se incluye en el índice. El contenido que no coincide con los patrones se excluye del índice. Si algún contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresiones regulares para excluir contenido específico en su origen de datos de Slack. El contenido que coincide con los patrones se excluye del índice. El contenido que no coincide con los patrones se incluye en el índice. Si algún contenido coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el contenido no se incluye en el índice.
crawlBotMessages truepara rastrear los mensajes de los bots.
Excluir archivados truepara excluir el rastreo de los mensajes archivados.
Tipo de conversación El tipo de conversación que desea indexarPUBLIC_CHANNEL, ya seaPRIVATE_CHANNEL, GROUP_MESSAGE y. DIRECT_MESSAGE
Filtro de canal El tipo de canal que quiere indexar si private_channel o public_channel.
sinceDate Puede optar por configurar un parámetro sinceDate para que el conector de Slack rastree el contenido en una sinceDate específica.
Mira hacia atrás Puede configurar un lookBack parámetro para que el Slack conector rastree el contenido actualizado o eliminado hasta un número específico de horas antes de la última sincronización del conector.
syncMode

Especifique cómo Amazon Kendra debe actualizarse el índice cuando cambie el contenido de la fuente de datos. Puede elegir entre las siguientes opciones:

  • FORCED_FULL_CRAWLpara indexar todo el contenido de forma actualizada, sustituyendo el contenido existente cada vez que la fuente de datos se sincronice con el índice.

  • FULL_CRAWLpara indexar únicamente el contenido nuevo, modificado y eliminado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.

  • CHANGE_LOGpara indexar solo el contenido nuevo y modificado cada vez que la fuente de datos se sincronice con el índice. Amazon Kendra puede usar el mecanismo de la fuente de datos para realizar un seguimiento de los cambios en el contenido e indexar el contenido que ha cambiado desde la última sincronización.
type El tipo del origen de datos. Especifica SLACK como el tipo de origen de datos.
enableIdentityCrawler trueutilizar el rastreador Amazon Kendra de identidad para sincronizar la información principal o de identidad de los usuarios y grupos con acceso a determinados documentos. Si el rastreador de identidad está desactivado, se pueden buscar públicamente todos los documentos. Si quieres usar el control de acceso para tus documentos y el rastreador de identidad está desactivado, también puedes usar la PutPrincipalMappingAPI para cargar la información de acceso de usuarios y grupos.
secretArn

El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su. Slack El secreto debe contener una estructura JSON con las siguientes claves:

{
    "slackToken": "token"
}
versión La versión de esta plantilla que se admite actualmente. 
{
  "$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"
  ]
}

Esquema de plantilla de Zendesk

Incluyes un JSON que contiene el esquema de la fuente de datos como parte del TemplateConfigurationobjeto. Debe proporcionar la URL del host como parte de la configuración de la conexión o de los detalles del punto de conexión del repositorio. Además, especifique el tipo de origen de datos como ZENDESK, un secreto para sus credenciales de autenticación y otras configuraciones necesarias. A continuación, TEMPLATE se especifica como Type cuando se llama CreateDataSource.

Puede usar la plantilla que se proporciona en esta guía para desarrolladores. Consulte Esquema JSON de Zendesk.

En la siguiente tabla se describen los parámetros del esquema JSON de Zendesk.

Configuración Descripción
connectionConfiguration Información de configuración para el punto de conexión para el origen de datos.
repositoryEndpointMetadata La información del punto de conexión para el origen de datos.
hostURL La URL del host de Zendesk. Por ejemplo, https://yoursubdomain.zendesk.com.
repositoryConfigurations Información de configuración del contenido del origen de datos. Por ejemplo, configurar tipos específicos de contenido y asignaciones de campos.

  • ticket

  • ticketComment

  • ticketCommentAttachment

  • article

  • articleComment

  • articleAttachment

  • communityTopic

  • communityPostComment

 Una lista de objetos que asignan atributos de origen de datos o nombres de campo de tickets de Zendesk a los nombres de campo del índice de Amazon Kendra. Para obtener más información, consulte Asignación de campos de origen de datos.
secretARN El nombre de recurso de Amazon (ARN) de un AWS Secrets Manager secreto que contiene los pares clave-valor necesarios para conectarse a su cuenta de Zendesk. El secreto debe contener una estructura JSON con las siguientes claves: URL de host, ID de cliente, secreto del cliente, nombre de usuario y contraseña.
additionalProperties Opciones de configuración adicionales para el contenido del origen de datos
organizationNameFilter Puede optar por indexar los tickets que existen en una organización específica.
sinceDate Puede optar por configurar un parámetro sinceDate para que el conector de Zendesk rastree el contenido en función de una sinceDate específica.
inclusionPatterns Una lista de patrones de expresión regular para incluir determinados archivos en su origen de datos de Zendesk. Los archivos que coinciden con los patrones se incluyen en el índice. Los archivos que no coincidan con los patrones se excluyen del índice. Si un archivo coincide con un patrón de inclusión y de exclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.
exclusionPatterns Una lista de patrones de expresión regular para excluir determinados archivos en su origen de datos de Zendesk. Los archivos que coinciden con los patrones se excluyen del índice. Los archivos que no coincidan con los patrones se incluyen en el índice. Si un archivo coincide con un patrón de exclusión y de inclusión, el patrón de exclusión tiene prioridad y el archivo no se incluye en el índice.

  • isCrawlTicket

  • isCrawlTicketComentario

  • isCrawlTicketCommentAttachment

  • isCrawlArticle

  • isCrawlArticleComentario

  • isCrawlArticleAdjunto

  • isCrawlCommunityTema

  • isCrawlCommunityPublicar

  • isCrawlCommunityPostComment

 Introduce true "» para rastrear estos tipos de contenido.
type Especifica ZENDESK como el tipo de origen de datos.
useChangeLog Introduzca true "» para usar el registro de cambios de Zendesk y determinar qué documentos del índice deben actualizarse. Según el tamaño del registro de cambios, podría ser más rápido escanear los documentos en Zendesk. Si está sincronizando el origen de datos de Zendesk con su índice por primera vez, se escanean todos los documentos. 
{
  "$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"
  ]
}