データソーステンプレートスキーマ - Amazon Kendra
Adobe Experience Manager テンプレートスキーマAmazon FSx (Windows) テンプレートスキーマAmazon FSx (NetApp ONTAP) テンプレートスキーマAlfresco テンプレートスキーマAurora (MySQL) テンプレートスキーマAurora (PostgreSQL) テンプレートスキーマAmazon RDS (Microsoft SQL サーバー) テンプレートスキーマAmazon RDS (MySQL) テンプレートスキーマAmazon RDS (Oracle) テンプレートスキーマAmazon RDS (PostgreSQL) テンプレートスキーマAmazon S3 テンプレートスキーマAmazon Kendra ウェブクローラーテンプレートスキーマConfluence テンプレートスキーマDropbox テンプレートスキーマDrupal テンプレートスキーマGitHub テンプレートスキーマGmail テンプレートスキーマGoogle Drive テンプレートスキーマIBM DB2 テンプレートスキーマMicrosoft Exchange テンプレートスキーマMicrosoft OneDrive テンプレートスキーマMicrosoft SharePoint テンプレートスキーマMicrosoft SQL サーバーテンプレートスキーマMicrosoft Teams テンプレートスキーマMicrosoft Yammer テンプレートスキーマMySQL テンプレートスキーマOracle Database テンプレートスキーマPostgreSQL テンプレートスキーマSalesforce テンプレートスキーマServiceNow テンプレートスキーマSlack テンプレートスキーマZendesk テンプレートスキーマ

データソーステンプレートスキーマ

以下は、テンプレートがサポートされているデータソースのテンプレートスキーマです。

Adobe Experience Manager テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。Adobe Experience Manager ホスト URL、認証タイプ、接続設定またはリポジトリエンドポイントの詳細の一部として、Adobe Experience Manager (AEM) をクラウドサービスとして使用するか AEM オンプレミスとして使用するかを指定します。また、データソースのタイプを AEM に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。詳細については、「Adobe Experience Manager JSON スキーマ」を参照してください。

次の表に、AEM JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
aemUrl Adobe Experience Manager ホスト URL。例えば、AEM オンプレミスを使用する場合は、ホスト名とポートを含めます。https://hostname:port。または、AEM をクラウドサービスとして使用する場合は、作成者 URL を使用できます。https://author-xxxxxx-xxxxxxx.adobeaemcloud.com。
authType 使用する認証のタイプ (Basic または OAuth2)。
deploymentType 使用する Adobe Experience Manager のタイプ (CLOUD または ON_PREMISE)。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ページで

  • アセット

 Adobe Experience Manager ページおよびアセットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
timeZoneId

AEM オンプレミスを使用していて、サーバーのタイムゾーンが AEM コネクタまたはインデックスのタイムゾーンと異なる場合は、Amazon Kendra AEM コネクタまたはインデックスに合わせてサーバーのタイムゾーンを指定できます。

AEM オンプレミスのデフォルトのタイムゾーンは、Amazon Kendra AEM コネクタまたはインデックスのタイムゾーンです。クラウドサービスとしての AEM のデフォルトのタイムゾーンはグリニッジ標準時です。

  • pageRootPaths

  • assetRootPaths

 ページとアセットのルートパスのリスト。例えば、ページのルートパスは /content/sub で、アセットのルートパスは /content/sub/asset1 という場合があります。
crawlAssets アセットをクロールする場合は、true にします。
crawlPages ページをクロールする場合は、true にします。

  • pagePathInclusionPatterns

  • pageNameInclusionPatterns

  • assetPathInclusionPatterns

  • assetTypeInclusionPatterns

  • assetNameInclusionPatterns

 特定のページやアセットを Adobe Experience Manager データソースに含めるための正規表現のパターンのリスト。パターンに一致するページやアセットは、インデックスに含まれます。パターンに一致しないページやアセットは、インデックスから除外されます。ページやアセットが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。

  • pagePathExclusionPatterns

  • pageNameExclusionPatterns

  • assetPathExclusionPatterns

  • assetTypeInclusionPatterns

  • assetNameInclusionPatterns

 Adobe Experience Manager データソースにある特定のページやアセットを除外するための正規表現のパターンのリスト。パターンに一致するページやアセットは、インデックスから除外されます。パターンに一致しないページやアセットは、インデックスに含まれます。ページやアセットが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。
