Esquemas de modelos de fonte de dados - Amazon Kendra
Esquema de modelo do Adobe Experience ManagerAmazon FSx Esquema de modelo (Windows)Amazon FSx Esquema de modelo (NetApp ONTAP)Esquema de modelo do AlfrescoAurora Esquema de modelo (MySQL)Aurora Esquema de modelo (PostgreSQL)Amazon RDS Esquema de modelo (Microsoft SQL Server)Amazon RDS Esquema de modelo (MySQL)Amazon RDS Esquema de modelo (Oracle)Amazon RDS Esquema de modelo (PostgreSQL)Amazon S3 esquema de modeloAmazon Kendra Esquema do modelo do Web CrawlerEsquema do modelo do ConfluenceEsquema de modelos do DropboxEsquema de modelos do DrupalGitHub esquema de modeloEsquema de modelos do GmailEsquema do modelo do Google DriveEsquema de modelo do IBM DB2Esquema de modelo do Microsoft ExchangeEsquema OneDrive de modelos da MicrosoftEsquema SharePoint de modelos da MicrosoftEsquema de modelo do Microsoft SQL ServerEsquema de modelo do Microsoft TeamsEsquema de modelo do Microsoft YammerEsquema de modelo do MySQLEsquema de modelos do Oracle DatabaseEsquema de modelo do (PostgreSQLEsquema de modelo do SalesforceServiceNow esquema de modeloEsquema de modelos do SlackEsquema do modelo do Zendesk

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Esquemas de modelos de fonte de dados

A seguir estão os esquemas de modelo para fontes de dados em que os modelos são compatíveis.

Esquema de modelo do Adobe Experience Manager

Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do TemplateConfiguration. Forneça a URL do host do Adobe Experience Manager, o tipo de autenticação e se você usa o Adobe Experience Manager (AEM) como um serviço de nuvem ou o AEM on-premises como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como AEM, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique TEMPLATE como Type ao chamar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Para ter mais informações, consulte Esquema JSON do Adobe Experience Manager.

A tabela a seguir descreve os parâmetros do esquema JSON do AEM.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
aemUrl O URL do host do Adobe Experience Manager. Por exemplo, ao usar o AEM on-premises, inclua o nome do host e a porta:. https://hostname:port Ou, ao usar o AEM como um serviço de nuvem, use a URL do autor: https://author-xxxxxx-xxxxxxx.adobeaemcloud.com.
authType O tipo de autenticação que você usa: Basic ou OAuth2.
deploymentType O tipo de Adobe Experience Manager que você usa: CLOUD ouON_PREMISE.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • page

  • asset

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas Adobe Experience Manager páginas e ativos para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
timeZoneId

Se você usa o AEM On-Premise e o fuso horário do seu servidor é diferente do fuso horário do conector ou índice do Amazon Kendra AEM, você pode especificar o fuso horário do servidor para alinhar com o conector ou índice do AEM.

O fuso horário padrão para o AEM On-Premise é o fuso horário do conector ou índice do Amazon Kendra AEM. O fuso horário padrão para o AEM como serviço de nuvem é o Greenwich Mean Time.

  • pageRootPaths

  • assetRootPaths

 Uma lista de caminhos raiz para páginas e ativos. Por exemplo, o caminho raiz de uma página pode ser /content/sub e o caminho raiz de um ativo pode ser /content/sub/asset1.
crawlAssets true para rastrear ativos.
crawlPages true para rastrear páginas.

  • pagePathInclusionPadrões

  • pageNameInclusionPadrões

  • assetPathInclusionPadrões

  • assetTypeInclusionPadrões

  • assetNameInclusionPadrões

 Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Adobe Experience Manager. As páginas e os ativos que correspondem aos padrões são incluídos no índice. As páginas e os ativos que não correspondem aos padrões são excluídos do índice. Se a página ou ativo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.

  • pagePathExclusionPadrões

  • pageNameExclusionPadrões

  • assetPathExclusionPadrões

  • assetTypeInclusionPadrões

  • assetNameInclusionPadrões

 Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Adobe Experience Manager. As páginas e os ativos que correspondem aos padrões são excluídos do índice. As páginas e os ativos que não correspondem aos padrões são incluídos no índice. Se a página ou ativo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.
pageComponents Uma lista de nomes para os componentes de página específicos que você deseja indexar.
contentFragmentVariations Uma lista de nomes para as variações salvas específicas dos fragmentos de conteúdo do Adobe Experience Manager que você deseja indexar.
tipo O tipo da fonte de dados. Especifique AEM como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Adobe Experience Manager. Para obter informações sobre esses pares de valores-chave, consulte Instruções de conexão para o Adobe Experience Manager.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (Windows)

Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do TemplateConfiguration. Você fornece a ID do sistema de arquivos como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Você também deve especificar o tipo de fonte de dados comoFSX, um segredo para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique TEMPLATE como Type ao chamar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon FSx Esquema JSON (Windows).

A tabela a seguir descreve os parâmetros do esquema JSON Amazon FSx (Windows).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
fileSystemId O identificador do sistema Amazon FSx de arquivos. Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no Amazon FSx console.
fileSystemType O tipo Amazon FSx de sistema de arquivos. Para usar Windows File Server como seu tipo de sistema de arquivos, especifiqueWINDOWS.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.
Todos Uma lista de objetos que mapeiam atributos ou nomes de campo de seus arquivos em sua fonte de Amazon FSx dados para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
isCrawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
inclusionPatterns Uma lista de padrões de expressão regular para incluir determinados arquivos em sua fonte Amazon FSx de dados. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressão regular para excluir determinados arquivos na sua fonte Amazon FSx de dados. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
tipo O tipo da fonte de dados. Para fontes de dados do sistema de arquivos do 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 modelo (NetApp ONTAP)

Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do TemplateConfiguration. Você fornece a ID do sistema de arquivos e a máquina virtual de armazenamento (SVM) como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Você também deve especificar o tipo de fonte de dados comoFSXONTAP, um segredo para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique TEMPLATE como Type ao chamar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon FSx Esquema NetApp JSON (ONTAP).

A tabela a seguir descreve os parâmetros do esquema JSON Amazon FSx (NetApp ONTAP).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
fileSystemId O identificador do sistema Amazon FSx de arquivos. Você pode encontrar o ID do sistema de arquivos no painel Sistemas de arquivos no Amazon FSx console. Para obter informações sobre como criar um sistema de arquivos no Amazon FSx console para o NetApp ONTAP, consulte o Guia de introdução do NetApp ONTAP no Guia do FSx for ONTAP usuário.
fileSystemType O tipo Amazon FSx de sistema de arquivos. Para usar NetApp ONTAP como seu tipo de sistema de arquivos, especifiqueONTAP.
SVMid O identificador da máquina virtual de armazenamento (SVM) usada com seu sistema de Amazon FSx arquivos paraNetApp ONTAP. Você pode encontrar sua ID SVM acessando o painel Sistemas de arquivos no Amazon FSx console, selecionando a ID do sistema de arquivos e, em seguida, selecionando Máquinas virtuais de armazenamento. Para obter informações sobre como criar um sistema de arquivos no Amazon FSx console paraNetApp ONTAP, consulte o Guia de introdução do NetApp ONTAP no Guia do FSx for ONTAP usuário.
Tipo de protocolo Se você usa o protocolo Common Internet File System (CIFS) para Windows ou o protocolo Network File System (NFS) para Linux.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.
file Uma lista de objetos que mapeiam atributos ou nomes de campo de seus arquivos em sua fonte de Amazon FSx dados para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte Mapear campos de fonte de dados. Os nomes dos campos da fonte de dados devem existir nos metadados personalizados dos seus arquivos.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
crawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
inclusionPatterns Uma lista de padrões de expressão regular para incluir determinados arquivos em sua fonte Amazon FSx de dados. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressão regular para excluir determinados arquivos na sua fonte Amazon FSx de dados. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
tipo O tipo da fonte de dados. Para fontes de dados do sistema de NetApp ONTAP arquivos, especifiqueFSXONTAP.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn

O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu sistema de arquivos. Amazon FSx O segredo deve conter uma estrutura JSON com as seguintes chaves:

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

Se você usa o protocolo NFS para seu sistema de Amazon FSx arquivos, o segredo é armazenado em uma estrutura JSON com as seguintes chaves:

{
    "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 modelo do Alfresco

Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do TemplateConfiguration. Forneça o ID do site, o URL do repositório, o URL da interface do usuário e o tipo de autenticação do Alfresco, se você usa a nuvem ou on-premises, e o tipo de conteúdo que deseja rastrear. Forneça isso como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como ALFRESCO, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, especifique TEMPLATE como Type ao chamar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Alfresco.

A tabela a seguir descreve os parâmetros do esquema JSON do Alfresco.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
siteId O identificador do site Alfresco.
repoUrl O URL do seu repositório do Alfresco. Você pode obter o URL do repositório com o administrador do Alfresco. Por exemplo, se você usa o Cloud (PaaS) do Alfresco, o URL do repositório pode ser https://company.alfrescocloud.com. Ou, se você usa o Alfresco on-premises, o URL do repositório pode ser https://company-alfresco-instance.company-domain.suffix:port.
webAppUrl O URL da sua interface de usuário do Alfresco. Você pode obter o URL da interface do usuário do Alfresco com o administrador do Alfresco. Por exemplo, o URL da interface do usuário pode ser https://example.com.
repositoryAdditionalProperties Propriedades adicionais para se conectar ao endpoint do repositório/fonte de dados.
authType O tipo de autenticação que você usa: OAuth2 ou Basic.
tipo implantação O tipo de Alfresco que você usa: PAAS ouON-PREM.
crawlType O tipo de conteúdo que você deseja rastrear, seja ASPECT (conteúdo marcado com “Aspectos” no Alfresco), SITE_ID (conteúdo em um site específico do Alfresco) ou ALL_SITES (conteúdo em todos os sites do Alfresco).
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • document

  • comentário

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus documentos e comentários do Alfresco para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
aspectName

O nome de um “Aspecto” específico que você deseja indexar.
aspectProperties

Uma lista de propriedades de conteúdo de “Aspecto” específicas que você deseja indexar.
enableFineGrainedControle

true para rastrear os “Aspectos”.
isCrawlComment

truepara rastrear comentários.

  • inclusionFileNamePadrões

  • inclusionFileTypePadrões

  • inclusionFilePathPadrões

 Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Alfresco. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • exclusionFileNamePadrões

  • exclusionFileTypePadrões

  • exclusionFilePathPadrões

 Uma lista de padrões de expressões regulares para excluir determinadas páginas e ativos em sua fonte de dados do Alfresco. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
tipo O tipo da fonte de dados. Especifique ALFRESCO como seu tipo de fonte de dados.
secretArn

O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. Alfresco O segredo deve conter uma estrutura JSON com as seguintes chaves:

Se estiver usando a autenticação básica:

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

Se estiver usando a autenticação OAuth 2.0:

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

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (MySQL)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados mysql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Aurora Esquema JSON (MySQL).

A tabela a seguir descreve os parâmetros do esquema JSON Aurora (MySQL).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (PostgreSQL)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados postgresql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Aurora (PostgreSQL) Esquema JSON.

A tabela a seguir descreve os parâmetros do esquema Aurora JSON (PostgreSQL).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (Microsoft SQL Server)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados sqlserver, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon RDS Esquema JSON (Microsoft SQL Server).

A tabela a seguir descreve os parâmetros do esquema JSON Amazon RDS (Microsoft SQL Server).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (MySQL)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados mysql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon RDS Esquema JSON (MySQL).

A tabela a seguir descreve os parâmetros do esquema JSON Amazon RDS (MySQL).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (Oracle)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados oracle, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon RDS Esquema JSON (Oracle).

A tabela a seguir descreve os parâmetros do esquema JSON Amazon RDS (Oracle).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo (PostgreSQL)

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados postgresql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon RDS (PostgreSQL) Esquema JSON.

A tabela a seguir descreve os parâmetros do esquema Amazon RDS JSON (PostgreSQL).

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo

Inclua um JSON que contém o esquema da fonte de dados como parte da configuração do modelo. Forneça o nome do bucket S3 como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como S3 e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON S3.

A tabela a seguir descreve os parâmetros do esquema Amazon S3 JSON.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
BucketName O nome do seu Amazon S3 balde.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • inclusionPatterns

  • exclusionPatterns

  • inclusionPrefixes

  • exclusionPrefixes

 Uma lista de padrões de expressão regular para incluir ou excluir arquivos específicos na sua fonte Amazon S3 de dados. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
aclConfigurationFileCaminho O caminho do arquivo que controla o acesso aos documentos em um índice do Amazon Kendra .
metadataFilesPrefix O local em seu bucket para arquivos de metadados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
tipo O tipo da fonte de dados. Especifique S3 como seu tipo de fonte de dados.
versão A versão do modelo que é compatível. 
{
  "$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 do modelo do Web Crawler

Inclua um JSON que contém o esquema da fonte de dados como parte do objeto do TemplateConfiguration.

Forneça os URLs iniciais ou de ponto de partida ou os URLs do mapa do site, como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Em vez de listar manualmente todos os seus URLs, você pode fornecer o caminho para o Amazon S3 bucket que armazena um arquivo de texto para sua lista de URLs iniciais ou arquivos XML de sitemap, que você pode agrupar em um arquivo ZIP no S3.

Você também especifica o tipo de fonte de dados comoWEBCRAWLERV2, as credenciais de autenticação do site e o tipo de autenticação, se seus sites exigirem autenticação, e outras configurações necessárias.

Em seguida, especifique TEMPLATE como Type ao chamar CreateDataSource.

Importante

A criação do conector Web Crawler v2.0 não é suportada pelo. AWS CloudFormation Use o conector Web Crawler v1.0 se precisar de suporte. AWS CloudFormation

Ao selecionar sites para indexar, você precisa aderir à Política de uso aceitável da Amazon e a todos os outros termos da Amazon. Lembre-se de que você só deve usar o Amazon Kendra Web Crawler para indexar suas próprias páginas da Web ou páginas da Web que você tenha autorização para indexar. Para saber como impedir que o Web Crawler do Amazon Kendra indexe seus sites, consulte Configurando o arquivo do robots.txt para o Web Crawler do Amazon Kendra.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Amazon Kendra Esquema JSON do Web Crawler.

A tabela a seguir descreve os parâmetros do esquema JSON do Amazon Kendra Web Crawler.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
siteMapUrls A lista de URLs de mapa dos sites nos quais você deseja fazer o crawling. Você pode listar até três URLs de mapa de site.
s3 SeedUrl O caminho do S3 para o arquivo de texto que armazena a lista de URLs semente ou de partida. Por exemplo, s3://bucket-name/directory/. Cada URL no arquivo de texto deve ser formatado em uma linha separada. Você pode listar até 100 URLs semente em um arquivo.
s3 SiteMapUrl O caminho do S3 para os arquivos XML do mapa do site. Por exemplo, s3://bucket-name/directory/. Você pode listar até três arquivos XML do mapa do site. Você pode agrupar vários arquivos de sitemap em um arquivo ZIP e armazená-lo em seu Amazon S3 bucket.
seedUrlConnections A lista de URLs semente ou de partida dos sites nos quais você deseja fazer o crawling. Você pode listar até 100 URLs semente.
seedUrl O URL semente ou de partida.
authentication O tipo de autenticação dos sites exigem a mesma autenticação, caso contrário, especifique NoAuthentication.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • webPage

  • attachment

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas páginas da Web e arquivos de páginas da Web para Amazon Kendra indexar nomes de campos. Por exemplo, a tag de título da página da web em HTML pode ser mapeada para o campo de índice _document_title. Para obter mais informações, consulte Mapear campos de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
rateLimit O número máximo de URLs que o crawling percorre por host de site por minuto.
maxFileSize O tamanho máximo (em MB) de uma página da Web ou anexo para crawling.
crawlDepth O número de níveis do URL semente para crawling. Por exemplo, a página de URL semente tem profundidade 1 e todos os hiperlinks nessa página que também são rastreados têm profundidade 2.
maxLinksPerURL O número máximo de URLs em uma página da Web a serem incluídos no crawling de um site. Esse número é por página da Web. À medida que as páginas de um site passam pelo crawling, todos os URLs aos quais as páginas se vinculam também são incluídos nele. Os URLs em uma página da Web passam pelo crawling por ordem de exibição.
crawlSubDomain true: fazer crawling dos domínios do site com subdomínios. Por exemplo, se o URL semente for "abc.example.com“, então “a.abc.example.com“ e “b.abc.example.com“ também serão rastreados. Se você não definir crawlSubDomain ou crawlAllDomain selecionartrue, Amazon Kendra rastreará apenas os domínios dos sites que você deseja rastrear.
crawlAllDomain true: fazer crawling dos domínios do site com subdomínios e outros domínios aos quais as páginas da Web estão vinculadas. Se você não definir crawlSubDomain ou crawlAllDomain selecionartrue, Amazon Kendra rastreará apenas os domínios dos sites que você deseja rastrear.
honorRobots true para respeitar as diretivas robots.txt dos sites nos quais você deseja fazer o crawling. Essas diretivas controlam como o Amazon Kendra Web Crawler rastreia os sites, se Amazon Kendra pode rastrear somente conteúdo específico ou não rastrear nenhum conteúdo.
crawlAttachments true para rastrear arquivos aos quais as páginas da web estão vinculadas.

  • URL de inclusão CrawlPatterns

  • URL de inclusão IndexPatterns

 Uma lista de padrões de expressão regular que inclui o crawling de determinados URLs e a indexação de quaisquer hiperlinks nessas páginas da Web com URL. Os URLs que correspondem aos padrões são incluídos no índice. Os URLs que não correspondem aos padrões são excluídos do índice. Se um URL corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o URL/páginas da Web não serão incluídos no índice.

  • URL de exclusão CrawlPatterns

  • URL de exclusão IndexPatterns

 Uma lista de padrões de expressão regular que inclui o crawling de determinados URLs e a indexação de quaisquer hiperlinks nessas páginas da Web com URL. Os URLs que correspondem aos padrões são excluídos do índice. Os URLs que não correspondem aos padrões são incluídos no índice. Se um URL corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o URL/páginas da Web não serão incluídos no índice.
inclusionFileIndexPadrões Uma lista de padrões de expressões regulares para incluirdeterminados arquivos de páginas da Web. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionFileIndexPadrões Uma lista de padrões de expressões regulares para excluirdeterminados arquivos de páginas da Web. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
proxy Informações de configuração necessárias para se conectar aos seus sites internos por meio de um proxy da Web.
host O nome do host do servidor proxy ao qual você deseja se conectar por sites internos. Por exemplo, o nome do host de https://a.example.com/page1.html é "a.example.com”.
porta O número da porta do servidor proxy ao qual você deseja se conectar por sites internos. Por exemplo, 443 é a porta padrão para HTTPS.
secretArn (proxy) Se forem necessárias credenciais de proxy da web para se conectar a um host de site, você poderá criar um AWS Secrets Manager segredo que armazene as credenciais. Forneça o nome do recurso da Amazon (ARN) da senha.
tipo O tipo da fonte de dados. Especifique WEBCRAWLERV2 como seu tipo de fonte de dados.
secretArn

O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo usado se seus sites precisarem de autenticação para acessá-los. Você armazena as credenciais de autenticação do site na senha que contém pares de valores-chave JSON.

Se você usa o básico ou NTML/Kerberos, digite o nome de usuário e a senha. As chaves JSON na senha devem ser userName e password. O protocolo de autenticação NTLM inclui hash de senha e o protocolo de autenticação Kerberos inclui criptografia de senha.

Se você usar SAML ou autenticação de formulário, insira o nome de usuário e a senha, XPath para o campo de nome de usuário (e botão de nome de usuário se estiver usando SAML), XPaths para o campo e botão de senha e a URL da página de login. As chaves JSON na senha devem ser userName, password, userNameFieldXpath, userNameButtonXpath, passwordFieldXpath, passwordButtonXpath e loginPageUrl. Você pode encontrar os XPaths (XML Path Language) dos elementos usando as ferramentas de desenvolvedor do navegador. Os XPaths geralmente seguem este formato://tagname[@Attribute='Value'].

Amazon Kendra também verifica se as informações do endpoint (URLs iniciais) incluídas no segredo são as mesmas informações do endpoint especificadas nos detalhes de configuração do endpoint da fonte de dados.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 do modelo do Confluence

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o URL do host do Confluence, o método de host e o tipo de autenticação como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como CONFLUENCEV2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Confluence.

A tabela a seguir descreve os parâmetros do esquema JSON do Confluence.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
hostUrl O URL da sua instância do Confluence. Por exemplo, https://example.confluence.com.
tipo O método de host para sua instância do Confluence: SAAS ou ON_PREM.
authType O método de autenticação para sua instância do Confluence: Basic, OAuth2 ou Personal-token.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • space

  • page

  • blog

  • comentário

  • attachment

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus espaços, páginas, blogs, comentários e anexos do Confluence para indexar Amazon Kendra nomes de campos. Para obter mais informações, consulte Mapping data source fields (Mapear campos de fonte de dados). Os nomes dos campos da fonte de dados do Confluence devem existir nos metadados personalizados do Confluence.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
isCrawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
fieldForUserIdentificação Especifique email se você deseja usar o e-mail do usuário como ID do usuário. emailé usado por padrão e atualmente é o único tipo de ID de usuário compatível.

  • inclusionSpaceKeyFiltro

  • exclusionSpaceKeyFiltro

  • pageTitleRegEX

  • blogTitleRegEX

  • commentTitleRegEX

  • attachmentTitleRegEX

  • inclusionFileTypePadrões

  • exclusionFileTypePadrões

  • inclusionUrlPatterns

  • exclusionUrlPatterns

 Uma lista de padrões de expressões regulares para incluir e/ou excluir determinadas páginas e ativos em sua fonte de dados do Confluence. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
proxyHost O nome do host do proxy da web que você usa, sem o https:// protocolo http:// ou.

proxyPort

 O número da porta usada pelo protocolo de transporte de URL do host. Esse valor deve estar entre 0 e 65.535.

  • isCrawlPersonalEspaço

  • isCrawlArchivedEspaço

  • isCrawlArchivedPágina

  • isCrawlPage

  • isCrawlBlog

  • isCrawlPageComente

  • isCrawlPageAnexo

  • isCrawlBlogComente

  • isCrawlBlogAnexo

 truepara rastrear arquivos em seus espaços pessoais, páginas, blogs, comentários de página, anexos de página, comentários de blog e anexos de blog do Confluence.
maxFileSizeInMegaBytes Especifique o limite de tamanho do arquivo em MBs que Amazon Kendra pode ser rastreado. Amazon Kendra rastreia somente os arquivos dentro do limite de tamanho definido. O tamanho padrão do arquivo é 50 MB. O tamanho máximo do arquivo deve ser maior que 0MB e menor ou igual a 50MB.
tipo O tipo da fonte de dados. Especifique CONFLUENCEV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Confluence. Para obter informações sobre esses pares de valores-chave, consulte Instruções de conexão para o Confluence.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelos do Dropbox

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Você fornece a chave do aplicativo, a senha do aplicativo e o token de acesso do Dropbox como parte da senha que armazena suas credenciais de autenticação. Especifique também o tipo de fonte de dadosDROPBOX, o tipo de token de acesso que você deseja usar (temporário ou permanente) e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Dropbox.

A tabela a seguir descreve os parâmetros do esquema JSON do Dropbox.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint em repositoryEndpointMetadata. Em vez disso, as informações de conexão são incluídas em um AWS Secrets Manager segredo que você fornece secretArn a.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • file

  • paper

  • papert

  • shortcut

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus arquivos do Dropbox, do Dropbox Paper e dos atalhos para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Dropbox. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "appKey": "Dropbox app key",
    "appSecret": "Dropbox app secret",
    "accesstoken": "temporary access token or refresh access token"
}
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
isCrawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

  • inclusionFileNamePadrões

  • inclusionFileTypePadrões

 Uma lista de padrões de expressões regulares para incluir determinados nomes e tipos de arquivos na fonte de dados do Dropbox. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • exclusionFileNamePadrões

  • exclusionFileTypePadrões

 Uma lista de padrões de expressões regulares para excluir determinados nomes e tipos de arquivos na fonte de dados do Dropbox. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • crawlFile

  • crawlPaper

  • crawlPapert

  • crawlShortcut

 truepara rastrear arquivos em seu Dropbox, documentos do Dropbox Paper, modelos do Dropbox Paper e atalhos de páginas da web armazenados em seu Dropbox.
tipo O tipo da fonte de dados. Especifique DROPBOX como seu tipo de fonte de dados.
tokenType Especifique o tipo de token de acesso: token de acesso permanente ou temporário. É recomendável criar um token de acesso de atualização que nunca expire no Dropbox, em vez de confiar em um token de acesso único que expira após quatro horas. Crie um aplicativo e um token de acesso de atualização no console do desenvolvedor do Dropbox e forneça o token de acesso na senha.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelos do Drupal

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça a URL do host do Drupal e o tipo de autenticação como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como DRUPAL, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Drupal.

A tabela a seguir descreve os parâmetros do esquema JSON do Drupal.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
hostUrl O URL do host do site do Drupal. Por exemplo, https:///<hostname><drupalsitename>.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados.

  • content

  • comentário

  • attachment

 Uma lista de objetos que mapeia atributos ou nomes de campos dos arquivos do Drupal. Para obter mais informações, consulte Mapear campos de fonte de dados. Os nomes dos campos da fonte de dados do Drupal devem existir nos metadados personalizados do Drupal .
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • inclusionFileNamePadrões

  • articleTitleInclusionPadrões

  • pageTitleInclusionPadrões

  • customContentTitleInclusionPatterns

  • basicBlockTitleInclusionPatterns

  • customBlockTitleInclusionPatterns

 Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Drupal. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • exclusionFileNamePadrões

  • articleTitleExclusionPadrões

  • pageTitleExclusionPadrões

  • customContentTitleExclusionPatterns

  • basicBlockTitleExclusionPatterns

  • customBlockTitleExclusionPatterns

 Uma lista de padrões de expressões regulares para excluir determinadas páginas e ativos em sua fonte de dados do Drupal. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
contentDefinitions

  • contentType

  • Definição de campo

  • isCrawlComments

  • isCrawlFiles

  • isCrawlArticle

  • isCrawlBasicPágina

  • isCrawlBasicBloquear

  • isCrawlCustomContentTypesList

 Especifique os tipos de conteúdo a serem rastreados e se os comentários e anexos devem ser rastreados para os tipos de conteúdo selecionados.
tipo O tipo da fonte de dados. Especifique DRUPAL como seu tipo de fonte de dados.
authType O tipo de autenticação que você usa: BASIC-AUTH ou OAUTH2.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Drupal. O segredo deve conter uma estrutura JSON com as seguintes chaves:

Se estiver usando a autenticação básica:

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

Se estiver usando a autenticação OAuth 2.0:

{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
	"$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 modelo

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Você fornece a URL do GitHub host, o nome da organização e se usa a GitHub nuvem ou o GitHub local como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como GITHUB, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte GitHub Esquema JSON.

A tabela a seguir descreve os parâmetros do esquema GitHub JSON.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
tipo Especifique o tipo como SAAS ouON_PREMISE.
hostUrl O URL do GitHub host. Por exemplo, se você usa GitHub SaaS/Enterprise Cloud:. https://api.github.com Ou, se você usa um servidor GitHub local/corporativo:. https://on-prem-host-url/api/v3/
organizationName Você pode encontrar o nome da sua organização ao fazer login no GitHub desktop e acessar Suas organizações no menu suspenso da foto do perfil.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • Repositório GH

  • GHCommit

  • ghIssueDocument

  • ghIssueComment

  • ghIssueAttachment

  • Documento GHPR

  • Comentário GHPR

  • Anexo GHPR

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu GitHub conteúdo para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
isCrawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
fieldForUserIdentificação Especifique o tipo de ID de usuário que você deseja usar para o rastreamento da ACL. Especifique email se você deseja usar o e-mail do usuário para a ID do usuário ou username se deseja usar o nome do usuário para a ID do usuário. Se você não especificar uma opção, ela email será usada por padrão.
Filtro de repositório Uma lista dos nomes dos repositórios e ramificações específicos que você deseja indexar.
Repositório de rastreamento truepara rastrear repositórios.
crawlRepositoryDocuments truepara rastrear documentos do repositório.
Problema de rastreamento truepara rastrear problemas.
crawlIssueComment truepara rastrear os comentários do problema.
crawlIssueCommentAnexo truepara rastrear anexos de comentários de problemas.
crawlPullRequest truepara rastrear pull requests.
crawlPullRequestComente truepara rastrear os comentários do pull request.
crawlPullRequestCommentAttachment truepara rastrear anexos de comentários do pull request.

  • inclusionFolderNamePadrões

  • inclusionFileTypePadrões

  • inclusionFileNamePadrões

 Uma lista de padrões de expressão regular para incluir determinado conteúdo em sua fonte GitHub de dados. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se algum conteúdo corresponder a um padrão de inclusão e exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.

  • exclusionFolderNamePadrões

  • exclusionFileTypePadrões

  • exclusionFileNamePadrões

 Uma lista de padrões de expressão regular para excluir determinado conteúdo em sua fonte GitHub de dados. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se algum conteúdo corresponder a um padrão de inclusão e exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.
tipo O tipo da fonte de dados. Especifique GITHUB como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn

O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. GitHub O segredo deve conter uma estrutura JSON com as seguintes chaves:

{
    "personalToken": "token"
}
versão A versão desse modelo que é compatível atualmente.

A seguir está o 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 modelos do Gmail

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como GMAIL, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Gmail.

A tabela a seguir descreve os parâmetros do esquema JSON do Gmail.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint em repositoryEndpointMetadata. Em vez disso, as informações de conexão são incluídas em um AWS Secrets Manager segredo que você fornece secretArn a.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

  • message

  • attachments

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas mensagens e anexos do Gmail para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • inclusionLabelNamePadrões

  • exclusionLabelNamePadrões

  • inclusionAttachmentTypePadrões

  • exclusionAttachmentTypePadrões

  • inclusionAttachmentNamePadrões

  • exclusionAttachmentNamePadrões

  • inclusionSubjectFilter

  • exclusionSubjectFilter

  • isSubjectAnd

  • inclusionFromFilter

  • exclusionFromFilter

  • inclusionToFilter

  • exclusionToFilter

  • inclusionCcFilter

  • exclusionCcFilter

  • inclusionBccFilter

  • exclusionBccFilter

 Uma lista de padrões de expressões regulares para incluir ou excluir mensagens com nomes de assuntos específicos na sua fonte de dados do Gmail. Os arquivos que correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
beforeDateFilter Especifique mensagens e anexos a serem incluídos antes de uma determinada data.
afterDateFilter Especifique mensagens e anexos a serem incluídos antes de uma determinada data.
isCrawlAttachment Um valor booleano para escolher se você deseja rastrear anexos. As mensagens são rastreadas automaticamente.
tipo O tipo da fonte de dados. Especifique GMAIL como seu tipo de fonte de dados.
shouldCrawlDraftMensagens Um valor booleano para escolher se você deseja rastrear rascunhos de mensagens.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

Importante

Como não há uma API para atualizar mensagens do Gmail excluídas permanentemente, qualquer conteúdo novo, modificado ou excluído é sincronizado:

  • Não removerá mensagens que foram excluídas permanentemente do Gmail do seu índice Amazon Kendra

  • Não sincronizará alterações nas etiquetas de e-mail do Gmail

Para sincronizar as alterações no rótulo da fonte de dados do Gmail e as mensagens de e-mail excluídas permanentemente com seu Amazon Kendra índice, você deve executar rastreamentos completos periodicamente.
secretARN O nome do recurso da Amazon (ARN) de uma senha do Secrets Manager que contém os pares de chave/valor necessários para se conectar ao Gmail. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 do modelo do Google Drive

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como GOOGLEDRIVE2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Google Drive.

A tabela a seguir descreve os parâmetros do esquema JSON do Google Drive.

Configuração Descrição
connectionConfiguration Informações de configuração sobre a fonte de dados
repositoryEndpointMetadata Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint. Você escolhe o tipo de autenticação: serviceAccount e OAuth2. As informações de conexão estão incluídas em um AWS Secrets Manager segredo que você fornece secretArn a.
authType Escolha entre serviceAccount e OAuth2 com base no caso de uso.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • file

  • comentário

 Uma lista de objetos que mapeia atributos ou nomes de campos do Google Drive para o Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • maxFileSizeInMegaBytes

 Especifique um limite de tamanho de arquivo em MBs que Amazon Kendra deve ser rastreado.

  • iscrawlComment

 truepara rastrear comentários na sua fonte de dados do Google Drive.

  • isCrawlMyDriveAndSharedWithMe

 truepara rastrear MyDrive e compartilhar unidades do Shared With Me na sua fonte de dados do Google Drive.

  • isCrawlSharedConduz

 truepara rastrear unidades compartilhadas na sua fonte de dados do Google Drive.
isCrawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • exclusionFileTypePadrões

  • exclusionFileNamePadrões

  • exclusionFilePathFiltro

 Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Google Drive. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • inclusionFileTypePadrões

  • inclusionFileNamePadrões

  • inclusionFilePathFiltro

 Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Google Drive. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
tipo O tipo da fonte de dados. Especifique GOOOGLEDRIVEV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Google Drive. O segredo deve conter uma estrutura JSON com as seguintes chaves:

Se estiver usando a autenticação da conta de serviço do Google:

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

Se estiver usando a autenticação OAuth 2.0:

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do IBM DB2

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados db2, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do IBM DB2.

A tabela a seguir descreve os parâmetros do esquema JSON do IBM DB2.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do Microsoft Exchange

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como MSEXCHANGE, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Microsoft Exchange.

A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Exchange.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
tenantId O ID do locatário do Microsoft 365. Encontre o ID de locatário nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • email

  • attachment

  • calendar

  • contacts

  • notes

 Uma lista de objetos que mapeiam os atributos ou nomes de campo da sua fonte de dados do Microsoft Exchange para campos de Amazon Kendra índice. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções de configuração adicionais para conteúdo em sua fonte de dados
inclusionPatterns Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • inclusionUsersList

  • inclusionUsersFileNome

  • inclusionDomainUsers

 Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os URLs que correspondem aos padrões são incluídos no índice. Os usuários que não correspondem aos padrões são excluídos do índice. Se um usuário corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o usuário não será incluído no índice.

  • exclusionUsersList

  • exclusionUsersFileNome

  • exclusionDomainUsers

 Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Exchange. Os usuários que não correspondem aos padrões são excluídos do índice. Os usuários que não correspondem aos padrões são incluídos no índice. Se um usuário corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o usuário não será incluído no índice.
s3bucketName O nome do seu bucket do S3, se quiser usar.

  • crawlCalendar

  • crawlNotes

  • crawlContacts

  • crawlFolderAcl

 truepara rastrear esses tipos de conteúdo e informações de controle de acesso à sua fonte de dados do Microsoft Exchange.
startCalendarDateHora Você pode configurar uma data e hora de início específica para o conteúdo do calendário.
endCalendarDateHora Você pode configurar uma data e hora de início específica para o conteúdo do calendário.
subject Você pode configurar uma linha de assunto específica para o conteúdo do e-mail.
emailFrom Você pode configurar um e-mail específico para o conteúdo do e-mail “De” ou do remetente.
emailTo Você pode configurar um e-mail específico para o conteúdo do e-mail “De” ou do remetente.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
tipo O tipo da fonte de dados. Especifique MSEXCHANGE como seu tipo de fonte de dados.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Exchange. Isso inclui o ID de cliente e a senha de cliente que são gerados ao criar um aplicativo OAuth no portal do Azure.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelos da Microsoft

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o ID do locatário como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como ONEDRIVEV2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema Microsoft OneDrive JSON.

A tabela a seguir descreve os parâmetros do esquema Microsoft OneDrive JSON.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
tenantId O ID do locatário do Microsoft 365. Encontre o ID de locatário nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.
file Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus OneDrive arquivos da Microsoft para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • userNameFilter

  • userFilterPath

  • inclusionFileTypePadrões

  • exclusionFileTypePadrões

  • inclusionFileNamePadrões

  • exclusionFileNamePadrões

  • inclusionFilePathPadrões

  • exclusionFilePathPadrões

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotepageNamePatterns

 Você pode optar por indexar arquivos, OneNote seções e OneNote páginas específicos e filtrar por nome de usuário.
isUserNameEm S3 true para fornecer uma lista de nomes de usuário em um arquivo armazenado em um Amazon S3.
tipo O tipo da fonte de dados. Especifique ONEDRIVEV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
tipo O tipo da fonte de dados. Especifique ONEDRIVEV2 como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar à sua Microsoft. OneDrive O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
	"$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 modelos da Microsoft

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Você fornece o URL/URLs do SharePoint site, o domínio e também um ID do locatário, se necessário, como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como SHAREPOINTV2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como o Tipo ao ligar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte SharePoint Esquema JSON.

A tabela a seguir descreve os parâmetros do esquema Microsoft SharePoint JSON.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
tenantId O ID do inquilino da sua SharePoint conta.
Domínio O domínio da sua SharePoint conta.
siteUrls Os URLs do host da sua SharePoint conta.
repositoryAdditionalProperties Propriedades adicionais para se conectar ao endpoint do repositório/fonte de dados.
s3bucketName O nome do Amazon S3 bucket que armazena seu certificado X.509 autoassinado do Azure AD.
s3certificateName O nome do certificado X.509 autoassinado do Azure AD armazenado em seu bucket. Amazon S3
authType O tipo de autenticação que você usa, seja OAuth2OAuth2Certificate,OAuth2App,Basic,OAuth2_RefreshToken,NTLM, ouKerberos.
versão A SharePoint versão que você usa, seja Server ouOnline.
onPremVersion A versão do SharePoint servidor que você usa2013, se 20162019, ouSubscriptionEdition.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • evento

  • page

  • file

  • link

  • attachment

  • comentário

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu SharePoint conteúdo para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • eventTitleFilterRegEx

  • pageTitleFilterRegEx

  • linkTitleFilterRegEx

  • inclusionFilePath

  • exclusionFilePath

  • inclusionFileTypePadrões

  • exclusionFileTypePadrões

  • inclusionFileNamePadrões

  • exclusionFileNamePadrões

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotePageNamePatterns

 Uma lista de padrões de expressão regular para incluir/excluir determinado conteúdo em sua fonte de SharePoint dados. Os itens de conteúdo que correspondem aos padrões de inclusão são incluídos no índice. Os itens de conteúdo que não correspondem aos padrões de inclusão são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • crawlFiles

  • crawlPages

  • crawlEvents

  • crawlComments

  • crawlLinks

  • crawlAttachments

 truepara rastrear esses tipos de conteúdo.
crawlAcl truepara rastrear as informações da lista de controle de acesso (ACL) de seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar e pesquisar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
fieldForUserIdentificação Especifique email se você deseja usar o e-mail do usuário para a ID do usuário ou userPrincipalName se deseja usar um nome de usuário para a ID do usuário. Se você não especificar uma opção, ela email será usada por padrão.
aclConfiguration ACLWithLDAPEmailFmtEspecifique ACLWithManualEmailFmt ouACLWithUsernameFmtM.
emailDomain O domínio do e-mail. Por exemplo, "amazon.com".

  • isCrawlLocalGroupMapping

  • isCrawlAdGroupMapping

 truepara rastrear informações de mapeamento de grupos.
proxyHost O nome do host do proxy da web que você usa, sem o protocolo http://ou https://.
proxyPort O número da porta usada pelo protocolo de transporte de URL do host. Esse valor deve estar entre 0 e 65.535.
tipo Especifique SHAREPOINTV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. SharePoint Para obter informações sobre esses pares de valores-chave, consulte as instruções de conexão para o SharePoint Online e SharePoint o Server.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
	"$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 modelo do Microsoft SQL Server

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados sqlserver, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Microsoft SQL Server.

A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft SQL Server.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do Microsoft Teams

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o ID do locatário como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como MSTEAMS, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Microsoft Teams.

A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Teams.

Configuração Descrição
connectionConfiguration Informações de configuração para um endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
tenantId O ID do locatário do Microsoft 365. Encontre o ID de locatário nas propriedades do portal do Azure Active Directory ou no aplicativo OAuth.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • chatMessage

  • chatAttachment

  • channelPost

  • channelWiki

  • channelAttachment

  • meetingChat

  • meetingFile

  • meetingNote

  • calendarMeeting

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu conteúdo do Microsoft Teams para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
paymentModel Especifica o tipo de modelo de pagamento a ser usado com fonte de dados do Microsoft Teams. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança. Os modelos de pagamento do modelo A são restritos aos modelos de licenciamento e pagamento que exigem conformidade de segurança.

  • inclusionTeamNameFiltro

  • inclusionChannelNameFiltro

  • inclusionFileNamePadrões

  • inclusionFileTypePadrões

  • inclusionUserEmailFiltro

  • inclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

 Uma lista de padrões de expressões regulares para incluir determinado conteúdo em sua fonte de dados do Microsoft Teams. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se o conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.

  • exclusionTeamNameFiltro

  • exclusionChannelNameFiltro

  • exclusionFileNamePadrões

  • exclusionFileTypePadrões

  • exclusionUserEmailFiltro

  • exclusionOneNoteSectionNamePatterns

  • exclusionOneNotePageNamePatterns

 Uma lista de padrões de expressões regulares para excluir determinados conteúdos em sua fonte de dados do Microsoft Teams. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se o conteúdo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.

  • isCrawlChatMensagem

  • isCrawlChatAnexo

  • isCrawlChannelPublicar

  • isCrawlChannelAnexo

  • isCrawlChannelWiki

  • isCrawlCalendarReunião

  • isCrawlMeetingBate-papo

  • isCrawlMeetingArquivo

  • isCrawlMeetingNota

 truepara rastrear esses tipos de conteúdo em sua fonte de dados do Microsoft Teams.
startCalendarDateHora Você pode configurar uma data e hora de início específica para o conteúdo do calendário.
endCalendarDateHora Você pode configurar uma data e hora de início específica para o conteúdo do calendário.
tipo O tipo da fonte de dados. Especifique MSTEAMS como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Teams. Isso inclui o ID de cliente e a senha de cliente que são gerados ao criar um aplicativo OAuth no portal do Azure.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do Microsoft Yammer

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como YAMMER, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como o Tipo ao ligar CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor.

A tabela a seguir descreve os parâmetros do esquema JSON do Microsoft Yammer.

Configuração Descrição
connectionConfiguration Informações de configuração sobre a fonte de dados
repositoryEndpointMetadata Informações do endpoint da fonte de dados. Essa fonte de dados não especifica um endpoint em repositoryEndpointMetadata. Em vez disso, as informações de conexão são incluídas em um AWS Secrets Manager segredo que você fornece secretArn a.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • community

  • usuário

  • message

  • attachment

 Uma lista de objetos que mapeia atributos de fonte de dados ou nomes de campos do Microsoft Yammer para nomes de campos de índice do Amazon Kendra. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
inclusionPatterns Uma lista de padrões de expressões regulares para incluir determinados arquivos em sua fonte de dados do Microsoft Yammer. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Microsoft Yammer. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
sinceDate Opte por configurar um parâmetro psinceDate ara que o conector do Microsoft Yammer rastreie o conteúdo com base em um sinceDate específico.
communityNameFilter Você pode optar por indexar um conteúdo específico da comunidade.

  • isCrawlMessage

  • isCrawlAttachment

  • isCrawlPrivateMensagem

 truepara rastrear mensagens, anexos de mensagens e mensagens privadas.
tipo Especifique YAMMER como seu tipo de fonte de dados.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Microsoft Yammer. Isto inclui o seu nome de usuário e a chave do Microsoft Yammer, assim como o ID e a senha do cliente que são gerados ao criar uma aplicação OAuth no portal do Azure.
useChangeLog truepara usar o log de alterações do Microsoft Yammer para determinar quais documentos precisam ser atualizados no índice.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e 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 modelo do MySQL

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados mysql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema MySQL JSON.

A tabela a seguir descreve os parâmetros do esquema JSON do MySQL.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelos do Oracle Database

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados oracle, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Oracle Database.

A tabela a seguir descreve os parâmetros do esquema JSON do banco de dados Oracle.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do (PostgreSQL

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Especifique o tipo de fonte de dados como JDBC, o tipo de banco de dados postgresql, como uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do PostgreSQL.

A tabela a seguir descreve os parâmetros do esquema JSON do PostgreSQL.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações de configuração necessárias para conectar sua fonte de dados.

  • dbtype—O tipo de banco de dados Java que você usa, seja,, mysqldb2, postgresql ou. oracle sqlserver

  • dbhost: o nome do host do banco de dados.

  • DBPort: a porta do banco de dados.

  • DBInstance: a instância do banco de dados.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo. Especifique o tipo de fonte de dados e o ARN da senha.

document

 Uma lista de objetos que mapeiam os atributos ou nomes de campo do conteúdo do seu banco de dados para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados. Use para incluir ou excluir um conteúdo específico em sua fonte de dados do banco de dados.
primaryKey Forneça a chave primária da tabela do banco de dados. Isso identifica uma tabela no banco de dados.
titleColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
bodyColumn Forneça o nome da coluna do título do documento na tabela do banco de dados.
sqlQuery Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
timestampColumn Insira o nome da coluna que contém carimbos de data e hora. Amazon Kendra usa informações de registro de data e hora para detectar alterações em seu conteúdo e sincronizar somente o conteúdo alterado.
timestampFormat Insira o nome da coluna que contém carimbos de data e hora para usar para detectar alterações de conteúdo e sincronizar novamente o conteúdo.
timezone Insira o nome da coluna que contém os fusos horários para o conteúdo a ser rastreado.
changeDetectingColumns Insira os nomes das colunas que Amazon Kendra serão usadas para detectar alterações no conteúdo. Amazon Kendra reindexará o conteúdo quando houver uma alteração em qualquer uma dessas colunas
allowedUsersColumns Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
allowedGroupsColumn Insira o nome da coluna que contém os IDs de usuário para ter acesso ao conteúdo.
sourceURIColumn Insira o nome da coluna que contém os URLs de origem a serem indexados.
isSslEnabled Insira instruções de consulta SQL, como as operações SELECT e JOIN. As consultas SQL devem ter menos de 32 KB. Amazon Kendra rastreará todo o conteúdo do banco de dados que corresponda à sua consulta.
tipo O tipo da fonte de dados. Especifique JDBC como seu tipo de fonte de dados.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretArn O nome do recurso da Amazon (ARN) de uma senha do Secret Manager que contém o nome do usuário e a senha para se conectar ao banco de dados. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "user name": "database user name",
    "password": "password"
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo do Salesforce

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o URL do host do Salesforce como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como SALESFORCEV2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Salesforce.

A tabela a seguir descreve os parâmetros do esquema JSON do Salesforce.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
hostUrl O URL da instância do Salesforce a ser indexado.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • account

  • contact

  • campaign

  • case

  • product

  • lead

  • contract

  • partner

  • profile

  • idea

  • pricebook

  • task

  • solution

  • attachment

  • user

  • document

  • knowledgeArticles

  • group

  • opportunity

  • chatter

  • customEntity

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de suas entidades do Salesforce para Amazon Kendra indexar nomes de campo. Para obter mais informações, consulte Mapear campos de fonte de dados.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Salesforce. O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "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 Opções adicionais de configuração para o conteúdo em sua fonte de dados.

  • accountFilter

  • contactFilter

  • caseFilter

  • campaignFilter

  • contractFilter

  • groupFilter

  • leadFilter

  • productFilter

  • opportunityFilter

  • partnerFilter

  • pricebookFilter

  • ideaFilter

  • profileFilter

  • taskFilter

  • solutionFilter

  • userFilter

  • chatterFilter

  • documentFilter

  • knowledgeArticleFilter

  • customEntities

 Uma coleção de sequências de caracteres que especifica quais 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

 Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Salesforce. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no í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

 Uma lista de padrões de expressões regulares para excluir determinadas páginas e ativos em sua fonte de dados do Salesforce. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • isCrawlAccount

  • isCrawlContact

  • isCrawlCase

  • isCrawlCampaign

  • isCrawlProduct

  • isCrawlLead

  • isCrawlContract

  • isCrawlPartner

  • isCrawlProfile

  • isCrawlIdea

  • isCrawlPricebook

  • isCrawlDocument

  • crawlSharedDocument

  • isCrawlGroup

  • isCrawlOpportunity

  • isCrawlChatter

  • isCrawlUser

  • isCrawlSolution

  • isCrawlTask

  • isCrawlAccountAnexos

  • isCrawlContactAnexos

  • isCrawlCaseAnexos

  • isCrawlCampaignAnexos

  • isCrawlLeadAnexos

  • isCrawlContractAnexos

  • isCrawlGroupAnexos

  • isCrawlOpportunityAnexos

  • isCrawlChatterAnexos

  • isCrawlSolutionAnexos

  • isCrawlTaskAnexos

  • isCrawlCustomEntityAttachments

  • isCrawlKnowledgeArtigos

    • isCrawlDraft

    • isCrawlPublish

    • isCrawlArchived

 truepara rastrear esses tipos de arquivos em sua conta do Salesforce.
tipo O tipo da fonte de dados. Especifique SALESFORCEV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelo

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Você fornece o URL do ServiceNow host, o tipo de autenticação e a versão da instância como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como SERVICENOWV2, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte ServiceNow Esquema JSON.

A tabela a seguir descreve os parâmetros do esquema ServiceNow JSON.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
hostUrl O URL do ServiceNow host. Por exemplo, your-domain.service-now.com.
authType O tipo de autenticação que você usa: basicAuth ou OAuth2.
servicenowInstanceVersion A ServiceNow versão que você usa. Você pode escolher entre Tokyo SandiegoRome,, Others e.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • knowledgeArticle

  • attachment

  • serviceCatalog

  • incident

 Uma lista de objetos que mapeiam os atributos ou nomes de campo de seus artigos de ServiceNow conhecimento, anexos, catálogo de serviços e incidentes para Amazon Kendra indexar nomes de campos. Para obter mais informações, consulte Mapear campos de fonte de dados. Os nomes dos campos da fonte de ServiceNow dados devem existir nos seus metadados ServiceNow personalizados.
additional properties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
maxFileSizeInMegaBytes Especifique o limite de tamanho do arquivo em MBs que o Amazon Kendra rastreará. O Amazon Kendra rastreará somente os arquivos dentro do limite de tamanho que você definir. O tamanho padrão do arquivo é 50 MB. O tamanho máximo do arquivo deve ser maior que 0MB e menor ou igual a 50MB.

  • knowledgeArticleFilter

  • incidentQueryFilter

  • serviceCatalogQueryFiltro

  • knowledgeArticleTitleRegExp

  • serviceCatalogTitleRegExp

  • incidentTitleRegExp

  • inclusionFileTypePadrões

  • exclusionFileTypePadrões

  • inclusionFileNamePadrões

  • exclusionFileNamePadrões

  • incidentStateType

 Uma lista de padrões de expressão regular para incluir e/ou excluir determinados arquivos em sua fonte ServiceNow de dados. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • isCrawlKnowledgeArtigo

  • isCrawlKnowledgeArticleAttachment

  • includePublicArticlesSomente

  • isCrawlServiceCatálogo

  • isCrawlServiceCatalogAttachment

  • isCrawlActiveServiceCatalog

  • isCrawlInactiveServiceCatalog

  • isCrawlIncident

  • isCrawlIncidentAnexo

  • isCrawlActiveIncidente

  • isCrawlInactiveIncidente

  • Aplicar ACL ForKnowledgeArticle

  • Aplicar ACL ForServiceCatalog

  • Aplicar ACL ForIncident

 truepara rastrear artigos de ServiceNow conhecimento, catálogos de serviços, incidentes e anexos.
tipo O tipo da fonte de dados. Especifique SERVICENOWV2 como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
secretARN O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. ServiceNow O segredo deve conter uma estrutura JSON com as seguintes chaves: 
{
    "username": "user name",
    "password": "password"
}
Se você usar uma autenticação OAuth 2.0, a senha deverá conter uma estrutura JSON com as seguintes chaves: 
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"         
}
versão Atualmente, apenas a versão do modelo tem suporte. 
{
  "$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 modelos do Slack

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como SLACK, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Slack.

A tabela a seguir descreve os parâmetros do esquema JSON do Slack.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
ID da equipe O ID da equipe do Slack que você copiou do URL da página principal do Slack.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.
Todos Uma lista de objetos que mapeiam os atributos ou nomes de campo do seu Slack conteúdo para Amazon Kendra indexar nomes de campos.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
inclusionPatterns Uma lista de padrões de expressão regular para incluir conteúdo específico em sua fonte Slack de dados. O conteúdo que corresponde aos padrões é incluído no índice. O conteúdo que não corresponde aos padrões é excluído do índice. Se algum conteúdo corresponder a um padrão de inclusão e exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressão regular para excluir conteúdo específico na sua fonte Slack de dados. O conteúdo que corresponde aos padrões é excluído do índice. O conteúdo que não corresponde aos padrões é incluído no índice. Se algum conteúdo corresponder a um padrão de inclusão e exclusão, o padrão de exclusão terá precedência e o conteúdo não será incluído no índice.
crawlBotMessages truepara rastrear mensagens de bots.
Excluir arquivado truepara excluir o rastreamento de mensagens arquivadas.
Tipo de conversa O tipo de conversa que você deseja indexar se PUBLIC_CHANNELPRIVATE_CHANNEL, GROUP_MESSAGE DIRECT_MESSAGE e.
Filtro de canais O tipo de canal que você deseja indexar, seja private_channel oupublic_channel.
sinceDate Você pode optar por configurar um sinceDate parâmetro para que o Slack conector rastreie o conteúdo com base em um parâmetro específico. sinceDate
Olhe para trás Você pode optar por configurar um lookBack parâmetro para que o Slack conector rastreie o conteúdo atualizado ou excluído até um determinado número de horas antes da última sincronização do conector.
syncMode

Especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Escolha uma das seguintes opções:

  • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

  • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
tipo O tipo da fonte de dados. Especifique SLACK como seu tipo de fonte de dados.
enableIdentityCrawler trueusar o rastreador Amazon Kendra de identidade para sincronizar informações de identidade/principal sobre usuários e grupos com acesso a determinados documentos. Se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos.
secretArn

O Amazon Resource Name (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu. Slack O segredo deve conter uma estrutura JSON com as seguintes chaves:

{
    "slackToken": "token"
}
versão A versão desse modelo atualmente compatível. 
{
  "$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 do modelo do Zendesk

Você inclui um JSON que contém o esquema da fonte de dados como parte do TemplateConfigurationobjeto. Forneça o URL do host como parte da configuração da conexão ou dos detalhes do endpoint do repositório. Além disso, especifique o tipo de fonte de dados como ZENDESK, uma senha para suas credenciais de autenticação e outras configurações necessárias. Em seguida, você especifica TEMPLATE como Type quando você liga CreateDataSource.

Você pode usar o modelo fornecido neste guia do desenvolvedor. Consulte Esquema JSON do Zendesk.

A tabela a seguir descreve os parâmetros do esquema JSON do Zendesk.

Configuração Descrição
connectionConfiguration Informações de configuração para o endpoint da fonte de dados.
repositoryEndpointMetadata Informações do endpoint da fonte de dados.
hostURL O URL do host do Zendesk. Por exemplo, https://yoursubdomain.zendesk.com.
repositoryConfigurations Informações de configuração de conteúdo da fonte de dados. Por exemplo, configurar tipos específicos de mapeamentos de conteúdo e campo.

  • ticket

  • ticketComment

  • ticketCommentAttachment

  • article

  • articleComment

  • articleAttachment

  • communityTopic

  • communityPostComment

 Uma lista de objetos que mapeia atributos de fonte de dados ou nomes de campos do Zendesk para nomes de campos de índice do Amazon Kendra. Para obter mais informações, consulte Mapear campos de fonte de dados.
secretARN O nome de recurso da Amazon (ARN) de um AWS Secrets Manager segredo que contém os pares de valores-chave necessários para se conectar ao seu Zendesk. A senha deve conter uma estrutura JSON com as seguintes chaves: URL do host, ID do cliente, senha do cliente, nome de usuário e senha.
additionalProperties Opções adicionais de configuração para o conteúdo em sua fonte de dados.
organizationNameFilter Você pode optar por indexar os tíquetes em uma organização específica.
sinceDate Você pode optar por configurar um parâmetro sinceDatepara que o conector do Zendesk rastreie o conteúdo com base em um sinceDate específico.
inclusionPatterns Uma lista de padrões de expressões regulares para incluir determinadas páginas e ativos em sua fonte de dados do Zendesk. Os arquivos que correspondem aos padrões são incluídos no índice. Os arquivos que não correspondem aos padrões são excluídos do índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.
exclusionPatterns Uma lista de padrões de expressões regulares para excluir determinados arquivos em sua fonte de dados do Zendesk. Os arquivos que correspondem aos padrões são excluídos do índice. Os arquivos que não correspondem aos padrões são incluídos no índice. Se um arquivo corresponder tanto a um padrão de inclusão como a um de exclusão, o padrão de exclusão terá precedência e o arquivo não será incluído no índice.

  • isCrawlTicket

  • isCrawlTicketComente

  • isCrawlTicketCommentAttachment

  • isCrawlArticle

  • isCrawlArticleComente

  • isCrawlArticleAnexo

  • isCrawlCommunityTópico

  • isCrawlCommunityPublicar

  • isCrawlCommunityPostComment

 Insira "true" para rastrear esses tipos de conteúdo.
tipo Especifique ZENDESK como seu tipo de fonte de dados.
useChangeLog Insira "true" para usar o registro de alterações do Zendesk para determinar quais documentos precisam ser atualizados no índice. Dependendo do tamanho do log de alterações, talvez seja mais rápido digitalizar os documentos no Zendesk. Se estiver sincronizando a fonte de dados do Zendesk com o índice pela primeira vez, todos os documentos serão digitalizados. 
{
  "$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"
  ]
}