pageComponents インデックスを作成する特定のページコンポーネントの名前のリスト。
contentFragmentVariations インデックスを作成する Adobe Experience Manager コンテンツフラグメントの特定の保存済みバリエーションの名前のリスト。
type データソースのタイプ。データソースタイプとして AEM を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn Adobe Experience Manager への接続に必要なキーと値のペアが含まれている AWS Secrets Manager のシークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアの詳細については、「Adobe Experience Manager の接続手順」を参照してください。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties":
  {
    "connectionConfiguration": {
      "type": "object",
      "properties":
      {
        "repositoryEndpointMetadata":
        {
          "type": "object",
          "properties":
          {
            "aemUrl":
            {
              "type": "string",
              "pattern": "https:.*"
            },
            "authType": {
              "type": "string",
              "enum": ["Basic", "OAuth2"]
            },
            "deploymentType": {
              "type": "string",
              "enum": ["CLOUD","ON_PREMISE"]
            }
          },
          "required":
          [
            "aemUrl",
            "authType",
            "deploymentType"
          ]
        }
      },
      "required":
      [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties":
      {
        "page":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "asset":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties":
      {
        "timeZoneId": {
          "type": "string",
          "enum": [
            "Africa/Abidjan",
            "Africa/Accra",
            "Africa/Addis_Ababa",
            "Africa/Algiers",
            "Africa/Asmara",
            "Africa/Asmera",
            "Africa/Bamako",
            "Africa/Bangui",
            "Africa/Banjul",
            "Africa/Bissau",
            "Africa/Blantyre",
            "Africa/Brazzaville",
            "Africa/Bujumbura",
            "Africa/Cairo",
            "Africa/Casablanca",
            "Africa/Ceuta",
            "Africa/Conakry",
            "Africa/Dakar",
            "Africa/Dar_es_Salaam",
            "Africa/Djibouti",
            "Africa/Douala",
            "Africa/El_Aaiun",
            "Africa/Freetown",
            "Africa/Gaborone",
            "Africa/Harare",
            "Africa/Johannesburg",
            "Africa/Juba",
            "Africa/Kampala",
            "Africa/Khartoum",
            "Africa/Kigali",
            "Africa/Kinshasa",
            "Africa/Lagos",
            "Africa/Libreville",
            "Africa/Lome",
            "Africa/Luanda",
            "Africa/Lubumbashi",
            "Africa/Lusaka",
            "Africa/Malabo",
            "Africa/Maputo",
            "Africa/Maseru",
            "Africa/Mbabane",
            "Africa/Mogadishu",
            "Africa/Monrovia",
            "Africa/Nairobi",
            "Africa/Ndjamena",
            "Africa/Niamey",
            "Africa/Nouakchott",
            "Africa/Ouagadougou",
            "Africa/Porto-Novo",
            "Africa/Sao_Tome",
            "Africa/Timbuktu",
            "Africa/Tripoli",
            "Africa/Tunis",
            "Africa/Windhoek",
            "America/Adak",
            "America/Anchorage",
            "America/Anguilla",
            "America/Antigua",
            "America/Araguaina",
            "America/Argentina/Buenos_Aires",
            "America/Argentina/Catamarca",
            "America/Argentina/ComodRivadavia",
            "America/Argentina/Cordoba",
            "America/Argentina/Jujuy",
            "America/Argentina/La_Rioja",
            "America/Argentina/Mendoza",
            "America/Argentina/Rio_Gallegos",
            "America/Argentina/Salta",
            "America/Argentina/San_Juan",
            "America/Argentina/San_Luis",
            "America/Argentina/Tucuman",
            "America/Argentina/Ushuaia",
            "America/Aruba",
            "America/Asuncion",
            "America/Atikokan",
            "America/Atka",
            "America/Bahia",
            "America/Bahia_Banderas",
            "America/Barbados",
            "America/Belem",
            "America/Belize",
            "America/Blanc-Sablon",
            "America/Boa_Vista",
            "America/Bogota",
            "America/Boise",
            "America/Buenos_Aires",
            "America/Cambridge_Bay",
            "America/Campo_Grande",
            "America/Cancun",
            "America/Caracas",
            "America/Catamarca",
            "America/Cayenne",
            "America/Cayman",
            "America/Chicago",
            "America/Chihuahua",
            "America/Ciudad_Juarez",
            "America/Coral_Harbour",
            "America/Cordoba",
            "America/Costa_Rica",
            "America/Creston",
            "America/Cuiaba",
            "America/Curacao",
            "America/Danmarkshavn",
            "America/Dawson",
            "America/Dawson_Creek",
            "America/Denver",
            "America/Detroit",
            "America/Dominica",
            "America/Edmonton",
            "America/Eirunepe",
            "America/El_Salvador",
            "America/Ensenada",
            "America/Fort_Nelson",
            "America/Fort_Wayne",
            "America/Fortaleza",
            "America/Glace_Bay",
            "America/Godthab",
            "America/Goose_Bay",
            "America/Grand_Turk",
            "America/Grenada",
            "America/Guadeloupe",
            "America/Guatemala",
            "America/Guayaquil",
            "America/Guyana",
            "America/Halifax",
            "America/Havana",
            "America/Hermosillo",
            "America/Indiana/Indianapolis",
            "America/Indiana/Knox",
            "America/Indiana/Marengo",
            "America/Indiana/Petersburg",
            "America/Indiana/Tell_City",
            "America/Indiana/Vevay",
            "America/Indiana/Vincennes",
            "America/Indiana/Winamac",
            "America/Indianapolis",
            "America/Inuvik",
            "America/Iqaluit",
            "America/Jamaica",
            "America/Jujuy",
            "America/Juneau",
            "America/Kentucky/Louisville",
            "America/Kentucky/Monticello",
            "America/Knox_IN",
            "America/Kralendijk",
            "America/La_Paz",
            "America/Lima",
            "America/Los_Angeles",
            "America/Louisville",
            "America/Lower_Princes",
            "America/Maceio",
            "America/Managua",
            "America/Manaus",
            "America/Marigot",
            "America/Martinique",
            "America/Matamoros",
            "America/Mazatlan",
            "America/Mendoza",
            "America/Menominee",
            "America/Merida",
            "America/Metlakatla",
            "America/Mexico_City",
            "America/Miquelon",
            "America/Moncton",
            "America/Monterrey",
            "America/Montevideo",
            "America/Montreal",
            "America/Montserrat",
            "America/Nassau",
            "America/New_York",
            "America/Nipigon",
            "America/Nome",
            "America/Noronha",
            "America/North_Dakota/Beulah",
            "America/North_Dakota/Center",
            "America/North_Dakota/New_Salem",
            "America/Nuuk",
            "America/Ojinaga",
            "America/Panama",
            "America/Pangnirtung",
            "America/Paramaribo",
            "America/Phoenix",
            "America/Port-au-Prince",
            "America/Port_of_Spain",
            "America/Porto_Acre",
            "America/Porto_Velho",
            "America/Puerto_Rico",
            "America/Punta_Arenas",
            "America/Rainy_River",
            "America/Rankin_Inlet",
            "America/Recife",
            "America/Regina",
            "America/Resolute",
            "America/Rio_Branco",
            "America/Rosario",
            "America/Santa_Isabel",
            "America/Santarem",
            "America/Santiago",
            "America/Santo_Domingo",
            "America/Sao_Paulo",
            "America/Scoresbysund",
            "America/Shiprock",
            "America/Sitka",
            "America/St_Barthelemy",
            "America/St_Johns",
            "America/St_Kitts",
            "America/St_Lucia",
            "America/St_Thomas",
            "America/St_Vincent",
            "America/Swift_Current",
            "America/Tegucigalpa",
            "America/Thule",
            "America/Thunder_Bay",
            "America/Tijuana",
            "America/Toronto",
            "America/Tortola",
            "America/Vancouver",
            "America/Virgin",
            "America/Whitehorse",
            "America/Winnipeg",
            "America/Yakutat",
            "America/Yellowknife",
            "Antarctica/Casey",
            "Antarctica/Davis",
            "Antarctica/DumontDUrville",
            "Antarctica/Macquarie",
            "Antarctica/Mawson",
            "Antarctica/McMurdo",
            "Antarctica/Palmer",
            "Antarctica/Rothera",
            "Antarctica/South_Pole",
            "Antarctica/Syowa",
            "Antarctica/Troll",
            "Antarctica/Vostok",
            "Arctic/Longyearbyen",
            "Asia/Aden",
            "Asia/Almaty",
            "Asia/Amman",
            "Asia/Anadyr",
            "Asia/Aqtau",
            "Asia/Aqtobe",
            "Asia/Ashgabat",
            "Asia/Ashkhabad",
            "Asia/Atyrau",
            "Asia/Baghdad",
            "Asia/Bahrain",
            "Asia/Baku",
            "Asia/Bangkok",
            "Asia/Barnaul",
            "Asia/Beirut",
            "Asia/Bishkek",
            "Asia/Brunei",
            "Asia/Calcutta",
            "Asia/Chita",
            "Asia/Choibalsan",
            "Asia/Chongqing",
            "Asia/Chungking",
            "Asia/Colombo",
            "Asia/Dacca",
            "Asia/Damascus",
            "Asia/Dhaka",
            "Asia/Dili",
            "Asia/Dubai",
            "Asia/Dushanbe",
            "Asia/Famagusta",
            "Asia/Gaza",
            "Asia/Harbin",
            "Asia/Hebron",
            "Asia/Ho_Chi_Minh",
            "Asia/Hong_Kong",
            "Asia/Hovd",
            "Asia/Irkutsk",
            "Asia/Istanbul",
            "Asia/Jakarta",
            "Asia/Jayapura",
            "Asia/Jerusalem",
            "Asia/Kabul",
            "Asia/Kamchatka",
            "Asia/Karachi",
            "Asia/Kashgar",
            "Asia/Kathmandu",
            "Asia/Katmandu",
            "Asia/Khandyga",
            "Asia/Kolkata",
            "Asia/Krasnoyarsk",
            "Asia/Kuala_Lumpur",
            "Asia/Kuching",
            "Asia/Kuwait",
            "Asia/Macao",
            "Asia/Macau",
            "Asia/Magadan",
            "Asia/Makassar",
            "Asia/Manila",
            "Asia/Muscat",
            "Asia/Nicosia",
            "Asia/Novokuznetsk",
            "Asia/Novosibirsk",
            "Asia/Omsk",
            "Asia/Oral",
            "Asia/Phnom_Penh",
            "Asia/Pontianak",
            "Asia/Pyongyang",
            "Asia/Qatar",
            "Asia/Qostanay",
            "Asia/Qyzylorda",
            "Asia/Rangoon",
            "Asia/Riyadh",
            "Asia/Saigon",
            "Asia/Sakhalin",
            "Asia/Samarkand",
            "Asia/Seoul",
            "Asia/Shanghai",
            "Asia/Singapore",
            "Asia/Srednekolymsk",
            "Asia/Taipei",
            "Asia/Tashkent",
            "Asia/Tbilisi",
            "Asia/Tehran",
            "Asia/Tel_Aviv",
            "Asia/Thimbu",
            "Asia/Thimphu",
            "Asia/Tokyo",
            "Asia/Tomsk",
            "Asia/Ujung_Pandang",
            "Asia/Ulaanbaatar",
            "Asia/Ulan_Bator",
            "Asia/Urumqi",
            "Asia/Ust-Nera",
            "Asia/Vientiane",
            "Asia/Vladivostok",
            "Asia/Yakutsk",
            "Asia/Yangon",
            "Asia/Yekaterinburg",
            "Asia/Yerevan",
            "Atlantic/Azores",
            "Atlantic/Bermuda",
            "Atlantic/Canary",
            "Atlantic/Cape_Verde",
            "Atlantic/Faeroe",
            "Atlantic/Faroe",
            "Atlantic/Jan_Mayen",
            "Atlantic/Madeira",
            "Atlantic/Reykjavik",
            "Atlantic/South_Georgia",
            "Atlantic/St_Helena",
            "Atlantic/Stanley",
            "Australia/ACT",
            "Australia/Adelaide",
            "Australia/Brisbane",
            "Australia/Broken_Hill",
            "Australia/Canberra",
            "Australia/Currie",
            "Australia/Darwin",
            "Australia/Eucla",
            "Australia/Hobart",
            "Australia/LHI",
            "Australia/Lindeman",
            "Australia/Lord_Howe",
            "Australia/Melbourne",
            "Australia/NSW",
            "Australia/North",
            "Australia/Perth",
            "Australia/Queensland",
            "Australia/South",
            "Australia/Sydney",
            "Australia/Tasmania",
            "Australia/Victoria",
            "Australia/West",
            "Australia/Yancowinna",
            "Brazil/Acre",
            "Brazil/DeNoronha",
            "Brazil/East",
            "Brazil/West",
            "CET",
            "CST6CDT",
            "Canada/Atlantic",
            "Canada/Central",
            "Canada/Eastern",
            "Canada/Mountain",
            "Canada/Newfoundland",
            "Canada/Pacific",
            "Canada/Saskatchewan",
            "Canada/Yukon",
            "Chile/Continental",
            "Chile/EasterIsland",
            "Cuba",
            "EET",
            "EST5EDT",
            "Egypt",
            "Eire",
            "Etc/GMT",
            "Etc/GMT+0",
            "Etc/GMT+1",
            "Etc/GMT+10",
            "Etc/GMT+11",
            "Etc/GMT+12",
            "Etc/GMT+2",
            "Etc/GMT+3",
            "Etc/GMT+4",
            "Etc/GMT+5",
            "Etc/GMT+6",
            "Etc/GMT+7",
            "Etc/GMT+8",
            "Etc/GMT+9",
            "Etc/GMT-0",
            "Etc/GMT-1",
            "Etc/GMT-10",
            "Etc/GMT-11",
            "Etc/GMT-12",
            "Etc/GMT-13",
            "Etc/GMT-14",
            "Etc/GMT-2",
            "Etc/GMT-3",
            "Etc/GMT-4",
            "Etc/GMT-5",
            "Etc/GMT-6",
            "Etc/GMT-7",
            "Etc/GMT-8",
            "Etc/GMT-9",
            "Etc/GMT0",
            "Etc/Greenwich",
            "Etc/UCT",
            "Etc/UTC",
            "Etc/Universal",
            "Etc/Zulu",
            "Europe/Amsterdam",
            "Europe/Andorra",
            "Europe/Astrakhan",
            "Europe/Athens",
            "Europe/Belfast",
            "Europe/Belgrade",
            "Europe/Berlin",
            "Europe/Bratislava",
            "Europe/Brussels",
            "Europe/Bucharest",
            "Europe/Budapest",
            "Europe/Busingen",
            "Europe/Chisinau",
            "Europe/Copenhagen",
            "Europe/Dublin",
            "Europe/Gibraltar",
            "Europe/Guernsey",
            "Europe/Helsinki",
            "Europe/Isle_of_Man",
            "Europe/Istanbul",
            "Europe/Jersey",
            "Europe/Kaliningrad",
            "Europe/Kiev",
            "Europe/Kirov",
            "Europe/Kyiv",
            "Europe/Lisbon",
            "Europe/Ljubljana",
            "Europe/London",
            "Europe/Luxembourg",
            "Europe/Madrid",
            "Europe/Malta",
            "Europe/Mariehamn",
            "Europe/Minsk",
            "Europe/Monaco",
            "Europe/Moscow",
            "Europe/Nicosia",
            "Europe/Oslo",
            "Europe/Paris",
            "Europe/Podgorica",
            "Europe/Prague",
            "Europe/Riga",
            "Europe/Rome",
            "Europe/Samara",
            "Europe/San_Marino",
            "Europe/Sarajevo",
            "Europe/Saratov",
            "Europe/Simferopol",
            "Europe/Skopje",
            "Europe/Sofia",
            "Europe/Stockholm",
            "Europe/Tallinn",
            "Europe/Tirane",
            "Europe/Tiraspol",
            "Europe/Ulyanovsk",
            "Europe/Uzhgorod",
            "Europe/Vaduz",
            "Europe/Vatican",
            "Europe/Vienna",
            "Europe/Vilnius",
            "Europe/Volgograd",
            "Europe/Warsaw",
            "Europe/Zagreb",
            "Europe/Zaporozhye",
            "Europe/Zurich",
            "GB",
            "GB-Eire",
            "GMT",
            "GMT0",
            "Greenwich",
            "Hongkong",
            "Iceland",
            "Indian/Antananarivo",
            "Indian/Chagos",
            "Indian/Christmas",
            "Indian/Cocos",
            "Indian/Comoro",
            "Indian/Kerguelen",
            "Indian/Mahe",
            "Indian/Maldives",
            "Indian/Mauritius",
            "Indian/Mayotte",
            "Indian/Reunion",
            "Iran",
            "Israel",
            "Jamaica",
            "Japan",
            "Kwajalein",
            "Libya",
            "MET",
            "MST7MDT",
            "Mexico/BajaNorte",
            "Mexico/BajaSur",
            "Mexico/General",
            "NZ",
            "NZ-CHAT",
            "Navajo",
            "PRC",
            "PST8PDT",
            "Pacific/Apia",
            "Pacific/Auckland",
            "Pacific/Bougainville",
            "Pacific/Chatham",
            "Pacific/Chuuk",
            "Pacific/Easter",
            "Pacific/Efate",
            "Pacific/Enderbury",
            "Pacific/Fakaofo",
            "Pacific/Fiji",
            "Pacific/Funafuti",
            "Pacific/Galapagos",
            "Pacific/Gambier",
            "Pacific/Guadalcanal",
            "Pacific/Guam",
            "Pacific/Honolulu",
            "Pacific/Johnston",
            "Pacific/Kanton",
            "Pacific/Kiritimati",
            "Pacific/Kosrae",
            "Pacific/Kwajalein",
            "Pacific/Majuro",
            "Pacific/Marquesas",
            "Pacific/Midway",
            "Pacific/Nauru",
            "Pacific/Niue",
            "Pacific/Norfolk",
            "Pacific/Noumea",
            "Pacific/Pago_Pago",
            "Pacific/Palau",
            "Pacific/Pitcairn",
            "Pacific/Pohnpei",
            "Pacific/Ponape",
            "Pacific/Port_Moresby",
            "Pacific/Rarotonga",
            "Pacific/Saipan",
            "Pacific/Samoa",
            "Pacific/Tahiti",
            "Pacific/Tarawa",
            "Pacific/Tongatapu",
            "Pacific/Truk",
            "Pacific/Wake",
            "Pacific/Wallis",
            "Pacific/Yap",
            "Poland",
            "Portugal",
            "ROK",
            "Singapore",
            "SystemV/AST4",
            "SystemV/AST4ADT",
            "SystemV/CST6",
            "SystemV/CST6CDT",
            "SystemV/EST5",
            "SystemV/EST5EDT",
            "SystemV/HST10",
            "SystemV/MST7",
            "SystemV/MST7MDT",
            "SystemV/PST8",
            "SystemV/PST8PDT",
            "SystemV/YST9",
            "SystemV/YST9YDT",
            "Turkey",
            "UCT",
            "US/Alaska",
            "US/Aleutian",
            "US/Arizona",
            "US/Central",
            "US/East-Indiana",
            "US/Eastern",
            "US/Hawaii",
            "US/Indiana-Starke",
            "US/Michigan",
            "US/Mountain",
            "US/Pacific",
            "US/Samoa",
            "UTC",
            "Universal",
            "W-SU",
            "WET",
            "Zulu",
            "EST",
            "HST",
            "MST",
            "ACT",
            "AET",
            "AGT",
            "ART",
            "AST",
            "BET",
            "BST",
            "CAT",
            "CNT",
            "CST",
            "CTT",
            "EAT",
            "ECT",
            "IET",
            "IST",
            "JST",
            "MIT",
            "NET",
            "NST",
            "PLT",
            "PNT",
            "PRT",
            "PST",
            "SST",
            "VST"
          ]
        },
        "pageRootPaths":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetRootPaths":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "crawlAssets":
        {
          "type": "boolean"
        },
        "crawlPages":
        {
          "type": "boolean"
        },
        "pagePathInclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pagePathExclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pageNameInclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pageNameExclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetPathInclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetPathExclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetTypeInclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetTypeExclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetNameInclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "assetNameExclusionPatterns":
        {
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pageComponents": {
          "type": "array",
          "items": {
            "type": "object"
            }
        },
        "contentFragmentVariations": {
          "type": "array",
          "items": {
            "type": "object"
          }
        },
        "cugExemptedPrincipals": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required":
      []
    },
    "type": {
      "type": "string",
      "pattern": "AEM"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

Amazon FSx (Windows) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。ファイルシステム ID を接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを FSX に指定し、認証情報のシークレット、およびその他の必要な設定も指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon FSx (Windows) JSON スキーマ」を参照してください。

次の表に、Amazon FSx (Windows) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
fileSystemId Amazon FSx ファイルシステムの識別子。ファイルシステム ID は、Amazon FSx コンソールのファイルシステムダッシュボードで確認できます。
fileSystemType Amazon FSx ファイルシステムのタイプ。Windows File Serverをファイルシステムのタイプとして使用するには、WINDOWS を指定します。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。
すべて Amazon FSx のデータソース内のファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
isCrawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
inclusionPatterns Amazon FSx データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionPatterns Amazon FSx データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
type データソースのタイプ。Windows ファイルシステムデータソースの場合は、FSX を指定します。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "fileSystemId": {
              "type": "string",
              "pattern": "fs-.*"
            },
            "fileSystemType": {
              "type": "string",
              "pattern": "WINDOWS"
            }
          },
          "required": ["fileSystemId", "fileSystemType"]
        }
      }
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "All": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        }
      },
      "required": ["All"]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "isCrawlAcl": {
          "type": "boolean"
        },
        "exclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": []
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "type" : {
      "type" : "string",
      "pattern": "FSX"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "enableIdentityCrawler",
    "additionalProperties",
    "type"
  ]
}

Amazon FSx (NetApp ONTAP) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。ファイルシステム ID とストレージ仮想マシン (SVM) を、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを FSXONTAP に指定し、認証情報のシークレット、およびその他の必要な設定も指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon FSx (NetApp ONTAP) JSON スキーマ」を参照してください。

次の表に、Amazon FSx (NetApp ONTAP) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
fileSystemId Amazon FSx ファイルシステムの識別子。ファイルシステム ID は、Amazon FSx コンソールのファイルシステムダッシュボードで確認できます。Amazon FSx コンソールで NetApp ONTAP 用のファイルシステムを作成する方法については、「FSx for ONTAP のユーザーガイド」の「NetApp ONTAP の開始方法」を参照してください。
fileSystemType Amazon FSx ファイルシステムのタイプ。NetApp ONTAPをファイルシステムのタイプとして使用するには、ONTAP を指定します。
svmId NetApp ONTAP 用の Amazon FSx ファイルシステムで使用されるストレージ仮想マシン (SVM) の識別子。SVM ID を確認するには、Amazon FSx コンソールのファイルシステムダッシュボードに移動し、ファイルシステム ID を選択してから、[ストレージ仮想マシン] を選択します。Amazon FSx コンソールで NetApp ONTAP 用のファイルシステムを作成する方法については、「FSx for ONTAP のユーザーガイド」の「NetApp ONTAP の開始方法」を参照してください。
protocolType Windows 用の共通インターネットファイルシステム (CIFS) プロトコルを使用するのか、Linux 用のネットワークファイルシステム (NFS) プロトコルを使用するのかを指定します。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。
ファイル Amazon FSx のデータソース内のファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。データソースのフィールド名は、ファイルのカスタムメタデータ内に存在する必要があります。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
crawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
inclusionPatterns Amazon FSx データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionPatterns Amazon FSx データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
type データソースのタイプ。NetApp ONTAP ファイルシステムのデータソースには、FSXONTAP を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
secretArn

Amazon FSx ファイルシステムへの接続に必要なキーと値のペアが含まれている、AWS Secrets Manager のシークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

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

Amazon FSx ファイルシステムに NFS プロトコルを使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。

{
    "leftId": "left ID",
    "rightId": "right ID",
    "preSharedKey": "pre-shared key"
}
 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "fileSystemId": {
              "type": "string",
                "pattern": "^(fs-[0-9a-f]{8,21})$"
            },
            "fileSystemType": {
              "type": "string",
              "enum": ["ONTAP"]
            },
            "svmId": {
              "type": "string",
              "pattern": "^(svm-[0-9a-f]{17,21})$"
            },
            "protocolType": {
              "type": "string",
              "enum": [
                "CIFS",
                "NFS"
              ]
            }
          },
          "required": [
            "fileSystemId",
            "fileSystemType"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "file": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string",
                      "pattern": "^([a-zA-Z_]{1,20})$"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string",
                      "pattern": "^([a-zA-Z_]{1,20})$"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ],
              "maxItems": 50
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
        "file"
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "crawlAcl": {
          "type": "boolean"
        },
        "inclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 30
          },
          "maxItems": 100
        },
        "exclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 30
          },
          "maxItems": 100
        }
      }
    },
    "type": {
      "type": "string",
      "pattern": "FSXONTAP"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "secretArn": {
      "type": "string",
      "pattern": "arn:aws:secretsmanager:.*"
    }
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

Alfresco テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。Alfresco サイト ID、リポジトリ URL、ユーザーインターフェイス URL、認証タイプ、クラウドとオンプレミスのどちらを使用するか、クロールするコンテンツのタイプを指定します。これは接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを ALFRESCO に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Alfresco JSON スキーマ」を参照してください。

次の表に、Alfresco JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
siteId Alfresco サイトの識別子。
repoUrl Alfresco リポジトリの URL。リポジトリ URL は Alfresco 管理者から取得できます。例えば、Alfresco クラウド (PaaS) を使用している場合、リポジトリ URL は、https://company.alfrescocloud.com になる可能性があります。または、Alfresco オンプレミスを使用している場合は、リポジトリ URL は https://company-alfresco-instance.company-domain.suffix:port になる可能性があります。
webAppUrl Alfresco ユーザーインターフェイスの URL。Alfresco ユーザーインターフェイスの URL はAlfresco管理者から取得できます。例えば、ユーザーインターフェイス URL は https://example.com とすることができます。
repositoryAdditionalProperties リポジトリ/データソースエンドポイントに接続するための追加プロパティ。
authType 使用する認証のタイプ (OAuth2 または Basic)。
タイプ: (デプロイ) 使用する Alfresco のタイプ (PAAS または ON-PREM)
crawlType クロールするコンテンツのタイプ。ASPECT (Alfresco で「アスペクト」とマークされているコンテンツ)、SITE_ID (特定の Alfresco サイト内のコンテンツ)、または ALL_SITES (すべての Alfresco サイトにわたるコンテンツ) のいずれかです。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ドキュメント

  • コメント

 Alfresco ドキュメントやコメントの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
aspectName

インデックスを作成する特定の「アスペクト」の名前。
aspectProperties

インデックスを作成する特定の「アスペクト」コンテンツプロパティのリスト。
enableFineGrainedControl

「アスペクト」をクロールする場合は、true にします。
isCrawlComment

true に設定すると、コメントをクロールします。

  • inclusionFileNamePatterns

  • inclusionFileTypePatterns

  • inclusionFilePathPatterns

 特定のファイルを Alfresco データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • exclusionFileNamePatterns

  • exclusionFileTypePatterns

  • exclusionFilePathPatterns

 Alfresco データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
type データソースのタイプ。データソースタイプとして ALFRESCO を指定します。
secretArn

Alfresco への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

基本認証を使用している場合。

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

OAuth 2.0 認証を使用している場合。

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

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "siteId": {
              "type": "string"
            },
            "repoUrl": {
              "type": "string"
            },
            "webAppUrl": {
              "type": "string"
            },
            "repositoryAdditionalProperties": {
              "type": "object",
              "properties": {
                "authType": {
                  "type": "string",
                  "enum": [
                    "OAuth2",
                    "Basic"
                  ]
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "PAAS",
                    "ON_PREM"
                  ]
                },
                "crawlType": {
                  "type": "string",
                  "enum": [
                    "ASPECT",
                    "SITE_ID",
                    "ALL_SITES"
                  ]
                }
              }
            }
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE",
                          "STRING_LIST",
                          "LONG"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "comment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE",
                          "STRING_LIST",
                          "LONG"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "aspectName": {
          "type": "string"
        },
        "aspectProperties": {
          "type": "array"
        },
        "enableFineGrainedControl": {
          "type": "boolean"
        },
        "isCrawlComment": {
          "type": "boolean"
        },
        "inclusionFileNamePatterns": {
          "type": "array"
        },
        "exclusionFileNamePatterns": {
          "type": "array"
        },
        "inclusionFileTypePatterns": {
          "type": "array"
        },
        "exclusionFileTypePatterns": {
          "type": "array"
        },
        "inclusionFilePathPatterns": {
          "type": "array"
        },
        "exclusionFilePathPatterns": {
          "type": "array"
        }
      }
    },
    "type": {
      "type": "string",
      "pattern": "ALFRESCO"
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "type",
    "secretArn"
  ]
}

Aurora (MySQL) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを mysql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Aurora (MySQL) JSON スキーマ」を参照してください。

次の表に、Aurora (MySQL) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Aurora (PostgreSQL) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを postgresql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Aurora (PostgreSQL) JSON スキーマ」を参照してください。

次の表に、Aurora (PostgreSQL) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (Microsoft SQL サーバー) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを sqlserver に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon RDS (Microsoft SQL サーバー) JSON スキーマ」を参照してください。

次の表に、Amazon RDS (Microsoft SQL Server) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (MySQL) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを mysql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon RDS (MySQL) JSON スキーマ」を参照してください。

次の表に、Amazon RDS (MySQL) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (Oracle) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを oracle に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon RDS (Oracle) JSON スキーマ」を参照してください。

次の表に、Amazon RDS (Oracle) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon RDS (PostgreSQL) テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを postgresql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon RDS (PostgreSQL) JSON スキーマ」を参照してください。

次の表に、Amazon RDS (PostgreSQL) JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Amazon S3 テンプレートスキーマ

テンプレート設定の一部として、データソーススキーマを含む JSON を含めます。接続設定またはリポジトリエンドポイントの詳細の一部として S3 バケットの名前を指定します。また、データソースのタイプを S3 として指定し、その他の必要な設定も指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「S3 JSON スキーマ」を参照してください。

次の表に、Amazon S3 JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
BucketName Amazon S3 バケットの名前。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • inclusionPatterns

  • exclusionPatterns

  • inclusionPrefixes

  • exclusionPrefixes

 Amazon S3 データソースにある特定のファイルを含めるまたは除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
aclConfigurationFilePath Amazon Kendra インデックス内のドキュメントへのアクセスを制御するファイルパス。
metadataFilesPrefix バケット内のメタデータファイルの場所。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
type データソースのタイプ。データソースタイプとして S3 を指定します。
version サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "BucketName": {
              "type": "string"
            }
          },
          "required": [
            "BucketName"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
        "document"
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "inclusionPatterns": {
          "type": "array"
        },
        "exclusionPatterns": {
          "type": "array"
        },
        "inclusionPrefixes": {
          "type": "array"
        },
        "exclusionPrefixes": {
          "type": "array"
        },
        "aclConfigurationFilePath": {
          "type": "string"
        },
        "metadataFilesPrefix": {
          "type": "string"
        }
      }
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FULL_CRAWL",
        "FORCED_FULL_CRAWL"
      ]
    },
    "type": {
      "type": "string",
      "pattern": "S3"
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "connectionConfiguration",
    "type",
    "syncMode",
    "repositoryConfigurations"
  ]
}

Amazon Kendra ウェブクローラーテンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。

接続設定またはリポジトリエンドポイントの詳細の一部として、シード URL または開始ポイント URL を指定するか、サイトマップ URL を指定できます。すべての URL を手動で一覧表示する代わりに、シード URL またはサイトマップ XML ファイルのリストのテキストファイルを保存する Amazon S3 バケットへのパスを指定できます。これらのファイルは S3 の ZIP ファイルにまとめることができます。

また、データソースのタイプを WEBCRAWLERV2 として指定し、ウェブサイト認証情報と認証タイプ (ウェブサイトで認証が必要な場合)、およびその他の必要な設定も指定します。

次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

重要

ウェブクローラー v2.0 コネクタの作成は、CloudFormation ではサポートされていません。CloudFormation でのサポートが必要な場合は、ウェブクローラー v1.0 コネクタを使用します。

インデックス作成するウェブサイトを選択するときは、Amazon 利用規定ポリシーおよびその他の Amazon 規約のすべてに準拠している必要があります。Amazon Kendra Web Crawler のみを使用して、独自のウェブページ、またはインデックス作成の認可があるウェブページをインデックスする必要があることに注意してください。 Web Crawler　によるウェブサイトのインデックス作成を停止する方法については、「Amazon Kendra」を参照してください。。Amazon Kendra Web Crawler 用の robots.txt ファイルの設定

このデベロッパーガイドで提供されているテンプレートを使用できます。「Amazon Kendra ウェブクローラー JSON スキーマ」を参照してください。

次の表に、Amazon Kendra ウェブクローラー JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
siteMapUrls クロールするウェブサイトのサイトマップ URL のリスト。サイトマップの URL は最大 3 つまで一覧表示できます。
s3SeedUrl シードまたは開始ポイント URL のリストを格納するテキストファイルへの S3 パス。例えば、s3://bucket-name/directory/。テキストファイル内の各 URL は、別々の行にフォーマットする必要があります。最大 100 件のシード URL を一覧表示できます。
s3SiteMapUrl サイトマップ XML ファイルへの S3 パス。例えば、s3://bucket-name/directory/。サイトマップ XML ファイルは最大 3 件まで一覧表示できます。複数のサイトマップファイルを 1 つの ZIP ファイルにまとめ、その ZIP ファイルを Amazon S3 バケットに保存できます。
seedUrlConnections クロールするウェブサイトのシードまたは開始ポイント URL のリスト。最大 100 件のシード URL を一覧表示できます。
seedUrl シードまたは開始点 URL。
認証 ウェブサイトが同じ認証を必要とする場合は認証タイプ、それ以外の場合は、NoAuthentication を指定します。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • webPage

  • 添付

 ウェブページとウェブページファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。例えば、HTML ウェブページのタイトルタグを _document_title インデックスフィールドにマッピングできます。詳細については、「データソースフィールドのマッピング」を参照してください。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
rateLimit 1 分あたりウェブサイトホストごとにクロールされる URL の最大数。
maxFileSize クロールするウェブページまたは添付ファイルの最大サイズ (MB 単位)。
crawlDepth シード URL からクロールするレベル数。例えば、シード URL ページは深度 1 で、このページ上でクロールされるハイパーリンクはすべて深度 2 です。
maxLinksPerUrl ウェブサイトをクロールするときに含めるウェブページ上の URL の最大数。この数字はウェブページごとです。ウェブサイトのウェブページがクロールされると、ウェブページがリンクしているすべての URL もクロールされます。ウェブページ上の URL は、表示順にクロールされます。
crawlSubDomain ウェブサイトのホスト名をサブドメインでクロールする場合は、true にします。例えば、シード URL が 「abc.example.com」の場合、「a.abc.example.com」と「b.abc.example.com」もクロールされます。crawlSubDomain または crawlAllDomain を true に設定しない場合、Amazon Kendra は、クロール対象のウェブサイトのドメインのみをクロールします。
crawlAllDomain ウェブページがリンクするサブドメインおよびその他のドメインでウェブサイトのドメインをクロールする場合は、true にします。crawlSubDomain または crawlAllDomain を true に設定しない場合、Amazon Kendra は、クロール対象のウェブサイトのドメインのみをクロールします。
honorRobots クロールするウェブサイトの robots.txt ディレクティブを優先する場合は、true にします。これらのディレクティブは、Amazon Kendra Web Crawler がウェブサイトをクロールする方法 (Amazon Kendra が特定のコンテンツのみをクロールできるか、どのコンテンツもクロールできないか) を制御します。
crawlAttachments ウェブページのリンク先のファイルをクロールする場合は、true にします。

  • inclusionURLCrawlPatterns

  • inclusionURLIndexPatterns

 特定の URL のクロールや、これらの URL ウェブページ上のハイパーリンクのインデックス作成を含む正規表現パターンのリスト。パターンに一致する URL は、インデックスに含まれます。パターンに一致しない URL は、インデックスから除外されます。URL が包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、その URL/ウェブサイトのウェブページはインデックスに含まれません。

  • exclusionURLCrawlPatterns

  • exclusionURLIndexPatterns

 特定の URL のクロールや、これらの URL ウェブページ上のハイパーリンクのインデックス作成を除外する正規表現パターンのリスト。パターンに一致する URL は、インデックスから除外されます。パターンに一致しない URL は、インデックスに含まれます。URL が包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、その URL/ウェブサイトのウェブページはインデックスに含まれません。
inclusionFileIndexPatterns 特定のウェブページを含めるための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionFileIndexPatterns 特定のウェブページを除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
implicitWaitDuration

implicitWaitDuration は、ウェブページをクローリングする前にコネクタが待機する時間を秒単位で指定します。

範囲: 0～10

例: "implicitWaitDuration": "5"
proxy ウェブプロキシ経由で内部ウェブサイトに接続するために必要となる構成情報。
ホスト 内部ウェブサイトへの接続に使用するプロキシサーバーのホストの名前。例えば、https://a.example.com/page1.html のホスト名は 「a.example.com」です。
ポート 内部ウェブサイトへの接続に使用するプロキシサーバーのポート数。例えば、443 は HTTPS の標準ポートです。
secretArn (proxy) ウェブサイトホストへの接続にウェブプロキシ認証情報が必要な場合は、認証情報を保存する AWS Secrets Manager シークレットを作成できます。シークレットの Amazon リソースネーム (ARN) を指定します。
type データソースのタイプ。データソースタイプとして WEBCRAWLERV2 を指定します。
secretArn

ウェブサイトにアクセスするために認証が必要な場合に使用される AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。ウェブサイトの認証情報は、JSON キーと値のペアを含むシークレットに保存します。

ベーシックまたは NTML/Kerberos を使用している場合は、ユーザー名とパスワードを入力します。シークレットの JSON キーは、userName と password である必要があります。NTLM 認証プロトコルにはパスワードハッシュが含まれ、Kerberos 認証プロトコルにはパスワード暗号化が含まれます。

SAML 認証またはフォーム認証を使用する場合は、ユーザー名とパスワード、ユーザー名フィールド (SAML を使用する場合はユーザー名ボタン) に XPath、パスワードフィールドとボタンには XPath、ログインページの URL を入力します。シークレットの JSON キーは、userName、password、userNameFieldXpath、userNameButtonXpath、passwordFieldXpath、passwordButtonXpath、と loginPageUrl である必要があります。要素の XPath (XML パス言語) は、ウェブブラウザのデベロッパーツールを使用して確認できます。XPath は通常、次の形式に従います。//tagname[@Attribute='Value']。

Amazon Kendra は、シークレットに含まれるエンドポイント情報 (シード URL) が、データソースのエンドポイント設定の詳細で指定されているエンドポイント情報と同じかどうかも確認します。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "siteMapUrls": {
              "type": "array",
              "items":{
                "type": "string",
                "pattern": "https://.*"
              }
            },
            "s3SeedUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "s3SiteMapUrl": {
              "type": "string",
              "pattern": "s3:.*"
            },
            "seedUrlConnections": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "seedUrl":{
                      "type": "string",
                      "pattern": "https://.*"
                    }
                  },
                  "required": [
                    "seedUrl"
                  ]
                }
              ]
            },
            "authentication": {
              "type": "string",
              "enum": [
                "NoAuthentication",
                "BasicAuth",
                "NTLM_Kerberos",
                "Form",
                "SAML"
              ]
            }
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "webPage": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "rateLimit": {
          "type": "string",
          "default": "300"
        },
        "maxFileSize": {
          "type": "string",
          "default": "50"
        },
        "crawlDepth": {
          "type": "string",
          "default": "2"
        },
        "maxLinksPerUrl": {
          "type": "string",
          "default": "100"
        },
        "crawlSubDomain": {
          "type": "boolean",
          "default": false
        },
        "crawlAllDomain": {
          "type": "boolean",
          "default": false
        },
        "honorRobots": {
          "type": "boolean",
          "default": false
        },
        "crawlAttachments": {
          "type": "boolean",
          "default": false
        },
        "inclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLCrawlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionURLIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileIndexPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "proxy": {
          "type": "object",
          "properties": {
            "host": {
              "type": "string"
            },
            "port": {
              "type": "string"
            },
            "secretArn": {
              "type": "string",
              "minLength": 20,
              "maxLength": 2048
            }
          }
        }
      },
      "implicitWaitDuration":  {
          "type":"object",
          "properties": {
            "innerNumber" : {
              "type": "number",
              "minimum": 0,
              "maximum": 10
            }
          }
        },
      "required": [
        "rateLimit",
        "maxFileSize",
        "crawlDepth",
        "crawlSubDomain",
        "crawlAllDomain",
        "maxLinksPerUrl",
        "honorRobots"
      ]
    },
    "type": {
      "type": "string",
      "pattern": "WEBCRAWLERV2"
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "type",
    "additionalProperties"
  ]
}

Confluence テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、Confluence ホスト URL、ホスティング方法、認証タイプを指定します。また、データソースのタイプを CONFLUENCEV2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Confluence JSON スキーマ」を参照してください。

次の表に、Confluence JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
hostUrl Confluence インスタンスの URL。例えば、https://example.confluence.com などです。
type Confluence インスタンスのホスティング方法 (SAAS およびON_PREM)。
authType Confluence インスタンスの認証方法 (Basic、OAuth2、Personal-token)。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • スペース

  • ページで

  • ブログ

  • コメント

  • 添付

 Confluence スペース、ページ、ブログ、コメント、添付ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。Confluence データソースのフィールド名は、Confluence カスタムメタデータ内に存在する必要があります。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
isCrawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL には、ユーザーとグループがアクセスできるドキュメントが指定されている点に留意してください。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。つまり、isCrawlACL をオフにすると、ドキュメントは公開され検索可能となります。詳細については、「User context filtering」を参照してください。
fieldForUserId ユーザー ID にユーザーの E メールを使用する場合は email を指定します。email はデフォルトで使用され、現在サポートされている唯一のユーザー ID タイプです。

  • inclusionSpaceKeyFilter

  • exclusionSpaceKeyFilter

  • pageTitleRegEX

  • blogTitleRegEX

  • commentTitleRegEX

  • attachmentTitleRegEX

  • inclusionFileTypePatterns

  • exclusionFileTypePatterns

  • inclusionUrlPatterns

  • exclusionUrlPatterns

 Confluence データソースに特定のファイルを含めるか、除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
proxyHost 使用しているウェブプロキシのホスト名 (http:// または https:// のプロトコルは含めません)。

proxyPort

 ホスト URL トランスポートプロトコルが使用するポート番号。これは 0～65535 の範囲の値にする必要があります。

  • isCrawlPersonalSpace

  • isCrawlArchivedSpace

  • isCrawlArchivedPage

  • isCrawlPage

  • isCrawlBlog

  • isCrawlPageComment

  • isCrawlPageAttachment

  • isCrawlBlogComment

  • isCrawlBlogAttachment

 Confluence のパーソナルスペース、ページ、ブログ、ページコメント、ページ添付ファイル、ブログコメント、ブログコメント、ブログ添付ファイル内のファイルをクロールする場合は、true に設定します。
maxFileSizeInMegaBytes Amazon Kendra がクロールできるファイルサイズの上限を MB 単位で指定します。Amazon Kendra では、定義したサイズ上限までのファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。
type データソースのタイプ。データソースタイプとして CONFLUENCEV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
secretARN Confluence への接続に必要なキーと値のペアが含まれている AWS Secrets Manager のシークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアの詳細については、「Confluence の接続手順」を参照してください。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "hostUrl": {
              "type": "string",
              "pattern": "https:.*"
            },
            "type": {
              "type": "string",
              "enum": [
                "SAAS",
                "ON_PREM"
              ]
            },
            "authType": {
              "type": "string",
              "enum": [
                "Basic",
                "OAuth2",
                "Personal-token"
              ]
            }
          },
          "required": [
            "hostUrl",
            "type",
            "authType"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "space": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "page": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "blog": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "comment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "usersAclS3FilePath": {
          "type": "string"
        },
        "isCrawlAcl": {
          "type": "boolean"
        },
        "fieldForUserId": {
          "type": "string"
        },
        "inclusionSpaceKeyFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionSpaceKeyFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "pageTitleRegEX": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "blogTitleRegEX": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "commentTitleRegEX": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "attachmentTitleRegEX": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "isCrawlPersonalSpace": {
          "type": "boolean"
        },
        "isCrawlArchivedSpace": {
          "type": "boolean"
        },
        "isCrawlArchivedPage": {
          "type": "boolean"
        },
        "isCrawlPage": {
          "type": "boolean"
        },
        "isCrawlBlog": {
          "type": "boolean"
        },
        "isCrawlPageComment": {
          "type": "boolean"
        },
        "isCrawlPageAttachment": {
          "type": "boolean"
        },
        "isCrawlBlogComment": {
          "type": "boolean"
        },
        "isCrawlBlogAttachment": {
          "type": "boolean"
        },
        "maxFileSizeInMegaBytes":  {
          "type":"string"
        },
        "inclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionUrlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionUrlPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "proxyHost": {
          "type": "string"
        },
        "proxyPort": {
          "type": "string"
        }
      },
      "required": []
    },
    "type": {
      "type": "string",
      "pattern": "CONFLUENCEV2"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FULL_CRAWL",
        "FORCED_FULL_CRAWL"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

Dropbox テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。認証情報を保存するシークレットの一部として、Dropbox アプリキー、アプリシークレット、アクセストークンを指定します。データソースのタイプを DROPBOX として指定し、使用するアクセストークンのタイプ (一時的または永続的)、その他の必要な設定も指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Dropbox JSON スキーマ」を参照してください。

次の表に、Dropbox JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。その代わり、接続情報はユーザーが secretArn に提供する AWS Secrets Manager シークレットに含まれます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ファイル

  • paper

  • papert

  • shortcut

 Dropbox ファイル、Dropbox Paper、ショートカットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
secretARN Confluence サーバーへの接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "appKey": "Dropbox app key",
    "appSecret": "Dropbox app secret",
    "accesstoken": "temporary access token or refresh access token"
}
additionalProperties データソース内のコンテンツ用の追加設定オプション。
isCrawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。

  • inclusionFileNamePatterns

  • inclusionFileTypePatterns

 特定のファイルを Dropbox データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • exclusionFileNamePatterns

  • exclusionFileTypePatterns

 Dropbox データソース内の特定のファイル名とタイプを除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • crawlFile

  • crawlPaper

  • crawlPapert

  • crawlShortcut

 Dropbox ファイル、Dropbox Paper ドキュメント、Dropbox Paper テンプレート、および Dropbox に保存されているウェブページのショートカットをクロールする場合は、true にします。
type データソースのタイプ。データソースタイプとして DROPBOX を指定します。
tokenType アクセストークンのタイプ (永続的アクセストークンまたは一時アクセストークン) を指定します。4 時間後に有効期限が切れる 1 回限りのアクセストークンに頼るのではなく、Dropbox で有効期限が切れることのない更新アクセストークンを作成することをお勧めします。Dropbox デベロッパーコンソールでアプリと更新アクセストークンを作成し、シークレットでアクセストークンを渡します。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "file": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "STRING_LIST",
                          "LONG",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "paper": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "STRING_LIST",
                          "LONG",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "papert": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "STRING_LIST",
                          "LONG",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "shortcut": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "STRING_LIST",
                          "LONG",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FULL_CRAWL",
        "FORCED_FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "secretArn": {
      "type": "string"
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "isCrawlAcl": {
          "type": "boolean"
        },
        "inclusionFileNamePatterns": {
          "type": "array"
        },
        "exclusionFileNamePatterns": {
          "type": "array"
        },
        "inclusionFileTypePatterns": {
          "type": "array"
        },
        "exclusionFileTypePatterns": {
          "type": "array"
        },
        "crawlFile": {
          "type": "boolean"
        },
        "crawlPaper": {
          "type": "boolean"
        },
        "crawlPapert": {
          "type": "boolean"
        },
        "crawlShortcut": {
          "type": "boolean"
        }
      }
    },
    "type": {
      "type": "string",
      "pattern": "DROPBOX"
    },
    "tokenType": {
      "type": "string",
      "enum": [
        "PERMANENT",
        "TEMPORARY"
      ]
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "syncMode",
    "enableIdentityCrawler",
    "secretArn",
    "type",
    "tokenType"
  ]
}

Drupal テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、Drupal ホスト URL と認証タイプを指定します。また、データソースのタイプを DRUPAL に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Drupal JSON スキーマ」を参照してください。

次の表に、Drupal JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
hostUrl Drupal ウェブサイトのホスト URL。例えば、https://<hostname>/<drupalsitename>。
repositoryConfigurations データソースのコンテンツに関する設定情報。

  • content

  • コメント

  • 添付

 Drupal ファイルの属性またはフィールド名をマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。Drupal データソースのフィールド名は、Drupal カスタムメタデータ内に存在する必要があります。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • inclusionFileNamePatterns

  • articleTitleInclusionPatterns

  • pageTitleInclusionPatterns

  • customContentTitleInclusionPatterns

  • basicBlockTitleInclusionPatterns

  • customBlockTitleInclusionPatterns

 Drupal データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • exclusionFileNamePatterns

  • articleTitleExclusionPatterns

  • pageTitleExclusionPatterns

  • customContentTitleExclusionPatterns

  • basicBlockTitleExclusionPatterns

  • customBlockTitleExclusionPatterns

 Drupal データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
contentDefinitions

  • contentType

  • fieldDefinition

  • isCrawlComments

  • isCrawlFiles

  • isCrawlArticle

  • isCrawlBasicPage

  • isCrawlBasicBlock

  • isCrawlCustomContentTypesList

 クロールするコンテンツタイプと、選択したコンテンツタイプのコメントと添付ファイルをクロールするかどうかを指定します。
type データソースのタイプ。データソースタイプとして DRUPAL を指定します。
authType 使用する認証のタイプ (BASIC-AUTH または OAUTH2)。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
secretARN Drupal への接続に必要なキーと値のペアが含まれている AWS Secrets Manager のシークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

基本認証を使用している場合。

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

OAuth 2.0 認証を使用している場合。

{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"
}
version 現在サポートされているこのテンプレートのバージョン。 
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"connectionConfiguration": {
			"type": "object",
			"properties": {
				"repositoryEndpointMetadata": {
					"type": "object",
					"properties": {
						"hostUrl": {
							"type": "string",
							"pattern": "https:.*"
						}
					},
					"required": [
						"hostUrl"
					]
				}
			},
			"required": [
				"repositoryEndpointMetadata"
			]
		},
		"repositoryConfigurations": {
			"type": "object",
			"properties": {
				"content": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"comment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"attachment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				}
			}
		},
		"additionalProperties": {
			"type": "object",
			"properties": {
				"isCrawlArticle": {
					"type": "boolean"
				},
				"isCrawlBasicPage": {
					"type": "boolean"
				},
				"isCrawlBasicBlock": {
					"type": "boolean"
				},
				"crawlCustomContentTypesList": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"crawlCustomBlockTypesList": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"filePath": {
					"anyOf": [
						{
							"type": "string",
							"pattern": "s3:.*"
						},
						{
							"type": "string",
							"pattern": ""
						}
					]
				},
				"inclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"articleTitleInclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"articleTitleExclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"pageTitleInclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"pageTitleExclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"customContentTitleInclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"customContentTitleExclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"basicBlockTitleInclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"basicBlockTitleExclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"customBlockTitleInclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"customBlockTitleExclusionPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"contentDefinitions": {
					"type": "array",
					"items": {
						"properties": {
							"contentType": {
								"type": "string"
							},
							"fieldDefinition": {
								"type": "array",
								"items": [
									{
										"type": "object",
										"properties": {
											"machineName": {
												"type": "string"
											},
											"type": {
												"type": "string"
											}
										},
										"required": [
											"machineName",
											"type"
										]
									}
								]
							},
							"isCrawlComments": {
								"type": "boolean"
							},
							"isCrawlFiles": {
								"type": "boolean"
							}
						}
					},
					"required": [
						"contentType",
						"fieldDefinition",
						"isCrawlComments",
						"isCrawlFiles"
					]
				}
			},
			"required": []
		},
		"type": {
			"type": "string",
			"pattern": "DRUPAL"
		},
		"authType": {
			"type": "string",
			"enum": [
				"BASIC-AUTH",
				"OAUTH2"
			]
		},
		"syncMode": {
			"type": "string",
			"enum": [
				"FORCED_FULL_CRAWL",
				"FULL_CRAWL",
				"CHANGE_LOG"
			]
		},
		"enableIdentityCrawler": {
			"type": "boolean"
		},
		"secretArn": {
			"type": "string",
			"minLength": 20,
			"maxLength": 2048
		}
	},
	"version": {
		"type": "string",
		"anyOf": [
			{
				"pattern": "1.0.0"
			}
		]
	},
	"required": [
		"connectionConfiguration",
		"repositoryConfigurations",
		"syncMode",
		"additionalProperties",
		"secretArn",
		"type"
	]
}

GitHub テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。GitHub ホスト URL、組織名、および接続設定またはリポジトリエンドポイントの詳細の一部として GitHub クラウドと GitHub オンプレミスのどちらを使用するかの情報を指定します。また、データソースのタイプを GITHUB に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「GitHub JSON スキーマ」を参照してください。

次の表に、GitHub JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
type タイプとして SAAS または ON_PREMISE のいずれかを指定します。
hostUrl GitHub ホスト URL。例えば、GitHub SaaS/Enterprise Cloud を使用する場合は https://api.github.com です。または、GitHub オンプレミス/Enterprise Server を使用の場合は https://on-prem-host-url/api/v3/ です。
organizationName 組織名を確認するには、GitHub デスクトップにログインし、プロファイル写真のドロップダウンから [組織] に移動します。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ghRepository

  • ghCommit

  • ghIssueDocument

  • ghIssueComment

  • ghIssueAttachment

  • ghPRDocument

  • ghPRComment

  • ghPRAttachment

 GitHub コンテンツの属性またはフィールド名を、Amazon Kendra のインデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
isCrawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
fieldForUserId ACL のクローリングに使用するユーザー ID のタイプを指定します。ユーザー ID にユーザーの E メールを使用する場合は email、ユーザー ID にユーザー名を使用する場合は username を指定します。値を指定しない場合、デフォルトで email が適用されます。
repositoryFilter インデックスを作成する特定のリポジトリ名とブランチ名のリスト。
crawlRepository リポジトリをクロールする場合は true を指定します。
crawlRepositoryDocuments リポジトリのドキュメントをクロールする場合は true を指定します。
crawlIssue 問題をクロールする場合は true を指定します。
crawlIssueComment 問題のコメントをクロールする場合は true を指定します。
crawlIssueCommentAttachment 問題コメントの添付ファイルをクロールする場合は true を指定します。
crawlPullRequest プルリクエストをクロールする場合は true を指定します。
crawlPullRequestComment プルリクエストのコメントをクロールする場合は true を指定します。
crawlPullRequestCommentAttachment プルリクエストのコメントの添付ファイルをクロールする場合は true を指定します。

  • inclusionFolderNamePatterns

  • inclusionFileTypePatterns

  • inclusionFileNamePatterns

 GitHub データソースにある特定のコンテンツを含めるための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスに含まれます。パターンに一致しないコンテンツは、インデックスから除外されます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。

  • exclusionFolderNamePatterns

  • exclusionFileTypePatterns

  • exclusionFileNamePatterns

 GitHub データソースにある特定のコンテンツを除外するための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスから除外されます。パターンに一致しないコンテンツは、インデックスに含まれます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。
type データソースのタイプ。データソースタイプとして GITHUB を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn

GitHub への接続に必要なキーと値のペアが含まれている AWS Secrets Manager のシークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

{
    "personalToken": "token"
}
version 現在サポートされているこのテンプレートのバージョン。

GitHub JSON スキーマは次のとおりです。

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

Gmail テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを GMAIL に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Gmail JSON スキーマ」を参照してください。

次の表に、Gmail JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。その代わり、接続情報はユーザーが secretArn に提供する AWS Secrets Manager シークレットに含まれます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

  • message

  • 添付ファイル

 Gmail メッセージおよび添付ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • inclusionLabelNamePatterns

  • exclusionLabelNamePatterns

  • inclusionAttachmentTypePatterns

  • exclusionAttachmentTypePatterns

  • inclusionAttachmentNamePatterns

  • exclusionAttachmentNamePatterns

  • inclusionSubjectFilter

  • exclusionSubjectFilter

  • isSubjectAnd

  • inclusionFromFilter

  • exclusionFromFilter

  • inclusionToFilter

  • exclusionToFilter

  • inclusionCcFilter

  • exclusionCcFilter

  • inclusionBccFilter

  • exclusionBccFilter

 Gmail データソースにある特定の件名のメールを含めるまたは除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
beforeDateFilter 特定の日付より前に含めるメッセージと添付ファイルを指定します。
afterDateFilter 特定の日付以降に含めるメッセージと添付ファイルを指定します。
isCrawlAttachment 添付ファイルをクロールするかどうかを選択するブール値。メッセージは自動的にクロールされます。
type データソースのタイプ。データソースタイプとして GMAIL を指定します。
shouldCrawlDraftMessages ドラフトメッセージをクロールするかどうかを選択するブール値。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

重要

完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は、以下のようになります。

  • Gmail から完全に削除されたメッセージは、Amazon Kendra インデックスから削除されません

  • Gmail のメールラベルの変更は同期されません。

Gmail のデータソースラベルの変更や完全に削除されたメールメッセージを Amazon Kendra インデックスに同期するには、定期的にフルクロールを実行する必要があります。
secretARN Gmail への接続に必要なキーと値のペアが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
      }
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "message": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          }
        },
        "attachments": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          }
        }
      },
      "required": []
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "inclusionLabelNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionLabelNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionAttachmentTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionAttachmentTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionAttachmentNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionAttachmentNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionSubjectFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionSubjectFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "isSubjectAnd": {
          "type": "boolean"
        },
        "inclusionFromFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFromFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionToFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionToFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionCcFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionCcFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionBccFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionBccFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "beforeDateFilter": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
            },
            {
              "type": "string",
              "pattern": ""
            }
          ]
        },
        "afterDateFilter": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
            },
            {
              "type": "string",
              "pattern": ""
            }
          ]
        },
        "isCrawlAttachment": {
          "type": "boolean"
        },
        "shouldCrawlDraftMessages": {
          "type": "boolean"
        }
      },
      "required": [
        "isCrawlAttachment",
        "shouldCrawlDraftMessages"
      ]
    },
    "type" : {
      "type" : "string",
      "pattern": "GMAIL"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "secretArn": {
      "type": "string"
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "syncMode",
    "secretArn",
    "type"
  ]
}

Google Drive テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを GOOGLEDRIVE2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Google Drive JSON スキーマ」を参照してください。

次の表に、Google Drive JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースに関する設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。このデータソースはエンドポイントを指定していません。認証タイプを選択します。serviceAccount と OAuth2。接続情報は、secretArn に提供する AWS Secrets Manager シークレットに含まれます。
authType ユースケースに基づいて serviceAccount と OAuth2 のどちらかを選んでください。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ファイル

  • コメント

 Google Drive の属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • maxFileSizeInMegaBytes

 Amazon Kendra がクロールするファイルサイズの制限を MB 単位で指定します。

  • iscrawlComment

 Google Drive データソース内のコメントをクロールする場合は、true にします。

  • isCrawlMyDriveAndSharedWithMe

 Google Drive のデータソースにある MyDrive と Shared With Me Drive をクロールする場合は、true にします。

  • isCrawlSharedDrives

 Google Drive のデータソース内の共有ドライブをクロールする場合は、true にします。
isCrawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。

  • excludeUserAccounts

  • excludeSharedDrives

  • excludeMimeTypes

  • exclusionFileTypePatterns

  • exclusionFileNamePatterns

  • exclusionFilePathFilter

 Google Drive データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • includeUserAccounts

  • includeSharedDrives

  • includeMimeTypes

  • inclusionFileTypePatterns

  • inclusionFileNamePatterns

  • inclusionFilePathFilter

 Google Drive データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
type データソースのタイプ。データソースタイプとして GOOOGLEDRIVEV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretARN Google Drive サーバーへの接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

Google サービスアカウント認証を使用している場合。

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

OAuth 2.0 認証を使用している場合。

{
    "clientID": "OAuth client ID",
    "clientSecret": "client secret",
    "refreshToken": "refresh token"
}
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "authType": {
              "type": "string",
              "enum": [
                "serviceAccount",
                "OAuth2"
              ]
            }
          },
          "required": [
            "authType"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "file": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "STRING_LIST",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "comment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "STRING_LIST"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "maxFileSizeInMegaBytes": {
          "type": "string"
        },
        "isCrawlComment": {
          "type": "boolean"
        },
        "isCrawlMyDriveAndSharedWithMe": {
          "type": "boolean"
        },
        "isCrawlSharedDrives": {
          "type": "boolean"
        },
        "isCrawlAcl": {
          "type": "boolean"
        },
        "excludeUserAccounts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "excludeSharedDrives": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "excludeMimeTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeUserAccounts": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeSharedDrives": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeMimeTypes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "includeTargetAudienceGroup": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFilePathFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFilePathFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "type": {
      "type": "string",
      "pattern": "GOOGLEDRIVEV2"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

IBM DB2 テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを db2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「IBM DB2 JSON スキーマ」を参照してください。

次の表に、IBM DB2 JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Microsoft Exchange テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。テナント ID は、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを MSEXCHANGE に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Microsoft Exchange JSON スキーマ」を参照してください。

次の表に、Microsoft Exchange JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
tenantId Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • email

  • 添付

  • カレンダー

  • contacts

  • 注意事項

 Microsoft Exchange データソースの属性またはフィールド名を Amazon Kendra インデックスフィールドにマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
inclusionPatterns Microsoft Exchange のデータソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionPatterns Microsoft Exchange のデータソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • inclusionUsersList

  • inclusionUsersFileName

  • inclusionDomainUsers

 Microsoft Exchange のデータソースにある特定のユーザーおよびユーザーファイルを含めるための正規表現のパターンのリスト。パターンに一致するユーザーは、インデックスに含まれます。パターンに一致しないユーザーは、インデックスから除外されます。ユーザーが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのユーザーはインデックスに含まれません。

  • exclusionUsersList

  • exclusionUsersFileName

  • exclusionDomainUsers

 Microsoft Exchange のデータソースにある特定のユーザーおよびユーザーファイルを除外するための正規表現のパターンのリスト。パターンに一致するユーザーは、インデックスから除外されます。パターンに一致しないユーザーは、インデックスに含まれます。ユーザーが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのユーザーはインデックスに含まれません。
s3bucketName S3 バケットの名前 (使用する場合)。

  • crawlCalendar

  • crawlNotes

  • crawlContacts

  • crawlFolderAcl

 Microsoft Exchange データソースのこれらのタイプのコンテンツとアクセスコントロール情報をクロールする場合は、true を指定します。
startCalendarDateTime カレンダーのコンテンツには特定の開始日時を設定できます。
endCalendarDateTime カレンダーのコンテンツには特定の終了日時を設定できます。
subject メールコンテンツには特定の件名を設定できます。
emailFrom 「差出人」または送信者のメールコンテンツに特定のメールを設定できます。
emailTo 「宛先」または受信者のメールコンテンツに特定のメールを設定できます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
type データソースのタイプ。データソースタイプとして MSEXCHANGE を指定します。
secretARN Microsoft Exchange への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Azure Portal で OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "tenantId": {
              "type": "string",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
              "minLength": 36,
              "maxLength": 36
            }
          },
          "required": ["tenantId"]
        }
      }
    },
    "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"
  ]
}

Microsoft OneDrive テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。テナント ID は接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを ONEDRIVEV2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Microsoft OneDrive JSON スキーマ」を参照してください。

次の表に、Microsoft OneDrive JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
tenantId Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。
ファイル Microsoft OneDrive ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • userNameFilter

  • userFilterPath

  • inclusionFileTypePatterns

  • exclusionFileTypePatterns

  • inclusionFileNamePatterns

  • exclusionFileNamePatterns

  • inclusionFilePathPatterns

  • exclusionFilePathPatterns

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotepageNamePatterns

 特定のファイル、OneNote セクション、OneNote ページのインデックスを作成したり、ユーザー名でフィルタリングできます。
isUserNameOnS3 Amazon S3 に保存されているファイル内のユーザー名のリストを提供する場合は、true にします。
type データソースのタイプ。データソースタイプとして ONEDRIVEV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
type データソースのタイプ。データソースタイプとして ONEDRIVEV2 を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretARN Microsoft OneDrive への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
version 現在サポートされているこのテンプレートのバージョン。 
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"connectionConfiguration": {
			"type": "object",
			"properties": {
				"repositoryEndpointMetadata": {
					"type": "object",
					"properties": {
						"tenantId": {
							"type": "string",
							"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
							"minLength": 36,
							"maxLength": 36
						}
					},
					"required": [
						"tenantId"
					]
				}
			},
			"required": [
				"repositoryEndpointMetadata"
			]
		},
		"repositoryConfigurations": {
			"type": "object",
			"properties": {
				"file": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE",
												"LONG"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				}
			}
		},
		"additionalProperties": {
			"type": "object",
			"properties": {
				"userNameFilter": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"userFilterPath": {
					"type": "string"
				},
				"isUserNameOnS3": {
					"type": "boolean"
				},
				"inclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFilePathPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFilePathPatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				}
			},
			"required": []
		},

		"enableIdentityCrawler": {
			"type": "boolean"
		},
		"type": {
			"type": "string",
			"pattern": "ONEDRIVEV2"
		},
		"syncMode": {
			"type": "string",
			"enum": [
				"FULL_CRAWL",
				"FORCED_FULL_CRAWL",
				"CHANGE_LOG"
			]
		},
		"secretArn": {
			"type": "string",
			"minLength": 20,
			"maxLength": 2048
		}
	},
	"version": {
		"type": "string",
		"anyOf": [
			{
				"pattern": "1.0.0"
			}
		]
	},
	"required": [
		"connectionConfiguration",
		"repositoryConfigurations",
		"syncMode",
		"additionalProperties",
		"secretArn",
		"type"
	]
}

Microsoft SharePoint テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、SharePoint サイト URL、ドメインを指定し、必要に応じてテナント ID も指定します。また、データソースのタイプを SHAREPOINTV2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに [タイプ] として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「SharePoint JSON スキーマ」を参照してください。

次の表に、Microsoft SharePoint JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
tenantId SharePoint アカウントのテナント ID。
ドメイン SharePoint アカウントのドメイン。
siteUrls SharePoint アカウントのホスト URL。
repositoryAdditionalProperties リポジトリ/データソースエンドポイントに接続するための追加プロパティ。
s3bucketName Azure AD の自己署名 X.509 証明書を保存する Amazon S3 バケットの名前。
s3certificateName Amazon S3 バケットに保存されている Azure AD 自己署名 X.509 証明書の名前。
authType 使用する認証のタイプ (OAuth2、OAuth2Certificate、OAuth2App、Basic、OAuth2_RefreshToken、NTLM、または Kerberos)。
version 使用する SharePoint のバージョン (Server または Online)。
onPremVersion 使用する SharePoint Server のバージョン (2013、2016、2019、または SubscriptionEdition)。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • イベント

  • ページで

  • ファイル

  • link (リンク)

  • 添付

  • コメント

 SharePoint のコンテンツの属性またはフィールド名を Amazon Kendra のインデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。

  • eventTitleFilterRegEx

  • pageTitleFilterRegEx

  • linkTitleFilterRegEx

  • inclusionFilePath

  • exclusionFilePath

  • inclusionFileTypePatterns

  • exclusionFileTypePatterns

  • inclusionFileNamePatterns

  • exclusionFileNamePatterns

  • inclusionOneNoteSectionNamePatterns

  • exclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

  • exclusionOneNotePageNamePatterns

 SharePoint データソース内の特定のコンテンツを含めるか、除外するための正規表現パターンのリスト。包含パターンに一致するコンテンツ項目は、インデックスに含まれます。包含パターンに一致しないコンテンツ項目は、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • crawlFiles

  • crawlPages

  • crawlEvents

  • crawlComments

  • crawlLinks

  • crawlAttachments

 これらのタイプのコンテンツをクロールする場合は、true を指定します。
crawlAcl アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「User context filtering」を参照してください。
fieldForUserId ユーザー ID にユーザーの E メールを使用する場合は email、ユーザー ID にユーザー名を使用する場合は userPrincipalName を指定します。値を指定しない場合、デフォルトで email が適用されます。
aclConfiguration ACLWithLDAPEmailFmt、ACLWithManualEmailFmt、または ACLWithUsernameFmtM のいずれかを指定します。
emailDomain E メールのドメイン。例: "amazon.com"。

  • isCrawlLocalGroupMapping

  • isCrawlAdGroupMapping

 グループマッピング情報をクロールする場合は、true を指定します。
proxyHost 使用しているウェブプロキシのホスト名 (http:// または https:// のプロトコルは含めません)。
proxyPort ホスト URL トランスポートプロトコルが使用するポート番号。これは 0～65535 の範囲の値にする必要があります。
type データソースタイプとして SHAREPOINTV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretARN SharePoint への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアについては、「Connection instructions for SharePoint Online and SharePoint Server」を参照してください。
version 現在サポートされているこのテンプレートのバージョン。 
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"type": "object",
	"properties": {
		"connectionConfiguration": {
			"type": "object",
			"properties": {
				"repositoryEndpointMetadata": {
					"type": "object",
					"properties": {
						"tenantId": {
							"type": "string",
							"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
							"minLength": 36,
							"maxLength": 36
						},
						"domain": {
							"type": "string"
						},
						"siteUrls": {
							"type": "array",
							"items": {
								"type": "string",
								"pattern": "https://.*"
							}
						},
						"repositoryAdditionalProperties": {
							"type": "object",
							"properties": {
								"s3bucketName": {
									"type": "string"
								},
								"s3certificateName": {
									"type": "string"
								},
								"authType": {
									"type": "string",
									"enum": [
										"OAuth2",
										"OAuth2Certificate",
										"OAuth2App",
										"Basic",
										"OAuth2_RefreshToken",
										"NTLM",
										"Kerberos"
									]
								},
								"version": {
									"type": "string",
									"enum": [
										"Server",
										"Online"
									]
								},
								"onPremVersion": {
									"type": "string",
									"enum": [
										"",
										"2013",
										"2016",
										"2019",
										"SubscriptionEdition"
									]
								}
							},
							"required": [
								"authType",
								"version"
							]
						}
					},
					"required": [
						"siteUrls",
						"domain",
						"repositoryAdditionalProperties"
					]
				}
			},
			"required": [
				"repositoryEndpointMetadata"
			]
		},
		"repositoryConfigurations": {
			"type": "object",
			"properties": {
				"event": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"page": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE",
												"LONG"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"file": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"DATE",
												"LONG"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"link": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"attachment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				},
				"comment": {
					"type": "object",
					"properties": {
						"fieldMappings": {
							"type": "array",
							"items": [
								{
									"type": "object",
									"properties": {
										"indexFieldName": {
											"type": "string"
										},
										"indexFieldType": {
											"type": "string",
											"enum": [
												"STRING",
												"STRING_LIST",
												"DATE"
											]
										},
										"dataSourceFieldName": {
											"type": "string"
										},
										"dateFieldFormat": {
											"type": "string",
											"pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
										}
									},
									"required": [
										"indexFieldName",
										"indexFieldType",
										"dataSourceFieldName"
									]
								}
							]
						}
					},
					"required": [
						"fieldMappings"
					]
				}
			}
		},
		"additionalProperties": {
			"type": "object",
			"properties": {
				"eventTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"pageTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"linkTitleFilterRegEx": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFilePath": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFilePath": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileTypePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionFileNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNoteSectionNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"inclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"exclusionOneNotePageNamePatterns": {
					"type": "array",
					"items": {
						"type": "string"
					}
				},
				"crawlFiles": {
					"type": "boolean"
				},
				"crawlPages": {
					"type": "boolean"
				},
				"crawlEvents": {
					"type": "boolean"
				},
				"crawlComments": {
					"type": "boolean"
				},
				"crawlLinks": {
					"type": "boolean"
				},
				"crawlAttachments": {
					"type": "boolean"
				},
				"crawlListData": {
					"type": "boolean"
				},
				"crawlAcl": {
					"type": "boolean"
				},
				"fieldForUserId": {
					"type": "string"
				},
				"aclConfiguration": {
					"type": "string",
					"enum": [
						"ACLWithLDAPEmailFmt",
						"ACLWithManualEmailFmt",
						"ACLWithUsernameFmt"
					]
				},
				"emailDomain": {
					"type": "string"
				},
				"isCrawlLocalGroupMapping": {
					"type": "boolean"
				},
				"isCrawlAdGroupMapping": {
					"type": "boolean"
				},
				"proxyHost": {
					"type": "string"
				},
				"proxyPort": {
					"type": "string"
				}
			},
			"required": [
			]
		},
		"type": {
			"type": "string",
			"pattern": "SHAREPOINTV2"
		},
		"enableIdentityCrawler": {
			"type": "boolean"
		},
		"syncMode": {
			"type": "string",
			"enum": [
				"FULL_CRAWL",
				"FORCED_FULL_CRAWL",
				"CHANGE_LOG"
			]
		},
		"secretArn": {
			"type": "string",
			"minLength": 20,
			"maxLength": 2048
		}
	},
	"version": {
		"type": "string",
		"anyOf": [
			{
				"pattern": "1.0.0"
			}
		]
	},
	"required": [
		"connectionConfiguration",
		"repositoryConfigurations",
		"enableIdentityCrawler",
		"syncMode",
		"additionalProperties",
		"secretArn",
		"type"
	]
}

Microsoft SQL サーバーテンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを sqlserver に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Microsoft SQL サーバー JSON スキーマ」を参照してください。

次の表に、Micorosft SQL Server JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Microsoft Teams テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。テナント ID は、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを MSTEAMS に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Microsoft Teams JSON スキーマ」を参照してください。

次の表に、Microsoft Teams JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
tenantId Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • chatMessage

  • chatAttachment

  • channelPost

  • channelWiki

  • channelAttachment

  • meetingChat

  • meetingFile

  • meetingNote

  • calendarMeeting

 Microsoft Teams のコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
paymentModel Microsoft Teams データソースで使用する支払いモデルのタイプを指定します。モデル A の支払いモデルは、セキュリティコンプライアンスを必要とするライセンスモデルと支払いモデルに限定されます。モデル B の支払いモデルは、セキュリティコンプライアンスを必要としないライセンスモデルや支払いモデルに適しています。

  • inclusionTeamNameFilter

  • inclusionChannelNameFilter

  • inclusionFileNamePatterns

  • inclusionFileTypePatterns

  • inclusionUserEmailFilter

  • inclusionOneNoteSectionNamePatterns

  • inclusionOneNotePageNamePatterns

 Microsoft Teams データソースにある特定のコンテンツを含めるための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスに含まれます。パターンに一致しないコンテンツは、インデックスから除外されます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。

  • exclusionTeamNameFilter

  • exclusionChannelNameFilter

  • exclusionFileNamePatterns

  • exclusionFileTypePatterns

  • exclusionUserEmailFilter

  • exclusionOneNoteSectionNamePatterns

  • exclusionOneNotePageNamePatterns

 Microsoft Teams のデータソースにある特定のコンテンツを除外するための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスから除外されます。パターンに一致しないコンテンツは、インデックスに含まれます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。

  • isCrawlChatMessage

  • isCrawlChatAttachment

  • isCrawlChannelPost

  • isCrawlChannelAttachment

  • isCrawlChannelWiki

  • isCrawlCalendarMeeting

  • isCrawlMeetingChat

  • isCrawlMeetingFile

  • isCrawlMeetingNote

 Microsoft Teams データソース内のこれらのタイプのコンテンツをクロールする場合は、true を指定します。
startCalendarDateTime カレンダーのコンテンツには特定の開始日時を設定できます。
endCalendarDateTime カレンダーのコンテンツには特定の終了日時を設定できます。
type データソースのタイプ。データソースタイプとして MSTEAMS を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn Microsoft Teams への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Azure Portal で OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "tenantId": {
              "type": "string",
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
              "minLength": 36,
              "maxLength": 36
            }
          },
          "required": [
            "tenantId"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "chatMessage": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "chatAttachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "channelPost": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "channelWiki": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "channelAttachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "meetingChat": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "meetingFile": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "meetingNote": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "calendarMeeting": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
     "additionalProperties": {
      "type": "object",
      "properties": {
        "paymentModel": {
          "type": "string",
          "enum": [
            "A",
            "B",
            "Evaluation Mode"
          ]
        },
        "inclusionTeamNameFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionTeamNameFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionChannelNameFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionChannelNameFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionUserEmailFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionOneNoteSectionNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionOneNoteSectionNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionOneNotePageNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionOneNotePageNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "isCrawlChatMessage": {
          "type": "boolean"
        },
        "isCrawlChatAttachment": {
          "type": "boolean"
        },
        "isCrawlChannelPost": {
          "type": "boolean"
        },
        "isCrawlChannelAttachment": {
          "type": "boolean"
        },
        "isCrawlChannelWiki": {
          "type": "boolean"
        },
        "isCrawlCalendarMeeting": {
          "type": "boolean"
        },
        "isCrawlMeetingChat": {
          "type": "boolean"
        },
        "isCrawlMeetingFile": {
          "type": "boolean"
        },
        "isCrawlMeetingNote": {
          "type": "boolean"
        },
        "startCalendarDateTime": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
            },
            {
              "type": "string",
              "pattern": ""
            }
          ]
        },
        "endCalendarDateTime": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
            },
            {
              "type": "string",
              "pattern": ""
            }
          ]
        }
      },
      "required": []
    },
    "type": {
      "type": "string",
      "pattern": "MSTEAMS"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

Microsoft Yammer テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを YAMMER に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに [タイプ] として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。

次の表に、Microsoft Yammer JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースに関する設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。その代わり、接続情報はユーザーが secretArn に提供する AWS Secrets Manager シークレットに含まれます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • community

  • ユーザー

  • message

  • 添付

 Microsoft Yammer の属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
inclusionPatterns Microsoft Yammer データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionPatterns Microsoft Yammer データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
sinceDate Microsoft Yammer コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。
communityNameFilter 特定のコミュニティコンテンツのインデックスを作成できます。

  • isCrawlMessage

  • isCrawlAttachment

  • isCrawlPrivateMessage

 メッセージ、メッセージの添付ファイル、プライベートメッセージをクロールする場合は、true にします。
type データソースタイプとして YAMMER を指定します。
secretARN Microsoft Yammer への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Microsoft Yammer のユーザー名とパスワード、Azure ポータルで OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。
useChangeLog Microsoft Yammer の変更ログを使用して、インデックス内の更新する必要があるドキュメントを特定する場合は、true にします。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
          }
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "community": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "user": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "message": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": [
                          "STRING",
                          "DATE"
                        ]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "inclusionPatterns": {
          "type": "array"
        },
        "exclusionPatterns": {
          "type": "array"
        },
        "sinceDate": {
          "type": "string",
          "pattern": "^(19|2[0-9])[0-9]{2}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])((\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]))?$"
        },
        "communityNameFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "isCrawlMessage": {
          "type": "boolean"
        },
        "isCrawlAttachment": {
          "type": "boolean"
        },
        "isCrawlPrivateMessage": {
          "type": "boolean"
        }
      },
      "required": [
        "sinceDate"
      ]
    },
    "type": {
      "type": "string",
      "pattern": "YAMMER"
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    },
    "useChangeLog": {
      "type": "string",
      "enum": [
        "true",
        "false"
      ]
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "type",
    "secretArn",
    "syncMode"
  ]
}

MySQL テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを mysql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「MySQL JSON スキーマ」を参照してください。

次の表に、MySQL JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Oracle Database テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを oracle に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Oracle Database JSON スキーマ」を参照してください。

次の表に、Oracle Database JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

PostgreSQL テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。データソースのタイプを JDBC に指定し、データベースタイプを postgresql に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「PostgreSQL JSON スキーマ」を参照してください。

次の表に、PostgreSQL JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースの接続に必要な設定情報。

  • dbType - 使用する Java データベースのタイプ。mysql、db2、postgresql、oracle、または sqlserver。

  • dbHost - データベースのホスト名。

  • dbPort - データベースポート。

  • dbInstance - データベースインスタンス。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。

ドキュメント

 データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
additionalProperties データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。
primaryKey データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。
titleColumn データベーステーブル内の文書タイトル列の名前を指定します。
bodyColumn データベーステーブル内の文書タイトル列の名前を指定します。
sqlQuery SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
timestampColumn タイムスタンプを含む列の名前を入力します。 Amazon Kendra はタイムスタンプ情報を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。
timestampFormat コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。
timezone クロールするコンテンツのタイムゾーンを含む列の名前を入力します。
changeDetectingColumns Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。 Amazon Kendra はこれらの列のいずれかに変更があると、コンテンツのインデックスを再作成します。
allowedUsersColumns コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
allowedGroupsColumn コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。
sourceURIColumn インデックスを作成するソース URL を含む列の名前を入力します。
isSslEnabled SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。
type データソースのタイプ。データソースタイプとして JDBC を指定します。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
secretArn データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "dbType": {
              "type": "string",
              "enum": [
                "mysql",
                "db2",
                "postgresql",
                "oracle",
                "sqlserver"
              ]
            },
            "dbHost": {
              "type": "string"
            },
            "dbPort": {
              "type": "string"
            },
            "dbInstance": {
              "type": "string"
            }
          },
          "required": [
            "dbType",
            "dbHost",
            "dbPort",
            "dbInstance"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "document": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string"
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "primaryKey": {
          "type": "string"
        },
        "titleColumn": {
          "type": "string"
        },
        "bodyColumn": {
          "type": "string"
        },
        "sqlQuery": {
          "type": "string",
          "not": {
            "pattern": ";+"
          }
        },
        "timestampColumn": {
          "type": "string"
        },
        "timestampFormat": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "changeDetectingColumns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "allowedUsersColumn": {
          "type": "string"
        },
        "allowedGroupsColumn": {
          "type": "string"
        },
        "sourceURIColumn": {
          "type": "string"
        },
        "isSslEnabled": {
          "type": "boolean"
        }
      },
      "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"]
    },
    "type" : {
      "type" : "string",
      "pattern": "JDBC"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
      "connectionConfiguration",
      "repositoryConfigurations",
      "syncMode",
      "additionalProperties",
      "secretArn",
      "type"
  ]
}

Salesforce テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として Salesforce ホスト URL を指定します。また、データソースのタイプを SALESFORCEV2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Salesforce JSON スキーマ」を参照してください。

次の表に、Salesforce JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
hostUrl インデックスを作成する Salesforce インスタンスの URL。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • アカウント

  • contact

  • キャンペーン

  • case

  • product

  • lead

  • contract

  • partner

  • profile

  • idea

  • pricebook

  • タスク

  • solution

  • 添付

  • ユーザー

  • ドキュメント

  • knowledgeArticles

  • グループ

  • opportunity

  • chatter

  • customEntity

 Salesforce エンティティの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
secretARN Salesforce への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "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 データソース内のコンテンツ用の追加設定オプション。

  • accountFilter

  • contactFilter

  • caseFilter

  • campaignFilter

  • contractFilter

  • groupFilter

  • leadFilter

  • productFilter

  • opportunityFilter

  • partnerFilter

  • pricebookFilter

  • ideaFilter

  • profileFilter

  • taskFilter

  • solutionFilter

  • userFilter

  • chatterFilter

  • documentFilter

  • knowledgeArticleFilter

  • customEntities

 フィルタリングするエンティティを指定する文字列のコレクション。

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

 特定のファイルを Salesforce データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

exclusionPatterns

  • exclusionDocumentFileTypePatterns

  • exclusionDocumentFileNamePatterns

  • exclusionAccountFileTypePatterns

  • exclusionCampaignFileTypePatterns

  • exclusionCampaignFileNamePatterns

  • exclusionCaseFileTypePatterns

  • exclusionCaseFileNamePatterns

  • exclusionContactFileTypePatterns

  • exclusionContractFileNamePatterns

  • exclusionLeadFileTypePatterns

  • exclusionLeadFileNamePatterns

  • exclusionOpportunityFileTypePatterns

  • exclusionOpportunityFileNamePatterns

  • exclusionSolutionFileTypePatterns

  • exclusionSolutionFileNamePatterns

  • exclusionTaskFileTypePatterns

  • exclusionTaskFileNamePatterns

  • exclusionGroupFileTypePatterns

  • exclusionGroupFileNamePatterns

  • exclusionChatterFileTypePatterns

  • exclusionChatterFileNamePatterns

  • exclusionCustomEntityFileTypePatterns

  • exclusionCustomEntityFileNamePatterns

 特定のファイルを Salesforce データソースから除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • isCrawlAccount

  • isCrawlContact

  • isCrawlCase

  • isCrawlCampaign

  • isCrawlProduct

  • isCrawlLead

  • isCrawlContract

  • isCrawlPartner

  • isCrawlProfile

  • isCrawlIdea

  • isCrawlPricebook

  • isCrawlDocument

  • crawlSharedDocument

  • isCrawlGroup

  • isCrawlOpportunity

  • isCrawlChatter

  • isCrawlUser

  • isCrawlSolution

  • isCrawlTask

  • isCrawlAccountAttachments

  • isCrawlContactAttachments

  • isCrawlCaseAttachments

  • isCrawlCampaignAttachments

  • isCrawlLeadAttachments

  • isCrawlContractAttachments

  • isCrawlGroupAttachments

  • isCrawlOpportunityAttachments

  • isCrawlChatterAttachments

  • isCrawlSolutionAttachments

  • isCrawlTaskAttachments

  • isCrawlCustomEntityAttachments

  • isCrawlKnowledgeArticles

    • isCrawlDraft

    • isCrawlPublish

    • isCrawlArchived

 Salesforce アカウントのこれらのタイプのファイルをクロールする場合は、true にします。
type データソースのタイプ。データソースタイプとして SALESFORCEV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties":
  {
    "connectionConfiguration": {
      "type": "object",
      "properties":
      {
        "repositoryEndpointMetadata":
        {
          "type": "object",
          "properties":
          {
            "hostUrl":
            {
              "type": "string",
              "pattern": "https:.*"
            }
          },
          "required":
          [
            "hostUrl"
          ]
        }
      },
      "required":
      [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties":
      {
        "account":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "contact":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "campaign":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "case":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "product":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "lead":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "contract":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "partner":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "profile":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "idea":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "pricebook":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "task":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "solution":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "attachment":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "user":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "document":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "knowledgeArticles":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "group":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "opportunity":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE",
                        "LONG"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "chatter":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        },
        "customEntity":
        {
          "type": "object",
          "properties":
          {
            "fieldMappings":
            {
              "type": "array",
              "items":
              [
                {
                  "type": "object",
                  "properties":
                  {
                    "indexFieldName":
                    {
                      "type": "string"
                    },
                    "indexFieldType":
                    {
                      "type": "string",
                      "enum":
                      [
                        "STRING",
                        "STRING_LIST",
                        "DATE"
                      ]
                    },
                    "dataSourceFieldName":
                    {
                      "type": "string"
                    },
                    "dateFieldFormat":
                    {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required":
                  [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required":
          [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties":
      {
        "accountFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "contactFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "caseFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "campaignFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "contractFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "groupFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "leadFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "productFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "opportunityFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "partnerFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "pricebookFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "ideaFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "profileFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "taskFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "solutionFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "userFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "chatterFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "documentFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "knowledgeArticleFilter":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "customEntities":{
          "type": "array",
          "items":
          {
            "type": "string"
          }
        },
        "isCrawlAccount": {
          "type": "boolean"
        },
        "isCrawlContact": {
          "type": "boolean"
        },
        "isCrawlCase": {
          "type": "boolean"
        },
        "isCrawlCampaign": {
          "type": "boolean"
        },
        "isCrawlProduct": {
          "type": "boolean"
        },
        "isCrawlLead": {
          "type": "boolean"
        },
        "isCrawlContract": {
          "type": "boolean"
        },
        "isCrawlPartner": {
          "type": "boolean"
        },
        "isCrawlProfile": {
          "type": "boolean"
        },
        "isCrawlIdea": {
          "type": "boolean"
        },
        "isCrawlPricebook": {
          "type": "boolean"
        },
        "isCrawlDocument": {
          "type": "boolean"
        },
        "crawlSharedDocument": {
          "type": "boolean"
        },
        "isCrawlGroup": {
          "type": "boolean"
        },
        "isCrawlOpportunity": {
          "type": "boolean"
        },
        "isCrawlChatter": {
          "type": "boolean"
        },
        "isCrawlUser": {
          "type": "boolean"
        },
        "isCrawlSolution":{
          "type": "boolean"
        },
        "isCrawlTask":{
          "type": "boolean"
        },

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

ServiceNow テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、ServiceNow ホスト URL、認証タイプ、およびインスタンスバージョンを指定します。また、データソースのタイプを SERVICENOWV2 に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「ServiceNow JSON スキーマ」を参照してください。

次の表に、ServiceNow JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
hostUrl ServiceNow ホスト URL。例えば、your-domain.service-now.com です。
authType 使用する認証のタイプ (basicAuth または OAuth2)。
servicenowInstanceVersion 使用する ServiceNow のバージョン。Tokyo、Sandiego、Rome、および Others のいずれかを選択できます。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • knowledgeArticle

  • 添付

  • serviceCatalog

  • インシデント

 ServiceNow ナレッジ記事、添付ファイル、サービスカタログ、およびインシデントの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。ServiceNow データソースのフィールド名は、ServiceNow カスタムメタデータ内に存在する必要があります。
その他のプロパティ データソース内のコンテンツ用の追加設定オプション。
maxFileSizeInMegaBytes Amazon Kendra がクロールするファイルサイズの上限を MB 単位で指定します。Amazon Kendra は、ユーザーが定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。

  • knowledgeArticleFilter

  • incidentQueryFilter

  • serviceCatalogQueryFilter

  • knowledgeArticleTitleRegExp

  • serviceCatalogTitleRegExp

  • incidentTitleRegExp

  • inclusionFileTypePatterns

  • exclusionFileTypePatterns

  • inclusionFileNamePatterns

  • exclusionFileNamePatterns

  • incidentStateType

 ServiceNow データソースにある特定のファイルを含めるか、除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • isCrawlKnowledgeArticle

  • isCrawlKnowledgeArticleAttachment

  • includePublicArticlesOnly

  • isCrawlServiceCatalog

  • isCrawlServiceCatalogAttachment

  • isCrawlActiveServiceCatalog

  • isCrawlInactiveServiceCatalog

  • isCrawlIncident

  • isCrawlIncidentAttachment

  • isCrawlActiveIncident

  • isCrawlInactiveIncident

  • applyACLForKnowledgeArticle

  • applyACLForServiceCatalog

  • applyACLForIncident

 ServiceNow ナレッジ記事、サービスカタログ、インシデント、および添付ファイルをクロールする場合は、true にします。
type データソースのタイプ。データソースタイプとして SERVICENOWV2 を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。
secretARN ServiceNow への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "username": "user name",
    "password": "password"
}
OAuth2 認証を使用する場合、シークレットには、次のキーを含む JSON 構造を含める必要があります。
{
    "username": "user name",
    "password": "password",
    "clientId": "client id",
    "clientSecret": "client secret"         
}
version 現在サポートされているテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "hostUrl": {
              "type": "string",
              "pattern": "^(?!(^(https?|ftp|file):\/\/))[a-z0-9-]+(.service-now.com|.servicenowservices.com)$",
              "minLength": 1,
              "maxLength": 2048
            },
            "authType": {
              "type": "string",
              "enum": [
                "basicAuth",
                "OAuth2"
              ]
            },
            "servicenowInstanceVersion": {
              "type": "string",
              "enum": [
                "Tokyo",
                "Sandiego",
                "Rome",
                "Others"
                ]
            }
          },
          "required": [
            "hostUrl",
            "authType",
            "servicenowInstanceVersion"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "knowledgeArticle": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "STRING_LIST"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "LONG",
                        "DATE",
                        "STRING_LIST"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "serviceCatalog": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "STRING_LIST"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "incident": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": [
                        "STRING",
                        "DATE",
                        "STRING_LIST"
                      ]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "maxFileSizeInMegaBytes": {
          "type": "string"
        },
        "isCrawlKnowledgeArticle": {
          "type": "boolean"
        },
        "isCrawlKnowledgeArticleAttachment": {
          "type": "boolean"
        },
        "includePublicArticlesOnly": {
          "type": "boolean"
        },
        "knowledgeArticleFilter": {
          "type": "string"
        },
        "incidentQueryFilter": {
          "type": "string"
        },
        "serviceCatalogQueryFilter": {
          "type": "string"
        },
        "isCrawlServiceCatalog": {
          "type": "boolean"
        },
        "isCrawlServiceCatalogAttachment": {
          "type": "boolean"
        },
        "isCrawlActiveServiceCatalog": {
          "type": "boolean"
        },
        "isCrawlInactiveServiceCatalog": {
          "type": "boolean"
        },
        "isCrawlIncident": {
          "type": "boolean"
        },
        "isCrawlIncidentAttachment": {
          "type": "boolean"
        },
        "isCrawlActiveIncident": {
          "type": "boolean"
        },
        "isCrawlInactiveIncident": {
          "type": "boolean"
        },
        "applyACLForKnowledgeArticle": {
          "type": "boolean"
        },
        "applyACLForServiceCatalog": {
          "type": "boolean"
        },
        "applyACLForIncident": {
          "type": "boolean"
        },
        "incidentStateType": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "Open",
              "Open - Unassigned",
              "Resolved",
              "All"
            ]
          }
        },
        "knowledgeArticleTitleRegExp": {
          "type": "string"
        },
        "serviceCatalogTitleRegExp": {
          "type": "string"
        },
        "incidentTitleRegExp": {
          "type": "string"
        },
        "inclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileTypePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionFileNamePatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": []
    },
    "type": {
      "type": "string",
      "pattern": "SERVICENOWV2"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL"
      ]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type"
  ]
}

Slack テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部としてホスト URL を指定します。また、データソースのタイプを SLACK に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Slack JSON スキーマ」を参照してください。

次の表に、Slack JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
teamId Slack のメインページの URL からコピーした Slack チーム ID。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。
すべて Slack コンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
inclusionPatterns Slack データソースにある特定のコンテンツを含めるための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスに含まれます。パターンに一致しないコンテンツは、インデックスから除外されます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。
exclusionPatterns Slack データソースの特定のコンテンツを除外するための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスから除外されます。パターンに一致しないコンテンツは、インデックスに含まれます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。
crawlBotMessages true ボットメッセージをクロールする場合は にします。
excludeArchived アーカイブされたメッセージをクローリングから除外する場合は、true にします。
conversationType インデックスを作成する会話のタイプ (PUBLIC_CHANNEL、PRIVATE_CHANNEL、GROUP_MESSAGE、DIRECT_MESSAGE)。
channelFilter インデックスを作成するチャネルのタイプ (private_channel または public_channel)。
sinceDate Slack コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。
lookBack lookBack パラメータを設定すると、最後にコネクタを同期した時点までの指定された時間内に更新または削除されたコンテンツを、Slack コネクタがクロールするようにできます。
syncMode

データソースのコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。

  • FORCED_FULL_CRAWL は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。

  • FULL_CRAWL は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。

  • CHANGE_LOG は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。
type データソースのタイプ。データソースタイプとして SLACK を指定します。
enableIdentityCrawler Amazon Kendra の ID クローラーを使用して、特定のドキュメントへのアクセス権を持つユーザーおよびグループの ID/プリンシパル情報を同期する場合は、true にします。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに PutPrincipalMapping API を使用して、ユーザーとグループのアクセス情報をアップロードできます。
secretArn

Slack への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。

{
    "slackToken": "token"
}
version 現在サポートされているこのテンプレートのバージョン。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "teamId": {
              "type": "string"
            }
          },
          "required": ["teamId"]
        }
      }
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "All": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE","LONG"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      },
      "required": [
      ]
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "exclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "crawlBotMessages": {
          "type": "boolean"
        },
        "excludeArchived": {
          "type": "boolean"
        },
        "conversationType": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "PUBLIC_CHANNEL",
              "PRIVATE_CHANNEL",
              "GROUP_MESSAGE",
              "DIRECT_MESSAGE"
            ]
          }
        },
        "channelFilter": {
            "type": "object",
            "properties": {
              "private_channel": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "public_channel": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
          }
        },
        "channelIdFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "sinceDate": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
            },
            {
              "type": "string",
              "pattern": ""
            }
          ]
        },
        "lookBack": {
          "type": "string",
          "pattern": "^[0-9]*$"
        }
      },
      "required": [
      ]
    },
    "syncMode": {
      "type": "string",
      "enum": [
        "FORCED_FULL_CRAWL",
        "FULL_CRAWL",
        "CHANGE_LOG"
      ]
    },
    "type" : {
      "type" : "string",
      "pattern": "SLACK"
    },
    "enableIdentityCrawler": {
      "type": "boolean"
    },
    "secretArn": {
      "type": "string"
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "syncMode",
    "additionalProperties",
    "secretArn",
    "type",
    "enableIdentityCrawler"
  ]
}

Zendesk テンプレートスキーマ

データソーススキーマを含む JSON を TemplateConfiguration オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部としてホスト URL を指定します。また、データソースのタイプを ZENDESK に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、CreateDataSource を呼び出すときに Type として TEMPLATE を指定します。

このデベロッパーガイドで提供されているテンプレートを使用できます。「Zendesk JSON スキーマ」を参照してください。

次の表に、Zendesk JSON スキーマのパラメータとその説明を示しています。

設定 説明
connectionConfiguration データソースのエンドポイントの設定情報。
repositoryEndpointMetadata データソースのエンドポイント情報。
hostURL Zendesk のホスト URL。例えば、https://yoursubdomain.zendesk.com。
repositoryConfigurations データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。

  • ticket

  • ticketComment

  • ticketCommentAttachment

  • article

  • articleComment

  • articleAttachment

  • communityTopic

  • communityPostComment

 Zendesk チケットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「データソースフィールドのマッピング」を参照してください。
secretARN Zendesk への接続に必要なキーと値のペアが含まれている AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、ホスト URL、クライアント ID、クライアントシークレット、ユーザー名、パスワードのキーを含む JSON 構造が含まれている必要があります。
additionalProperties データソース内のコンテンツ用の追加設定オプション。
organizationNameFilter 特定の [組織] 内に存在するチケットのインデックスを作成できます。
sinceDate Zendesk コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。
inclusionPatterns Zendesk データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。
exclusionPatterns Zendesk データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。

  • isCrawlTicket

  • isCrawlTicketComment

  • isCrawlTicketCommentAttachment

  • isCrawlArticle

  • isCrawlArticleComment

  • isCrawlArticleAttachment

  • isCrawlCommunityTopic

  • isCrawlCommunityPost

  • isCrawlCommunityPostComment

 これらのタイプのコンテンツをクロールするには、true を入力します。
type データソースタイプとして ZENDESK を指定します。
useChangeLog Zendesk の変更ログを使用して、インデックス内の更新する必要があるドキュメントを特定するには、「true」を入力します。変更ログのサイズによっては、Zendesk でドキュメントをスキャンする方が速い場合があります。Zendesk データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "hostUrl": {
              "type": "string",
              "pattern": "https:.*"
            }
          },
          "required": [
            "hostUrl"
          ]
        }
      },
      "required": [
        "repositoryEndpointMetadata"
      ]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "ticket": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"

                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "ticketComment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"

                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "ticketCommentAttachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "article": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "communityPostComment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "articleComment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "articleAttachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        },
        "communityTopic": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "indexFieldName": {
                        "type": "string"
                      },
                      "indexFieldType": {
                        "type": "string",
                        "enum": ["STRING", "STRING_LIST", "LONG", "DATE"]
                      },
                      "dataSourceFieldName": {
                        "type": "string"
                      },
                      "dateFieldFormat": {
                        "type": "string",
                        "pattern": "dd-MM-yyyy HH:mm:ss"
                      }
                    },
                    "required": [
                      "indexFieldName",
                      "indexFieldType",
                      "dataSourceFieldName"
                    ]
                  }
                ]
              }
            }
          },
          "required": [
            "fieldMappings"
          ]
        }
      }
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "organizationNameFilter": {
          "type": "array"
        },
        "sinceDate": {
          "type": "string",
          "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$"
        },
        "inclusionPatterns": {
          "type": "array"
        },
        "exclusionPatterns": {
          "type": "array"
        },
        "isCrawTicket": {
          "type": "string"
        },
        "isCrawTicketComment": {
          "type": "string"
        },
        "isCrawTicketCommentAttachment": {
          "type": "string"
        },
        "isCrawlArticle": {
          "type": "string"
        },
        "isCrawlArticleAttachment": {
          "type": "string"
        },
        "isCrawlArticleComment": {
          "type": "string"
        },
        "isCrawlCommunityTopic": {
          "type": "string"
        },
        "isCrawlCommunityPost": {
          "type": "string"
        },
        "isCrawlCommunityPostComment": {
          "type": "string"
        }
      }
    },
    "type": {
      "type": "string",
      "pattern": "ZENDESK"
    },
    "useChangeLog": {
      "type": "string",
      "enum": ["true", "false"]
    }
  },
  "version": {
    "type": "string",
    "anyOf": [
      {
        "pattern": "1.0.0"
      }
    ]
  },
  "additionalProperties": false,
  "required": [
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties",
    "useChangeLog",
    "secretArn",
    "type"
  ]
}