翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # データソースコネクタの作成 のデータソースコネクタを作成して Amazon Kendra 、ドキュメントに接続してインデックスを作成できます。 は、Microsoft SharePoint、Google Drive、およびその他の多くのプロバイダーに接続 Amazon Kendra できます。データソースコネクタを作成するときは、ソースリポジトリへの接続に必要な Amazon Kendra 設定情報を指定します。ドキュメントをインデックスに直接追加する場合とは異なり、データソースを定期的にスキャンしてインデックスを更新できます。 たとえば、 Amazon S3 バケットに保存されている税ドキュメントのリポジトリがあるとします。ときどき、既存のドキュメントが変更され、新しいドキュメントが随時リポジトリに追加されます。リポジトリをデータソース Amazon Kendra として に追加する場合、データソースとインデックス間の定期的な同期を設定することで、インデックスを最新の状態に保つことができます。 コンソールまたは [StartDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StartDataSourceSyncJob.html) API を使用してインデックスを手動で更新することを選択できます。それ以外の場合は、インデックスを更新してデータソースと同期させるスケジュールを設定します。 インデックスには複数のデータソースを使用できます。各データソースには、独自の更新スケジュールを設定できます。例えば、アーカイブが変更されるたびに、アーカイブされたドキュメントを手動で更新しながら、作業中のドキュメントのインデックスを毎日更新したり、時間ごとに更新したりできます。 ドキュメント取り込みプロセス中にドキュメントメタデータまたは属性とコンテンツを変更する場合は、「[Amazon Kendra Custom Document Enrichment](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html)」を参照してください。 **注記** それぞれのドキュメント ID はインデックスごとに一意である必要があります。一意の ID でドキュメントにインデックスを付けるデータソースを作成してから、`BatchPutDocument` API を使用して同じドキュメントにインデックスを付けることはできません。その逆も同様です。データソースを削除してから `BatchPutDocument` API を使用して同じドキュメントにインデックスを付けることができます。その逆も可能です。`BatchPutDocument` および `BatchDeleteDocument` APIs を同じドキュメントセットの Amazon Kendra データソースコネクタと組み合わせて使用すると、データとの不整合が発生する可能性があります。代わりに、[Amazon Kendra カスタムデータソースコネクタ](https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html)の使用をお勧めします。 **注記** インデックスに追加されるファイルは、UTF-8 でエンコードされたバイトストリームに存在する必要があります。のドキュメントの詳細については Amazon Kendra、[「ドキュメント](https://docs.aws.amazon.com/kendra/latest/dg/hiw-documents.html)」を参照してください。 ## 更新スケジュールの設定 データソースを作成または更新するときに、コンソールか、または `Schedule` パラメータを使用して、データソースを定期的に更新するように構成します。パラメータの内容は、`cron` 形式スケジュール文字列、またはインデックスをオンデマンドで更新することを示す空の文字列のいずれかを保持する文字列です。cron 式の形式については、[「 ユーザーガイド」の「ルールのスケジュール式](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)」を参照してください。 は cron 式のみ Amazon Kendra をサポートしています。 *Amazon CloudWatch Events *rate 式はサポートしていません。 ## 言語設定 サポートされている言語で、データソース内のすべてのドキュメントにインデックスを作成できます。[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに、データソース内のすべてのドキュメントの言語コードを指定します。ドキュメントにメタデータフィールドで指定された言語コードがない場合、データソースレベルですべてのドキュメントに指定された言語コードを使用して、ドキュメントのインデックスが作成されます。言語を指定しない場合、 Amazon Kendra はデフォルトで英語でデータソースのドキュメントをインデックス作成します。コードを含む、サポートされている言語の詳細については、[英語以外の言語でドキュメントを追加する](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html)を参照してください。 コンソールを使用するサポートされている言語で、データソース内のすべてのドキュメントにインデックスを作成できます。新しいデータソースを追加する場合、**[データソース]** に移動してデータソースを編集するか、**[データソースを追加]** します。**[Specify data source details]** (データソースの詳細を指定) ページで、**[Language]** (言語) のドロップダウンから言語を選択します。**Update** (更新) を選択するか、続けて構成情報を入力してデータソースに接続します。 # データソースコネクタ このセクションでは、 および Amazon Kendra APIs Amazon Kendra で を使用して、サポートされているデータベース AWS マネジメントコンソール とデータソースリポジトリ Amazon Kendra に接続する方法について説明します。 **Topics** + [ # データソーステンプレートスキーマ ](ds-schemas.md) + [ # Adobe Experience Manager ](data-source-aem.md) + [ # Alfresco ](data-source-alfresco.md) + [ # Aurora(MySQL) ](data-source-aurora-mysql.md) + [ # Aurora(PostgreSQL) ](data-source-aurora-postgresql.md) + [ # Amazon FSx(Windows) ](data-source-fsx.md) + [ # Amazon FSx(NetApp ONTAP) ](data-source-fsx-ontap.md) + [ # Amazon RDS/Aurora ](data-source-database.md) + [ # Amazon RDS(Microsoft SQL Server) ](data-source-rds-ms-sql-server.md) + [ # Amazon RDS(MySQL) ](data-source-rds-mysql.md) + [ # Amazon RDS(Oracle) ](data-source-rds-oracle.md) + [ # Amazon RDS(PostgreSQL) ](data-source-rds-postgresql.md) + [ # Amazon S3 ](data-source-s3.md) + [ # Amazon Kendra ウェブクローラー ](data-source-web-crawler.md) + [ # Box ](data-source-box.md) + [ # Confluence ](data-source-confluence.md) + [ # カスタムデータソースコネクタ ](data-source-custom.md) + [ # Dropbox ](data-source-dropbox.md) + [ # Drupal ](data-source-drupal.md) + [ # GitHub ](data-source-github.md) + [ # Gmail ](data-source-gmail.md) + [ # Google ドライブ ](data-source-google-drive.md) + [ # IBM DB2 ](data-source-ibm-db2.md) + [ # Jira ](data-source-jira.md) + [ # Microsoft Exchange ](data-source-exchange.md) + [ # Microsoft OneDrive ](data-source-onedrive.md) + [ # Microsoft SharePoint ](data-source-sharepoint.md) + [ # Microsoft SQL Server ](data-source-ms-sql-server.md) + [ # Microsoft Teams ](data-source-teams.md) + [ # Microsoft Yammer ](data-source-yammer.md) + [ # MySQL ](data-source-mysql.md) + [ # Oracle Database ](data-source-oracle-database.md) + [ # PostgreSQL ](data-source-postgresql.md) + [ # Quip ](data-source-quip.md) + [ # Salesforce ](data-source-salesforce.md) + [ # ServiceNow ](data-source-servicenow.md) + [ # Slack ](data-source-slack.md) + [ # Zendesk ](data-source-zendesk.md) # データソーステンプレートスキーマ 以下は、テンプレートがサポートされているデータソースのテンプレートスキーマです。 **Topics** + [ ## Adobe Experience Manager テンプレートスキーマ ](#ds-aem-schema) + [ ## Amazon FSx (Windows) テンプレートスキーマ ](#ds-fsx-windows-schema) + [ ## Amazon FSx (NetApp ONTAP) テンプレートスキーマ ](#ds-fsx-ontap-schema) + [ ## Alfresco テンプレートスキーマ ](#ds-alfresco-schema) + [ ## Aurora (MySQL) テンプレートスキーマ ](#ds-aurora-mysql-schema) + [ ## Aurora (PostgreSQL) テンプレートスキーマ ](#ds-aurora-postgresql-schema) + [ ## Amazon RDS (Microsoft SQL Server) テンプレートスキーマ ](#ds-rds-ms-sql-server-schema) + [ ## Amazon RDS (MySQL) テンプレートスキーマ ](#ds-rds-mysql-schema) + [ ## Amazon RDS (Oracle) テンプレートスキーマ ](#ds-rds-oracle-schema) + [ ## Amazon RDS (PostgreSQL) テンプレートスキーマ ](#ds-rds-postgresql-schema) + [ ## Amazon S3 テンプレートスキーマ ](#ds-s3-schema) + [ ## Amazon Kendra ウェブクローラーテンプレートスキーマ ](#ds-schema-web-crawler) + [ ## Confluence テンプレートスキーマ ](#ds-confluence-schema) + [ ## Dropbox テンプレートスキーマ ](#ds-dropbox-schema) + [ ## Drupal テンプレートスキーマ ](#ds-drupal-schema) + [ ## GitHub テンプレートスキーマ ](#ds-github-schema) + [ ## Gmail テンプレートスキーマ ](#ds-gmail-schema) + [ ## Google Drive テンプレートスキーマ ](#ds-googledrive-schema) + [ ## IBM DB2 テンプレートスキーマ ](#ds-ibm-db2-schema) + [ ## Microsoft Exchange テンプレートスキーマ ](#ds-msexchange-schema) + [ ## Microsoft OneDrive テンプレートスキーマ ](#ds-onedrive-schema) + [ ## Microsoft SharePoint テンプレートスキーマ ](#ds-schema-sharepoint) + [ ## Microsoft SQL サーバーテンプレートスキーマ ](#ds-ms-sql-server-schema) + [ ## Microsoft Teams テンプレートスキーマ ](#ds-msteams-schema) + [ ## Microsoft Yammer テンプレートスキーマ ](#ds-schema-yammer) + [ ## MySQL テンプレートスキーマ ](#ds-mysql-schema) + [ ## Oracle Database テンプレートスキーマ ](#ds-oracle-database-schema) + [ ## PostgreSQL テンプレートスキーマ ](#ds-postgresql-schema) + [ ## Salesforce テンプレートスキーマ ](#ds-salesforce-schema) + [ ## ServiceNow テンプレートスキーマ ](#ds-servicenow-schema) + [ ## Slack テンプレートスキーマ ](#ds-schema-slack) + [ ## Zendesk テンプレートスキーマ ](#ds-schema-zendesk) ## Adobe Experience Manager テンプレートスキーマ データソーススキーマを含む JSON を [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) オブジェクトの一部として含めます。Adobe Experience Manager ホスト URL、認証タイプ、接続設定またはリポジトリエンドポイントの詳細の一部として、Adobe Experience Manager (AEM) をクラウドサービスとして使用するか AEM オンプレミスとして使用するかを指定します。また、データソースのタイプを `AEM` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。詳細については、「[Adobe Experience Manager JSON スキーマ](#aem-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\$1PREMISE)。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Adobe Experience Manager ページとアセットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | timeZoneId | AEM オンプレミスを使用し、サーバーのタイムゾーンが Amazon Kendra AEM コネクタまたはインデックスのタイムゾーンと異なる場合は、AEM コネクタまたはインデックスに合わせてサーバーのタイムゾーンを指定できます。 AEM オンプレミスのデフォルトのタイムゾーンは、 Amazon Kendra AEM コネクタまたはインデックスのタイムゾーンです。クラウドサービスとしての AEM のデフォルトのタイムゾーンはグリニッジ標準時です。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | ページとアセットのルートパスのリスト。例えば、ページのルートパスは /content/sub で、アセットのルートパスは /content/sub/asset1 という場合があります。 | | crawlAssets | アセットをクロールする場合は、true にします。 | | crawlPages | ページをクロールする場合は、true にします。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のページやアセットを Adobe Experience Manager データソースに含めるための正規表現のパターンのリスト。パターンに一致するページやアセットは、インデックスに含まれます。パターンに一致しないページやアセットは、インデックスから除外されます。ページやアセットが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Adobe Experience Manager データソースにある特定のページやアセットを除外するための正規表現のパターンのリスト。パターンに一致するページやアセットは、インデックスから除外されます。パターンに一致しないページやアセットは、インデックスに含まれます。ページやアセットが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | pageComponents | インデックスを作成する特定のページコンポーネントの名前のリスト。 | | contentFragmentVariations | インデックスを作成する Adobe Experience Manager コンテンツフラグメントの特定の保存済みバリエーションの名前のリスト。 | | 型 | データソースのタイプ。データソースタイプとして AEM を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | Adobe Experience Manager への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアの詳細については、「[Adobe Experience Manager の接続手順](https://docs.aws.amazon.com/kendra/latest/dg/data-source-aem.html#data-source-procedure-aem)」を参照してください。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Adobe Experience Manager JSON スキーマ ``` { "$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 を [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。ファイルシステム ID を接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `FSX` に指定し、認証情報のシークレット、およびその他の必要な設定も指定します。次に、[https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon FSx (Windows) JSON スキーマ](#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 インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | isCrawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | inclusionPatterns | Amazon FSx データソースに特定のファイルを含めるための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns | Amazon FSx データソース内の特定のファイルを除外する正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 型 | データソースのタイプ。Windows ファイルシステムデータソースの場合は、FSX を指定します。 | ### Amazon FSx (Windows) JSON スキーマ ``` { "$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 を [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。ファイルシステム ID とストレージ仮想マシン (SVM) を、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `FSXONTAP` に指定し、認証情報のシークレット、およびその他の必要な設定も指定します。次に、[https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon FSx (NetApp ONTAP) JSON スキーマ](#fsx-ontap-json)」を参照してください。 次の表に、 Amazon FSx (NetApp ONTAP) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | fileSystemId | Amazon FSx ファイルシステムの識別子。ファイルシステム ID は、 Amazon FSx コンソールのファイルシステムダッシュボードにあります。NetApp ONTAP の Amazon FSx コンソールでファイルシステムを作成する方法については、「 FSx for ONTAP ユーザーガイド」の[NetApp ONTAP 入門ガイド](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/getting-started.html)」を参照してください。 | | fileSystemType | Amazon FSx ファイルシステムタイプ。NetApp ONTAPをファイルシステムのタイプとして使用するには、ONTAP を指定します。 | | svmId | NetApp ONTAP 用の Amazon FSx ファイルシステムで使用されるストレージ仮想マシン (SVM) の識別子。SVM ID を見つけるには、 Amazon FSx コンソールのファイルシステムダッシュボードに移動し、ファイルシステム ID を選択してから、Storage 仮想マシンを選択します。の Amazon FSx コンソールでファイルシステムを作成する方法についてはNetApp ONTAP、「 FSx for ONTAP ユーザーガイド」の[NetApp ONTAP 入門ガイド](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/getting-started.html)」を参照してください。 | | protocolType | Windows 用の共通インターネットファイルシステム (CIFS) プロトコルを使用するのか、Linux 用のネットワークファイルシステム (NFS) プロトコルを使用するのかを指定します。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | および | Amazon FSx データソース内のファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。データソースのフィールド名は、ファイルのカスタムメタデータ内に存在する必要があります。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | crawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | inclusionPatterns | Amazon FSx データソースに特定のファイルを含めるための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns | Amazon FSx データソース内の特定のファイルを除外する正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | 型 | データソースのタイプ。NetApp ONTAP ファイルシステムのデータソースには、FSXONTAP を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 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"
}
| ### Amazon FSx (NetApp ONTAP) JSON スキーマ ``` { "$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 を [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) オブジェクトの一部として含めます。Alfresco サイト ID、リポジトリ URL、ユーザーインターフェイス URL、認証タイプ、クラウドとオンプレミスのどちらを使用するか、クロールするコンテンツのタイプを指定します。これは接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `ALFRESCO` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Alfresco JSON スキーマ](#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\$1ID (特定の Alfresco サイト内のコンテンツ)、または ALL\$1SITES (すべての Alfresco サイトにわたるコンテンツ) のいずれかです。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Alfresco ドキュメントとコメントの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | aspectName | インデックスを作成する特定の「アスペクト」の名前。 | | aspectProperties | インデックスを作成する特定の「アスペクト」コンテンツプロパティのリスト。 | | enableFineGrainedControl | 「アスペクト」をクロールする場合は、`true` にします。 | | isCrawlComment | `true` に設定すると、コメントをクロールします。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のファイルを Alfresco データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Alfresco データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | 型 | データソースのタイプ。データソースタイプとして ALFRESCO を指定します。 | | secretArn | への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)Alfresco。シークレットには、次のキーを持つ JSON 構造を含める必要があります。 基本認証を使用している場合。 
{
    "username": "user name",
    "password": "password"
}
OAuth 2.0 認証を使用している場合。 
{
    "clientId": "client ID",
    "clientSecret": "client secret",
    "tokenUrl": "token URL"
}
| | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Alfresco JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `mysql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Aurora (MySQL) JSON スキーマ](#aurora-mysql-json)」を参照してください。 次の表に、 Aurora (MySQL) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Aurora (MySQL) JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `postgresql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Aurora (PostgreSQL) JSON スキーマ](#aurora-postgresql-json)」を参照してください。 次の表に、 Aurora (PostgreSQL) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Aurora (PostgreSQL) JSON スキーマ ``` { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties": { "connectionConfiguration": { "type": "object", "properties": { "repositoryEndpointMetadata": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "mysql", "db2", "postgresql", "oracle", "sqlserver" ] }, "dbHost": { "type": "string" }, "dbPort": { "type": "string" }, "dbInstance": { "type": "string" } }, "required": [ "dbType", "dbHost", "dbPort", "dbInstance" ] } }, "required": [ "repositoryEndpointMetadata" ] }, "repositoryConfigurations": { "type": "object", "properties": { "document": { "type": "object", "properties": { "fieldMappings": { "type": "array", "items": [ { "type": "object", "properties": { "indexFieldName": { "type": "string" }, "indexFieldType": { "type": "string" }, "dataSourceFieldName": { "type": "string" } }, "required": [ "indexFieldName", "indexFieldType", "dataSourceFieldName" ] } ] } }, "required": [ "fieldMappings" ] } }, "required": [ ] }, "additionalProperties": { "type": "object", "properties": { "primaryKey": { "type": "string" }, "titleColumn": { "type": "string" }, "bodyColumn": { "type": "string" }, "sqlQuery": { "type": "string", "not": { "pattern": ";+" } }, "timestampColumn": { "type": "string" }, "timestampFormat": { "type": "string" }, "timezone": { "type": "string" }, "changeDetectingColumns": { "type": "array", "items": { "type": "string" } }, "allowedUsersColumn": { "type": "string" }, "allowedGroupsColumn": { "type": "string" }, "sourceURIColumn": { "type": "string" }, "isSslEnabled": { "type": "boolean" } }, "required": ["primaryKey", "titleColumn", "bodyColumn", "sqlQuery"] }, "type" : { "type" : "string", "pattern": "JDBC" }, "syncMode": { "type": "string", "enum": [ "FORCED_FULL_CRAWL", "FULL_CRAWL", "CHANGE_LOG" ] }, "secretArn": { "type": "string" } }, "version": { "type": "string", "anyOf": [ { "pattern": "1.0.0" } ] }, "required": [ "connectionConfiguration", "repositoryConfigurations", "syncMode", "additionalProperties", "secretArn", "type" ] } ``` ## Amazon RDS (Microsoft SQL Server) テンプレートスキーマ データソーススキーマを含む JSON を [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `sqlserver` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon RDS (Microsoft SQL Server) JSON スキーマ](#rds-ms-sql-server-json)」を参照してください。 次の表に、 Amazon RDS (Microsoft SQL Server) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Amazon RDS (Microsoft SQL Server) JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `mysql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon RDS (MySQL) JSON スキーマ](#rds-mysql-json)」を参照してください。 次の表に、 Amazon RDS (MySQL) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Amazon RDS (MySQL) JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `oracle` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon RDS (Oracle) JSON スキーマ](#rds-oracle-json)」を参照してください。 次の表に、 Amazon RDS (Oracle) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Amazon RDS (Oracle) JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `postgresql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon RDS (PostgreSQL) JSON スキーマ](#rds-postgresql-json)」を参照してください。 次の表に、 Amazon RDS (PostgreSQL) JSON スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Amazon RDS (PostgreSQL) JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[S3 JSON スキーマ](#s3-json)」を参照してください。 次の表に、JSON Amazon S3 スキーマのパラメータを示します。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | BucketName | Amazon S3 バケットの名前。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Amazon S3 データソース内の特定のファイルを含めるか除外する正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | aclConfigurationFilePath | Amazon Kendra インデックス内のドキュメントへのアクセスを制御するファイルパス。 | | metadataFilesPrefix | バケット内のメタデータファイルの場所。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 型 | データソースのタイプ。データソースタイプとして S3 を指定します。 | | バージョン | サポートされているテンプレートのバージョン。 | ### S3 JSON スキーマ ``` { "$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 を [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) オブジェクトの一部として含めます。 接続設定またはリポジトリエンドポイントの詳細の一部として、シード URL または開始ポイント URL を指定するか、サイトマップ URL を指定できます。すべての URLs を手動で一覧表示する代わりに、シード URLs またはサイトマップ XML ファイルのリストのテキストファイルを保存する Amazon S3 バケットへのパスを指定できます。このパスは、S3 の ZIP ファイルでまとめることができます。 また、データソースのタイプを `WEBCRAWLERV2` として指定し、ウェブサイト認証情報と認証タイプ (ウェブサイトで認証が必要な場合)、およびその他の必要な設定も指定します。 次に、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 **重要** Web Crawler v2.0 コネクタの作成は ではサポートされていません CloudFormation。 CloudFormation サポートが必要な場合は、Web Crawler v1.0 コネクタを使用します。 *インデックス作成するウェブサイトを選択するときは、[Amazon 利用規定ポリシー](https://aws.amazon.com/aup/)およびその他の Amazon 規約のすべてに準拠している必要があります。Web Amazon Kendra Crawler は、独自のウェブページ、またはインデックス作成の権限を持つウェブページのインデックス作成にのみ使用する必要があることに注意してください。 Amazon Kendra ウェブクローラーによるウェブサイトのインデックスの作成を停止する方法については、「[Amazon Kendra Web Crawler の `robots.txt` ファイルの設定](stop-web-crawler.md)」を参照してください。* このデベロッパーガイドで提供されているテンプレートを使用できます。「[Amazon Kendra ウェブクローラー JSON スキーマ](#web-crawler-json)」を参照してください。 次の表に、 Amazon Kendra Web Crawler 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 件まで一覧表示できます。複数のサイトマップファイルを ZIP ファイルにまとめ、その ZIP ファイルを Amazon S3 バケットに保存できます。 | | seedUrlConnections | クロールするウェブサイトのシードまたは開始ポイント URL のリスト。最大 100 件のシード URL を一覧表示できます。 | | seedUrl | シードまたは開始点 URL。 | | 認証 | ウェブサイトが同じ認証を必要とする場合は認証タイプ、それ以外の場合は、NoAuthentication を指定します。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | ウェブページとウェブページファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。例えば、HTML ウェブページのタイトルタグを \$1document\$1title インデックスフィールドにマッピングできます。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 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 できるかどうかにかかわらず、 Amazon Kendra Web Crawler がウェブサイトをクロールする方法を制御します。 | | crawlAttachments | ウェブページのリンク先のファイルをクロールする場合は、true にします。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定の URL のクロールや、これらの URL ウェブページ上のハイパーリンクのインデックス作成を含む正規表現パターンのリスト。パターンに一致する URL は、インデックスに含まれます。パターンに一致しない URL は、インデックスから除外されます。URL が包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、その URL/ウェブサイトのウェブページはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定の URL のクロールや、これらの URL ウェブページ上のハイパーリンクのインデックス作成を除外する正規表現パターンのリスト。パターンに一致する URL は、インデックスから除外されます。パターンに一致しない URL は、インデックスに含まれます。URL が包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、その URL/ウェブサイトのウェブページはインデックスに含まれません。 | | inclusionFileIndexPatterns | 特定のウェブページを含めるための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionFileIndexPatterns | 特定のウェブページを除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | implicitWaitDuration | implicitWaitDuration は、ウェブページをクローリングする前にコネクタが待機する時間を秒単位で指定します。 範囲: 0～10 例: "implicitWaitDuration": "5" | | proxy | ウェブプロキシ経由で内部ウェブサイトに接続するために必要となる構成情報。 | | ホスト | 内部ウェブサイトへの接続に使用するプロキシサーバーのホストの名前。例えば、https://a.example.com/page1.html のホスト名は 「a.example.com」です。 | | port | 内部ウェブサイトへの接続に使用するプロキシサーバーのポート数。例えば、443 は HTTPS の標準ポートです。 | | secretArn (proxy) | ウェブサイトホストに接続するためにウェブプロキシ認証情報が必要な場合は、認証情報を保存する AWS Secrets Manager シークレットを作成できます。シークレットの Amazon リソースネーム (ARN) を指定します。 | | 型 | データソースのタイプ。データソースタイプとして 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 は、シークレットに含まれるエンドポイント情報 (シード URLs) が、データソースエンドポイント設定の詳細で指定されたエンドポイント情報と同じかどうかも確認します。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Amazon Kendra ウェブクローラー JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、Confluence ホスト URL、ホスティング方法、認証タイプを指定します。また、データソースのタイプを `CONFLUENCEV2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Confluence JSON スキーマ](#confluence-json)」を参照してください。 次の表に、Confluence JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | hostUrl | Confluence インスタンスの URL。例えば、https://example.confluence.com などです。 | | 型 | Confluence インスタンスのホスティング方法 (SAAS およびON\$1PREM)。 | | authType | Confluence インスタンスの認証方法 (Basic、OAuth2、Personal-token)。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Confluence スペース、ページ、ブログ、コメント、添付ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。Confluence データソースのフィールド名は、Confluence カスタムメタデータ内に存在する必要があります。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | isCrawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL には、ユーザーとグループがアクセスできるドキュメントが指定されている点に留意してください。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。つまり、isCrawlACL をオフにすると、ドキュメントは公開され検索可能となります。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | fieldForUserId | ユーザー ID にユーザーの E メールを使用する場合は email を指定します。email はデフォルトで使用され、現在サポートされている唯一のユーザー ID タイプです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Confluence データソースに特定のファイルを含めるか、除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | proxyHost | 使用しているウェブプロキシのホスト名 (http:// または https:// のプロトコルは含めません)。 | | proxyPort | ホスト URL トランスポートプロトコルが使用するポート番号。これは 0～65535 の範囲の値にする必要があります。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Confluence のパーソナルスペース、ページ、ブログ、ページコメント、ページ添付ファイル、ブログコメント、ブログコメント、ブログ添付ファイル内のファイルをクロールする場合は、true に設定します。 | | maxFileSizeInMegaBytes | クロール Amazon Kendra できるファイルサイズ制限を MBs 単位で指定します。 Amazon Kendra 定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。 | | 型 | データソースのタイプ。データソースタイプとして CONFLUENCEV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretARN | Confluence への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアの詳細については、「[Confluence の接続手順](https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-confluence.html#data-source-procedure-v2-confluence)」を参照してください。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Confluence JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。認証情報を保存するシークレットの一部として、Dropbox アプリキー、アプリシークレット、アクセストークンを指定します。データソースのタイプを `DROPBOX` として指定し、使用するアクセストークンのタイプ (一時的または永続的)、その他の必要な設定も指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Dropbox JSON スキーマ](#dropbox-json)」を参照してください。 次の表に、Dropbox JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。むしろ、接続情報は、 を指定する AWS Secrets Manager シークレットに含まれますsecretArn。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Dropbox ファイル、Dropbox Paper、ショートカットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | secretARN | Dropbox への接続に必要なキーと値のペアを含む 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](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のファイルを Dropbox データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Dropbox データソース内の特定のファイル名とタイプを除外するための正規表現パターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Dropbox ファイル、Dropbox Paper ドキュメント、Dropbox Paper テンプレート、および Dropbox に保存されているウェブページのショートカットをクロールする場合は、true にします。 | | 型 | データソースのタイプ。データソースタイプとして DROPBOX を指定します。 | | tokenType | アクセストークンのタイプ (永続的アクセストークンまたは一時アクセストークン) を指定します。4 時間後に有効期限が切れる 1 回限りのアクセストークンに頼るのではなく、Dropbox で有効期限が切れることのない更新アクセストークンを作成することをお勧めします。Dropbox デベロッパーコンソールでアプリと更新アクセストークンを作成し、シークレットでアクセストークンを渡します。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Dropbox JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、Drupal ホスト URL と認証タイプを指定します。また、データソースのタイプを DRUPAL に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Drupal JSON スキーマ](#drupal-json)」を参照してください。 次の表に、Drupal JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | hostUrl | Drupal ウェブサイトのホスト URL。例えば、https:///。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Drupal ファイルの属性またはフィールド名をマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。Drupal データソースのフィールド名は、Drupal カスタムメタデータ内に存在する必要があります。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Drupal データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Drupal データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | contentDefinitions[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | クロールするコンテンツタイプと、選択したコンテンツタイプのコメントと添付ファイルをクロールするかどうかを指定します。 | | 型 | データソースのタイプ。データソースタイプとして DRUPAL を指定します。 | | authType | 使用する認証のタイプ (BASIC-AUTH または OAUTH2)。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) 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"
}
| | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Drupal JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) オブジェクトの一部として含めます。GitHub ホスト URL、組織名、および接続設定またはリポジトリエンドポイントの詳細の一部として GitHub クラウドと GitHub オンプレミスのどちらを使用するかの情報を指定します。また、データソースのタイプを `GITHUB` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[GitHub JSON スキーマ](#github-json)」を参照してください。 次の表に、GitHub JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | 型 | タイプとして SAAS または ON\$1PREMISE のいずれかを指定します。 | | hostUrl | GitHub ホスト URL。例えば、GitHub SaaS/Enterprise Cloud を使用する場合は https://api.github.com です。または、GitHub オンプレミス/Enterprise Server を使用の場合は https://on-prem-host-url/api/v3/ です。 | | organizationName | 組織名を確認するには、GitHub デスクトップにログインし、プロファイル写真のドロップダウンから [組織] に移動します。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | GitHub コンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | isCrawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | 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 を指定します。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | GitHub データソースにある特定のコンテンツを含めるための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスに含まれます。パターンに一致しないコンテンツは、インデックスから除外されます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | GitHub データソースにある特定のコンテンツを除外するための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスから除外されます。パターンに一致しないコンテンツは、インデックスに含まれます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | 型 | データソースのタイプ。データソースタイプとして GITHUB を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | GitHub への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。 
{
    "personalToken": "token"
}
| | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### GitHub JSON スキーマ 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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `GMAIL` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Gmail JSON スキーマ](#gmail-json)」を参照してください。 次の表に、Gmail JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。むしろ、接続情報は、 を指定する AWS Secrets Manager シークレットに含まれますsecretArn。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Gmail メッセージと添付ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Gmail データソースにある特定の件名のメールを含めるまたは除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | beforeDateFilter | 特定の日付より前に含めるメッセージと添付ファイルを指定します。 | | afterDateFilter | 特定の日付以降に含めるメッセージと添付ファイルを指定します。 | | isCrawlAttachment | 添付ファイルをクロールするかどうかを選択するブール値。メッセージは自動的にクロールされます。 | | 型 | データソースのタイプ。データソースタイプとして GMAIL を指定します。 | | shouldCrawlDraftMessages | ドラフトメッセージをクロールするかどうかを選択するブール値。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) 完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は、以下のようになります。 Gmail から完全に削除されたメッセージは、 Amazon Kendra インデックスから削除されません Gmail のメールラベルの変更は同期されません。 Gmail データソースラベルの変更と完全に削除された E メールメッセージを Amazon Kendra インデックスに同期するには、定期的にフルクロールを実行する必要があります。 | | secretARN | Gmail への接続に必要なキーと値のペアが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "adminAccountEmailId": "service account email",
    "clientEmailId": "user account email",
    "privateKey": "private key"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Gmail JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `GOOGLEDRIVE2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Google Drive JSON スキーマ](#googledrive-json)」を参照してください。 次の表に、Google Drive JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースに関する設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。このデータソースはエンドポイントを指定していません。認証タイプを選択します。serviceAccount と OAuth2。接続情報は、 を指定する AWS Secrets Manager シークレットに含まれていますsecretArn。 | | authType | ユースケースに基づいて serviceAccount と OAuth2 のどちらかを選んでください。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive の属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | クロール Amazon Kendra するファイルサイズの制限を MBs 単位で指定します。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive データソース内のコメントをクロールする場合は、true にします。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive のデータソースにある MyDrive と Shared With Me Drive をクロールする場合は、true にします。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive のデータソース内の共有ドライブをクロールする場合は、true にします。 | | isCrawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Google Drive データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | 型 | データソースのタイプ。データソースタイプとして GOOOGLEDRIVEV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretARN | Google ドライブへの接続に必要なキーと値のペアを含む 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"
}
| | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Google Drive JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `db2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[IBM DB2 JSON スキーマ](#ibm-db2-json)」を参照してください。 次の表に、IBM DB2 JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### IBM DB2 JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。テナント ID は、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `MSEXCHANGE` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Microsoft Exchange JSON スキーマ](#msexchange-json)」を参照してください。 次の表に、Microsoft Exchange JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | tenantId | Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Exchange データソースの属性またはフィールド名を Amazon Kendra インデックスフィールドにマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | inclusionPatterns | Microsoft Exchange のデータソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns | Microsoft Exchange のデータソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Exchange のデータソースにある特定のユーザーおよびユーザーファイルを含めるための正規表現のパターンのリスト。パターンに一致するユーザーは、インデックスに含まれます。パターンに一致しないユーザーは、インデックスから除外されます。ユーザーが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのユーザーはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Exchange のデータソースにある特定のユーザーおよびユーザーファイルを除外するための正規表現のパターンのリスト。パターンに一致するユーザーは、インデックスから除外されます。パターンに一致しないユーザーは、インデックスに含まれます。ユーザーが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのユーザーはインデックスに含まれません。 | | s3bucketName | S3 バケットの名前 (使用する場合)。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Exchange データソースのこれらのタイプのコンテンツとアクセスコントロール情報をクロールする場合は、true を指定します。 | | startCalendarDateTime | カレンダーのコンテンツには特定の開始日時を設定できます。 | | endCalendarDateTime | カレンダーのコンテンツには特定の終了日時を設定できます。 | | subject | メールコンテンツには特定の件名を設定できます。 | | emailFrom | 「差出人」または送信者のメールコンテンツに特定のメールを設定できます。 | | emailTo | 「宛先」または受信者のメールコンテンツに特定のメールを設定できます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 型 | データソースのタイプ。データソースタイプとして MSEXCHANGE を指定します。 | | secretARN | Microsoft Exchange への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Azure Portal で OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Microsoft Exchange JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。テナント ID は接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `ONEDRIVEV2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Microsoft OneDrive JSON スキーマ](#onedrive-json)」を参照してください。 次の表に、Microsoft OneDrive JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | tenantId | Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | および | Microsoft OneDrive ファイルの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のファイル、OneNote セクション、OneNote ページのインデックスを作成したり、ユーザー名でフィルタリングできます。 | | isUserNameOnS3 | Amazon S3に保存されているファイル内のユーザー名のリストを提供する場合は、true にします。 | | 型 | データソースのタイプ。データソースタイプとして ONEDRIVEV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | 型 | データソースのタイプ。データソースタイプとして ONEDRIVEV2 を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretARN | Microsoft OneDrive への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "clientId": "client ID",
    "clientSecret": "client secret"
}
| | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Microsoft OneDrive JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、SharePoint サイト URL、ドメインを指定し、必要に応じてテナント ID も指定します。また、データソースのタイプを `SHAREPOINTV2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに **[タイプ]** として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[SharePoint JSON スキーマ](#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\$1RefreshToken、NTLM、または Kerberos)。 | | バージョン | 使用する SharePoint のバージョン (Server または Online)。 | | onPremVersion | 使用する SharePoint Server のバージョン (2013、2016、2019、または SubscriptionEdition)。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | SharePoint コンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | SharePoint データソース内の特定のコンテンツを含めるか、除外するための正規表現パターンのリスト。包含パターンに一致するコンテンツ項目は、インデックスに含まれます。包含パターンに一致しないコンテンツ項目は、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | これらのタイプのコンテンツをクロールする場合は、true を指定します。 | | crawlAcl | アクセスコントロールリスト (ACL) があり、それをアクセス制御に使用したい場合は、true に設定すると、ドキュメントの ACL 情報をクロールします。ACL では、ユーザーとグループがアクセスおよび検索できるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 | | fieldForUserId | ユーザー ID にユーザーの E メールを使用する場合は email、ユーザー ID にユーザー名を使用する場合は userPrincipalName を指定します。値を指定しない場合、デフォルトで email が適用されます。 | | aclConfiguration | ACLWithLDAPEmailFmt、ACLWithManualEmailFmt、または ACLWithUsernameFmtM のいずれかを指定します。 | | emailDomain | E メールのドメイン。例: "amazon.com"。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | グループマッピング情報をクロールする場合は、true を指定します。 | | proxyHost | 使用しているウェブプロキシのホスト名 (http:// または https:// のプロトコルは含めません)。 | | proxyPort | ホスト URL トランスポートプロトコルが使用するポート番号。これは 0～65535 の範囲の値にする必要があります。 | | 型 | データソースタイプとして SHAREPOINTV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretARN | SharePoint への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これらのキーと値のペアについては、「[Connection instructions for SharePoint Online and SharePoint Server](https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-sharepoint.html#data-source-procedure-v2-sharepoint)」を参照してください。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ## SharePoint JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `sqlserver` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Microsoft SQL サーバー JSON スキーマ](#ms-sql-server-json)」を参照してください。 次の表に、Micorosft SQL Server JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Microsoft SQL サーバー JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。テナント ID は、接続設定またはリポジトリエンドポイントの詳細の一部として指定します。また、データソースのタイプを `MSTEAMS` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Microsoft Teams JSON スキーマ](#msteams-json)」を参照してください。 次の表に、Microsoft Teams JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | tenantId | Microsoft 365 テナント ID。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Teams コンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | paymentModel | Microsoft Teams データソースで使用する支払いモデルのタイプを指定します。モデル A の支払いモデルは、セキュリティコンプライアンスを必要とするライセンスモデルと支払いモデルに限定されます。モデル B の支払いモデルは、セキュリティコンプライアンスを必要としないライセンスモデルや支払いモデルに適しています。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Teams データソースにある特定のコンテンツを含めるための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスに含まれます。パターンに一致しないコンテンツは、インデックスから除外されます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Teams のデータソースにある特定のコンテンツを除外するための正規表現のパターンのリスト。パターンに一致するコンテンツは、インデックスから除外されます。パターンに一致しないコンテンツは、インデックスに含まれます。コンテンツが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのコンテンツはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Teams データソース内のこれらのタイプのコンテンツをクロールする場合は、true を指定します。 | | startCalendarDateTime | カレンダーのコンテンツには特定の開始日時を設定できます。 | | endCalendarDateTime | カレンダーのコンテンツには特定の終了日時を設定できます。 | | 型 | データソースのタイプ。データソースタイプとして MSTEAMS を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | Microsoft Teams への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Azure Portal で OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。 | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Microsoft Teams JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `YAMMER` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに **[タイプ]** として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。 次の表に、Microsoft Yammer JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースに関する設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。このデータソースは repositoryEndpointMetadata のエンドポイントを指定していません。むしろ、接続情報は、 を指定する AWS Secrets Manager シークレットに含まれますsecretArn。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Microsoft Yammer の属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | inclusionPatterns | Microsoft Yammer データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns | Microsoft Yammer データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | sinceDate | Microsoft Yammer コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。 | | communityNameFilter | 特定のコミュニティコンテンツのインデックスを作成できます。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | メッセージ、メッセージの添付ファイル、プライベートメッセージをクロールする場合は、true にします。 | | 型 | データソースタイプとして YAMMER を指定します。 | | secretARN | Microsoft Yammer への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。これには、Microsoft Yammer のユーザー名とパスワード、Azure ポータルで OAuth アプリケーションを作成したときに生成されるクライアント ID とクライアントシークレットが含まれます。 | | useChangeLog | Microsoft Yammer の変更ログを使用して、インデックス内の更新する必要があるドキュメントを特定する場合は、true にします。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | ### Microsoft Yammer JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `mysql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[MySQL JSON スキーマ](#mysql-json)」を参照してください。 次の表に、MySQL JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### MySQL JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `oracle` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Oracle Database JSON スキーマ](#oracle-database-json)」を参照してください。 次の表に、Oracle Database JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### Oracle Database JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。データソースのタイプを `JDBC` に指定し、データベースタイプを `postgresql` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[PostgreSQL JSON スキーマ](#postgresql-json)」を参照してください。 次の表に、PostgreSQL JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースの接続に必要な設定情報。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。データソースのタイプとシークレット ARN を指定します。 | | ドキュメント | データベースコンテンツの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。データベースデータソースに特定のコンテンツを含めたり除外したりするのに使用します。 | | primaryKey | データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 | | titleColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | bodyColumn | データベーステーブル内の文書タイトル列の名前を指定します。 | | sqlQuery | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | timestampColumn | タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報 Amazon Kendra を使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 | | timestampFormat | コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプ形式を含む列の名前を入力します。 | | timezone | クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 | | changeDetectingColumns | Amazon Kendra がコンテンツの変更を検出するために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再 Amazon Kendra 作成します。 | | allowedUsersColumns | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | allowedGroupsColumn | コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 | | sourceURIColumn | インデックスを作成するソース URL を含む列の名前を入力します。 | | isSslEnabled | SELECT や JOIN 操作などの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。 Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 | | 型 | データソースのタイプ。データソースタイプとして JDBC を指定します。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | secretArn | データベースに接続するためのユーザー名とパスワードが含まれている Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、次のキーを持つ JSON 構造を含める必要があります。
{
    "user name": "database user name",
    "password": "password"
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### PostgreSQL JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として Salesforce ホスト URL を指定します。また、データソースのタイプを `SALESFORCEV2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Salesforce JSON スキーマ](#salesforce-json)」を参照してください。 次の表に、Salesforce JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | hostUrl | インデックスを作成する Salesforce インスタンスの URL。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Salesforce エンティティの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | 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 | データソース内のコンテンツ用の追加設定オプション。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | フィルタリングするエンティティを指定する文字列のコレクション。 | | inclusionPatterns [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のファイルを Salesforce データソースに含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | 特定のファイルを Salesforce データソースから除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Salesforce アカウントのこれらのタイプのファイルをクロールする場合は、true にします。 | | 型 | データソースのタイプ。データソースタイプとして SALESFORCEV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Salesforce JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部として、ServiceNow ホスト URL、認証タイプ、およびインスタンスバージョンを指定します。また、データソースのタイプを `SERVICENOWV2` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[ServiceNow JSON スキーマ](#servicenow-json)」を参照してください。 次の表に、ServiceNow JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | hostUrl | ServiceNow ホスト URL。例えば、your-domain.service-now.com です。 | | authType | 使用する認証のタイプ (basicAuth または OAuth2)。 | | servicenowInstanceVersion | 使用する ServiceNow のバージョン。Tokyo、Sandiego、Rome、および Others のいずれかを選択できます。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | ServiceNow ナレッジ記事、添付ファイル、サービスカタログ、およびインシデントの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。ServiceNow データソースのフィールド名は、ServiceNow カスタムメタデータ内に存在する必要があります。 | | その他のプロパティ | データソース内のコンテンツ用の追加設定オプション。 | | maxFileSizeInMegaBytes | Amazon Kendra がクロールするファイルサイズの上限を MB 単位で指定します。Amazon Kendra は、ユーザーが定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | ServiceNow データソースにある特定のファイルを含めるか、除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | ServiceNow ナレッジ記事、サービスカタログ、インシデント、および添付ファイルをクロールする場合は、true にします。 | | 型 | データソースのタイプ。データソースタイプとして SERVICENOWV2 を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 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"         
}
| | バージョン | 現在サポートされているテンプレートのバージョン。 | ### ServiceNow JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部としてホスト URL を指定します。また、データソースのタイプを `SLACK` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Slack JSON スキーマ](#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\$1CHANNEL、PRIVATE\$1CHANNEL、GROUP\$1MESSAGE、DIRECT\$1MESSAGE)。 | | channelFilter | インデックスを作成するチャネルのタイプ (private\$1channel または public\$1channel)。 | | sinceDate | Slack コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。 | | lookBack | lookBack パラメータを設定すると、最後にコネクタを同期した時点までの指定された時間内に更新または削除されたコンテンツを、Slack コネクタがクロールするようにできます。 | | syncMode | データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。以下のいずれかから選択できます。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | | 型 | データソースのタイプ。データソースタイプとして SLACK を指定します。 | | enableIdentityCrawler | true は、 Amazon Kendraの ID クローラを使用して、特定のドキュメントにアクセスできるユーザーとグループの ID/プリンシパル情報を同期します。ID クローラーがオフになっている場合は、すべてのドキュメントが検索可能として公開されます。ID クローラーがオフになっているときにドキュメントのアクセス制御を使用する場合は、代わりに [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html) API を使用して、ユーザーとグループのアクセス情報をアップロードできます。 | | secretArn | への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)Slack。シークレットには、次のキーを持つ JSON 構造を含める必要があります。 
{
    "slackToken": "token"
}
| | バージョン | 現在サポートされているこのテンプレートのバージョン。 | ### Slack JSON スキーマ ``` { "$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](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトの一部として含めます。接続設定またはリポジトリエンドポイントの詳細の一部としてホスト URL を指定します。また、データソースのタイプを `ZENDESK` に指定します。認証情報のシークレット、およびその他の必要な設定を指定します。次に、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに `Type` として `TEMPLATE` を指定します。 このデベロッパーガイドで提供されているテンプレートを使用できます。「[Zendesk JSON スキーマ](#zendesk-json)」を参照してください。 次の表に、Zendesk JSON スキーマのパラメータとその説明を示しています。 | 設定 | 説明 | | --- | --- | | connectionConfiguration | データソースのエンドポイントの設定情報。 | | repositoryEndpointMetadata | データソースのエンドポイント情報。 | | hostURL | Zendesk のホスト URL。例えば、https://yoursubdomain.zendesk.com。 | | repositoryConfigurations | データソースのコンテンツに関する設定情報。例えば、特定のタイプのコンテンツやフィールドマッピングの設定などです。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | Zendesk チケットの属性またはフィールド名を Amazon Kendra インデックスフィールド名にマッピングするオブジェクトのリスト。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 | | secretARN | Zendesk への接続に必要なキーと値のペアを含む AWS Secrets Manager シークレットの Amazon リソースネーム (ARN)。シークレットには、ホスト URL、クライアント ID、クライアントシークレット、ユーザー名、パスワードのキーを含む JSON 構造が含まれている必要があります。 | | additionalProperties | データソース内のコンテンツ用の追加設定オプション。 | | organizationNameFilter | 特定の [組織] 内に存在するチケットのインデックスを作成できます。 | | sinceDate | Zendesk コネクタが特定の sinceDate に基づいてコンテンツをクロールするように sinceDate パラメータを設定できます。 | | inclusionPatterns | Zendesk データソースにある特定のファイルを含めるための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスに含まれます。パターンに一致しないファイルは、インデックスから除外されます。ファイルが包含パターンと除外パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | exclusionPatterns | Zendesk データソースにある特定のファイルを除外するための正規表現のパターンのリスト。パターンに一致するファイルは、インデックスから除外されます。パターンに一致しないファイルは、インデックスに含まれます。ファイルが除外パターンと包含パターンの両方に一致する場合、除外パターンが優先され、そのファイルはインデックスに含まれません。 | | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/ds-schemas.html) | これらのタイプのコンテンツをクロールするには、true を入力します。 | | 型 | データソースタイプとして ZENDESK を指定します。 | | useChangeLog | Zendesk の変更ログを使用して、インデックス内の更新する必要があるドキュメントを特定するには、「true」を入力します。変更ログのサイズによっては、Zendesk でドキュメントをスキャンする方が速い場合があります。Zendesk データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 | ### Zendesk JSON スキーマ ``` { "$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" ] } ``` # Adobe Experience Manager **注記** Adobe Experience Manager コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。新規ユーザーがこのコネクタを使用することはできなくなりましたが、現在のユーザーは中断なく引き続きご使用いただけます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Adobe Experience Manager は、ウェブサイトまたはモバイルアプリケーションのコンテンツの作成に使用されるコンテンツ管理システムです。を使用してAmazon Kendra、ページAdobe Experience Managerとコンテンツアセットに接続してインデックスを作成できます。 Amazon KendraはAdobe Experience Manager、 (AEM) を Cloud Service の作成者インスタンスおよびAdobe Experience Managerオンプレミスの作成者およびパブリッシュインスタンスとしてサポートします。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAdobe Experience ManagerデータソースAmazon Kendraに接続できます。 Adobe Experience Manager データソースコネクタAmazon Kendraのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-aem) + [ ## 前提条件 ](#prerequisites-aem) + [ ## 接続手順 ](#data-source-procedure-aem) ## サポートされている機能 Adobe Experience Manager データソースコネクタは以下の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + OAuth 2.0 と基本的な認証 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAdobe Experience ManagerデータソースAmazon Kendraのインデックスを作成する前に、 Adobe Experience Managerおよび AWSアカウントでこれらの変更を行います。 **Adobe Experience Manager で以下を確認してください**。 + 管理者権限を持つアカウント、または管理者ユーザーへのアクセス。 + Adobe Experience Manager ホスト URL をコピー済み。 **注記** (オンプレミス/サーバー) Amazon KendraAWS Secrets Managerは、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。[混乱する代理問題](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。 + 管理者ユーザー名とパスワードの基本認証情報を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション**: Adobe Experience Manager (AEM) でクラウドサービスまたは AEM オンプレミスとして OAuth 2.0 認証情報を設定済み。AEM オンプレミスを使用する場合、認証情報にはクライアント ID、クライアントシークレット、プライベートキーが含まれます。AEM をクラウドサービスとして使用する場合、認証情報にはクライアント ID、クライアントシークレット、プライベートキー、組織 ID、テクニカルアカウント ID、および Adobe Identity Management System (IMS) ホストが含まれます。[AEM をクラウドサービスとして使用するための認証情報を生成する方法については、「Adobe Experience Manager ドキュメント](https://experienceleague.adobe.com/docs/experience-manager-learn/getting-started-with-aem-headless/authentication/service-credentials.html)」を参照してください。AEM オンプレミスでは、Adobe Granite OAuth 2.0 サーバー実装 (com.adobe.granite.oauth.server) が AEM の OAuth 2.0 サーバー機能をサポートしています。 + 各ドキュメントが Adobe Experience Manager および同じインデックスに使用する予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Adobe Experience Manager の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合はシークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Adobe Experience Manager データソースを接続するときに、コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Adobe Experience Manager データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Adobe Experience Managerデータソースの必要な詳細を指定する必要があります。をまだ設定していない場合はAmazon Kendra、Adobe Experience Manager「」を参照してください[前提条件](#prerequisites-aem)。 ------ #### [ Console ] **Amazon Kendraに接続するには Adobe Experience Manager** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[Adobe Experience Manager コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Adobe Experience Manager コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** - **[AEM オンプレミス]** または **[クラウドサービスとしての AEM]** を選択します。 Adobe Experience Manager ホスト URL を入力します。例えば、AEM オンプレミスを使用する場合は、ホスト名とポートを含めます。*https://hostname:port*。または、AEM をクラウドサービスとして使用する場合は、作成者 URL を使用できます。*https://author-xxxxxx-xxxxxxx.adobeaemcloud.com*。 1. **[SSL 証明書の場所]** - Amazon S3 バケットに保存されている SSL 証明書へのパスを入力します。これを使用して、安全な SSL 接続で AEM オンプレミスに接続します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** - **[基本認証]** または **[OAuth 2.0 認証]** を選択します。次に、既存のAWS Secrets Managerシークレットを選択するか、新しいシークレットを作成してAdobe Experience Manager認証情報を保存します。新しいシークレットを作成すると、AWS Secrets Managerシークレットウィンドウが開きます。 **[基本認証]** を選択した場合は、シークレットの名前、Adobe Experience Manager サイトユーザー名、パスワードを入力します。ユーザーは管理者アクセス許可を持っているか、管理者ユーザーである必要があります。 **[OAuth 2.0 認証]** を選択し、AEM オンプレミスを使用する場合は、シークレットの名前、クライアント ID、クライアントシークレット、およびプライベートキーを入力します。AEM をクラウドサービスとして使用する場合は、シークレット、クライアント ID、クライアントシークレット、プライベートキー、組織 ID、テクニカルアカウント ID、および Adobe Identity Management System (IMS) ホストの名前を入力します。 シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリ認証情報にアクセスし、コンテンツにインデックスを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** - 特定のコンテンツタイプ、ページコンポーネント、ルートパスのクロールに制限を設定し、正規表現パターンを使用してコンテンツをフィルタリングします。 1. **[コンテンツタイプ]** - ページまたはアセットのみ、あるいはその両方をクロールするかを選択します。 1. (オプション) **[その他の設定]** で、次のオプションフィールドを設定します。 + **[ページコンポーネント]** - ページコンポーネントの特定の名前。ページコンポーネントは、Adobe Experience Manager テンプレートエディタと連携するように設計された拡張可能なページコンポーネントで、ページヘッダー/フッターコンポーネントと構造コンポーネントをテンプレートエディタで組み立てることができます。 + **[コンテンツフラグメントバリエーション]** - コンテンツフラグメントバリエーションの具体的な名前。コンテンツフラグメントを使用すると、Adobe Experience Manager でページに依存しないコンテンツをデザイン、作成、キュレーション、公開できます。これにより、複数の場所や複数のチャネルですぐに使用できるコンテンツを準備できます。 + **[ルートパス]** - 特定のコンテンツへのルートパス。 + **[正規表現パターン]** - 特定のページやアセットを含めるまたは除外する正規表現パターン。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[タイムゾーン ID]** - EM オンプレミスを使用していて、サーバーのタイムゾーンが Amazon Kendra AEM コネクタまたはインデックスのタイムゾーンと異なる場合は、 AEM コネクタまたはインデックスに合わせてサーバーのタイムゾーンを指定できます。AEM オンプレミスのデフォルトのタイムゾーンは、Amazon Kendra AEM コネクタまたはインデックスのタイムゾーンです。クラウドサービスとしての AEM のデフォルトのタイムゾーンはグリニッジ標準時です。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングするAmazon Kendra、生成されたデフォルトのデータソースフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Adobe Experience Manager** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-aem-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `AEM` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **AEM ホスト URL** - Adobe Experience Manager ホスト URL を指定します。例えば、AEM オンプレミスを使用する場合は、ホスト名とポートを含めます。*https://hostname:port*。または、AEM をクラウドサービスとして使用する場合は、作成者 URL を使用できます。*https://author-xxxxxx-xxxxxxx.adobeaemcloud.com*。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **認証タイプ** - 使用する認証タイプを指定します (`Basic` または `OAuth2`)。 + **AEM タイプ** - 使用する Adobe Experience Manager のタイプを指定します (`CLOUD` または `ON_PREMISE`)。 + **シークレットの Amazon リソースネーム (ARN)** - AEM オンプレミスまたは Cloud のいずれかで基本認証を使用する場合は、ユーザー名とパスワードの認証情報を保存するシークレットを指定します。AWS Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "aemUrl": "Adobe Experience Manager On-Premise host URL", "username": "user name with admin permissions", "password": "password with admin permissions" } ``` AEM オンプレミスに OAuth 2.0 認証を使用する場合、シークレットは次のキーを含む JSON 構造に保存されます。 ``` { "aemUrl": "Adobe Experience Manager host URL", "clientId": "client ID", "clientSecret": "client secret", "privateKey": "private key" } ``` AEM の OAuth 2.0 認証をクラウドサービスとして使用する場合、シークレットは次のキーを含む JSON 構造に保存されます。 ``` { "clientId": "client ID", "clientSecret": "client secret", "privateKey": "private key", "orgId": "organization ID", "technicalAccountId": "technical account ID", "imsHost": "Adobe Identity Management System (IMS) host" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Adobe Experience Manager コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Adobe Experience Manager data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **タイムゾーン ID** — AEM オンプレミスを使用し、サーバーのタイムゾーンが Amazon KendraAEM コネクタまたはインデックスのタイムゾーンと異なる場合は、AEM コネクタまたはインデックスに合わせてサーバーのタイムゾーンを指定できます。 AEM オンプレミスのデフォルトのタイムゾーンは、Amazon KendraAEM コネクタまたはインデックスのタイムゾーンです。クラウドサービスとしての AEM のデフォルトのタイムゾーンはグリニッジ標準時です。 サポートされているタイムゾーン ID の詳細については、「[Adobe Experience Manager JSON schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#aem-json)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のページやアセットを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - Adobe Experience Manager のデータソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Adobe Experience Manager template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-aem-schema)」を参照してください。 ------ # Alfresco **注記** Alfresco コネクタは、2026 年 5 月 31 日まで、既存のお客様を対象に引き続き完全にサポートされます。新規ユーザーがこのコネクタを使用することはできなくなりましたが、現在のユーザーは中断なく引き続きご使用いただけます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Alfresco は、お客様のコンテンツの保存と管理を支援するコンテンツ管理サービスです。を使用してAmazon Kendra、Alfrescoドキュメントライブラリ、Wiki、ブログのインデックスを作成できます。 Amazon KendraはオンプレミスとAlfrescoクラウド (Platform as a Service) Alfresco をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAlfrescoデータソースAmazon Kendraに接続できます。 Amazon KendraAlfresco データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-alfresco) + [ ## 前提条件 ](#prerequisites-alfresco) + [ ## 接続手順 ](#data-source-procedure-alfresco) + [ ## 詳細はこちら ](#alfresco-learn-more) ## サポートされている機能 Amazon KendraAlfresco データソースコネクタは以下の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + OAuth 2.0 と基本的な認証 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Alfresco データソースのインデックスを作成する前に、 Alfrescoと でこれらの変更を行いますAWS アカウント。 **Alfresco で以下を確認してください。** + Alfresco リポジトリ URL とウェブアプリケーション URL をコピー済み。特定の Alfresco サイトのみのインデックスを作成する場合は、サイト ID もコピーしてください。 + 少なくとも読み取りアクセス許可のあるユーザー名とパスワードを含む Alfresco 認証情報を記録しました。OAuth 2.0 認証を使用する場合は、ユーザーを Alfresco 管理者グループに追加する必要があります。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション**: Alfresco で OAuth 2.0 認証情報を設定しました。認証情報には、クライアント ID、クライアントシークレット、およびトークン URL が含まれます。クライアントを Alfresco オンプレミス用に設定する方法について詳しくは、[Alfresco のドキュメント](https://docs.alfresco.com/identity-service/latest/tutorial/sso/saml/)を参照してください。Alfresco クラウド (PaaS) を使用している場合は、[Hyland サポート](https://community.hyland.com/)に連絡して Alfresco OAuth 2.0 認証を受ける必要があります。 + 各ドキュメントが Alfresco および同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Alfresco 認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合はシークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Alfresco データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Alfresco データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Alfresco データソースの必要な詳細を指定する必要があります。Alfresco をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-alfresco)。 ------ #### [ Console ] **Amazon Kendraに接続するには Alfresco** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Alfresco コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Alfresco コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **Alfresco のタイプ** - Alfresco オンプレミス/サーバーを使用するか Alfresco クラウド (Platform as a Service) を使用するかを選択します。 1. **Alfresco リポジトリ URL** - Alfresco リポジトリ URL を入力します。例えば、Alfresco クラウド (PaaS) を使用している場合、リポジトリ URL は、*https://company.alfrescocloud.com* になる可能性があります。または、Alfresco オンプレミスを使用している場合は、リポジトリ URL は *https://company-alfresco-instance.company-domain.suffix:port* になる可能性があります。 1. **Alfresco ユーザーアプリケーション。URL** - Alfresco ユーザーインターフェイスの URL を入力します。リポジトリ URL は Alfresco 管理者から取得できます。例えば、ユーザーインターフェイス URL は *https://example.com* とすることができます。 1. **SSL 証明書の場所** — Amazon S3バケットに保存されている SSL 証明書へのパスを入力します。これを使用して、安全な SSL 接続で Alfresco オンプレミスに接続します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** - **[基本認証]** または **[OAuth 2.0 認証]** を選択します。次に、既存の Secrets Manager シークレットを選択するか、新しいシークレットを作成して Alfresco 認証情報を保存します。新しいシークレットを作成すると、AWS Secrets Managerシークレットウィンドウが開きます。 **[基本認証]** を選択した場合は、シークレットの名前、Alfresco サイトユーザー名、パスワードを入力します。 **[OAuth 2.0 認証]**を選択した場合は、シークレットの名前、クライアント ID、クライアントシークレット、トークン URL を入力します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** - 特定のコンテンツのクロールに制限を設定し、正規表現パターンを使用してコンテンツをフィルタリングします。 1. 1. **[コンテンツ]** - Alfresco の「アスペクト」とマークされたコンテンツ、特定の Alfresco サイト内のコンテンツ、またはすべての Alfresco サイトにわたるコンテンツをクロールするかどうかを選択します。 1. (オプション) **[その他の設定]** - 以下の設定を設定します。 + **[コメントを含める]** - Alfresco ドキュメントライブラリとブログにコメントを含めるかどうかを選択します。 + **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターン。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングする、Amazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Alfresco** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-alfresco-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `ALFRESCO` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **Alfresco サイト ID** - Alfresco サイト ID を指定します。 + **Alfresco リポジトリ URL** - Alfresco リポジトリ URL を指定します。リポジトリ URL は Alfresco 管理者から取得できます。例えば、Alfresco クラウド (PaaS) を使用している場合、リポジトリ URL は、*https://company.alfrescocloud.com* になる可能性があります。または、Alfresco オンプレミスを使用している場合は、リポジトリ URL は *https://company-alfresco-instance.company-domain.suffix:port* になる可能性があります。 + **Alfresco ウェブアプリケーション URL** - Alfresco ユーザーインターフェイス URL を指定します。リポジトリ URL は Alfresco 管理者から取得できます。例えば、ユーザーインターフェイス URL は *https://example.com* とすることができます。 + **認証タイプ** - 使用する認証タイプを指定します (`OAuth2` または `Basic`)。 + **Alfresco タイプ** - 使用する `PAAS` のタイプを指定します。Alfresco (クラウド/Platform as a Service) または `ON_PREM` (オンプレミス) のいずれかを使用するかを指定します。 + **シークレットの Amazon リソースネーム (ARN)** - 基本認証を使用する場合は、ユーザー名とパスワードの認証情報を保存するシークレットを指定します。AWS Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "clientId": "client ID", "clientSecret": "client secret", "tokenUrl": "token URL" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Alfresco コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Alfresco data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **コンテンツタイプ** - クロールするコンテンツのタイプ。Alfresco の「アスペクト」でマークされたコンテンツ、特定のAlfresco サイト内のコンテンツ、またはすべての Alfresco サイトにわたるコンテンツ。特定の「アスペクト」コンテンツを一覧表示することもできます。 + **包含フィルターと除外フィルター** - 特定のファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Alfresco template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-alfresco-schema)」を参照してください。 ------ ## 詳細はこちら Alfresco データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [を使用してAlfrescoコンテンツをインテリジェントに検索するAmazon Kendra](https://aws.amazon.com/blogs/machine-learning/intelligently-search-alfresco-content-using-amazon-kendra/) # Aurora(MySQL) **注記** Aurora(MySQL) コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Auroraは、クラウド向けに構築されたリレーショナルデータベース管理システム (RDBMS) です。Auroraユーザーの場合は、 Amazon Kendraを使用してAurora(MySQL)データソースのインデックスを作成できます。データソースコネクタはAuroraMySQL Amazon KendraAurora(MySQL)3 と AuroraServerless MySQL 8.0 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAurora(MySQL)データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraAurora(MySQL)トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-aurora-mysql) + [ ## 前提条件 ](#prerequisites-aurora-mysql) + [ ## 接続手順 ](#data-source-procedure-aurora-mysql) + [ ## 注意事項 ](#aurora-mysql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAurora(MySQL)データソースAmazon Kendraのインデックスを作成する前に、 Aurora(MySQL)および AWSアカウントでこれらの変更を行います。 **Aurora(MySQL) で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。この情報は Amazon RDSコンソールで確認できます。 + 各ドキュメントが Aurora(MySQL) および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Aurora(MySQL) の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、Aurora(MySQL)データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Aurora(MySQL) データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Aurora(MySQL)認証情報の詳細を指定する必要があります。をまだ設定していない場合は、Aurora(MySQL)Amazon Kendra「」を参照してください[前提条件](#prerequisites-aurora-mysql)。 ------ #### [ Console ] **Amazon Kendraに接続するには Aurora(MySQL)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Aurora(MySQL) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Aurora(MySQL) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **ホスト** – データベースのホスト URL を入力します (例: `http://instance URL.region.rds.amazonaws.com`)。 1. **ポート** – データベースポートを入力します (例: `5432`)。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Aurora(MySQL)新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Aurora(MySQL)-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。SQL クエリは 32KB 未満で、セミコロン (;) を含まない必要があります。 Amazon Kendraは、クエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Aurora(MySQL)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `mySql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Aurora(MySQL)アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Aurora(MySQL)コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Aurora(MySQL) data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Aurora(MySQL) データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Aurora (MySQL) テンプレートスキーマ](ds-schemas.md#ds-aurora-mysql-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックする場合、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Aurora(PostgreSQL) **注記** Aurora(PostgreSQL) コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Auroraは、クラウド用に構築されたリレーショナルデータベース管理システム (RDBMS) です。Auroraユーザーの場合は、 Amazon Kendraを使用してAurora(PostgreSQL)データソースのインデックスを作成できます。データソースコネクタはAmazon KendraAurora(PostgreSQL) Aurora PostgreSQL 1 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAurora(PostgreSQL)データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraAurora(PostgreSQL)トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-aurora-postgresql) + [ ## 前提条件 ](#prerequisites-aurora-postgresql) + [ ## 接続手順 ](#data-source-procedure-aurora-postgresql) + [ ## 注意事項 ](#aurora-postgresql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAurora(PostgreSQL)データソースAmazon Kendraのインデックスを作成する前に、 Aurora(PostgreSQL)および AWSアカウントでこれらの変更を行います。 **Aurora(PostgreSQL) で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが Aurora(PostgreSQL) および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Aurora(PostgreSQL) の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、Aurora(PostgreSQL)データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Aurora(PostgreSQL) データソースAmazon Kendraに接続するには、 がデータにアクセスできるようにAmazon Kendra、Aurora(PostgreSQL)認証情報の詳細を指定する必要があります。をまだ設定していない場合は、Aurora(PostgreSQL)Amazon Kendra「」を参照してください[前提条件](#prerequisites-aurora-postgresql)。 ------ #### [ Console ] **Amazon Kendraに接続するには Aurora(PostgreSQL)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Aurora(PostgreSQL) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Aurora(PostgreSQL) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **ホスト** – データベースのホスト URL を入力します (例: `http://instance URL.region.rds.amazonaws.com`)。 1. **ポート** – データベースポートを入力します (例: `5432`)。 1. **インスタンス** – データベースインスタンスを入力します (例: `postgres`)。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Aurora(PostgreSQL)新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Aurora(PostgreSQL)-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。SQL クエリは 32KB 未満で、セミコロン (;) を含まない必要があります。 Amazon Kendraは、クエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **列の変更検出** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Aurora(PostgreSQL)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `postgresql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Aurora(PostgreSQL)アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** - を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Aurora(PostgreSQL)コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Aurora(PostgreSQL) data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Aurora(PostgreSQL) データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Aurora (PostgreSQL) テンプレートスキーマ](ds-schemas.md#ds-aurora-postgresql-schema)」を参照してください。 ------ ## 注意事項 + 削除されたデータベース行は、 が更新されたコンテンツAmazon Kendraをチェックするときに で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Amazon FSx(Windows) Amazon FSx(Windows) は、共有ストレージ機能を提供するフルマネージド型のクラウドベースのファイルサーバーシステムです。Amazon FSx(Windows) ユーザーの場合は、 を使用してAmazon Kendra Amazon FSx(Windows) データソースのインデックスを作成できます。 **注記** Amazon Kendraがアップグレードされた Amazon FSx(Windows) コネクタをサポートするようになりました。 コンソールは自動的にアップグレードされています。コンソールで新しくコネクタを作成すると、コネクタにはアップグレードされたアーキテクチャが使用されます。API を使用する場合は、`FSxConfiguration` オブジェクトではなく、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトを使用してコネクタを設定する必要があります。 古いコンソールと API アーキテクチャを使用して設定されたコネクタは、引き続き設定どおりに機能します。ただし、それらを編集したり更新したりすることはできません。コネクタ設定を編集または更新する場合は、新しいコネクタを作成する必要があります。 コネクタワークフローをアップグレードされたバージョンに移行することをお勧めします。古いアーキテクチャを使用して設定されたコネクタのサポートは、2024 年 6 月までに終了する予定です。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、 Amazon FSx(Windows) データソースAmazon Kendraに接続できます。 Amazon KendraAmazon FSx(Windows) データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-fsx) + [ ## 前提条件 ](#prerequisites-fsx) + [ ## 接続手順 ](#data-source-procedure-fsx) + [ ## 詳細はこちら ](#fsx-learn-more) ## サポートされている機能 Amazon KendraAmazon FSx(Windows) データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + ユーザー ID のクローリング + 包含フィルターと除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Amazon FSx(Windows) データソースのインデックスを作成する前に、 Amazon FSx(Windows) と の詳細を確認してくださいAWS アカウント。 **Amazon FSx(Windows) の場合は、以下があることを確認してください**。 + 読み取りおよびマウントのアクセス許可で Amazon FSx(Windows) を設定します。 + ファイルシステム ID を書き留めてある。ファイルシステム ID はAmazon FSx、(Windows) コンソールのファイルシステムダッシュボードにあります。 + Amazon FSx(Windows) ファイルシステムが存在する Amazon VPCを使用して仮想プライベートクラウドを設定しました。 + Active Directory ユーザーアカウントの Amazon FSx(Windows) 認証情報を記録しました。これには、DNS ドメイン名を使用した Active Directory ユーザー名 (*user@corp.example.com* など) とパスワードが含まれます。 **注記** コネクタが機能するために必要な認証情報のみを使用してください。ドメイン管理者などの特権認証情報は使用しないでください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + 各ドキュメントが Amazon FSx(Windows) および同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Amazon FSx(Windows) 認証情報を AWS Secrets Managerシークレットに保存し、 API を使用している場合はシークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 Amazon FSx(Windows) データソースを接続するときに、コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon FSx(Windows) データソースAmazon Kendraに接続するには、 がデータAmazon KendraにアクセスできるようにAmazon FSx、(Windows) データソースの必要な詳細を指定する必要があります。(Amazon FSxWindows) をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-fsx)。 ------ #### [ Console ] **Amazon FSx(Windows) ファイルシステムAmazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[Amazon FSx (Windows) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon FSx (Windows) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **Amazon FSx(Windows) ファイルシステム ID** — Amazon FSx(Windows) から取得した既存のファイルシステム ID をドロップダウンから選択します。または、[Amazon FSx (Windows) ファイルシステム](https://console.aws.amazon.com/fsx/)を作成します。ファイルシステム ID は、Amazon FSx(Windows) コンソールのファイルシステムダッシュボードにあります。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **認証** — 既存のAWS Secrets Managerシークレットを選択するか、新しいシークレットを作成してファイルシステムの認証情報を保存します。新しいシークレットを作成すると、AWS Secrets Manager シークレットウィンドウが開きます。 ユーザー名とパスワードの認証情報を保存するシークレットを指定します。ユーザー名には DNS ドメイン名が含まれている必要があります。例えば、*user@corp.example.com* と入力します。 シークレットを保存して追加します。 1. **Virtual Private Cloud (VPC)** — Amazon VPCAmazon FSx(Windows) が存在する を選択する必要があります。VPC サブネットとセキュリティグループを指定します。[「 の設定Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期スコープ]、[正規表現パターン]** - 特定のファイルを含めるまたは除外するための、正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** — **[頻度]** では、データソースのコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングするファイルのAmazon Kendra生成されたデフォルトフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon FSx(Windows) ファイルシステムAmazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `FSX` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **ファイルシステム ID** — Amazon FSx(Windows) ファイルシステムの識別子。ファイルシステム ID は、Amazon FSx (Windows) コンソールのファイルシステムダッシュボードで確認できます。 + **ファイルシステムタイプ** - ファイルシステムのタイプを `WINDOWS` として指定します。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 **注記** Amazon FSx(Windows) が存在する を選択する必要がありますAmazon VPC。VPC サブネットとセキュリティグループを指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **シークレット Amazon リソースネーム (ARN)** — (Windows) アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム Amazon FSx(ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user@corp.example.com", "password": "password" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、 IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、 Amazon FSx(Windows) コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、[IAMAmazon FSx「(Windows) データソースのロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **包含フィルターと除外フィルター** - 特定のファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 **注記** ユーザーに対してユーザーコンテキストフィルタリングをテストするには、クエリを発行するときにユーザー名の一部として DNS ドメイン名を含める必要があります。Active Directory ドメインの管理用のアクセス許可が必要です。グループ名でユーザーコンテキストフィルタリングをテストすることもできます。 + **フィールドマッピング** — 選択すると、Amazon FSx(Windows) データソースフィールドをAmazon Kendraインデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Amazon FSx (Windows) テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-windows-schema)」を参照してください。 ------ ## 詳細はこちら (Amazon FSxWindows) データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [for Amazon FSx(Windows) for のAmazon Kendraコネクタを使用して、Windows ファイルシステムで非構造化データを安全に検索しますWindows File Server](https://aws.amazon.com/blogs/machine-learning/securely-search-unstructured-data-on-windows-file-systems-with-amazon-kendra-connector-for-amazon-fsx-for-windows-file-server/)。 # Amazon FSx(NetApp ONTAP) Amazon FSx(NetApp ONTAP) は、共有ストレージ機能を提供するフルマネージド型のクラウドベースのファイルサーバーシステムです。Amazon FSx(NetApp ONTAP) ユーザーの場合は、 を使用してAmazon Kendra Amazon FSx(NetApp ONTAP) データソースのインデックスを作成できます。 (Amazon FSxNetApp ONTAP) データソースAmazon Kendraに接続するには、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用します。 Amazon KendraAmazon FSx(NetApp ONTAP) データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-fsx-ontap) + [ ## 前提条件 ](#prerequisites-fsx-ontap) + [ ## 接続手順 ](#data-source-procedure-fsx-ontap) ## サポートされている機能 Amazon KendraAmazon FSx(NetApp ONTAP) データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含フィルターと除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Amazon FSx(NetApp ONTAP) データソースのインデックスを作成する前に、Amazon FSx(NetApp ONTAP) と の詳細を確認してくださいAWS アカウント。 **Amazon FSx(NetApp ONTAP) の場合は、以下があることを確認してください**。 + 読み取りおよびマウントのアクセス許可を持つ Amazon FSx(NetApp ONTAP) を設定します。 + ファイルシステム ID を書き留めてある。ファイルシステム ID は、Amazon FSx(NetApp ONTAP) コンソールのファイルシステムダッシュボードにあります。 + ファイルシステムで使用されるストレージ仮想マシン (SVM) ID を書き留めてある。SVM ID を確認するには、Amazon FSx (NetApp ONTAP) コンソールのファイルシステムダッシュボードに移動し、ファイルシステム ID を選択してから、**[ストレージ仮想マシン]** を選択します。 + Amazon FSx(NetApp ONTAP) ファイルシステムが存在する Amazon VPCを使用して仮想プライベートクラウドを設定しました。 + Active Directory ユーザーアカウントの Amazon FSx(NetApp ONTAP) 認証情報を記録しました。これには、DNS ドメイン名を使用した Active Directory ユーザー名 (*user@corp.example.com* など) とパスワードが含まれます。Amazon FSx(NetApp ONTAP) ファイルシステムにネットワークファイルシステム (NFS) プロトコルを使用する場合、認証情報には左 ID、右 ID、および事前共有キーが含まれます。 **注記** コネクタが機能するために必要な認証情報のみを使用してください。ドメイン管理者などの特権認証情報は使用しないでください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + 各ドキュメントが Amazon FSx(NetApp ONTAP) および同じインデックスに使用する予定の他のデータソース間で一意であることを確認します。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Amazon FSx(NetApp ONTAP) 認証情報を AWS Secrets Managerシークレットに保存し、 API を使用している場合はシークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 Amazon FSx(NetApp ONTAP) データソースを接続するときに、コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon FSx(NetApp ONTAP) データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Amazon FSx(NetApp ONTAP) データソースの必要な詳細を指定する必要があります。(Amazon FSxNetApp ONTAP) をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-fsx-ontap)。 ------ #### [ Console ] **Amazon FSx(NetApp ONTAP) ファイルシステムAmazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[Amazon FSx (NetApp ONTAP) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon FSx (NetApp ONTAP) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** — ファイルシステム情報を入力します。 + **ファイルシステムプロトコル** — Amazon FSx(NetApp ONTAP) ファイルシステムのプロトコルを選択します。共通インターネットファイルシステム (CIFS) プロトコル、または、Linux の場合はネットワークファイルシステム (NFS) プロトコルを選択します。 + **Amazon FSx(NetApp ONTAP) ファイルシステム ID** — Amazon FSx(NetApp ONTAP) から取得した既存のファイルシステム ID をドロップダウンから選択します。または、[Amazon FSx (NetApp ONTAP) ファイルシステム](https://console.aws.amazon.com/fsx/)を作成します。ファイルシステム ID は、Amazon FSx (NetApp ONTAP) コンソールのファイルシステムダッシュボードで確認できます。 + **SVM ID** (Amazon FSx(NetApp ONTAP) for NetApp ONTAPのみ) — (NetApp ONTAP) のストレージ仮想マシン Amazon FSx(SVM) ID を指定しますNetApp ONTAP。SVM ID を見つけるには、Amazon FSx(NetApp ONTAP) コンソールのファイルシステムダッシュボードに移動し、ファイルシステム ID を選択し、**Storage 仮想マシン**を選択します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **認証** — 既存のAWS Secrets Managerシークレットを選択するか、新しいシークレットを作成してファイルシステムの認証情報を保存します。新しいシークレットを作成すると、AWS Secrets Manager シークレットウィンドウが開きます。 ユーザー名とパスワードの認証情報を保存するシークレットを指定します。ユーザー名には DNS ドメイン名が含まれている必要があります。例えば、*user@corp.example.com* と入力します。 Amazon FSx (NetApp ONTAP) ファイルシステムに NFS プロトコルを使用する場合は、左 ID、右 ID、および事前共有キーの認証情報を保存するシークレットを指定します。 シークレットを保存して追加します。 1. **Virtual Private Cloud (VPC)** — Amazon VPCAmazon FSx(NetApp ONTAP) が存在する を選択する必要があります。VPC サブネットとセキュリティグループを指定します。[「 の設定Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期スコープ]、[正規表現パターン]** - 特定のファイルを含めるまたは除外するための、正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** — **[頻度]** では、データソースのコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングするファイルのAmazon Kendra生成されたデフォルトフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon FSx(NetApp ONTAP) ファイルシステムAmazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-ontap-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `FSXONTAP` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **ファイルシステム ID** — Amazon FSx(NetApp ONTAP) ファイルシステムの識別子。ファイルシステム ID は、Amazon FSx (NetApp ONTAP) コンソールのファイルシステムダッシュボードで確認できます。 + **[SVM ID]** — ファイルシステムで使用されるストレージ仮想マシン (SVM) ID。SVM ID を確認するには、Amazon FSx (NetApp ONTAP) コンソールのファイルシステムダッシュボードに移動し、ファイルシステム ID を選択してから、**[ストレージ仮想マシン]** を選択します。 + **[プロトコルタイプ]** — 共通インターネットファイルシステム (CIFS) プロトコル、または Linux 用のネットワークファイルシステム (NFS) プロトコルのどちらを使用するかを指定します。 + **[ファイルシステムタイプ]** - ファイルシステムのタイプを `FSXONTAP` と指定します。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 **注記** Amazon FSx(NetApp ONTAP) が存在する を選択する必要がありますAmazon VPC。VPC サブネットとセキュリティグループを指定します。 + **シークレット Amazon リソースネーム (ARN)** — (NetApp ONTAP) アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム Amazon FSx(ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user@corp.example.com", "password": "password" } ``` Amazon FSx(NetApp ONTAP) ファイルシステムに NFS プロトコルを使用する場合、シークレットは次のキーを持つ JSON 構造に保存されます。 ``` { "leftId": "left ID", "rightId": "right ID", "preSharedKey": "pre-shared key" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、 IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、 Amazon FSx(NetApp ONTAP) コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、[IAMAmazon FSx「(NetApp ONTAP) データソースのロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + **包含フィルターと除外フィルター** - 特定のファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 **注記** ユーザーに対してユーザーコンテキストフィルタリングをテストするには、クエリを発行するときにユーザー名の一部として DNS ドメイン名を含める必要があります。Active Directory ドメインの管理用のアクセス許可が必要です。グループ名でユーザーコンテキストフィルタリングをテストすることもできます。 + **フィールドマッピング** — 選択すると、Amazon FSx(NetApp ONTAP) データソースフィールドをAmazon Kendraインデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Amazon FSx (NetApp ONTAP) テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-fsx-ontap-schema)」を参照してください。 ------ # Amazon RDS/Aurora データベースデータソースを使用して、データベースに保存されているドキュメントにインデックスを作成することができます。データベースの接続情報を提供すると、 はドキュメントAmazon Kendraの接続とインデックス作成を行います。 Amazon Kendraは、次のデータベースをサポートしています。 + Amazon Aurora MySQL + Amazon Aurora PostgreSQL + Amazon RDSMySQL 用 + Amazon RDSPostgreSQL 用 **注記** サーバーレス Aurora データベースはサポートされていません。 **重要** この Amazon RDS/Aurora コネクタは、2023 年末までに廃止される予定です。 Amazon Kendraは、新しいデータベースデータソースコネクタをサポートするようになりました。エクスペリエンスを向上させるために、ユースケースに応じて次の新しいコネクタから選択することをお勧めします。 [Aurora(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-aurora-mysql.html) [Aurora(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-aurora-postgresql.html) [Amazon RDS(MySQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-mysql.html) [Amazon RDS(Microsoft SQL Server)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-ms-sql-server.html) [Amazon RDS(Oracle)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-oracle.html) [Amazon RDS(PostgreSQL)](https://docs.aws.amazon.com/kendra/latest/dg/data-source-rds-postgresql.html) [IBM DB2](https://docs.aws.amazon.com/kendra/latest/dg/data-source-ibm-db2.html) [Microsoft SQL Server](https://docs.aws.amazon.com/kendra/latest/dg/data-source-ms-sql-server.html) [MySQL](https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html) [Oracle Database](https://docs.aws.amazon.com/kendra/latest/dg/data-source-oracle-database.html) [[PostgreSQL]](https://docs.aws.amazon.com/kendra/latest/dg/data-source-postgresql.html) [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [DatabaseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DatabaseConfiguration.html) API を使用して、データベースデータソースAmazon Kendraに接続できます。 Amazon Kendraデータベースデータソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-database) + [ ## 前提条件 ](#prerequisites-database) + [ ## 接続手順 ](#data-source-procedure-database) ## サポートされている機能 Amazon Kendraデータベースデータソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーコンテキストフィルタリング + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用してデータベースデータソースのインデックスを作成する前に、データベースとAWSアカウントでこれらの変更を行います。 **データベースで以下を確認してください。** + データベースのユーザー名とパスワードの基本認証情報を記録しました。 + ホスト名、ポート番号、ホストアドレス、データベース名、ドキュメントデータが含まれているデータテーブルの名前をコピーしました。PostgreSQL の場合、データテーブルはパブリックテーブルまたはパブリックスキーマである必要があります。 **注記** ホストとポートは、インターネット上のデータベースサーバーAmazon Kendraの場所を指定します。データベース名とテーブル名Amazon Kendraは、データベースサーバー上のドキュメントデータの場所を示します。 + ドキュメントデータを含むデータテーブル内の列の名前をコピーしました。ドキュメント ID、ドキュメント本文、ドキュメントが変更されたかどうかを検出する列 (最終更新列など)、カスタムインデックスフィールドにマッピングされるオプションのデータテーブル列を含める必要があります。[Amazon Kendra の予約済みフィールド名](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html#index-reserved-fields)をテーブルの列にマッピングできます。 + Amazon RDSMySQL に使用するか別のタイプに使用するかなどのデータベースエンジンタイプ情報をコピーしました。 + 各ドキュメントがデータベースおよび同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + データベースの認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、データベースデータソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 データベースデータソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、データベースデータソースの必要な詳細を指定する必要があります。データベースをまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-database)。 ------ #### [ Console ] **データベースAmazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**データベースコネクタ**を選択し、**[データソースを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた**データベースコネクタ**を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[エンドポイント]** - DNS ホスト名、IPv4 アドレス、または IPv6 アドレス。 1. **[ポート]** - ポート番号。 1. **[データベース]** - データベース名。 1. **[テーブル名]** - テーブル名。 1. **[認証のタイプ]** で **[既存]** または **[新規]** を選択してデータベース認証情報を保存します。新しいシークレットの作成を選択すると、AWS Secrets Manager シークレットウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-database-」が自動的に追加されます。 1. **[ユーザー名]** と **[パスワード]** - データベースアカウントから認証情報の値を入力します。 1. **[認証を保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 **注記** プライベートサブネットを使用する必要があります。RDS インスタンスが VPC のパブリックサブネットにある場合は、パブリックサブネット内の NAT ゲートウェイへのアウトバウンドアクセス権を持つプライベートサブネットを作成します。VPC 設定で指定するサブネットは、米国西部 (オレゴン)、米国東部 (バージニア北部)、欧州 (アイルランド) のいずれかに存在する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. ユースケースに基づいて **[Aurora MySQL]**、**[MySQL]**、**[Aurora PostgreSQL]**、**[PostgreSQL]** の中から選択してください。 1. **[SQL 識別子を二重引用符で囲む]** - 選択して SQL 識別子を二重引用符で囲んでください。例えば、“columnName”。 1. **ACL 列**と**変更検出列** — が変更検出Amazon Kendraに使用する列 (最後に更新された列など) とアクセスコントロールリストを設定します。 1. **同期実行スケジュール**で**、頻度** - Amazon Kendraがデータソースと同期する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **Amazon Kendraデフォルトフィールドマッピング** — インデックスにマッピングするAmazon Kendra生成されたデフォルトデータソースフィールドから選択します。`document_id` および `document_body` の **[データベース列]** 値を追加する必要があります。 1. **[カスタムフィールドマッピング]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **データベースAmazon Kendraに接続するには** 次の [DatabaseConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DatabaseConfiguration.html) API を指定する必要があります。 + **ColumnConfiguration** - インデックスがデータベースからドキュメント情報を取得する必要がある場所に関する情報。詳細については、「[ColumnConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ColumnConfiguration.html)」を参照してください。`DocumentDataColumnName` (ドキュメント本文または本文)、`DocumentIdColumnName`、および `ChangeDetectingColumn` (最終更新列など) フィールドを指定する必要があります。`DocumentIdColumnName` フィールドにマッピングされた列は整数の列である必要があります。次の例は、データベースデータソースの単純な列構成を示しています。 ``` "ColumnConfiguration": { "ChangeDetectingColumns": [ "LastUpdateDate", "LastUpdateTime" ], "DocumentDataColumnName": "TextColumn", "DocumentIdColumnName": "IdentifierColumn", "DocoumentTitleColumnName": "TitleColumn", "FieldMappings": [ { "DataSourceFieldName": "AbstractColumn", "IndexFieldName": "Abstract" } ] } ``` + **ConnectionConfiguration** - データベースに接続するために必要な設定情報。詳細については、「[ConnectionConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConnectionConfiguration.html)」を参照してください。 + **DatabaseEngineType** - データベースを実行するデータベースエンジンのタイプ。の `DatabaseHost`フィールドは、データベースの Amazon Relational Database Service(Amazon RDS) インスタンスエンドポイント`ConnectionConfiguration`である必要があります。クラスターエンドポイントを使用しないでください。 + **シークレット Amazon リソースネーム (ARN)** — データベースアカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` 次の例は、シークレット ARN を含むデータベース設定を示します。 ``` "DatabaseConfiguration": { "ConnectionConfiguration": { "DatabaseHost": "host.subdomain.domain.tld", "DatabaseName": "DocumentDatabase", "DatabasePort": 3306, "SecretArn": "arn:aws:secretmanager:region:account ID:secret/secret name", "TableName": "DocumentTable" } } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、データベースコネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for database data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - データソース設定の一部として `VpcConfiguration` を指定します。「[VPC を使用するための Amazon Kendra の設定](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 **注記** プライベートサブネットのみを使用する必要があります。RDS インスタンスが VPC のパブリックサブネットにある場合は、パブリックサブネット内の NAT ゲートウェイへのアウトバウンドアクセス権を持つプライベートサブネットを作成します。VPC 設定で指定するサブネットは、米国西部 (オレゴン)、米国東部 (バージニア北部)、欧州 (アイルランド) のいずれかに存在する必要があります。 + **フィールドマッピング** - 選択すると、データベースデータソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ # Amazon RDS(Microsoft SQL Server) **注記** Amazon RDS(Microsoft SQL Server) コネクタは、2026 年 5 月 31 日まで既存のお客様に対して完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 SQL Server は、Microsoft によって開発されたデータベース管理システムです。 Amazon RDSfor SQL Server を使用すると、クラウドでの SQL Server のデプロイを簡単にセットアップ、運用、スケーリングできます。Amazon RDS(Microsoft SQL Server) ユーザーの場合は、 Amazon Kendraを使用して Amazon RDS(Microsoft SQL Server) データソースのインデックスを作成できます。Amazon KendraJDBC データソースコネクタは、Microsoft SQL Server 2019 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAmazon RDS、 (Microsoft SQL Server) データソースAmazon Kendraに接続できます。 Amazon KendraAmazon RDS(Microsoft SQL Server) データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-rds-ms-sql-server) + [ ## 前提条件 ](#prerequisites-rds-ms-sql-server) + [ ## 接続手順 ](#data-source-procedure-rds-ms-sql-server) + [ ## 注意事項 ](#rds-ms-sql-server-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Amazon RDS(Microsoft SQL Server) データソースのインデックスを作成する前に、 Amazon RDS(Microsoft SQL Server) と AWSアカウントでこれらの変更を行います。 **Amazon RDS(Microsoft SQL Server) で、以下があることを確認します。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが Amazon RDS(Microsoft SQL Server) および同じインデックスに使用する予定の他のデータソース間で一意であることを確認します。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + (Amazon RDSMicrosoft SQL Server) 認証情報を AWS Secrets Managerシークレットに保存し、 API を使用している場合はシークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 Amazon RDS(Microsoft SQL Server) データソースを に接続するときに、 コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon RDS(Microsoft SQL Server) データソースAmazon Kendraに接続するには、 Amazon Kendraがデータにアクセスできるように Amazon RDS(Microsoft SQL Server) 認証情報の詳細を指定する必要があります。(Amazon RDSMicrosoft SQL Server) をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-rds-ms-sql-server)。 ------ #### [ Console ] **Amazon Kendraに接続するには Amazon RDS(Microsoft SQL Server)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Amazon RDS (Microsoft SQL Server) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon RDS (Microsoft SQL Server) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** — SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Amazon RDS(Microsoft SQL Server) 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。プレフィックスAmazonKendra-Amazon RDS(Microsoft SQL Server)-」がシークレット名に自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 **注記** テーブル名に特殊文字 (英数字以外) が含まれている場合は、テーブル名の前後を角括弧で囲む必要があります。例: *select \$1 from [my-database-table]* + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** — タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Amazon RDS(Microsoft SQL Server)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `sqlserver` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 **注記** テーブル名に特殊文字 (英数字以外) が含まれている場合は、テーブル名の前後を角括弧で囲む必要があります。例: *select \$1 from [my-database-table]* + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — (Microsoft SQL Server) アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム Amazon RDS(ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、 Amazon RDS(Microsoft SQL Server) コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、[IAMAmazon RDS(Microsoft SQL Server) データソースの ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、 Amazon RDS(Microsoft SQL Server) データソースフィールドをAmazon Kendraインデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Amazon RDS (Microsoft SQL Server) テンプレートスキーマ](ds-schemas.md#ds-rds-ms-sql-server-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックする場合、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Amazon RDS(MySQL) **注記** Amazon RDS(MySQL) コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Amazon RDS(Amazon Relational Database Service) は、 AWSクラウドでのリレーショナルデータベースのセットアップ、運用、スケーリングを容易にするウェブサービスです。Amazon RDSユーザーの場合は、 Amazon Kendraを使用してAmazon RDS(MySQL)データソースのインデックスを作成できます。Amazon Kendraデータソースコネクタは、Amazon RDSMySql 5.6、5.7、および 8.0 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAmazon RDS(MySQL)データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraAmazon RDS(MySQL)トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-rds-mysql) + [ ## 前提条件 ](#prerequisites-rds-mysql) + [ ## 接続手順 ](#data-source-procedure-rds-mysql) + [ ## 注意事項 ](#rds-mysql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAmazon RDS(MySQL)データソースAmazon Kendraのインデックスを作成する前に、 Amazon RDS(MySQL)および AWSアカウントでこれらの変更を行います。 **Amazon RDS(MySQL) で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。この情報は Amazon RDSコンソールで確認できます。 + 各ドキュメントが Amazon RDS(MySQL) および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Amazon RDS(MySQL) の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、Amazon RDS(MySQL)データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon RDS(MySQL) データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Amazon RDS(MySQL)認証情報の詳細を指定する必要があります。Amazon RDS(MySQL) をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-rds-mysql)。 ------ #### [ Console ] **Amazon Kendraに接続するには Amazon RDS(MySQL)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Amazon RDS(MySQL) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon RDS(MySQL) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **ホスト** – データベースのホスト URL を入力します (例: `http://instance URL.region.rds.amazonaws.com`)。 1. **ポート** – データベースポートを入力します (例: `5432`)。 1. **インスタンス** – データベースインスタンスを入力します (例: `postgres`)。 1. **SSL 証明書の場所を有効にする** — SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Amazon RDS(MySQL)新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Amazon RDS(MySQL)-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。SQL クエリは 32KB 未満で、セミコロン (;) を含まない必要があります。 Amazon Kendraは、クエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **列の変更検出** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Amazon RDS(MySQL)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `mySql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Amazon RDS(MySQL)アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Amazon RDS(MySQL)コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Amazon RDS(MySQL) data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **フィールドマッピング** - 選択すると、Amazon RDS(MySQL) データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Amazon RDS (MySQL) テンプレートスキーマ](ds-schemas.md#ds-rds-mysql-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックする場合、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Amazon RDS(Oracle) **注記** Amazon RDS(Oracle) コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Amazon RDS(Amazon Relational Database Service) は、 AWSクラウドでのリレーショナルデータベースのセットアップ、運用、スケーリングを容易にするウェブサービスです。Amazon RDS(Oracle) ユーザーの場合は、 Amazon Kendraを使用してAmazon RDS(Oracle)データソースのインデックスを作成できます。データソースコネクタは、Amazon RDSOracle Database Amazon KendraAmazon RDS(Oracle)21c、Oracle Database 19c、Oracle Database 12c をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAmazon RDS(Oracle)データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraAmazon RDS(Oracle)トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-rds-oracle) + [ ## 前提条件 ](#prerequisites-rds-oracle) + [ ## 接続手順 ](#data-source-procedure-rds-oracle) + [ ## 注意事項 ](#rds-oracle-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAmazon RDS(Oracle)データソースAmazon Kendraのインデックスを作成する前に、 Amazon RDS(Oracle)および AWSアカウントでこれらの変更を行います。 **Amazon RDS(Oracle) で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが Amazon RDS(Oracle) および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Amazon RDS(Oracle) の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、Amazon RDS(Oracle)データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon RDS(Oracle) データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Amazon RDS(Oracle)認証情報の詳細を指定する必要があります。Amazon RDS(Oracle) をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-rds-oracle)。 ------ #### [ Console ] **Amazon Kendraに接続するには Amazon RDS(Oracle)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Amazon RDS(Oracle) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon RDS(Oracle) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Amazon RDS(Oracle)新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Amazon RDS(Oracle)-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** — タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Amazon RDS(Oracle)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `oracle` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Amazon RDS(Oracle)アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Amazon RDS(Oracle)コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Amazon RDS(Oracle) data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Amazon RDS(Oracle) データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Amazon RDS (Oracle) テンプレートスキーマ](ds-schemas.md#ds-rds-oracle-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックすると、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Amazon RDS(PostgreSQL) **注記** Amazon RDS(PostgreSQL) コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Amazon RDSは、 AWSクラウドでのリレーショナルデータベースのセットアップ、運用、スケーリングを容易にするウェブサービスです。Amazon RDSユーザーの場合は、 Amazon Kendraを使用してAmazon RDS(PostgreSQL)データソースのインデックスを作成できます。データソースコネクタはAmazon KendraAmazon RDS(PostgreSQL) PostgreSQL 9.6 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してAmazon RDS(PostgreSQL)データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraAmazon RDS(PostgreSQL)トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-rds-postgresql) + [ ## 前提条件 ](#prerequisites-rds-postgresql) + [ ## 接続手順 ](#data-source-procedure-rds-postgresql) + [ ## 注意事項 ](#rds-postgresql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してAmazon RDS(PostgreSQL)データソースAmazon Kendraのインデックスを作成する前に、 Amazon RDS(PostgreSQL)および AWSアカウントでこれらの変更を行います。 **Amazon RDS(PostgreSQL) で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。この情報は Amazon RDSコンソールで確認できます。 + 各ドキュメントが Amazon RDS(PostgreSQL) および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Amazon RDS(PostgreSQL) の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Amazon RDS(PostgreSQL)データソースの接続時に コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Amazon RDS(PostgreSQL) データソースAmazon Kendraに接続するには、 がデータにアクセスできるようにAmazon Kendra、Amazon RDS(PostgreSQL)認証情報の詳細を指定する必要があります。Amazon RDS(PostgreSQL) をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-rds-postgresql)。 ------ #### [ Console ] **Amazon Kendraに接続するには Amazon RDS(PostgreSQL)** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Amazon RDS(PostgreSQL) コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Amazon RDS(PostgreSQL) コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **ホスト** – データベースのホスト URL を入力します (例: `http://instance URL.region.rds.amazonaws.com`)。 1. **ポート** – データベースポートを入力します (例: `5432`)。 1. **インスタンス** – データベースインスタンスを入力します (例: `postgres`)。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Amazon RDS(PostgreSQL)新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Amazon RDS(PostgreSQL)-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32KB 未満である必要があります。SQL クエリは 32KB 未満で、セミコロン (;) を含まない必要があります。 Amazon Kendraは、クエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **列の変更検出** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Amazon RDS(PostgreSQL)** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `postgresql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Amazon RDS(PostgreSQL)アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Amazon RDS(PostgreSQL)コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Amazon RDS(PostgreSQL) data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Amazon RDS(PostgreSQL) データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Amazon RDS (PostgreSQL) テンプレートスキーマ](ds-schemas.md#ds-rds-postgresql-schema)」を参照してください。 ------ ## 注意事項 + 削除されたデータベース行は、 が更新されたコンテンツAmazon Kendraをチェックするときに で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Amazon S3 Amazon S3 は、バケット内のオブジェクトとしてデータを保存するオブジェクトストレージサービスです。を使用して Amazon Kendra 、ドキュメントの Amazon S3 バケットリポジトリのインデックスを作成できます。 **警告** Amazon Kendra は、S3 バケットを操作するアクセス許可を Amazon Kendra プリンシパルに付与するバケットポリシーを使用しません。代わりに、 IAM ロールを使用します。 Amazon Kendra が信頼されたメンバーとしてバケットポリシーに含まれていないことを確認します。これにより、任意のプリンシパルに誤ってアクセス許可を付与する際のデータセキュリティの問題を回避できます。ただしバケットポリシーを追加すれば、異なるアカウント間で Amazon S3 バケットを使用できます。詳細については、「[Amazon S3 アカウントで使用するポリシー](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds-s3-cross-accounts)」(S3 IAM ロールタブの **[データソースのIAM ロール]**) を参照してください。S3 データソースの IAM ロールの詳細については、[IAM 「 ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds-s3)」を参照してください。 **注記** Amazon Kendra がアップグレードされた Amazon S3 コネクタをサポートするようになりました。 コンソールは自動的にアップグレードされています。コンソールで新しくコネクタを作成すると、コネクタにはアップグレードされたアーキテクチャが使用されます。API を使用する場合は、`S3DataSourceConfiguration` オブジェクトではなく [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトを使用してコネクタを設定する必要があります。 古いコンソールと API アーキテクチャを使用して設定されたコネクタは、引き続き設定どおりに機能します。ただし、それらを編集したり更新したりすることはできません。コネクタ設定を編集または更新する場合は、新しいコネクタを作成する必要があります。 コネクタワークフローをアップグレードされたバージョンに移行することをお勧めします。古いアーキテクチャを使用して設定されたコネクタのサポートは、2024 年 6 月までに終了する予定です。 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)または [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して Amazon S3 データソースに接続できます。 **注記** Amazon S3 データソースの同期ステータスレポートを生成するには、[「データソースのトラブルシューティング](https://docs.aws.amazon.com/kendra/latest/dg/troubleshooting-data-sources.html#troubleshooting-data-sources-sync-status-manifest)」を参照してください。 Amazon Kendra S3 データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-s3) + [ ## 前提条件 ](#prerequisites-s3) + [ ## 接続手順 ](#data-source-procedure-s3) + [ # Amazon S3 データソースの作成 ](create-ds-s3.md) + [ # Amazon S3 ドキュメントメタデータ ](s3-metadata.md) + [ # Amazon S3 データソースのアクセスコントロール ](s3-acl.md) + [ # Amazon S3 データソース Amazon VPC での の使用 ](s3-vpc-example-1.md) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して S3 データソースのインデックスを作成する前に、S3 と AWS アカウントでこれらの変更を行います。 **S3 で以下を確認してください。** + Amazon S3 バケットの名前をコピーしました。 **注記** バケットは Amazon Kendra インデックスと同じリージョンにあり、インデックスにはドキュメントを含むバケットへのアクセス許可が必要です。 + 各ドキュメントが S3 および同じインデックスに使用する予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていない必要があります。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 ** AWS アカウントで、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 既存の IAM ロールがない場合は、S3 データソースを接続するときに コンソールを使用して新しい IAM ロールを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールの ARN とインデックス ID を指定する必要があります。 ## 接続手順 S3 データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、S3 データソースの必要な詳細を指定する必要があります。S3 をまだ設定していない場合は Amazon Kendra、「」を参照してください[前提条件](#prerequisites-s3)。 ------ #### [ Console ] ** Amazon Kendra に接続するには Amazon S3 ** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[S3 コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[S3 コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次のオプション情報を入力します。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[データソースの場所]** - データが保存されている Amazon S3 バケットへのパスを指定します。**[S3 をブラウズ]** を選択し、S3 バケットを選択します。 1. **[最大ファイルサイズ]** - 特定のファイルサイズ未満のファイルのみをクロールするには、MB 単位で上限値を指定します。ファイルの最大サイズは 50 MB Amazon Kendra です。 1. (オプション) **[メタデータファイルのプレフィックスフォルダの場所]** - フィールド/属性、およびその他のドキュメントメタデータが保存されているフォルダへのパスを指定します。**[S3 をブラウズ]** を選択してメタデータフォルダを探します。 1. (オプション) **[アクセスコントロールリスト設定ファイルの場所]** — ユーザーの JSON 構造とドキュメントへのアクセスを含むファイルへのパスを指定します。**[S3 をブラウズ]** を選択して ACL ファイルを探します。 1. (オプション) **[復号キーを選択]** - 復号キーを使用する場合は選択します。既存の AWS KMS キーの使用も選択できます。 1. (オプション) **[追加設定]** - 特定のファイルを含めるか除外するパターンを追加します。すべてのパスは、データソースの場所の S3 バケットに相対的です。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次のオプション情報を入力します。 1. **デフォルトのフィールドマッピング** — インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] ** Amazon Kendra に接続するには Amazon S3** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `S3` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **BucketName** - ドキュメントが含まれているバケットの名前。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + **IAM role** - を呼び出し`CreateDataSource`て IAM ロールに Secrets Manager シークレットへのアクセス許可を付与し、S3 コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[S3 データソースのIAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[包含フィルターと除外フィルター]** - 特定のファイル名、ファイルタイプ、ファイルパスを含めるか除外するかを指定します。glob パターン (ワイルドカードパターンを指定したパターンに一致するパス名のリストに展開できるパターン) を使用します。例については、「 AWS CLI コマンドリファレンス[」の「フィルタの除外と包含の使用](https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)」を参照してください。 + **[ドキュメントのメタデータとアクセスコントロールの設定]** - ソース URI、ドキュメントの作成者、カスタムドキュメントの属性/フィールド、およびユーザーとユーザーがアクセス可能なドキュメントなどの情報が含まれている、ドキュメントのメタデータとアクセスコントロールファイルを追加します。各メタデータファイルには、1 つのドキュメントに関するメタデータが含まれています。 + **フィールドマッピング** - 選択すると、S3 データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[S3 template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-s3-schema)」を参照してください。 ------ ### 詳細情報 S3 データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [VPC サポートで Amazon Kendra S3 Connector を使用して回答を正確に検索する](https://aws.amazon.com/blogs/machine-learning/search-for-answers-accurately-using-amazon-kendra-s3-connector-with-vpc-support/) # Amazon S3 データソースの作成 次の例は、 Amazon S3 データソースの作成を示しています。この例では、インデックスからデータを読み取るアクセス許可を持つインデックスと IAM ロールを既に作成していることを前提としています。 IAM ロールの詳細については、[IAM 「アクセスロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。インデックスの作成の詳細については、「[インデックスの作成](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)」を参照してください。 ------ #### [ CLI ] ``` aws kendra create-data-source \ --index-id index ID \ --name example-data-source \ --type S3 \ --configuration '{"S3Configuration":{"BucketName":"bucket name"}}' --role-arn 'arn:aws:iam::account id:role:/role name ``` ------ #### [ Python ] 次の Python コードのスニペットは、 Amazon S3 データソースを作成します。完全な例については、[開始方法 (AWS SDK for Python (Boto3))](gs-python.md) を参照してください。 ``` print("Create an Amazon S3 data source.") # Provide a name for the data source name = "getting-started-data-source" # Provide an optional description for the data source description = "Getting started data source." # Provide the IAM role ARN required for data sources role_arn = "arn:aws:iam::${accountID}:role/${roleName}" # Provide the data soource connection information s3_bucket_name = "S3-bucket-name" type = "S3" # Configure the data source configuration = {"S3DataSourceConfiguration": { "BucketName": s3_bucket_name } } data_source_response = kendra.create_data_source( Configuration = configuration, Name = name, Description = description, RoleArn = role_arn, Type = type, IndexId = index_id ) ``` ------ データソースの作成には時間がかかることがあります。[DescribeDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DescribeDataSource.html) API を使用して進行状況をモニタリングできます。データソースのステータスが `ACTIVE` の場合、データソースを使用する準備ができています。 次の例は、データソースのステータスの取得を示しています。 ------ #### [ CLI ] ``` aws kendra describe-data-source \ --index-id index ID \ --id data source ID ``` ------ #### [ Python ] 次の Python コードのスニペットでは、 S3 データソースに関する情報を取得します。完全な例については、[開始方法 (AWS SDK for Python (Boto3))](gs-python.md) を参照してください。 ``` print("Wait for Amazon Kendra to create the data source.") while True: data_source_description = kendra.describe_data_source( Id = "data-source-id", IndexId = "index-id" ) status = data_source_description["Status"] print(" Creating data source. Status: "+status) time.sleep(60) if status != "CREATING": break ``` ------ このデータソースにはスケジュールがないため、自動的に実行されません。データソースのインデックスを作成するには、[StartDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StartDataSourceSyncJob.html) を呼び出し、インデックスをデータソースと同期させます。 次の例は、データソースの同期を示しています。 ------ #### [ CLI ] ``` aws kendra start-data-source-sync-job \ --index-id index ID \ --id data source ID ``` ------ #### [ Python ] 次の Python コードのスニペットで Amazon S3 データソースを同期します。完全な例については、[開始方法 (AWS SDK for Python (Boto3))](gs-python.md) を参照してください。 ``` print("Synchronize the data source.") sync_response = kendra.start_data_source_sync_job( Id = "data-source-id", IndexId = "index-id" ) ``` ------ # Amazon S3 ドキュメントメタデータ メタデータファイルを使用して、メタデータ、つまりドキュメントに関する追加情報を Amazon S3 バケット内のドキュメントに追加できます。各メタデータファイルは、インデックス作成されたドキュメントに関連付けられます。 メタデータファイルは、インデックス作成されたファイルと同じバケットに保存する必要があります。 Amazon S3 データソースの作成時に、 コンソールまたは `DocumentsMetadataConfiguration`パラメータの `S3Prefix`フィールドを使用して、メタデータファイルのバケット内の場所を指定できます。 Amazon S3 プレフィックスを指定しない場合、メタデータファイルはインデックス作成されたドキュメントと同じ場所に保存する必要があります。 メタデータファイルの Amazon S3 プレフィックスを指定すると、インデックスが作成されたドキュメントと並行するディレクトリ構造になります。 は、メタデータの指定されたディレクトリでのみ Amazon Kendra 参照します。メタデータが読み込まれない場合は、ディレクトリの場所がメタデータの場所と一致していることをチェックします。 次の例は、インデックス作成されたドキュメントの場所がメタデータファイルの場所にどのようにマッピングされるかを示しています。ドキュメントの Amazon S3 キーはメタデータの Amazon S3 プレフィックスに追加され、メタデータファイルの Amazon S3 パスを形成する`.metadata.json`ためにサフィックスが付きます。メタデータの Amazon S3 プレフィックスと`.metadata.json`サフィックスを含む結合 Amazon S3 キーは、合計 1024 文字以下にする必要があります。 Amazon S3 キーをプレフィックスとサフィックスと組み合わせるときは、追加文字を考慮して、キーを 1000 文字未満にしておくことをお勧めします。 ``` Bucket name: s3://bucketName Document path: documents Metadata path: none File mapping s3://bucketName/documents/file.txt -> s3://bucketName/documents/file.txt.metadata.json ``` ``` Bucket name: s3://bucketName Document path: documents/legal Metadata path: metadata File mapping s3://bucketName/documents/legal/file.txt -> s3://bucketName/metadata/documents/legal/file.txt.metadata.json ``` ドキュメントのメタデータは JSON ファイルで定義されます。ファイルは、BOM マーカーの無い UTF-8 テキストファイルである必要があります。JSON ファイルのファイル名は `..metadata.json` である必要があります。この例では、「document」はメタデータが適用されるドキュメントの名前、「extension」はドキュメントのファイル拡張子です。ドキュメント ID は `..metadata.json` 内で一意である必要があります。 JSON ファイルの内容はこのテンプレートに従います。すべての属性やフィールドはオプションなので、すべての属性を含める必要はありません。含める属性ごとに値を指定する必要があります。値を空にすることはできません。を指定しない場合`_source_uri`、検索結果 Amazon Kendra で から返されるリンクは、ドキュメントを含む Amazon S3 バケットを指します。 `DocumentId`は フィールドにマッピング`s3_document_id`され、 は S3 のドキュメントへの絶対パスです。 ``` { "DocumentId": "S3 document ID, the S3 path to doc", "Attributes": { "_category": "document category", "_created_at": "ISO 8601 encoded string", "_last_updated_at": "ISO 8601 encoded string", "_source_uri": "document URI", "_version": "file version", "_view_count": number of times document has been viewed, "custom attribute key": "custom attribute value", additional custom attributes }, "AccessControlList": [ { "Name": "user name", "Type": "GROUP | USER", "Access": "ALLOW | DENY" } ], "Title": "document title", "ContentType": "For example HTML | PDF. For supported content types, see [Types of documents](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html)." } ``` `_created_at` および `_last_updated_at` メタデータフィールドは ISO 8601 でエンコードされた日付です。例えば、2012-03-25T12:30:10\$101:00 は、中央ヨーロッパ時間の 2012 年 3 月 25 日午後 12 時 30 分 (プラス 10 秒) の ISO 8601 の日付/時刻形式です。 クエリをフィルタリングしたり、クエリ応答をグループ化したりするために使用するドキュメントに関する `Attributes` フィールドに追加情報を追加できます。詳細については、「[カスタムドキュメントフィールドの作成](custom-attributes.md)」を参照してください。 `AccessControlList` フィールドを使用して、クエリからのレスポンスをフィルタリングできます。これにより、特定のユーザーおよびグループのみがドキュメントにアクセスできます。詳細については、「[ユーザーコンテキストでのフィルタリング](user-context-filter.md)」を参照してください。 # Amazon S3 データソースのアクセスコントロール 設定ファイルを使用して、 Amazon S3 データソース内のドキュメントへのアクセスを制御できます。ファイルはコンソールで指定するか、[CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) または [UpdateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html) API を呼び出すときに `AccessControlListConfiguration` パラメータとして指定します。 設定ファイルには、S3 プレフィックスを識別し、プレフィクスのアクセス設定を一覧表示する JSON 構造が含まれています。プレフィックスには、パス、または個別のファイルを使用できます。プレフィックスがパスの場合、アクセス設定はそのパス内のすべてのファイルに適用されます。JSON 設定ファイルには、S3 プレフィックスの最大数とデフォルトの最大ファイルサイズがあります。詳細については、[のクォータ Amazon Kendra](quotas.md)を参照してください。 アクセス設定でユーザーとグループの両方を指定できます。インデックスをクエリするときは、ユーザー情報とグループ情報を指定します。詳細については、「[ユーザー属性でフィルタリングする](user-context-filter.md#context-filter-attribute)」を参照してください。 設定ファイルの JSON 構造は次のような形式になります。 ``` [ { "keyPrefix": "s3://BUCKETNAME/prefix1/", "aclEntries": [ { "Name": "user1", "Type": "USER", "Access": "ALLOW" }, { "Name": "group1", "Type": "GROUP", "Access": "DENY" } ] }, { "keyPrefix": "s3://prefix2", "aclEntries": [ { "Name": "user2", "Type": "USER", "Access": "ALLOW" }, { "Name": "user1", "Type": "USER", "Access": "DENY" }, { "Name": "group1", "Type": "GROUP", "Access": "DENY" } ] } ] ``` # Amazon S3 データソース Amazon VPC での の使用 Amazon VPC での の使用 Amazon S3 このトピックでは、Amazon VPC を介して Amazon S3 コネクタを使用して、Amazon S3 バケットに接続する方法を示すステップバイステップの例を示します。この例では、既存の S3 バケットから開始することを前提としています。この例をテストするには、S3 バケットにドキュメントをいくつかアップロードすることをお勧めします。 を介して Amazon S3 バケット Amazon Kendra に接続できます Amazon VPC。そのためには、 Amazon S3 データソースコネクタを作成するときに Amazon VPC サブネットと Amazon VPC セキュリティグループを指定する必要があります。 **重要** Amazon S3 コネクタが Amazon Kendra Amazon S3 バケットにアクセスできるように、仮想プライベートクラウド (VPC) に Amazon S3 エンドポイントを割り当てていることを確認します。 が を介して Amazon S3 バケットからドキュメントを同期 Amazon Kendra するには Amazon VPC、次の手順を実行する必要があります。 + の Amazon S3 エンドポイントを設定します Amazon VPC。 Amazon S3 エンドポイントの設定方法の詳細については、「 *AWS PrivateLink ガイド*」の[「 のゲートウェイエンドポイント Amazon S3](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html)」を参照してください。 + (オプション) Amazon S3 バケットポリシーをチェックして、 Amazon S3 バケットが、割り当てた Virtual Private Cloud (VPC) からアクセス可能であることを確認します Amazon Kendra。詳細については、「*Amazon S3 ユーザーガイド*」の「[バケットポリシーを使用した VPC エンドポイントからのアクセスコントロール](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies-vpc-endpoint.html)」を参照してください。 **Topics** + [ ## ステップ 1: を設定する Amazon VPC ](#s3-configure-vpc) + [ ## (オプション) ステップ 2: Amazon S3 バケットポリシーを設定する ](#s3-configure-bucket-policy) + [ ## ステップ 3: テスト Amazon S3 データソースコネクタを作成する ](#s3-connect-vpc) ## ステップ 1: を設定する Amazon VPC Amazon S3 ゲートウェイエンドポイントを持つプライベートサブネットと、後で Amazon Kendra 使用するために のセキュリティグループを含む VPC ネットワークを作成します。 **プライベートサブネット、S3 エンドポイント、セキュリティグループを使用して VPC を設定するには** 1. にサインイン AWS マネジメントコンソール し、 で Amazon VPC コンソールを開きます[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/)。 1. **プライベートサブネットと Amazon Kendra 用の S3 エンドポイントを使用して VPC を作成します。** ナビゲーションペインで **[VPC]**、**[VPC を作成]** の順に選択します。 1. **[Resources to create]** (作成するリソース) で、**[VPC and more]** (VPC など) を選択します。 1. **[Name タグ]** で、**[自動生成]** を有効にし、「**kendra-s3-example**」と入力します。 1. **[IPv4/IPv6 CIDR ブロック]** は、デフォルト値のままにしておきます。 1. **[アベイラビリティゾーン (AZ) の数]** には、**数字の 1** を選択します。 1. **[AZ のカスタマイズ]** を選択し、**[第 1 アベイラビリティーゾーンリスト]** からアベイラビリティーゾーンを選択します。 Amazon Kendra は、特定のアベイラビリティーゾーンのセットのみをサポートします。 1. **[パブリックサブネットの数]** には、**数字の 0** を選択します。 1. **[プライベートサブネットの数]** には、**数字の 1** を選択します。 1. **[NAT ゲートウェイ]** には、**[なし]** を選択します。 1. **[VPC エンドポイント]** には、**[Amazon S3 ゲートウェイ]** を選択します。 1. 残りの値はデフォルト設定のままにしておきます。 1. [**VPC の作成**] を選択します。 **[VPC を作成]** ワークフローが終了するまで待ちます。次に、**[VPC を表示]** を選択して、先ほど作成した **VPC** を確認します。 これで、パブリックインターネットにアクセスできないプライベートサブネットを持つ VPC ネットワークが作成されました。 1. **Amazon S3 エンドポイントの VPC エンドポイント ID をコピーします。** 1. ナビゲーションペインで、**[Endpoints]** (エンドポイント) を選択します。 1. **[エンドポイント]** リストで、VPC と一緒に作成した Amazon S3 エンドポイント `kendra-s3-example-vpce-s3` を見つけます。 1. **VPC エンドポイント ID** を書きとめておきます。 これで、サブネットを介して Amazon S3 バケットにアクセスするための、Amazon S3 ゲートウェイエンドポイントが作成されました。 1. ** Amazon Kendra で使用する**セキュリティグループ**を作成します。** 1. ナビゲーションペインで、**[セキュリティグループ]**、次に **[セキュリティグループの作成]** を選択します。 1. **[Security group name]** (セキュリティグループ名) に **s3-data-source-security-group** と入力します。 1. **Amazon VPC** リストから VPC を選択します。 1. **[インバウンドルール]** と **[アウトバウンドルール]** は、デフォルトのままにしておきます。 1. **[セキュリティグループの作成]** を選択してください。 これで、VPC セキュリティグループが作成されました。 コネクタ設定プロセス中に作成したサブネットとセキュリティグループを Amazon Kendra Amazon S3 データソースコネクタに割り当てます。 ## (オプション) ステップ 2: Amazon S3 バケットポリシーを設定する このオプションのステップでは、 Amazon Kendraに割り当てた VPC からのみ Amazon S3 バケットにアクセスできるように、Amazon S3 バケットポリシーを設定する方法について説明します。 Amazon Kendra は IAM ロールを使用して Amazon S3 バケットにアクセスするため、Amazon S3 バケットポリシーを設定する必要はありません。ただし、パブリックインターネットからのアクセスを制限する既存のポリシーを持つ Amazon S3 バケットを使用して Amazon S3 コネクタを設定する場合は、バケットポリシーを作成すると便利です。 **Amazon S3 バケットポリシーを設定するには** 1. [https://console.aws.amazon.com/s3/](https://console.aws.amazon.com/s3/) で Amazon S3 コンソールを開きます。 1. ナビゲーションペインで、**[バケット]** を選択します。 1. 同期する Amazon S3 バケットの名前を選択します Amazon Kendra。 1. **[アクセス許可]** タブを選択し、**[バケットポリシー]** まで下にスクロールして、**[編集]** をクリックします。 1. バケットポリシーを追加または変更して、作成した VPC エンドポイントからのアクセスのみを許可します。 以下は、バケットポリシーの例です。*`bucket-name`* と *`vpce-id`* を、前にメモした Amazon S3 バケット名と Amazon S3 エンドポイント ID に置き換えます。 1. **[変更を保存]** を選択します。 これで、S3 バケットが、作成した特定の VPC からのみアクセスできるようになりました。 ## ステップ 3: テスト Amazon S3 データソースコネクタを作成する Amazon VPC 設定をテストするには、 コネクタを作成します Amazon S3 。次に、「[Amazon S3](https://docs.aws.amazon.com/kendra/latest/dg/data-source-s3.html)」で説明されている手順に従って、作成した VPC で設定します。 Amazon VPC 設定値については、この例で作成した値を選択します。 + **Amazon VPC(VPC)** — `kendra-s3-example-vpc` + **サブネット** – `kendra-s3-example-subnet-private1-[availability zone]` + **セキュリティグループ** – `s3-data-source-security-group` コネクタの作成が完了するまで待ちます。 Amazon S3 コネクタを作成したら、**今すぐ同期**を選択して同期を開始します。 Amazon S3 バケット内のドキュメントの数によっては、同期が完了するまでに数分から数時間かかる場合があります。この例をテストするには、S3 バケットにほんのいくつかのドキュメントをアップロードすることをお勧めします。設定が正しい場合は、最終的に **[同期ステータス]** が **[完了]** と表示されます。 エラーが発生した場合は、[Amazon VPC 「接続のトラブルシューティング](https://docs.aws.amazon.com/kendra/latest/dg/vpc-connector-troubleshoot.html)」を参照してください。 # Amazon Kendra ウェブクローラー Amazon Kendra Web Crawler を使用して、ウェブページをクロールおよびインデックス作成できます。 クロールできるのは、公開ウェブサイト、または、安全な通信プロトコルである Hypertext Transfer Protocol Secure (HTTPS) を使用する社内ウェブサイトのみです。ウェブサイトをクロールするときにエラーが発生した場合は、ウェブサイトのクロールがブロックされている可能性があります。内部ウェブサイトをクロールするには、ウェブプロキシを設定できます。ウェブプロキシは公開されている必要があります。認証を使用してウェブサイトにアクセスし、クロールすることもできます。 *インデックス作成するウェブサイトを選択するときは、[Amazon 利用規定ポリシー](https://aws.amazon.com/aup/)およびその他の Amazon 規約のすべてに準拠している必要があります。Web Amazon Kendra Crawler は、独自のウェブページ、またはインデックス作成の権限を持つウェブページのインデックス作成にのみ使用する必要があることに注意してください。Web Crawler によるウェブサイト Amazon Kendra のインデックス作成を停止する方法については、「」を参照してください[Amazon Kendra Web Crawler の `robots.txt` ファイルの設定](stop-web-crawler.md)。* **注記** Web Amazon Kendra Crawler を使用して、所有していないウェブサイトやウェブページを積極的にクロールすることは、許容される用途とは見な**されません**。 Amazon Kendra にはweb crawlerコネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **Amazon Kendra ウェブクローラーコネクタ v1.0 / [https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html) API** + ウェブプロキシ + 包含/除外フィルター **Amazon Kendra ウェブクローラーコネクタ v2.0 / [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API** + フィールドマッピング + 包含/除外フィルター + 完全および増分コンテンツ同期 + ウェブプロキシ + ウェブサイトの基本認証、NTLM/Kerberos 認証、SAML 認証、フォーム認証 + Virtual Private Cloud (VPC) **重要** Web Crawler v2.0 コネクタの作成は ではサポートされていません CloudFormation。 CloudFormation サポートが必要な場合は、Web Crawler v1.0 コネクタを使用します。 Amazon Kendra ウェブクローラーデータソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # Amazon Kendra ウェブクローラーコネクタ v1.0 ](data-source-v1-web-crawler.md) + [ # Amazon Kendra ウェブクローラーコネクタ v2.0 ](data-source-v2-web-crawler.md) + [ # Amazon Kendra Web Crawler の `robots.txt` ファイルの設定 ](stop-web-crawler.md) # Amazon Kendra ウェブクローラーコネクタ v1.0 Amazon Kendra Web Crawler を使用して、ウェブページをクロールおよびインデックス作成できます。 クロールできるのは、公開ウェブサイトと、安全な通信プロトコルである Hypertext Transfer Protocol Secure (HTTPS) を使用するウェブサイトのみです。ウェブサイトをクロールするときにエラーが発生した場合は、ウェブサイトのクロールがブロックされている可能性があります。内部ウェブサイトをクロールするには、ウェブプロキシを設定できます。ウェブプロキシは公開されている必要があります。 *インデックス作成するウェブサイトを選択するときは、[Amazon 利用規定ポリシー](https://aws.amazon.com/aup/)およびその他の Amazon 規約のすべてに準拠している必要があります。Web Amazon Kendra Crawler は、独自のウェブページ、またはインデックス作成の権限を持つウェブページのインデックス作成にのみ使用する必要があることに注意してください。Web Crawler によるウェブサイト Amazon Kendra のインデックス作成を停止する方法については、「」を参照してください[Amazon Kendra Web Crawler の `robots.txt` ファイルの設定](stop-web-crawler.md)。* **注記** Amazon Kendra Web Crawler を使用して、所有していないウェブサイトやウェブページを積極的にクロールすることは、許容される用途とは見な**されません**。 Amazon Kendra ウェブクローラーデータソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-web-crawler) + [ ## 前提条件 ](#prerequisites-v1-web-crawler) + [ ## 接続手順 ](#data-source-v1-procedure-web-crawler) + [ ## 詳細情報 ](#web-crawler-learn-more) ## サポートされている機能 + ウェブプロキシ + 包含/除外フィルター ## 前提条件 を使用してウェブサイト Amazon Kendra のインデックスを作成する前に、ウェブサイトと AWS アカウントの詳細を確認してください。 **ウェブサイトについて、以下を確認してください。** + インデックス作成するウェブサイトのシードまたはサイトマップ URL をコピーしました。 + **基本認証を必要とするウェブサイトの場合**: ユーザー名とパスワードを書き留め、ウェブサイトのホスト名とポート番号をコピーしました。 + **オプション:**ウェブプロキシを使用して、クロールする内部ウェブサイトに接続する場合に、ウェブサイトのホスト名とポート番号をコピーしました。ウェブプロキシは公開されている必要があります。 Amazon Kendra では、基本認証によってバックアップされたウェブプロキシサーバーへの接続がサポートされています。認証なしで接続することもできます。 + インデックスを作成する各ドキュメントが一意であり、同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 ** AWS アカウントで、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + 認証を必要とするウェブサイトの場合、または認証でウェブプロキシを使用する場合、 は認証情報を AWS Secrets Manager シークレットに保存し、API を使用する場合はシークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、 コンソールを使用して、web crawlerデータソースを接続するときに新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 web crawler データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、web crawlerデータソースの必要な詳細を指定する必要があります。をまだ設定していない場合は、web crawler Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v1-web-crawler)。 ------ #### [ Console ] ** Amazon Kendra に接続するには web crawler** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[ウェブクローラーコネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた**ウェブクローラーコネクタ**を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** では、ユースケースに応じて **[ソース URL]** と **[ソースサイトマップ]** を選択し、それぞれの値を入力します。 ソース URL は 10 個まで、サイトマップは 3 個まで追加できます。 **注記** サイトマップをクロールする場合は、ベース URL またはルート URL がサイトマップページに記載されている URL と同じであることを確認してください。例えば、サイトマップ URL が *https://example.com/sitemap-page.html* の場合、このサイトマップページに記載されている URL にもベース URL "https://example.com/" を使用する必要があります。 1. (オプション) **[ウェブプロキシ]** - 次の情報を入力します。 1. **[ホスト名]** - ウェブプロキシを必要とするホスト名。 1. **[ポート番号]** - ホスト URL トランスポートプロトコルが使用するポート。ポート番号は 0～65535 の数字である必要があります。 1. **ウェブプロキシ認証情報**の場合 - ウェブプロキシ接続で認証が必要な場合は、既存のシークレットを選択するか、認証情報を保存する新しいシークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。 1. **[ AWS Secrets Manager Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-WebCrawler-」が自動的に追加されます。 1. **[ユーザー名]** と **[パスワード]** - ウェブサイトの基本認証情報を入力します。 1. **[保存]** を選択します。 1. (オプション) **[認証済みのホスト] - 選択すると、認証付きのホストをさらに追加できます**。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[クロール範囲]** - クロールするウェブページの種類を選択します。 1. **クロール深度** — クロール Amazon Kendra するシード URL からレベルの数を選択します。 1. **[クロールの詳細設定]** および **[追加設定]** - 次の情報を入力します。 1. **[最大ファイルサイズ]** - クロールするウェブページまたは添付ファイルの最大サイズ。最小 0.000001 MB (1 バイト)。最大 50 MB。 1. **1 ページあたりの最大リンク数** - 1 ページあたりにクロールされるリンクの最大数。リンクは表示順にクロールされます。1 ページあたり最小 1 リンク。1 ページあたり最大 1000 リンク。 1. **最大スロットリング** - ホスト名ごとにクロールされる URL の、1 分あたりの最大数。ホスト名ごとに 1 分あたり最小 1 URL。ホスト名ごとに 1 分あたり最大 300 URL。 1. **[正規表現パターン]** - 特定の URL を含めるまたは除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **同期実行スケジュール**で**、頻度** - Amazon Kendra がデータソースと同期する頻度を選択します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] ** Amazon Kendra に接続するには web crawler** [WebCrawlerConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_WebCrawlerConfiguration.html) API を使用して以下を指定する必要があります。 + **URL** - [https://docs.aws.amazon.com/kendra/latest/dg/API_SeedUrlConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_SeedUrlConfiguration.html) と [https://docs.aws.amazon.com/kendra/latest/dg/API_SiteMapsConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_SiteMapsConfiguration.html) を使用して、ウェブサイトのシード URL または開始ポイント URL、または、クロールするウェブサイトのサイトマップ URL を指定します。 **注記** サイトマップをクロールする場合は、ベース URL またはルート URL がサイトマップページに記載されている URL と同じであることを確認してください。例えば、サイトマップ URL が *https://example.com/sitemap-page.html* の場合、このサイトマップページに記載されている URL にもベース URL "https://example.com/" を使用する必要があります。 + **シークレットの Amazon リソースネーム (ARN)** - ウェブサイトが基本認証を使用する場合は、ホスト名、ポート番号、および、ユーザー名とパスワードの基本認証情報を保存するシークレットを指定します。[https://docs.aws.amazon.com/kendra/latest/dg/API_AuthenticationConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_AuthenticationConfiguration.html) API を使用してシークレット ARN を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` AWS Secrets Manager シークレットを使用してウェブプロキシ認証情報を指定することもできます。[https://docs.aws.amazon.com/kendra/latest/dg/API_ProxyConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_ProxyConfiguration.html) API を使用して、ウェブサイトのホスト名とポート番号、およびウェブプロキシ認証情報を保存するシークレットを指定します。 + **IAM role** — を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、ウェブクローラーコネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for web crawler data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **クロールモード** –ウェブサイトのホスト名のみをクロールするか、サブドメインを含むホスト名をクロールするか、ウェブページのリンク先となる他のドメインもクロールするかを選択します。 + 深さ、またはシードレベルからクロールするレベルの数。例えば、シード URL ページは深度 1 で、このページ上でクロールされるハイパーリンクはすべて深度 2 です。 + クロールする単一ウェブページの URL の最大数。 + クロールするウェブページの最大サイズ (MB 単位)。 + 1 分あたりウェブサイトホストごとにクロールされる URL の最大数。 + 内部ウェブサイトに接続してクロールするウェブプロキシのホストとポート番号。例えば、*https://a.example.com/page1.html* のホスト名は 「a.example.com」で、ポート番号は HTTPS の標準ポートである 443 です。ウェブサイトホストへの接続にウェブプロキシ認証情報が必要な場合は、認証情報を保存する AWS Secrets Manager を作成できます。 + ユーザー認証を必要とするウェブサイトにアクセスしてクロールするための認証情報。 + *カスタムドキュメントエンリッチメント*ツールを使用して、HTML メタタグをフィールドとして抽出できます。詳細については、[取り込みプロセス中のドキュメントのメタデータのカスタマイズ](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html)を参照してください。HTML メタタグの抽出例については、「[CDE サンプル](https://github.com/aws-samples/amazon-kendra-cde-examples)」を参照してください。 + **包含フィルターと除外フィルター** - 特定の URL を含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 ------ ## 詳細情報 web crawler データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [Amazon Kendraの Web Crawler を使用してナレッジ検出を再考する](https://aws.amazon.com/blogs/machine-learning/reimagine-knowledge-discovery-using-amazon-kendras-web-crawler/) # Amazon Kendra ウェブクローラーコネクタ v2.0 Amazon Kendra Web Crawler を使用して、ウェブページをクロールおよびインデックス作成できます。 クロールできるのは、公開ウェブサイト、または、安全な通信プロトコルである Hypertext Transfer Protocol Secure (HTTPS) を使用する社内ウェブサイトのみです。ウェブサイトをクロールするときにエラーが発生した場合は、ウェブサイトのクロールがブロックされている可能性があります。内部ウェブサイトをクロールするには、ウェブプロキシを設定できます。ウェブプロキシは公開されている必要があります。認証を使用してウェブサイトにアクセスし、クロールすることもできます。 Amazon Kendra Web Crawler v2.0 は、Selenium ウェブクローラーパッケージと Chromium ドライバーを使用します。 は、継続的インテグレーション (CI) を使用して Selenium と Chromium ドライバーのバージョン Amazon Kendra を自動的に更新します。 *インデックス作成するウェブサイトを選択するときは、[Amazon 利用規定ポリシー](https://aws.amazon.com/aup/)およびその他の Amazon 規約のすべてに準拠している必要があります。Web Amazon Kendra Crawler は、独自のウェブページ、またはインデックス作成の権限を持つウェブページのインデックス作成にのみ使用する必要があることに注意してください。 Amazon Kendra Web Crawler によるウェブサイトのインデックス作成を停止する方法については、「」を参照してください[Amazon Kendra Web Crawler の `robots.txt` ファイルの設定](stop-web-crawler.md)。*Web Amazon Kendra Crawler を使用して、所有していないウェブサイトやウェブページを積極的にクロールすることは、許容される用途とは見な**されません**。 Amazon Kendra ウェブクローラーデータソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **注記** Web Crawler コネクタ v2.0 は、 AWS KMS 暗号化された Amazon S3 バケットからのウェブサイトリストのクローリングをサポート*していません*。 Amazon S3 マネージドキーによるサーバー側の暗号化のみをサポートします。 **重要** Web Crawler v2.0 コネクタの作成は ではサポートされていません CloudFormation。 CloudFormation サポートが必要な場合は、Web Crawler v1.0 コネクタを使用します。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-web-crawler) + [ ## 前提条件 ](#prerequisites-v2-web-crawler) + [ ## 接続手順 ](#data-source-v2-procedure-web-crawler) ## サポートされている機能 + フィールドマッピング + 包含/除外フィルター + 完全および増分コンテンツ同期 + ウェブプロキシ + ウェブサイトの基本認証、NTLM/Kerberos 認証、SAML 認証、フォーム認証 + Virtual Private Cloud (VPC) ## 前提条件 を使用してウェブサイト Amazon Kendra のインデックスを作成する前に、ウェブサイトと AWS アカウントの詳細を確認してください。 **ウェブサイトについて、以下を確認してください。** + インデックス作成するウェブサイトのシードまたはサイトマップ URL をコピーしました。URL をテキストファイルに保存して、それを Amazon S3 バケットにアップロードできます。テキストファイル内の各 URL は、別々の行にフォーマットする必要があります。サイトマップを Amazon S3 バケットに保存する場合は、サイトマップ XML をコピーして XML ファイルに保存していることを確認してください。複数のサイトマップ XML ファイルを 1 つの ZIP ファイルにまとめることもできます。 **注記** (オンプレミス/サーバー) Amazon Kendra AWS Secrets Manager は、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。[混乱する代理問題](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、 Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。 + **基本認証、NTLM 認証、または Kerberos 認証を必要とするウェブサイトの場合**: + ユーザー名とパスワードを含むウェブサイトの認証情報を書き留めました。 **注記** Amazon Kendra Web Crawler v2.0 は、パスワードハッシュを含む NTLM 認証プロトコルと、パスワード暗号化を含む Kerberos 認証プロトコルをサポートしています。 + **SAML 認証またはログインフォーム認証を必要とするウェブサイトの場合**: + ユーザー名とパスワードを含むウェブサイトの認証情報を書き留めました。 + ユーザー名フィールド (SAML を使用する場合は、加えてユーザー名ボタン)、パスワードフィールド、ボタンの XPath (XML Path Language) をコピーし、ログインページ URL をコピーしました。要素の XPath は、ウェブブラウザのデベロッパーツールを使用して確認できます。XPath は通常、次の形式に従います。`//tagname[@Attribute='Value']`。 **注記** Amazon Kendra Web Crawler v2.0 では、ヘッドレス Chrome ブラウザとフォームからの情報を使用して、OAuth 2.0 で保護された URL によるアクセスの認証と認可を行います。 + **オプション**: ウェブプロキシを使用して、クロールする内部ウェブサイトに接続する場合に、ウェブプロキシサーバーのホスト名とポート番号をコピーしました。ウェブプロキシは公開されている必要があります。 は、基本認証でバックアップされたウェブプロキシサーバーへの接続 Amazon Kendra をサポートしているか、認証なしで接続できます。 + **オプション**: VPC を使用して、クロールする内部ウェブサイトに接続する場合は、仮想プライベートクラウド (VPC) のサブネット ID をコピー済み。詳細については、[「 の設定 Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 + インデックスを作成する各ドキュメントが一意であり、同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 ** AWS アカウントで、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合は、 IAM ロールの Amazon リソースネームを記録しました。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + 認証を必要とするウェブサイトの場合、または認証でウェブプロキシを使用する場合、 は認証情報を AWS Secrets Manager シークレットに保存し、API を使用する場合はシークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、 コンソールを使用して、web crawlerデータソースを接続するときに新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 web crawler データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、web crawlerデータソースの必要な詳細を指定する必要があります。をまだ設定していない場合は、web crawler Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v2-web-crawler)。 ------ #### [ Console ] ** Amazon Kendra に接続するには web crawler** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[ウェブクローラーコネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた**ウェブクローラーコネクタ**を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** - **[ソース URL]**、**[ソースサイトマップ]**、**[ソース URL ファイル]**、**[ソースサイトマップファイル]** のいずれかを選択します。最大 100 個のシード URLs のリストを含むテキストファイルを使用する場合は、ファイルが保存されている Amazon S3 バケットへのパスを指定します。サイトマップ XML ファイルを使用する場合は、ファイルが保存されている Amazon S3 バケットへのパスを指定します。複数のサイトマップ XML ファイルを 1 つの ZIP ファイルにまとめることもできます。それ以外の場合は、最大 10 個のシードまたは開始ポイント URL と、最大 3 つのサイトマップ URL を手動で入力できます。 **注記** サイトマップをクロールする場合は、ベース URL またはルート URL がサイトマップページに記載されている URL と同じであることを確認してください。例えば、サイトマップ URL が *https://example.com/sitemap-page.html* の場合、このサイトマップページに記載されている URL にもベース URL "https://example.com/" を使用する必要があります。 ウェブサイトが、そのウェブサイトにアクセスするために認証を必要とする場合は、基本認証、NTLM/Kerberos 認証、SAML 認証、またはフォーム認証のいずれかを選択できます。それ以外の場合は、認証なしのオプションを選択します。 **注記** 後でデータソースを編集して、認証を含むシード URL をサイトマップに変更する場合は、新しいデータソースを作成する必要があります。 Amazon Kendra は認証用の Secrets Manager のシークレット内のシード URL エンドポイント情報を使用してデータソースを設定するため、サイトマップに変更してもデータソースを再設定することはできません。 1. secret — ウェブサイトにアクセスするために同じ認証が必要な場合は、既存のシー**AWS Secrets Manager クレット**を選択するか、新しいシー Secrets Manager クレットを作成してウェブサイトの認証情報を保存します。新しいシークレットを作成すると、 AWS Secrets Manager シークレットウィンドウが開きます。 **[基本]** または **[NTML/Kerberos]** を選択した場合は、シークレットの名前と、ユーザー名、パスワードを入力します。NTLM 認証プロトコルにはパスワードハッシュが含まれ、Kerberos 認証プロトコルにはパスワード暗号化が含まれます。 **[SAML]** または **[フォーム]** を選択した場合は、シークレットの名前と、ユーザー名、パスワードを入力します。ユーザー名フィールドには XPath を使用します (SAML を使用する場合はユーザー名ボタンに XPath を使用します)。パスワードフィールドとボタン、およびログインページの URL には XPath を使用します。要素の XPath (XML パス言語) は、ウェブブラウザのデベロッパーツールを使用して確認できます。XPath は通常、次の形式に従います。`//tagname[@Attribute='Value']`。 1. (オプション) **[ウェブプロキシ** - 内部ウェブサイトへの接続に使用するプロキシサーバーのホスト名とポート番号を入力します。例えば、*https://a.example.com/page1.html* のホスト名は 「a.example.com」で、ポート番号は HTTPS の標準ポートである 443 です。ウェブサイトホストに接続するためにウェブプロキシ認証情報が必要な場合は、認証情報 AWS Secrets Manager を保存する を作成できます。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAM role** — 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** - ドメイン、ファイルサイズ、リンクなど、ウェブページのクローリングに制限を設定し、正規表現パターンを使用して URL をフィルタリングします。 1. (オプション) **[クロールドメイン範囲]** - ウェブサイトのドメインのみをクロールするか、サブドメインのあるドメインをクロールするか、ウェブページのリンク先となる他のドメインもクロールするかを選択します。デフォルトでは、 はクロールするウェブサイトのドメイン Amazon Kendra のみをクロールします。 1. (オプション) **[追加設定]** - 以下の設定を設定します。 + **[クロールの深さ]** - 深さ、またはシードレベルからクロールするレベルの数。例えば、シード URL ページは深度 1 で、このページ上でクロールされるハイパーリンクはすべて深度 2 です。 + **[最大ファイルサイズ]** - クロールするウェブページまたは添付ファイルの最大サイズ (MB 単位)。 + **1 ページあたりの最大リンク数** - クロールする単一ウェブページの URL の最大数。 + **[クローリング速度の最大スロットリング]** - ウェブサイトホストごとにクロールされる URL の 1 分あたりの最大数。 + **[ファイル]** - ウェブページのリンク先のファイルをクロールすることを選択します。 + **[URL のクロールおよびインデックス作成** - 正規表現パターンを追加して、特定の URL のクローリングと、その URL ウェブページのハイパーリンクのインデックス作成を含めるか除外します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** - **[頻度]** で、 Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングするウェブページとファイルの Amazon Kendra 生成されたデフォルトフィールドから選択します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] ** Amazon Kendra に接続するには web crawler** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-web-crawler-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `WEBCRAWLERV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **URL** - ウェブサイトのシードまたは開始ポイント URL、またはクロールするウェブサイトのサイトマップ URL を指定します。シード URLs のリストを保存する Amazon S3 バケットへのパスを指定できます。シード URL のテキストファイル内の各 URL は、別々の行にフォーマットする必要があります。サイトマップ XML ファイルを保存する Amazon S3 バケットへのパスを指定することもできます。複数のサイトマップファイルを 1 つの ZIP ファイルにまとめ、その ZIP ファイルを Amazon S3 バケットに保存できます。 **注記** サイトマップをクロールする場合は、ベース URL またはルート URL がサイトマップページに記載されている URL と同じであることを確認してください。例えば、サイトマップ URL が *https://example.com/sitemap-page.html* の場合、このサイトマップページに記載されている URL にもベース URL "https://example.com/" を使用する必要があります。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + **認証** — ウェブサイトで同じ認証を必要とする場合は、`BasicAuth`、`NTLM_Kerberos`、`SAML`、または `Form` 認証のいずれかを指定します。ウェブサイトが認証を必要としない場合は、`NoAuthentication` を指定してください。 + **シークレットの Amazon リソースネーム (ARN)** - ウェブサイトで基本認証、NTLM、または Kerberos 認証が必要な場合は、ユーザー名とパスワードの認証情報を保存するシークレットを指定します。 AWS Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "seedUrlsHash": "Hash representation of all seed URLs", "userName": "user name", "password": "password" } ``` ウェブサイトで SAML 認証が必要な場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "seedUrlsHash": "Hash representation of all seed URLs", "userName": "user name", "password": "password", "userNameFieldXpath": "XPath for user name field", "userNameButtonXpath": "XPath for user name button", "passwordFieldXpath": "XPath for password field", "passwordButtonXpath": "XPath for password button", "loginPageUrl": "Full URL for website login page" } ``` ウェブサイトでフォーム認証が必要な場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "seedUrlsHash": "Hash representation of all seed URLs", "userName": "user name", "password": "password", "userNameFieldXpath": "XPath for user name field", "passwordFieldXpath": "XPath for password field", "passwordButtonXpath": "XPath for password button", "loginPageUrl": "Full URL for website login page" } ``` 要素の XPath (XML パス言語) は、ウェブブラウザのデベロッパーツールを使用して確認できます。XPath は通常、次の形式に従います。`//tagname[@Attribute='Value']`。 AWS Secrets Manager シークレットを使用してウェブプロキシ認証情報を指定することもできます。 + **IAM role** - を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、ウェブクローラーコネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for web crawler data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **ドメイン範囲** - サブドメインのみを含むウェブサイトドメインをクロールするか、ウェブページのリンク先となる他のドメインもクロールするかを選択します。デフォルトでは、 はクロールするウェブサイトのドメイン Amazon Kendra のみをクロールします。 + 深さ、またはシードレベルからクロールするレベルの数。例えば、シード URL ページは深度 1 で、このページ上でクロールされるハイパーリンクはすべて深度 2 です。 + クロールする単一ウェブページの URL の最大数。 + クロールするウェブページまたは添付ファイルの最大サイズ (MB 単位)。 + 1 分あたりウェブサイトホストごとにクロールされる URL の最大数。 + 内部ウェブサイトに接続してクロールするウェブプロキシのホストとポート番号。例えば、*https://a.example.com/page1.html* のホスト名は 「a.example.com」で、ポート番号は HTTPS の標準ポートである 443 です。ウェブサイトホストへの接続にウェブプロキシ認証情報が必要な場合は、認証情報を保存する AWS Secrets Manager を作成できます。 + **包含フィルターと除外フィルター** - 特定の URL のクローリングと、その URL ウェブページのハイパーリンクのインデックス作成を含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、ウェブページとウェブページファイルのフィールドが Amazon Kendra インデックスフィールドにマッピングされます。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 設定が必要なその他の重要な JSON キーのリストについては、「[Amazon Kendra ウェブクローラーテンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-web-crawler)」を参照してください。 ------ # Amazon Kendra Web Crawler の `robots.txt` ファイルの設定 Amazon Kendra Web Crawler の `robots.txt` ファイルの設定 Amazon Kendra は、 AWS お客様が選択したドキュメントのインデックス作成と検索に使用するインテリジェントな検索サービスです。ウェブ上のドキュメントのインデックスを作成するには、顧客は Amazon Kendra ウェブクローラを使用できます。これは、インデックスを作成する URL やその他の運用パラメータを示します。 Amazon Kendra 顧客は、特定のウェブサイトのインデックスを作成する前に認可を取得する必要があります。 Amazon Kendra Web Crawler は、 `Allow`や などの標準の robots.txt ディレクティブを尊重します`Disallow`。ウェブサイトの `robots.txt` ファイルを変更して、 Amazon Kendra Web Crawler がウェブサイトをクロールする方法を制御できます。 ## Amazon Kendra Web Crawler がウェブサイトにアクセスする方法の設定 `Allow` および `Disallow`ディレクティブを使用して、 Amazon Kendra Web Crawler がウェブサイトのインデックスを作成する方法を制御できます。また、インデックス作成されるウェブページとクロールしないウェブページを制御することもできます。 **Web Crawler Amazon Kendra が、許可されていないウェブページを除くすべてのウェブページをクロールできるようにするには、次のディレクティブを使用します。** ``` User-agent: amazon-kendra # Amazon Kendra Web Crawler Disallow: /credential-pages/ # disallow access to specific pages ``` ** Amazon Kendra Web Crawler が特定のウェブページのみをクロールできるようにするには、次のディレクティブを使用します。** ``` User-agent: amazon-kendra # Amazon Kendra Web Crawler Allow: /pages/ # allow access to specific pages ``` ** Amazon Kendra Web Crawler がすべてのウェブサイトコンテンツをクロールし、他のロボットのクロールを禁止するには、次のディレクティブを使用します。** ``` User-agent: amazon-kendra # Amazon Kendra Web Crawler Allow: / # allow access to all pages User-agent: * # any (other) robot Disallow: / # disallow access to any pages ``` ## Amazon Kendra Web Crawler によるウェブサイトのクロールの停止 `Disallow` ディレクティブを使用して、 Amazon Kendra Web Crawler によるウェブサイトのインデックス作成を停止できます。また、クロールされるウェブページとクロールしないウェブページを制御できます。 ** Amazon Kendra Web Crawler によるウェブサイトのクロールを停止するには、次のディレクティブを使用します。** ``` User-agent: amazon-kendra # Amazon Kendra Web Crawler Disallow: / # disallow access to any pages ``` Amazon Kendra Web Crawler に関するご質問やご不明点がございましたら、 [AWS サポートチーム](https://aws.amazon.com/contact-us/?nc1=f_m)にお問い合わせください。 # Box Box は、ファイルホスティング機能を提供するクラウドストレージサービスです。を使用してAmazon Kendra、コメント、タスク、ウェブリンクなど、Box コンテンツ内のコンテンツのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [BoxConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BoxConfiguration.html) API を使用して Box データソースAmazon Kendraに接続できます。 Amazon KendraBox データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-box) + [ ## 前提条件 ](#prerequisites-box) + [ ## 接続手順 ](#data-source-procedure-box) + [ ## 詳細はこちら ](#box-learn-more) + [ ## 注意事項 ](#box-notes) ## サポートされている機能 Amazon KendraBox データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 変更ログ、完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Box データソースのインデックスを作成する前に、Box とAWSアカウントでこれらの変更を行います。 **Box で以下を確認してください。** + Box Enterprise または Box Enterprise Plus アカウント。 + JSON Web トークン (JWT) を使用したサーバー側認証で、Box 開発者コンソールで Box カスタムアプリを設定済み。詳細については、[カスタムアプリの作成に関する Box ドキュメント](https://developer.box.com/guides/applications/app-types/platform-apps/)と[JWT Auth の設定に関する Box ドキュメント](https://developer.box.com/guides/authentication/jwt/)を参照してください。 + **[アプリのアクセスレベル]** を **[アプリ \$1 エンタープライズアクセス]** に設定し、**[as-user ヘッダーを使用して API 呼び出しを行えるようにします]**。 + 管理者ユーザーを使用して、以下の**[アプリケーションのスコープ]** を Box アプリに追加しました。 + Box に保存されているすべてのファイルとフォルダを書き込みます。 + ユーザーの管理 + グループの管理 + エンタープライズプロパティの管理 + クライアント ID、クライアントシークレット、パブリックキー ID、プライベートキー ID、パスフレーズ、認証情報として使用するエンタープライズ ID を含むパブリックキー/プライベートキーペアを設定済み。詳細については、「[Public and private key pair](https://developer.box.com/guides/authentication/jwt/jwt-setup/#public-and-private-key-pair)」を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Box Developer Console の設定または Box アプリから Box エンタープライズ ID をコピーしました。例えば、*801234567* です。 + 各ドキュメントが Box および同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Box の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Box データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Box データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Box データソースの必要な詳細を指定する必要があります。Box をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-box)。 ------ #### [ Console ] **Box Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Box コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Box コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **Box エンタープライズ ID** - Box エンタープライズ ID を入力します。例えば、*801234567* です。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Box 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Box-」が自動的に追加されます。 1. **[クライアント ID]**、**[クライアントシークレット]**、**[パブリックキー ID]**、**[プライベートキー ID]**、**[パスフレーズ]** - Box で設定したパブリックキー/プライベートキーの値を入力します。 1. シークレットを追加して保存します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[Box のファイル]** — ウェブリンク、コメント、タスクをクロールするかどうかを選択します。 1. **[追加設定]** - 特定のコンテンツを含める、または除外するための正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新しい、変更された同期: データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + 新規作成、変更、削除の同期: データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Box Amazon Kendraに接続するには** [BoxConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BoxConfiguration.html) API を使用して以下を指定する必要があります。 **[Box エンタープライズ ID]** - Box エンタープライズ ID を入力します。エンタープライズ ID は、Box 開発者コンソールの設定で、または Box でアプリを設定するときに確認できます。 + **Secret Amazon Resource Name (ARN)** — Box アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "clientID": "client-id", "clientSecret": "client-secret", "publicKeyID": "public-key-id", "privateKey": "private-key", "passphrase": "pass-phrase" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、Secrets Managerシークレットにアクセスするためのアクセス許可を IAMロールに提供し、Box コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Box data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - データソース設定の一部として `VpcConfiguration` を指定します。「[VPC を使用するための Amazon Kendra の設定](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 + **変更ログ** - インデックス内でドキュメントを更新する必要があるかどうかを判断するために、Amazon Kendra が Box データソースの変更ログメカニズムを使用するかどうか。 **注記** Amazon Kendra にすべてのドキュメントをスキャンさせない場合は、変更ログを使用します。変更ログが大きい場合、変更ログを処理するよりも Box データソース内のドキュメントのスキャンにAmazon Kendra時間がかかる場合があります。Box データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 + **[コメント、タスク、ウェブリンク]** — これらのタイプのコンテンツをクロールするかどうかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[包含フィルターと除外フィルター]** - Box の特定のファイルおよびフォルダを含める、または除外するように指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Box データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 ------ ## 詳細はこちら Box データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Amazon KendraBox コネクタの開始方法](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-box-connector/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Box API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用できません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # Confluence Confluence は、プロジェクト計画、ソフトウェア開発、製品管理を共有、保存、作業するために設計された共同作業管理ツールです。 は、Confluence Server/Data Center と Confluence Cloud の両方 Amazon Kendra をサポートしています。を使用して Amazon Kendra 、次の Confluence エンティティのインデックスを作成できます。 + **スペース** – 関連コンテンツを整理するための指定エリアの最上位部分。各スペースはコンテナとして機能し、複数のページ、ブログ、添付ファイルを保持できます。 + **ページ** – ユーザーがコンテンツを作成および管理するスペース内の個々のドキュメント。ページには、テキスト、画像、表、マルチメディア要素を含めることができ、ネストされた子ページを含めることもできます。各ページは 1 つのドキュメントと見なされます。 + **ブログ** – ページに似たコンテンツで、通常は、更新や発表に使用されます。各ブログ投稿は 1 つのドキュメントと見なされます。 + **コメント** – ユーザーは、ページまたはブログ投稿内の特定のコンテンツについてフィードバックを提供したり、ディスカッションに参加したりできます。 + **添付ファイル** – 画像やドキュメント、またはその他のファイル形式の、Confluence のページやブログ投稿にアップロードされたファイル。 デフォルトでは、Confluence アーカイブと個人用スペースのインデックス Amazon Kendra は作成されません。データソースの作成時に、インデックス作成を行うことができます。スペース Amazon Kendra のインデックスを作成しない場合は、Confluence でプライベートにマークします。 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API、または [ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html) API を使用して Confluence データソース Amazon Kendra に接続できます。 Amazon Kendra には Confluence コネクタの 2 つのバージョンがあります。次の機能がサポートされています。 ****Confluence コネクタ V2.0 / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API**** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外パターン + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ****Confluence コネクタ V1.0/[ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html) API** (サポートされなくなりました)** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + (Confluence Server のみ) 仮想プライベートクラウド (VPC) **注記** Confluence Connector V1.0 / ConfluenceConfiguration API は 2023 年に終了しました。Confluence コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra Confluence データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## Confluence コネクタの ACL ](#data-source-confluence-acls) + [ # Confluence コネクタ V2.0 ](data-source-v2-confluence.md) + [ # Confluence コネクタ V1.0 ](data-source-v1-confluence.md) ## Confluence コネクタの ACL コネクタでは、データソースに応じて、該当する場合はアクセスコントロールリスト (ACL) と ID 情報のクローリングをサポートしています。ACL を使用せずにドキュメントのインデックスを作成すると、すべてのドキュメントがパブリックと見なされます。ACL を使用してドキュメントのインデックスを作成することで、データのセキュリティが確保されます。 Amazon Kendra Confluence コネクタはスペースをスキャンして、ACLs。ページまたはブログに制限が適用されていない場合は、コネクタはそのスペースからアクセス許可を継承します。特定のユーザーまたはグループの制限がページに適用されている場合は、それらのユーザーのみがそのページにアクセスできます。ページがネストされている場合は、制限が適用されていない限り、ネストされたページは親ページのアクセス許可を継承します。ブログにも同様のアクセス許可モデルが適用されますが、Confluence はネストされたブログをサポートしていません。 さらに、 Amazon Kendra Confluence コネクタは、設定された各スペースのユーザープリンシパル情報 (ローカルユーザーエイリアス、ローカルグループ、フェデレーティッドグループ ID 設定) とそのアクセス許可をクロールします。 **注記** Confluence Cloud コネクタは、マクロ、ホワイトボード、またはデータベースのクローリングをサポートしていません。 Amazon Kendra Confluence コネクタは、データソースコンテンツをクロールするたびに ACL の変更を更新します。正しいユーザーが正しいコンテンツにアクセスすることを確実にするために、定期的にデータソースを再同期して ACL の更新をキャプチャするようにしてください。 # Confluence コネクタ V2.0 Confluence は、プロジェクト計画、ソフトウェア開発、製品管理の共有、保存、作業を目的とした共同作業管理ツールです。 Amazon Kendra を使用して、Confluence スペース、ページ (ネストされたページを含む）、ブログ、およびコメントと添付ファイルをインデックス付きページとブログにインデックス付けできます。 Amazon Kendra Confluence データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-confluence) + [ ## 前提条件 ](#prerequisites-v2-confluence) + [ ## 接続手順 ](#data-source-procedure-v2-confluence) ## サポートされている機能 Amazon Kendra Confluence データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外パターン + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して Confluence データソースのインデックスを作成する前に、Confluence と AWS アカウントでこれらの変更を行います。 **Confluence で以下を確認してください。** + Confluence インスタンスの URL をコピーしました。例: *https://example.confluence.com*、*https://www.example.confluence.com/*、または *https:// atlassian.net/*。 Amazon Kendraに接続するには、Confluence インスタンス URL が必要です。 Confluence Cloud を使用している場合、ホスト URL は *atlassian.net/* で終わる必要があります。 **注記** 以下の URL の形式はサポートされて**いません**。 *https://example.confluence.com/xyz* *https://www.example.confluence.com//wiki/spacekey/xxx* *https://atlassian.net/xyz* **注記** (オンプレミス/サーバー) Amazon Kendra AWS Secrets Manager は、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。[混乱する代理問題](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、 Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。 + ユーザー名 (Confluence へのログインに使用する電子メール ID) とパスワード (Confluence API トークンをパスワードとして) を含む基本認証情報を設定済みであること。「[Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/#Create-an-API-token)」を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション:** Amazon Kendra を Confluence インスタンスに接続できるように、Confluence アプリキー、Confluence アプリシークレット、Confluence アクセストークン、および Confluence リフレッシュトークンを含む OAuth 2.0 認証情報を設定しました。アクセストークンの有効期限が切れた場合は、更新トークンを使用してアクセストークンと更新トークンのペアを再生成できます。または、認可プロセスを繰り返すこともできます。アクセストークンの詳細については、「[OAuth アクセストークンの管理](https://support.atlassian.com/confluence-cloud/docs/manage-oauth-access-tokens/)」を参照してください。 + (Confluence Server/Data Center のみ) **オプション:** Confluence で個人用アクセストークン (PAT) を設定済みであること。「[Using Personal Access Tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)」を参照してください。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + Confluence の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、コンソールを使用して Confluence データソースを接続するときに新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Confluence データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように Confluence データソースの必要な詳細を指定する必要があります。Confluence をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v2-confluence)。 ------ #### [ Console ] **Confluence Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Confluence コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Confluence コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** で、**[Confluence Cloud]** または **[Confluence Server/Data Center]** を選択します。 1. **Confluence の URL** - Confluence のホスト URL を入力します。例: *https://example.confluence.com* 1. (Confluence Server/データセンターのみ) **SSL 証明書の場所 - *オプション*** - Confluence Server の SSL 証明書ファイルへの Amazon S3 パスを入力します。 1. (Confluence Server/Data Center のみ) **[ウェブプロキシ - *オプション*]** - ウェブプロキシのホスト名 (`http://` プロトコルまたは `https://` プロトコルは含めません) とポート番号 (ホスト URL トランスポートプロトコルが使用するポート) を入力します。ポート番号は 0～65535 の数字である必要があります。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** — **基本認証**、**Oauth 2.0 認証**、または (Confluence Server/Data Center のみ) **個人用アクセストークン認証**のいずれかを選択します。 1. **[AWS Secrets Manager シークレット]** - Confluence の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Confluence-」が自動的に追加されます。 1. **基本認証**を使用する場合 - Confluence で設定したシークレット名、ユーザー名、パスワード (Confluence API トークンをパスワードとして使用) を入力します。 **OAuth2.0 認証**を使用する場合 - Confluence で設定したシークレット名、アプリキー、アプリシークレット、アクセストークン、更新トークンを入力します。 (Confluence Server/Data Center のみ) **個人用アクセストークン認証**を使用する場合 - Confluence で設定したシークレット名と Confluence トークンを入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAM role** — 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期スコープ]** の **[コンテンツを同期]** - 次のコンテンツタイプから同期するものを選択します。ページ、ページのコメント、ページの添付ファイル、ブログ、ブログのコメント、ブログの添付ファイル、個人用スペース、アーカイブ済みスペース。 **注記** ページのコメントとページの添付ファイルは、**ページ**を同期することを選択した場合にのみ選択できます。ブログのコメントとブログの添付ファイルは、**ブログ**を同期することを選択した場合にのみ削除できます。 **重要** **[追加設定]** でスペースキーの正規表現パターンを指定しない場合、すべてのページとブログがデフォルトでクロールされます。 1. **追加設定**で、**ファイルの最大サイズ** - クロール Amazon Kendra するファイルサイズの制限を MBs 単位で指定します。 Amazon Kendra は、定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50 MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。 **[スペースの正規表現パターン]** - 特定のスペースをインデックスに含めるか除外するかを次のように指定します。 + スペースキー (例: *my-space-123*) **注記** スペースキーの正規表現パターンを指定しない場合、すべてのページとブログがデフォルトでクロールされます。 + URL (例: *.\$1/MySite/MyDocuments/*) + ファイルタイプ (例: *.\$1\$1.pdf, .\$1\$1.txt*) **[エンティティタイトル正規表現パターン]** - 特定のブログ、ページ、コメント、添付ファイルをタイトル別に含めたり除外したりするための正規表現パターンを指定します。 **注記** 特定のページまたは子ページのクローリングを含める、または除外する場合には、ページタイトルの正規表現パターンを使用できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. インデックスにマッピングする Amazon Kendra 、生成されたデフォルトのデータソースフィールドから選択します。カスタムデータソースフィールドを追加するには、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Confluence Amazon Kendra に接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-confluence-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `CONFLUENCEV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **[ホスト URL]** - Confluence のホスト URL インスタンスを指定します。例: *https://example.confluence.com* + **[同期モード]** - データソースのコンテンツが変更されたときに、 Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **[認証タイプ]** — 認証のタイプを指定します。`Basic`、`OAuth2`、`Personal-token` (Confluence Server のみ) のいずれかを指定します。 + (オプション - Confluence サーバーのみ) **SSL 証明書の場所** - SSL 証明書の保存に使用した `S3bucketName` および `s3certificateName` を指定します。 + **Secret Amazon Resource Name (ARN)** — Confluence で設定した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "username": "email ID or user name", "password": "Confluence API token" } ``` OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "confluenceAppKey": "app key", "confluenceAppSecret": "app secret", "confluenceAccessToken": "access token", "confluenceRefreshToken": "refresh token" } ``` (Confluence サーバーのみ) 基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "hostUrl": "Confluence Server host URL", "username": "Confluence Server user name", "password": "Confluence Server password" } ``` (Confluence サーバーのみ) パーソナルアクセストークン認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "hostUrl": "Confluence Server host URL", "patToken": "personal access token" } ``` + **IAM role** — を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、Confluence コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for Confluence data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[ファイルサイズ]** - クロールする最大ファイルサイズを指定します。 + **[ドキュメント/コンテンツタイプ]** — ページ、ページのコメント、ページの添付ファイル、ブログ、ブログのコメント、ブログの添付ファイル、スペース、アーカイブされたスペースをクロールするかどうかを指定します。 + **[包含フィルターと除外フィルター]** - 特定のスペース、ページ、ブログ、およびそれらのコメントや添付ファイルを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ウェブプロキシ]** — ウェブプロキシを介して Confluence の URL インスタンスに接続する場合は、ウェブプロキシ情報を指定します。このオプションは Confluence サーバーに使用できます。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 + **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Confluence データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Confluence テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-confluence-schema)」を参照してください。 ------ ### 注意事項 + 個人用アクセストークン (PAT) は Confluence クラウドでは使用できません。 # Confluence コネクタ V1.0 Confluence は、プロジェクト計画、ソフトウェア開発、製品管理の共有、保存、作業を目的とした共同作業管理ツールです。 Amazon Kendra を使用して、Confluence スペース、ページ (ネストされたページを含む）、ブログ、およびコメントと添付ファイルをインデックス付きページとブログにインデックス付けできます。 **注記** Confluence Connector V1.0 / ConfluenceConfiguration API は 2023 年に終了しました。Confluence コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra Confluence データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-confluence) + [ ## 前提条件 ](#prerequisites-v1-confluence) + [ ## 接続手順 ](#data-source-procedure-v1-confluence) + [ ## 詳細情報 ](#confluence-v1-learn-more) ## サポートされている機能 Amazon Kendra Confluence データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + (Confluence サーバーのみ) 仮想プライベートクラウド (VPC) ## 前提条件 Amazon Kendra を使用して Confluence データソースのインデックスを作成する前に、Confluence と AWS アカウントでこれらの変更を行います。 **Confluence で以下を確認してください。** + Confluence インスタンス内のすべてのコンテンツを表示するアクセス Amazon Kendra 許可を付与 + `confluence-administrators` グループのメンバー Amazon Kendra を作成する。 + 既存のすべてのスペース、ブログ、ページにサイト管理者アクセス許可を付与する。 + Confluence インスタンスの URL をコピーしました。 + **SSO (シングルサインオン) ユーザー向け:** Confluence データセンターで Confluence **認証方法**を設定するときに、ユーザー名とパスワードの **[ログインページに表示]** をアクティブ化しました。 + **Confluence サーバー用** + Amazon Kendraに接続するための Confluence 管理アカウントのユーザー名とパスワードを含む基本認証情報を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション:** Amazon Kendraに接続するための個人アクセストークンが Confluence アカウントで生成されました。詳細については、「[個人用アクセストークンの生成に関する Confluence ドキュメント](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)」を参照してください。 + **Confluence クラウド用** + Amazon Kendraに接続するための Confluence 管理アカウントのユーザー名とパスワードを含む基本認証情報を記録しました。 + 各ドキュメントが Confluence および同じインデックスに使用する予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + Confluence の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、コンソールを使用して Confluence データソースを接続するときに新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Confluence データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように Confluence 認証情報の詳細を指定する必要があります。Confluence をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v1-confluence)。 ------ #### [ Console ] **Confluence Amazon Kendra に接続するには** 1. AWS マネジメントコンソールにサインインし、[Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[Confluence コネクタ V1.0]** を選択し、**[データソースを追加]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[Confluence Cloud]** と **[Confluence Server]** のどちらかを選択します。 1. **[Confluence Cloud]** を選択した場合は、次の情報を入力します。 1. **[Confluence URL]** - ユーザーの Confluence URL。 1. **AWS Secrets Manager secret** — 既存のシークレットを選択するか、Confluence 認証情報を保存する新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、[ AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[ AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Confluence-」が自動的に追加されます。 1. **[ユーザー名]** と **[パスワード]** - Confluence のユーザー名とパスワードを入力します。 1. **[認証を保存]** を選択します。 1. **[Confluence Server]** を選択した場合は、次の情報を入力します。 1. **[Confluence URL]** - お客様の Confluence ユーザー名とパスワード。 1. (オプション) **[ウェブプロキシ]** には次の情報を入力します。 1. **[ホスト名]** - Confluence アカウントのホスト名。 1. **[ポート番号]** - ホスト URL トランスポートプロトコルが使用するポート。 1. **[認証]** には、**[基本認証]** または **[個人用アクセストークン]** (Confluence Server のみ) を選択します。 1. **AWS Secrets Manager secret** — 既存のシークレットを選択するか、Confluence 認証情報を保存する新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、[ AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[ AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Confluence-」が自動的に追加されます。 1. **[ユーザー名]** と **[パスワード]** - Confluence で設定した認証情報値を入力します。基本認証を使用の場合は、Confluence のユーザー名 (E メール ID) とパスワード (API トークン) を使用します。個人用アクセストークンを使用の場合は、Confluence アカウントで設定した **[個人用アクセストークン]** の詳細を入力します。 1. シークレットを保存して追加します。 1. **IAM role** — 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[個人用スペースを含める]** と **[アーカイブされたスペースを含む]** の場合 - このデータソースに含めるオプションのスペースタイプを選択します。 1. **[追加設定]** の場合: 特定のコンテンツを含めるか除外する正規表現パターンを指定します。最大 100 のパターンを追加できます。 1. **選択したスペース内の添付ファイルをクロールする**こともできます。 1. **同期実行スケジュール**で**、頻度** - Amazon Kendra がデータソースと同期する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **スペース**、**ページ**、**ブログ** - Amazon Kendra 生成されたデフォルトのデータソースフィールドまたは**追加の推奨フィールドマッピング**から選択して、インデックスフィールドを追加します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Confluence Amazon Kendra に接続するには** [ConfluenceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ConfluenceConfiguration.html) API を使用して以下を指定する必要があります。 + **Confluence バージョン** - `CLOUD` または `SERVER` として使用している Confluence インスタンスのバージョンを指定します。 + **Secret Amazon Resource Name (ARN)** — Confluence 認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。 Confluence Server を使用している場合は、Confluence のユーザー名とパスワード、または個人アクセストークンのいずれかを認証情報として使用できます。 Confluence のユーザー名とパスワードを認証情報として使用する場合、以下の認証情報を JSON 構造として Secrets Manager のシークレットに保存します。 ``` { "username": "user name", "password": "password" } ``` 個人用アクセストークンを使用して Confluence Server を に接続する場合 Amazon Kendra、次の認証情報を JSON 構造としてシークレットに Secrets Manager 保存します。 ``` { "patToken": "personal access token" } ``` Confluence Cloud を使用する場合は、Confluence で設定された Confluence のユーザー名、および API トークンをパスワードとして使用します。次の認証情報を JSON 構造として Secrets Manager シークレットに保存します。 ``` { "username": "user name", "password": "API token" } ``` + **IAM role** — を呼び出し`CreateDataSource`て IAM ロールに Secrets Manager シークレットへのアクセス許可を付与し、Confluence コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for Confluence data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **ウェブプロキシ** - ウェブプロキシ経由で Confluence URL インスタンスに接続するかどうか。このオプションは Confluence サーバーに使用できます。 + (Confluence サーバーのみ) **[仮想プライベートクラウド (VPC)]** - データソース設定の一部として `VpcConfiguration` を指定します。[「VPC を使用する Amazon Kendra ように を設定する](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のスペース、ブログ投稿、ページ、スペース、および添付ファイルを含めるか除外する正規表現パターンを指定します。添付ファイルのインデックスを作成する場合は、インデックスで指定されたページおよびブログへの添付ファイルのみがインデックス作成されます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、Confluence データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ ## 詳細情報 Confluence データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [Amazon Kendra Confluence Server コネクタの設定 ](https://aws.amazon.com/blogs/machine-learning/configuring-your-amazon-kendra-confluence-server-connector/) # カスタムデータソースコネクタ Amazon Kendra がまだデータソースコネクタを提供していないリポジトリがある場合は、カスタムデータソースを使用します。Amazon Kendra のデータソースを使用してリポジトリを同期できない場合でも、Amazon Kendra データソースが提供する同じ実行履歴メトリクスを確認できます。これを使用して、Amazon Kendra データソースとカスタムデータソース間で一貫した同期モニタリングエクスペリエンスを作成します。具体的には、カスタムデータソースを使用して、[BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html) および [BatchDeleteDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchDeleteDocument.html) API を使用して作成したデータソースコネクタの同期メトリクスを確認します。 Amazon Kendra データソースコネクタのトラブルシューティングについては、「[データソースのトラブルシューティング](troubleshooting-data-sources.md)」を参照してください。 カスタムデータソースを作成すると、インデックスを作成するドキュメントの選択方法を完全に制御できます。Amazon Kendra はデータソース同期ジョブのモニタリングに使用できるメトリクス情報のみを提供します。データソースインデックスを決定するクローラを作成し、実行する必要があります。 `Query` 結果のレスポンスに `DocumentTitle` と `DocumentURI` を含めるには、[ドキュメント](https://docs.aws.amazon.com/kendra/latest/APIReference/API_Document.html)オブジェクトを使用してドキュメントのメインタイトルを指定し、[DocumentAttribute](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttribute.html) で `_source_uri` を指定する必要があります。 コンソールを使用して、または [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) API を使用してカスタムデータソースの識別子を作成します。コンソールを使用するには、データソースに名前を付け、オプションで説明とリソースタグを指定します。データソースが作成されると、データソース ID が表示されます。この ID をコピーして、データソースをインデックスと同期するときに使用します。 ![\[Form for specifying data source details, including name, description, and optional tags.\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/images/CustomDataSource.png) `CreateDataSource` API を使用して、カスタムデータソースを作成することもできます。この API は、データソースを同期するときに使用する ID を返します。`CreateDataSource` API を使用してカスタムデータソースを作成する場合、`Configuration`、`RoleArn` または `Schedule` パラメータは設定できません。これらのパラメータを設定すると、Amazon Kendra は `ValidationException` 例外を返します。 カスタムデータソースを使用するには、Amazon Kendra インデックスの更新を担当するアプリケーションを作成します。アプリケーションは、作成するクローラによって異なります。クローラーはリポジトリ内のドキュメントを読み取り、Amazon Kendra に送信するドキュメントを決定します。アプリケーションでは、以下のステップを実行する必要があります。 1. リポジトリをクロールし、リポジトリ内の追加、更新、または削除されるドキュメントのリストを作成します。 1. [StartDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StartDataSourceSyncJob.html) API を呼び出して、同期ジョブが開始されていることを通知します。同期しているデータソースを識別するためのデータソース ID を指定します。 Amazon Kendra は、特定の同期ジョブを識別するために実行 ID を返します。 1. [BatchDeleteDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchDeleteDocument.html) API を呼び出して、インデックスからドキュメントを削除します。同期しているデータソースと、この更新が関連付けられているジョブを識別するために、データソース ID と実行 ID を指定します。 1. [StopDataSourceSyncJob](https://docs.aws.amazon.com/kendra/latest/APIReference/API_StopDataSourceSyncJob.html) API を呼び出し、同期ジョブの終了を通知します。`StopDataSourceSyncJob` API を呼び出すと、関連付けられた実行 ID は無効になります。 1. インデックスとデータソース識別子を使用して [ListDataSourceSyncJobs](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ListDataSourceSyncJobs.html) API を呼び出し、データソースの同期ジョブを一覧表示し、同期ジョブのメトリクスを表示します。 同期ジョブを終了したら、新しい同期ジョブを開始できます。提出されたすべてのドキュメントがインデックスに追加されるまで期間がある場合があります。`ListDataSourceSyncJobs` API を使用して、同期ジョブのステータスを確認します。同期ジョブに対して返された `Status` が `SYNCING_INDEXING` の場合、一部のドキュメントはまだインデックス作成中です。前のジョブのステータスが `FAILED` または `SUCCEEDED` の場合は、新しい同期ジョブを開始できます。 `StopDataSourceSyncJob` API を呼び出した後、同期ジョブ識別子は、`BatchPutDocument` または `BatchDeleteDocument` API への呼び出には使えません。呼び出しに使用した場合、送信されたすべてのドキュメントは、API からの `FailedDocuments` レスポンスメッセージに返されます。 ## 必須属性 `BatchPutDocument` API を使用して Amazon Kendra にドキュメントを送信すると、各ドキュメントにはドキュメントが属するデータソースと同期実行を識別するために 2 つの属性が必要です。カスタムデータソースのドキュメントを Amazon Kendra インデックスに正しくマッピングするには、次の 2 つの属性を指定する必要があります。 + `_data_source_id` - データソースの識別子。これは、コンソールまたは `CreateDataSource` API を使用してデータソースを作成したときに返されます。 + `_data_source_sync_job_execution_id` - 同期実行の識別子。これは、`StartDataSourceSyncJob` API とのインデックスの同期を開始したときに返されます。 カスタムデータソースを使用してドキュメントのインデックスを作成するために必要な JSON を次に示します。 ``` { "Documents": [ { "Attributes": [ { "Key": "_data_source_id", "Value": { "StringValue": "data source identifier" } }, { "Key": "_data_source_sync_job_execution_id", "Value": { "StringValue": "sync job identifier" } } ], "Blob": "document content", "ContentType": "content type", "Id": "document identifier", "Title": "document title" } ], "IndexId": "index identifier", "RoleArn": "IAM role ARN" } ``` `BatchDeleteDocument` API を使用してインデックスからドキュメントを削除すると、`DataSourceSyncJobMetricTarget` パラメータで次の 2 つのフィールドを指定する必要があります。 + `DataSourceId` - データソースの識別子。これは、コンソールまたは `CreateDataSource` API を使用してデータソースを作成したときに返されます。 + `DataSourceSyncJobId` - 同期実行の識別子。これは、`StartDataSourceSyncJob` API とのインデックスの同期を開始したときに返されます。 以下は、`BatchDeleteDocument` API を使用してインデックスからドキュメントを削除するのに必要な JSON です。 ``` { "DataSourceSyncJobMetricTarget": { "DataSourceId": "data source identifier", "DataSourceSyncJobId": "sync job identifier" }, "DocumentIdList": [ "document identifier" ], "IndexId": "index identifier" } ``` ## メトリクスの表示 同期ジョブが終了したら、 [DataSourceSyncJobMetrics](https://docs.aws.amazon.com/kendra/latest/APIReference/API_DataSourceSyncJobMetrics.html) API を使用して、同期ジョブに関連付けられたメトリクスを取得します。これを使用して、カスタムデータソースの同期をモニタリングします。 同じドキュメントを複数回提出する場合、`BatchPutDocument` API、`BatchDeleteDocument` API のいずれかの一部で、ドキュメントが追加と削除の両方で送信された場合、ドキュメントはメトリクスで一度だけカウントされます。 + `DocumentsAdded` - インデックスに初めて追加されたこの同期ジョブに関連付けられた `BatchPutDocument` API で送信されたドキュメントの数。ドキュメントが同期で複数回追加されるように送信された場合、そのドキュメントはメトリクスで 1 回だけカウントされます。 + `DocumentsDeleted` - インデックスから削除されたこの同期ジョブに関連付けられた `BatchDeleteDocument` API を使用して送信されたドキュメントの数。ドキュメントが同期で複数回削除されるように送信された場合、そのドキュメントはメトリクスで 1 回だけカウントされます。 + `DocumentsFailed` - インデックス作成に失敗したこの同期ジョブに関連付けられているドキュメントの数。これらは、Amazon Kendra がインデックス作成のために受け入れましたが、インデックス作成または削除はできなかったドキュメントです。Amazon Kendra によってドキュメントが受け入れられない場合、ドキュメントの識別子は `BatchPutDocument` および `BatchDeleteDocument` API の `FailedDocuments` レスポンスプロパティに返されます。 + `DocumentsModified` - Amazon Kendra インデックスで変更されたこの同期ジョブに関連付けられた `BatchPutDocument` API を使用して送信された、変更されたドキュメントの数。 Amazon Kendra は、ドキュメントのインデックス作成中に Amazon CloudWatch メトリクスも発行します。詳細については、「[Amazon CloudWatch による Amazon Kendra のモニタリング](https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-metrics.html)」を参照してください。 Amazon Kendra はカスタムデータソースの `DocumentsScanned` メトリクスを返しません。また、[Amazon Kendra データソースのメトリクス](https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-metrics.html#cloudwatch-metrics-data-source)ドキュメントに記載されている CloudWatch メトリクスも出力します。 ## 詳細 Amazon Kendra とカスタムデータソースの統合について詳しくは、以下をご覧ください。 + [Amazon Kendra へのカスタムデータソースの追加](https://aws.amazon.com/blogs/machine-learning/adding-custom-data-sources-to-amazon-kendra/) # カスタムデータソース (Java) 以下のコードは、Java を使用したカスタムデータソースの実装の例を示します。プログラムはまずカスタムデータソースを作成し、次に新しく追加されたドキュメントをカスタムデータソースを持つインデックスに同期します。 次のコードは、カスタムデータソースを作成して使用する方法を示しています。アプリケーションでカスタムデータソースを使用している場合は、インデックスをデータソースと同期するたびに新しいデータソースを作成する必要はありません (1 回限りのプロセス)。インデックス ID とデータソース ID を使用してデータを同期します。 ``` package com.amazonaws.kendra; import java.util.concurrent.TimeUnit; import software.amazon.awssdk.services.kendra.KendraClient; import csoftware.amazon.awssdk.services.kendra.model.BatchPutDocumentRequest; import csoftware.amazon.awssdk.services.kendra.model.BatchPutDocumentResponse; import software.amazon.awssdk.services.kendra.model.CreateDataSourceRequest; import software.amazon.awssdk.services.kendra.model.CreateDataSourceResponse; import software.amazon.awssdk.services.kendra.model.DataSourceType; import software.amazon.awssdk.services.kendra.model.Document; import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsRequest; import software.amazon.awssdk.services.kendra.model.ListDataSourceSyncJobsResponse; import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobRequest; import software.amazon.awssdk.services.kendra.model.StartDataSourceSyncJobResponse; import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobRequest; import software.amazon.awssdk.services.kendra.model.StopDataSourceSyncJobResponse; public class SampleSyncForCustomDataSource { public static void main(String[] args) { KendraClient kendra = KendraClient.builder().build(); String myIndexId = "yourIndexId"; String dataSourceName = "custom data source"; String dataSourceDescription = "Amazon Kendra custom data source connector" // Create custom data source CreateDataSourceRequest createDataSourceRequest = CreateDataSourceRequest .builder() .indexId(myIndexId) .name(dataSourceName) .description(dataSourceDescription) .type(DataSourceType.CUSTOM) .build(); CreateDataSourceResponse createDataSourceResponse = kendra.createDataSource(createDataSourceRequest); System.out.println(String.format("Response of creating data source: %s", createDataSourceResponse)); // Get the data source ID from createDataSourceResponse String dataSourceId = createDataSourceResponse.Id(); // Wait for the custom data source to become active System.out.println(String.format("Waiting for Amazon Kendra to create the data source %s", dataSourceId)); // You can use the DescribeDataSource API to check the status DescribeDataSourceRequest describeDataSourceRequest = DescribeDataSourceRequest .builder() .indexId(myIndexId) .id(dataSourceId) .build(); while (true) { DescribeDataSourceResponse describeDataSourceResponse = kendra.describeDataSource(describeDataSourceRequest); DataSourceStatus status = describeDataSourceResponse.status(); System.out.println(String.format("Creating data source. Status: %s", status)); if (status != DataSourceStatus.CREATING) { break; } TimeUnit.SECONDS.sleep(60); } // Start syncing yor data source by calling StartDataSourceSyncJob and providing your index ID // and your custom data source ID System.out.println(String.format("Synchronize the data source %s", dataSourceId)); StartDataSourceSyncJobRequest startDataSourceSyncJobRequest = StartDataSourceSyncJobRequest .builder() .indexId(myIndexId) .id(dataSourceId) .build(); StartDataSourceSyncJobResponse startDataSourceSyncJobResponse = kendra.startDataSourceSyncJob(startDataSourceSyncJobRequest); // Get the sync job execution ID from startDataSourceSyncJobResponse String executionId = startDataSourceSyncJobResponse.ExecutionId(); System.out.println(String.format("Waiting for the data source to sync with the index %s for execution ID %s", indexId, startDataSourceSyncJobResponse.executionId())); // Add 2 documents uploaded to S3 bucket to your index using the BatchPutDocument API // The added documents should sync with your custom data source Document pollyDoc = Document .builder() .s3Path( S3Path.builder() .bucket("amzn-s3-demo-bucket") .key("what_is_Amazon_Polly.docx") .build()) .title("What is Amazon Polly?") .id("polly_doc_1") .build(); Document rekognitionDoc = Document .builder() .s3Path( S3Path.builder() .bucket("amzn-s3-demo-bucket") .key("what_is_amazon_rekognition.docx") .build()) .title("What is Amazon rekognition?") .id("rekognition_doc_1") .build(); BatchPutDocumentRequest batchPutDocumentRequest = BatchPutDocumentRequest .builder() .indexId(myIndexId) .documents(pollyDoc, rekognitionDoc) .build(); BatchPutDocumentResponse result = kendra.batchPutDocument(batchPutDocumentRequest); System.out.println(String.format("BatchPutDocument result: %s", result)); // Once custom data source synced, stop the sync job using the StopDataSourceSyncJob API StopDataSourceSyncJobResponse stopDataSourceSyncJobResponse = kendra.stopDataSourceSyncJob( StopDataSourceSyncJobRequest() .indexId(myIndexId) .id(dataSourceId) ); // List your sync jobs ListDataSourceSyncJobsRequest listDataSourceSyncJobsRequest = ListDataSourceSyncJobsRequest .builder() .indexId(myIndexId) .id(dataSourceId) .build(); while (true) { ListDataSourceSyncJobsResponse listDataSourceSyncJobsResponse = kendra.listDataSourceSyncJobs(listDataSourceSyncJobsRequest); DataSourceSyncJob job = listDataSourceSyncJobsResponse.history().get(0); System.out.println(String.format("Status: %s", job.status())); } } } ``` # Dropbox Dropbox は、クラウドストレージ、ドキュメント整理、ドキュメントテンプレートサービスを提供するファイルホスティングサービスです。Dropbox ユーザーの場合は、 Amazon Kendraを使用して Dropbox ファイル、Dropbox Paper、Dropbox Paper Templates、およびウェブページへの保存されたショートカットのインデックスを作成できます。特定の Dropbox ファイル、Dropbox Paper、Dropbox Paper Templates、およびウェブページへの保存されたショートカットのインデックスを作成するAmazon Kendraように を設定することもできます。 Amazon Kendraは、Dropbox Business 用の Dropbox と Dropbox Advanced の両方をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して、Dropbox データソースAmazon Kendraに接続できます。 Amazon KendraDropbox データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-dropbox) + [ ## 前提条件 ](#prerequisites-dropbox) + [ ## 接続手順 ](#data-source-procedure-dropbox) + [ ## 詳細はこちら ](#dropbox-learn-more) + [ ## 注意事項 ](#dropbox-notes) ## サポートされている機能 Amazon KendraDropbox データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Dropbox データソースのインデックスを作成する前に、Dropbox とAWSアカウントでこれらの変更を行います。 **Dropbox で以下を確認してください。** + Dropbox Advanced アカウントを作成し、管理者ユーザーを設定しました。 + 独自の **[アプリ名]** を使用して Dropbox アプリを設定し、**[スコープ付きアクセス]** を有効化しました。[アプリの作成については Dropbox のドキュメントを参照してください。](https://www.dropbox.com/developers/reference/getting-started#app%20console) + Dropbox コンソールで **[フル Dropbox]** アクセス許可を有効にし、次のアクセス許可を追加しました。 + files.content.read + files.metadata.read + sharing.read + file\$1requests.read + groups.read + team\$1info.read + team\$1data.content.read + 基本認証情報として Dropbox アプリキー、Dropbox アプリシークレット、Dropbox アクセストークンを記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Dropbox アプリ用の一時的な OAuth 2.0 アクセストークンを設定してコピーしました。このトークンは一時的なもので、4 時間後に有効期限が切れます。[OAuth 認証については Dropbox のドキュメント](https://developers.dropbox.com/oauth-guide)を参照してください。 **注記** 4 時間後に有効期限が切れる 1 回限りのアクセストークンに頼るのではなく、有効期限のない Dropbox 更新アクセストークンを作成することをお勧めします。更新アクセストークンは永続的で有効期限がないため、今後もデータソースを同期し続けることができます。 + **推奨:** が中断することなくデータソースAmazon Kendraの同期を継続できるように、有効期限のない Dropbox 永続更新トークンを設定しました。[更新トークンについては Dropbox のドキュメント](https://developers.dropbox.com/oauth-guide)を参照してください。 + 各ドキュメントが Dropbox および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Dropbox の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Dropbox データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Dropbox データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Dropbox データソースの必要な詳細を指定する必要があります。Dropbox をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-dropbox)。 ------ #### [ Console ] **Dropbox Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Dropbox コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Dropbox コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証トークンのタイプ]** — 永続的なトークン (推奨)、または一時的なアクセストークンを選択します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Dropbox 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレットネームには「AmazonKendra-Dropbox-」というプレフィックスが自動的に追加されます。 1. **[アプリキー]**、**[アプリケーションのシークレット]**、トークン情報 (永続的または一時的) - Dropbox で設定した認証情報の値を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[エンティティまたはコンテンツタイプを選択]** - クロールする Dropbox のエンティティまたはコンテンツタイプを選択します。 1. **[正規表現パターン]** の **[追加設定]** - 特定のファイルを含めたり除外する正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **ファイル**、**Dropbox Paper**、および **Dropbox Paper テンプレート** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Dropbox Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-dropbox-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `DROPBOX` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **[アクセストークンタイプ]** - 認証情報を保存する AWS Secrets Manager シークレットに、永続的アクセストークンを使用するか一時的なアクセストークンを使用するかを指定します。 **注記** 4 時間後に有効期限が切れる 1 回限りのアクセストークンに頼るのではなく、Dropbox で有効期限が切れることのない更新アクセストークンを作成することをお勧めします。Dropbox デベロッパーコンソールでアプリと更新アクセストークンを作成し、シークレットでアクセストークンを渡します。 + **シークレット Amazon リソースネーム (ARN)** — Dropbox アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "appKey": "Dropbox app key", "appSecret": "Dropbox app secret", "accesstoken": "temporary access token or refresh access token" } ``` + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Dropbox コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Dropbox data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[ドキュメント/コンテンツのタイプ]** - Dropbox 内のファイル、Dropbox Paper ドキュメント、Dropbox Paper テンプレート、Dropbox に保存されているウェブページのショートカットをクロールするかどうかを指定します。 + **包含フィルターと除外フィルター** - 特定のファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 + **フィールドマッピング** - 選択すると、Dropbox データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Dropbox テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-dropbox-schema)」を参照してください。 ------ ## 詳細はこちら Amazon Kendra と Dropbox データソースとの統合について詳しくは、以下を参照してください。 + [Amazon Kendra の Dropbox コネクタを使用して Dropbox コンテンツのインデックスを作成してください](https://aws.amazon.com/blogs/machine-learning/index-your-dropbox-content-using-the-dropbox-connector-for-amazon-kendra/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Dropbox API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用できません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # Drupal **注記** Drupal コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。新規ユーザーがこのコネクタを使用することはできなくなりましたが、現在のユーザーは中断なく引き続きご使用いただけます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Drupal は、ウェブサイトやウェブアプリケーションの作成に使用できるオープンソースのコンテンツ管理システム (CMS) です。を使用してAmazon Kendra、Drupal で次のインデックスを作成できます。 + コンテンツ - 記事、基本ページ、基本ブロック、ユーザー定義コンテンツタイプ、ユーザー定義ブロックタイプ、カスタムコンテンツタイプ、カスタムブロックタイプ + コメント - すべてのコンテンツタイプとブロックタイプに対応 + 添付ファイル - すべてのコンテンツタイプとブロックタイプに対応 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して Drupal データソースAmazon Kendraに接続できます。 Amazon KendraDrupal データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-drupal) + [ ## 前提条件 ](#prerequisites-drupal) + [ ## 接続手順 ](#data-source-procedure-drupal) + [ ## 注意事項 ](#drupal-notes) ## サポートされている機能 Amazon KendraDrupal データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Drupal データソースのインデックスを作成する前に、Drupal とAWSアカウントでこれらの変更を行います。 **Drupal で以下を確認してください。** + Drupal (スタンダード) Suite のアカウントと管理者ロールを持つユーザーを作成しました。 + Drupal サイト名をコピーし、ホスト URL を設定しました。例えば、*https:///*。 + ユーザー名 (Drupal ウェブサイトのログインユーザー名) とパスワード (Drupal ウェブサイトのパスワード) を含む基本認証情報を設定しました。 + **推奨:** OAuth 2.0 認証情報トークンを設定しました。このトークンを、接続先の Drupal パスワード付与、クライアント ID、クライアントシークレット、ユーザー名 (Drupal ウェブサイトのログインユーザー名)、パスワード (Drupal ウェブサイトのパスワード) とともに使用して Amazon Kendra に接続します。 + 管理者ロールを使用して Drupal アカウントに次のアクセス許可を追加しました。 + ブロックを管理 + block\$1content の表示を管理 + block\$1content フィールドを管理 + block\$1content の形式表示を管理 + ビューを管理 + ユーザーの E メールアドレスを表示 + 自分の未公開コンテンツを表示 + ページリビジョンを表示 + 記事のリビジョンを表示 + すべてのリビジョンを表示 + 管理テーマを表示 + コンテンツへのアクセス + コンテンツへのアクセスの概要 + コメントへのアクセス + コンテンツを検索 + ファイルへのアクセスの概要 + コンテキストリンクへのアクセス **注記** ユーザー定義のコンテンツタイプまたはユーザー定義のブロックタイプがある場合、またはビューやブロックを Drupal ウェブサイトに追加する場合は、それらに管理者アクセスを提供する必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Drupal の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Drupal データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Drupal データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように Drupal 認証情報の詳細を指定する必要があります。Drupal をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-drupal)。 ------ #### [ Console ] **Drupal Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Drupal コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Drupal コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** の **[ホスト URL]** - Drupal サイトのホスト URL。例えば、*https:///*。 1. **[SSL 証明書の場所]** - Amazon S3 バケットに保存されている SSL 証明書へのパスを入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **認証用** - ユースケースに応じて、**[基本認証]** と **[OAuth 2.0 認証]** のいずれかを選択します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Drupal 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[基本認証]** を選択した場合は、コピーした **[シークレット名]**、**[ユーザー名]** (Drupal サイトのユーザー名)、および **[パスワード]** (Drupal サイトのパスワード) を入力し、**[保存してシークレットを追加]** を選択します。 1. **[OAuth 2.0 認証]** を選択した場合は、Drupal アカウントで生成された **[シークレット名]**、**[ユーザー名]** (Drupal サイトのユーザー名)、**[パスワード]** (Drupal サイトのパスワード)、**[クライアント ID]**、および **[クライアントシークレット]** を入力して、**[シークレットを保存して追加]** を選択します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** は、次のオプションから選択します。 **注記** **[記事]**、**[基本ページ]**、**[基本ブロック]** のクロールを選択すると、それぞれのデフォルトのフィールドが自動的に同期されます。コメント、添付ファイル、カスタムフィールド、その他のカスタムエンティティを同期することもできます。 1. **[エンティティを選択]** の場合。 + **記事** - **[記事]**、そのコメント **[コメント]**、および **[添付ファイル]**をクロールするかどうかを選択します。 + **[基本ページ]** - **[基本ページ]**、その **[コメント]**、その **[添付ファイル]** をクロールするかどうかを選択します。 + **[基本ブロック]** - **[基本ブロック]**、その **[コメント]**、その **[添付ファイル]** をクロールするかどうかを選択します。 + **[カスタムコンテンツタイプ]** と **[カスタムブロック]** を追加することもできます。 1. **[追加設定 - オプション]**。 + **[正規表現パターン]** - 特定のエンティティタイトルとファイル名を含めるか除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **コンテンツ**、**コメント**、**添付ファイル** - インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Drupal Amazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-drupal-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `DRUPAL` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — Drupal アカウントで作成した認証情報を含むSecrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。 基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Drupal コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Drupal data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - コンテンツ、コメント、添付ファイルを含めるかどうかを指定できます。また、コンテンツ、コメント、添付ファイルを含めるか除外する正規表現パターンを指定することもできます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Drupal データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Drupal テンプレートスキーマ](ds-schemas.md#ds-drupal-schema)」を参照してください。 ------ ## 注意事項 + Drupal API には公式なスロットリング制限はありません。 + Java SDK は Drupal では使用できません。 + Drupal データは、ネイティブ JSON API を使用してのみ取得できます。 + どの Drupal **[ビュー]** にも関連付けられていないコンテンツタイプはクロールできません。 + Drupal **[ブロック]** からデータをクロールするには、管理者権限が必要です。 + HTTP 動詞を使用してユーザー定義コンテンツタイプを作成するための JSON API はありません。 + **[記事]**、**[基本ページ]**、**[基本ブロック]**、ユーザー定義コンテンツタイプ、ユーザー定義ブロックタイプのドキュメント本文とコメントは HTML 形式で表示されます。HTML コンテンツの形式が正しくない場合、HTML 関連のタグがドキュメント本文とコメントに表示され、Amazon Kendra 検索結果に表示されます。 + 説明や本文のないコンテンツタイプと**ブロック**タイプは取り込まれませんAmazon Kendra。このような**コンテンツ**または**ブロック**タイプの**コメント**と**添付ファイル**のみがAmazon Kendraインデックスに取り込まれます。 # GitHub GitHub は、バージョン管理機能を備えたコードストレージおよび管理サービスを提供するソフトウェア開発用のウェブベースのホスティングサービスです。を使用してAmazon Kendra、GitHub Enterprise Cloud (SaaS) および GitHub Enterprise Server (オンプレミス) リポジトリファイルのインデックス作成、リクエストの発行とプル、リクエストのコメントの発行とプル、リクエストのコメントの添付ファイルの発行とプルを行うことができます。また、特定のファイルを含めるまたは除外することもできます。 **注記** Amazon Kendraがアップグレードされた GitHub コネクタをサポートするようになりました。 コンソールは自動的にアップグレードされています。コンソールで新しくコネクタを作成すると、コネクタにはアップグレードされたアーキテクチャが使用されます。API を使用する場合は、`GitHubConfiguration` オブジェクトではなく [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトを使用してコネクタを設定する必要があります。 古いコンソールと API アーキテクチャを使用して設定されたコネクタは、引き続き設定どおりに機能します。ただし、それらを編集したり更新したりすることはできません。コネクタ設定を編集または更新する場合は、新しいコネクタを作成する必要があります。 コネクタワークフローをアップグレードされたバージョンに移行することをお勧めします。古いアーキテクチャを使用して設定されたコネクタのサポートは、2024 年 6 月までに終了する予定です。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して GitHub データソースAmazon Kendraに接続できます。 Amazon KendraGitHub データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-github) + [ ## 前提条件 ](#prerequisites-github) + [ ## 接続手順 ](#data-source-procedure-github) + [ ## 詳細はこちら ](#github-learn-more) ## サポートされている機能 Amazon KendraGitHub データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して GitHub データソースのインデックスを作成する前に、GitHub と AWSアカウントでこれらの変更を行います。 **GitHub で、以下を確認してください。** + GitHub 組織への管理者アクセス許可を持つ GitHub ユーザーを作成済み。 + 認証情報として使用するように Git Hub で個人用アクセストークンを設定済み。[個人アクセストークンの作成については、GitHub のドキュメントを参照してください](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **推奨:** 認証情報用の OAuth トークンを設定済み。API のスロットル制限とコネクタのパフォーマンスを向上させるには、OAuth トークンを使用してください。[OAuth 認証に関する GitHub のドキュメント](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#about-oauth-apps-and-oauth-authorizations-of-github-apps)を参照してください。 + 使用している GitHub サービスのタイプに対応する GitHub ホスト URL を記録済み。*例えば、GitHub クラウドのホスト URL は *https://api.github.com* で、GitHub サーバーのホスト URL は https://on-prem-host-url/api/v3/* である可能性があります。 + 接続する GitHub、GitHub Enterprise Cloud (SaaS) アカウント、または GitHub Enterprise Server (オンプレミス) アカウントの Organization 名前を書き留めた。組織名は、GitHub Desktop にログインし、プロファイル写真のドロップダウンから **[組織]** を選択して確認できます。 + **オプション (サーバーのみ):** SSL 証明書を生成し、 Amazon S3バケットに保存されている証明書へのパスをコピーしました。安全な SSL 接続が必要な場合は、これを使用して GitHub に接続します。OpenSSL を使用して、任意のコンピュータで自己署名 X509 証明書を生成できます。OpenSSL を使用して X509 証明書を作成する例については、「[X509 証明書の作成と署名](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html)」を参照してください。 + 以下のアクセス許可を追加しました。 **GitHub Enterprise Cloud (SaaS) の場合** + `repo:status` - パブリックおよびプライベートリポジトリのコミットステータスへの読み取り/書き込みアクセスを許可します。コードへのアクセスを許可せずに、プライベートリポジトリのコミットステータスへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `repo_deployment` – パブリックおよびプライベートリポジトリのデプロイステータスへのアクセスを許可します。コードへのアクセスを許可せずに、デプロイステータスへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `public_repo` – パブリックリポジトリへのアクセスを制限します。これには、パブリックリポジトリと組織のコード、コミットステータス、リポジトリプロジェクト、共同作業者、デプロイステータスへの読み取り/書き込みアクセスが含まれます。パブリックリポジトリのスター付けにも必要です。 + `repo:invite` – リポジトリで共同作業を行うための招待を承諾/拒否することを許可します。コードへのアクセスを許可せずに、招待へのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `security_events` – コードスキャン API のセキュリティイベントへの読み取りおよび書き込みアクセスを許可します。コードへのアクセスを許可せずに、セキュリティイベントへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `read:org` – 組織メンバーシップ、組織プロジェクト、チームメンバーシップへの読み取り専用アクセス。 + `user:email` – ユーザーの E メールアドレスへの読み取りアクセスを許可します。Amazon Kendra が ACL をクロールするために必要です。 + `user:follow` – 他のユーザーをフォローまたはフォロー解除するためのアクセス許可を付与します。Amazon Kendra が ACL をクロールするために必要です。 + `read:user` – ユーザーのプロファイルデータを読み取るためのアクセス許可を付与します。Amazon Kendra が ACL をクロールするために必要です。 + `workflow` – GitHub Actions ワークフローファイルを追加および更新することを許可します。同じリポジトリ内の別のブランチに同じファイル (同じパスとコンテンツの両方を持つ) が存在する場合、このスコープなしでワークフローファイルをコミットできます。 詳細については、GitHub Docs の「[Scopes for OAuth apps](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)」を参照してください。 **GitHub Enterprise Server (On Prem) の場合** + `repo:status` - パブリックおよびプライベートリポジトリのコミットステータスへの読み取り/書き込みアクセスを許可します。コードへのアクセスを許可せずに、プライベートリポジトリのコミットステータスへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `repo_deployment` – パブリックおよびプライベートリポジトリのデプロイステータスへのアクセスを許可します。コードへのアクセスを許可せずに、デプロイステータスへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `public_repo` – パブリックリポジトリへのアクセスを制限します。これには、パブリックリポジトリと組織のコード、コミットステータス、リポジトリプロジェクト、共同作業者、デプロイステータスへの読み取り/書き込みアクセスが含まれます。パブリックリポジトリのスター付けにも必要です。 + `repo:invite` – リポジトリで共同作業を行うための招待を承諾/拒否することを許可します。コードへのアクセスを許可せずに、招待へのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `security_events` – コードスキャン API のセキュリティイベントへの読み取りおよび書き込みアクセスを許可します。コードへのアクセスを許可せずに、セキュリティイベントへのアクセスを他のユーザーまたはサービスに許可する場合にのみこのスコープが必要になります。 + `read:user` – ユーザーのプロファイルデータを読み取るためのアクセス許可を付与します。Amazon Q Business が ACL をクロールするために必要です。 + `user:email` – ユーザーの E メールアドレスへの読み取りアクセスを許可します。Amazon Q Business が ACL をクロールするために必要です。 + `user:follow` – 他のユーザーをフォローまたはフォロー解除するためのアクセス許可を付与します。Amazon Q Business が ACL をクロールするために必要です。 + `site_admin` – サイト管理者に GitHub Enterprise Server Administration API エンドポイントへのアクセスを許可します。 + `workflow` – GitHub Actions ワークフローファイルを追加および更新することを許可します。同じリポジトリ内の別のブランチに同じファイル (同じパスとコンテンツの両方を持つ) が存在する場合、このスコープなしでワークフローファイルをコミットできます。 詳細については、GitHub ドキュメントの「[OAuth アプリのスコープ](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)」および GitHub Developer の「[Understanding scopes for OAuth Apps](https://developer.github.com/enterprise/2.16/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes)」を参照してください。 + 各ドキュメントが GitHub および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + GitHub の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、GitHub データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 GitHub データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、GitHub データソースの必要な詳細を指定する必要があります。GitHub をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-github)。 ------ #### [ Console ] **GitHub Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[GitHub コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[GitHub コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[GitHub ソース]** - **[GitHub エンタープライズクラウド]** と **[GitHub Enterprise Server]** のいずれかを選択します。 1. **[GitHub host URL]** - 例えば、GitHub クラウドのホスト URL は *https://api.github.com*、GitHub サーバーのホスト URL は *https://on-prem-host-url/api/v3/* のようになります。 1. **GitHub 組織名** - GitHub の組織名を入力します。組織の情報は GitHub アカウントで確認できます。 **注記** GitHub コネクタは、データソースコネクタインスタンスごとに 1 つの Organization のクローリングをサポートしています。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して GitHub 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-GitHub-」が自動的に追加されます。 1. **[GitHub トークン]** - GitHub で設定した認証情報の値を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[リポジトリを選択する]** — すべてのリポジトリをクロールするか、クロールするリポジトリを選択します。 選択したリポジトリのクロールを選択した場合は、リポジトリの名前を追加し、必要に応じて特定のブランチの名前を追加します。 1. **[コンテンツタイプ]** — ファイル、Issue、プルリクエストなどからクロールするコンテンツタイプを選択します。 1. **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新しい、変更された同期: データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + 新規作成、変更、削除の同期: データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **GitHub Amazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-github-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `GITHUB` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **[GitHub のタイプ]** — [`SAAS`] または [`ON_PREMISE`] をタイプとして指定します。 + **[ホスト URL]** — GitHub ホスト URL または API エンドポイント URL を指定します。たとえば、GitHub SaaS/Enterprise Cloud を使用する場合はホスト URL は `https://api.github.com`、GitHub オンプレミス/Enterprise Server の場合はホスト URL は `https://on-prem-host-url/api/v3/` になります。 + **[Organization 名]** - GitHub アカウントの Organization の名前を指定します。組織名は、GitHub Desktop にログインし、プロファイル写真のドロップダウンから **[組織]** を選択して確認できます。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **Secret Amazon Resource Name (ARN)** — GitHub アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "personalToken": "token" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、GitHub コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for GitHub data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 **注記** GitHub サーバーを使用する場合は、Amazon VPC を使用して GitHub サーバーに接続する必要があります。 + **[リポジトリフィルター]** — リポジトリを名前とブランチ名でフィルタリングします。 + **[ドキュメント/コンテンツタイプ]** — リポジトリドキュメント、Issue、Issue のコメント、Issue のコメントの添付ファイル、プルリクエスト、プルリクエストのコメント、プルリクエストのコメントの添付ファイルをクロールするかどうかを指定します。 + **[包含フィルターと除外フィルター]** - 特定のファイルおよびフォルダを含める、または除外するように指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 + **フィールドマッピング** - 選択すると、GitHub データソースフィールドをAmazon Kendraインデックスフィールドにマッピングします。ドキュメント、コミット、Issue、Issue の添付ファイル、Issue のコメント、プルリクエスト、プルリクエストの添付ファイル、プルリクエストのコメントのフィールドを含めることができます。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** Amazon Kendra がドキュメントを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[GitHub template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-github-schema)」を参照してください。 ------ ## 詳細はこちら GitHub データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [GitHub コネクタのパワーで Amazon KendraGitHub リポジトリの検索を再考する](https://aws.amazon.com/blogs/machine-learning/reimagine-search-on-github-repositories-with-the-power-of-the-amazon-kendra-github-connector/) # Gmail Gmail は Google が開発した E メールクライアントで、添付ファイル付きのメールメッセージを送信できます。Gmail のメッセージは、フォルダやラベルを使用して E メールの受信トレイ内で分類して保存できます。Amazon Kendraを使用して、E メールメッセージとメッセージ添付ファイルのインデックスを作成できます。インデックス作成のために、特定の E メールメッセージ、メッセージの添付ファイル、ラベルを含めるか除外Amazon Kendraするように を設定することもできます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して Gmail データソースAmazon Kendraに接続できます。 Amazon KendraGmail データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-gmail) + [ ## 前提条件 ](#prerequisites-gmail) + [ ## 接続手順 ](#data-source-procedure-gmail) + [ ## 詳細はこちら ](#gmail-learn-more) + [ ## 注意事項 ](#gmail-notes) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Gmail データソースのインデックスを作成する前に、Gmail とAWSアカウントでこれらの変更を行います。 **Gmail で以下を確認してください。** + Google Cloud Platform の管理者アカウントを作成し、Google Cloud プロジェクトを作成しました。 + 管理者アカウントで Gmail API と管理者 SDK API を有効にしました。 + サービスアカウントを作成し、Gmail の JSON プライベートキーをダウンロードしました。プライベートキーを作成してアクセスする方法については、Google Cloud のドキュメントの「[サービスアカウントキーの作成方法](https://cloud.google.com/iam/docs/keys-create-delete#creating)」と「[サービスアカウントの認証情報](https://cloud.google.com/iam/docs/service-account-creds#key-types)」を参照してください。 + 認証情報として使用する管理者アカウントの E メール、サービスアカウントの E メール、プライベートキーをコピーしました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + ユーザーおよびインデックスを作成する共有ディレクトリに、次の OAuth スコープ (管理者ロールを使用) を追加しました。 + https://www.googleapis.com/auth/admin.directory.user.readonly + https://www.googleapis.com/auth/gmail.readonly + 各ドキュメントが Gmail および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Gmail の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Gmail データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Gmail データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Gmail 認証情報の詳細を指定する必要があります。Gmail をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-gmail)。 ------ #### [ Console ] **Gmail Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Gmail コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Gmail コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. シー**AWSSecrets Managerクレット**の**認証** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Gmail 認証情報を保存します。新しいシークレットを作成すると、AWSSecrets Managerシークレットウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。 1. **[クライアント E メール]** - Google サービスアカウントからコピーしたクライアント E メール。 1. **[管理者アカウント E メール]** - 使用する管理者アカウントの E メールです。 1. **[プライベートキー]** - Google サービスアカウントからコピーしたプライベートキー。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[エンティティタイプ]** - メッセージの添付ファイルを同期する場合に選択します。 1. (オプション) **[追加設定]** で、以下の情報を入力します。 1. **[期間]** - クロールする E メールの開始日と終了日を指定するための期間を入力します。 1. **[E メールドメイン]** — 「to」、「from」、「cc」、「bcc」の E メールドメインに基づいて、特定の E メールを含める、または除外します。 1. **[件名のキーワード]** - E メールの件名のキーワードに基づいて、メールを含める、または除外します。 **注記** また、入力した件名のキーワードすべてに一致するドキュメントを含めることもできます。 1. **[ラベル]** - 特定の E メールラベルを含める、または除外するための正規表現パターンを追加します。 1. **[添付ファイル]** - 特定の E メールの添付ファイルを含める、または除外するための正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 **重要** 完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は以下のようになります。 Gmail から完全に削除されたメッセージは、Amazon Kendra インデックスから削除されません Gmail のメールラベルの変更は同期されません。 Gmail のデータソースラベルの変更や完全に削除されたメールメッセージを Amazon Kendra インデックスに同期するには、定期的にフルクロールを実行する必要があります。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 **注記** Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Gmail Amazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-gmail-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `GMAIL` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 **重要** 完全に削除された Gmail メッセージを更新する API がないため、新規作成、変更、削除されたコンテンツの同期は以下のようになります。 Gmail から完全に削除されたメッセージは、Amazon Kendra インデックスから削除されません Gmail のメールラベルの変更は同期されません。 Gmail データソースラベルの変更と完全に削除された E メールメッセージをAmazon Kendraインデックスに同期するには、定期的にフルクロールを実行する必要があります。 + **Secret Amazon Resource Name (ARN)** — Gmail アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "adminAccountEmailId": "service account email", "clientEmailId": "user account email", "privateKey": "private key" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Gmail コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Gmail data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[包含フィルターと除外フィルター]** - 特定の「to」、「from」、「cc」、「bcc」の E メールを含める、または除外するかどうかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Gmail データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 **注記** Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。 設定が必要なその他の重要な JSON キーのリストについては、「[Gmail template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-gmail-schema)」を参照してください。 ------ ## 詳細はこちら Gmail データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Amazon Kendra の Gmail コネクタを使用して、Google ワークスペース内のメール全体でインテリジェントな検索を実行します](https://aws.amazon.com/blogs/machine-learning/perform-intelligent-search-across-emails-in-your-google-workspace-using-the-gmail-connector-for-amazon-kendra/)。 ## 注意事項 + 完全に削除された Gmail メッセージを更新する API がないため、`FULL_CRAWL`/**[新規、変更、削除したコンテンツの同期]** は以下のようになります。 + Gmail から完全に削除されたメッセージをAmazon Kendraインデックスから削除しない + Gmail のメールラベルの変更は同期されません。 Gmail データソースラベルの変更と完全に削除された E メールメッセージをAmazon Kendraインデックスに同期するには、定期的にフルクロールを実行する必要があります。 + Amazon KendraGmail データソースコネクタは、API の制限により、カスタムインデックスフィールドの作成をサポートしていません。 # Google ドライブ Google Drive はクラウドベースのファイルストレージサービスです。 Amazon Kendra を使用して、Google Drive データソースの共有ドライブ、My Drives、共有フォルダに保存されているドキュメントのインデックスを作成できます。Google WorkSpace のドキュメントと、[ドキュメントのタイプ](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html)に記載されているドキュメントの両方にインデックスを作成できます。包含フィルターと除外フィルターを使用して、ファイル名、ファイルタイプ、ファイルパスでコンテンツにインデックスを作成することもできます。 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API、または [GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html) API を使用して、Google Drive データソース Amazon Kendra に接続できます。 Amazon Kendra には Google Drive コネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **Google Drive コネクタ V1.0/[GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター **Google コネクタ V2.0 / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) **注記** Google Drive コネクタ V1.0/Google DriveConfiguration API のサポートは 2023 年に終了しました。Google Drive コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra Google Drive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # Google Drive コネクタ V1.0 ](data-source-v1-google-drive.md) + [ # Google Drive コネクタ V2.0 ](data-source-v2-google-drive.md) # Google Drive コネクタ V1.0 Google Drive はクラウドベースのファイルストレージサービスです。を使用して Amazon Kendra 、Google Drive データソースの共有ドライブ、マイドライブ、共有フォルダに保存されているドキュメントやコメントのインデックスを作成できます。Google WorkSpace のドキュメントと、[ドキュメントのタイプ](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html)に記載されているドキュメントにインデックスを作成できます。包含フィルターと除外フィルターを使用して、ファイル名、ファイルタイプ、ファイルパスでコンテンツにインデックスを作成することもできます。 **注記** Google Drive コネクタ V1.0/Google DriveConfiguration API のサポートは 2023 年に終了しました。Google Drive コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra Google Drive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-google-drive) + [ ## 前提条件 ](#prerequisites-v1-google-drive) + [ ## 接続手順 ](#data-source-v1-procedure-google-drive) + [ ## 詳細情報 ](#google-drive-learn-more) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター ## 前提条件 Amazon Kendra を使用して Google Drive データソースのインデックスを作成する前に、Google Drive と AWS アカウントでこれらの変更を行います。 **Google Drive で以下を確認してください。** + スーパー管理者ロールからアクセスを許可されている**か**、管理者権限を持つユーザーである**かのどちらか**です。スーパー管理者ロールからアクセス許可を付与されている場合は、スーパー管理者ロールは必要ありません。 + **[G Suite ドメイン全体の委任を有効にする]** を有効にしたサービスアカウントを作成し、そのアカウントを使用してプライベートキーとして JSON キーを作成しました。 + ユーザーアカウント E メールとサービスアカウント E メールをコピーしました。に接続する Amazon Kendra ときは、ユーザーアカウントの E メールを管理者アカウントの E メールとして、サービスアカウントの E メールをクライアント E メールとして AWS Secrets Manager シークレットに入力します。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + 管理者 SDK API と Google Drive API がアカウントに追加されました。 + スーパー管理者ロールを使用して、以下のアクセス許可をサービスアカウントに追加しました (またはスーパー管理者ロールを持つユーザーに追加を依頼しました)。 + https://www.googleapis.com/auth/drive.readonly + https://www.googleapis.com/auth/drive.metadata.readonly + https://www.googleapis.com/auth/admin.directory.user.readonly + https://www.googleapis.com/auth/admin.directory.group.readonly + 各ドキュメントが Google Drive および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + Google Drive の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、Google Drive データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Google Drive データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、Google Drive データソースの必要な詳細を指定する必要があります。Google Drive をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v1-google-drive)。 ------ #### [ Console ] **Google Drive Amazon Kendra に接続するには** 1. AWS マネジメントコンソールにサインインし、[Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[Google Drive コネクタ V1.0]** を選択し、**[コネクタを追加]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[認証のタイプ]** の場合 - **[既存]** と **[新規]** を選択します。既存のシークレットを使用する場合は、**[シークレットを選択]** を使用してシークレットを選択してください。 1. 新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットオプションが開きます。 1. **[ AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレットネームには「AmazonKendra-Google Drive-」というプレフィックスが自動的に追加されます。 1. **[管理者アカウントの E メール]**、**[クライアントの E メール]**、**[プライベートキー]** の場合 - Google Drive アカウントから生成してダウンロードした認証情報の値を入力します。 1. **[認証を保存]** を選択します。 1. **IAM role** — 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[ユーザーアカウントを除外する]** - インデックスから除外する Google Drive ユーザー。最大 100 件のユーザーアカウントを追加できます。 1. **[共有ドライブを除外する]** - インデックスから除外する Google Drive の共有ドライブ。最大 100 件の共有ドライブを追加できます。 1. **[ファイルタイプのドライブを除外する]** - インデックスから除外する Google Drive のファイルタイプ。MIME タイプの選択を編集することもできます。 1. **[追加設定]** の場合: 特定のコンテンツを含めるか除外する正規表現パターンを指定します。最大 100 のパターンを追加できます。 1. **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **GoogleDrive フィールド名**と**その他の推奨フィールドマッピング**の場合 - インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Google Drive Amazon Kendra に接続するには** [GoogleDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_GoogleDriveConfiguration.html) API を使用して以下を指定する必要があります。 + **Secret Amazon Resource Name (ARN)** — Google Drive アカウントの認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "clientAccount": "service account email", "adminAccount": "user account email"", "privateKey": "private key" } ``` + **IAM role** - を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、Google Drive コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for Google Drive data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **包含フィルターと除外フィルター** - デフォルトでは、 Amazon Kendra は Google Drive 内のすべてのドキュメントのインデックスを作成します。共有ドライブ、ユーザーアカウント、ドキュメント MIME タイプ、ファイルに特定のコンテンツを含めるか除外するかを指定できます。ユーザーアカウントを除外すると、そのアカウントが所有する My Drive 内のファイルにはインデックスが作成されません。ユーザーと共有されているファイルは、ファイルの所有者も除外されない限り、インデックスが作成されます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、Google Drive データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ ## 詳細情報 Google Drive データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [Amazon Kendra Google Drive コネクタの開始方法](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-google-drive-connector/) # Google Drive コネクタ V2.0 Google Drive はクラウドベースのファイルストレージサービスです。を使用して Amazon Kendra 、Google Drive データソースの共有ドライブ、マイドライブ、共有フォルダに保存されているドキュメントやコメントのインデックスを作成できます。Google WorkSpace のドキュメントと、[ドキュメントのタイプ](https://docs.aws.amazon.com/kendra/latest/dg/index-document-types.html)に記載されているドキュメントにインデックスを作成できます。包含フィルターと除外フィルターを使用して、ファイル名、ファイルタイプ、ファイルパスでコンテンツにインデックスを作成することもできます。 **注記** Google Drive コネクタ V1.0/Google DriveConfiguration API のサポートは 2023 年に終了しました。Google Drive コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra Google Drive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-google-drive) + [ ## 前提条件 ](#prerequisites-v2-google-drive) + [ ## 接続手順 ](#data-source-procedure-v2-google-drive) + [ ## 注意事項 ](#google-drive-notes) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して Google Drive データソースのインデックスを作成する前に、Google Drive と AWS アカウントでこれらの変更を行います。 **Google Drive で以下を確認してください。** + スーパー管理者ロールからアクセスを許可されている**か**、管理者権限を持つユーザーである**かのどちらか**です。スーパー管理者ロールからアクセス許可を付与されている場合は、スーパー管理者ロールは必要ありません。 + 管理者アカウントの E メール、クライアントの E メール (サービスアカウントの E メール)、シークレットキーを含む Google Drive サービスアカウントの接続認証情報を設定しました。[サービスアカウントキーの作成と削除については、Google Cloud のドキュメント](https://cloud.google.com/iam/docs/keys-create-delete)を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + サーバー間認証で **[G Suite ドメイン全体の委任を有効にする]** を有効化して Google Cloud サービスアカウント (ユーザー ID を引き継ぐ権限が委任されたアカウント) を作成し、そのアカウントを使用して JSON プライベートキーを生成しました。 **注記** シークレットキーは、サービスアカウントの作成後に生成する必要があります。 + ユーザーアカウントに管理 SDK API と Google Drive API が追加されました。 + **オプション:** クライアント ID、クライアントシークレット、更新トークンを含む Google Drive OAuth 2.0 接続認証情報を特定のユーザーの接続認証情報として設定しました。これは個々のアカウントデータをクロールするのに必要です。[OAuth 2.0 を使用して API にアクセスする方法については、Google のドキュメント](https://developers.google.com/identity/protocols/oauth2)を参照してください。 + スーパー管理者ロールを使用して、以下の OAuth スコープをサービスアカウントに追加しました (またはスーパー管理者ロールを持つユーザーに追加を依頼しました)。これらの API スコープは、Google Workspace ドメイン内のすべてのドキュメントとアクセスコントロール (ACL) 情報をクロールするために必要です。 + https://www.googleapis.com/auth/drive.readonly - Google Drive のファイルをすべて表示してダウンロードします + https://www.googleapis.com/auth/drive.metadata.readonly - Google Drive 内のファイルのメタデータを表示します。 + https://www.googleapis.com/auth/admin.directory.group.readonly - スコープは、グループ、グループエイリアス、およびメンバー情報のみを取得するためのものです。これは Amazon Kendra Identity Crawler に必要です。 + https://www.googleapis.com/auth/admin.directory.user.readonly - スコープは、ユーザーまたはユーザーエイリアスのみを取得するためのものです。これは、 Amazon Kendra Identity Crawler にユーザーを一覧表示したり、ACLs を設定したりするために必要です。 + https://www.googleapis.com/auth/cloud-platform - スコープは、大きな Google Drive ファイルのコンテンツを取得するためのアクセストークンを生成するためのものです。 + https://www.googleapis.com/auth/forms.body.readonly - スコープは、Google フォームからデータを取得するためのものです。 **Forms API をサポートするには、以下のスコープを追加してください。** + https://www.googleapis.com/auth/forms.body.readonly + 各ドキュメントが Google Drive および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + Google Drive の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、Google Drive データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Google Drive データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、Google Drive データソースの必要な詳細を指定する必要があります。Google Drive をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v2-google-drive)。 ------ #### [ Console ] **Google Drive Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[Google Drive コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Google Drive コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** 用 - ユースケースに基づいて **[Google サービスアカウント]** と **[OAuth 2.0 認証]** のいずれかを選択します。 1. **AWS Secrets Manager secret** — 既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成して Google Drive 認証情報を保存します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。 1. **[Google サービスアカウント]** を選択した場合は、シークレットの名前、サービスアカウント設定の管理者ユーザーまたは「サービスアカウントユーザー」の E メール ID (管理者 E メール)、サービスアカウントの E メール ID (クライアント E メール)、およびサービスアカウントで作成したプライベートキーを入力します。 シークレットを保存して追加します。 1. **[OAuth 2.0 認証]** を選択した場合は、OAuth アカウントで作成したシークレット名、クライアント ID、クライアントシークレット、更新トークンを入力します。ユーザーの E メール ID (接続の詳細が設定されているユーザー) が ACL として設定されます。API の制限により、コネクタは他のユーザー/グループのプリンシパル情報を ACL として設定しません。 シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. (Google サービスアカウント認証を使用しているユーザーのみ対象) **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[コンテンツの同期]** — クロールするオプションまたはコンテンツを選択します。[マイドライブ] (個人用フォルダ）、[共有ドライブ] (共有フォルダ）、またはその両方をクロールするように指定できます。ファイルのコメントを含めることもできます。 1. **[追加設定 - オプション]** で、以下のオプション情報を入力することもできます。 1. **[最大ファイルサイズ]** - クロールするファイルの最大サイズ制限を MB 単位で設定します。 1. **[ユーザー E メール]** - 含める、または除外するユーザー E メールを追加します。 1. **[共有ドライブ]** - 含める、または除外する共有ドライブ名を追加します。 1. **[MIME タイプ]** - 含める、または除外する MIME タイプを追加します。 1. **[エンティティ正規表現パターン]** - 正規表現パターンを追加して、サポートされているすべてのエンティティの特定の添付ファイルを含めたり除外したりできます。最大 100 のパターンを追加できます。 **ファイル名**、**ファイルタイプ**、**ファイルパス**の包含/除外正規表現パターンを設定できます。 + **ファイル名** – 含める、または除外するファイルの名前。たとえば、`teamroster.txt` という名前のファイルのインデックスを作成するには、`teamroster` を指定します。 + **ファイルタイプ** – 含める、または除外するファイルのタイプ。例: .pdf、.txt、.docx + **ファイルパス** – 含める、または除外するファイルのパス。たとえば、ドライブの `Products list` フォルダ内のファイルのみにインデックスを作成するには、`/Products list` を指定します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新しい、変更された同期: データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + 新規作成、変更、削除の同期: データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 **重要** Google Drive API は、完全に削除されたファイルからのコメントの取得をサポートしていません。ゴミ箱に捨てられたファイルからのコメントは取得可能です。ファイルが破棄されると、コネクタは Amazon Kendra インデックスからコメントを削除します。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. **同期実行履歴**で、データソースを同期 Amazon S3 するときに、自動生成されたレポートを に保存することを選択します。データソースを同期する際の問題を追跡するのに役立ちます。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **ファイル** - インデックスにマッピングする Amazon Kendra 、生成されたデフォルトのデータソースフィールドから選択します。 **注記** Google Drive API はカスタムフィールドの作成をサポートしていません。Google Drive コネクタではカスタムフィールドマッピングは使用できません。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Google Drive Amazon Kendra に接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `GOOGLEDRIVEV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **[認証タイプ]** — サービスアカウント認証と OAuth 2.0 認証のどちらを使用するかを指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 **重要** Google Drive API は、完全に削除されたファイルからのコメントの取得をサポートしていません。ゴミ箱に捨てられたファイルからのコメントは取得可能です。ファイルが破棄されると、コネクタは Amazon Kendra インデックスからコメントを削除します。 + **Secret Amazon Resource Name (ARN)** — Google Drive アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。Google サービスアカウント認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "clientEmail": "user account email", "adminAccountEmail": "service account email", "privateKey": "private key" } ``` OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "clientID": "OAuth client ID", "clientSecret": "client secret", "refreshToken": "refresh token" } ``` + **IAM role** — を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、Google Drive コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for Google Drive data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[マイドライブ、共有ドライブ、コメント]** — これらのタイプのコンテンツをクロールするかどうかを指定できます。 + **[包含フィルターと除外フィルター]** — 特定のユーザーアカウント、共有ドライブ、MIME タイプを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 + **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Google Drive データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Google Drive template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-google-drive-schema)」を参照してください。 ------ ## 注意事項 + Google Drive UI はカスタムフィールドの作成をサポートしていないため、Google Drive コネクタではカスタムフィールドマッピングを使用できません。 + Google Drive API は、完全に削除されたファイルからのコメントの取得をサポートしていません。ただし、ゴミ箱に捨てられたファイルのコメントは取得できます。ファイルが破棄されると、 Amazon Kendra コネクタは Amazon Kendra インデックスからコメントを削除します。 + Google Drive API は .docx ファイルにあるコメントを返しません。 + 特定の Google document (ドキュメント、スプレッドシート、スライドなど) のアクセス許可が **[一般的なアクセス: リンクを知っている全員]**、または **[特定の会社ドメインと共有]** に設定されていいる場合は、クエリを実行するユーザーがそのドキュメントにアクセスするまでは、ドキュメントは Amazon Kendra の検索ユーザーに表示されません。 # IBM DB2 **注記** IBM DB2 コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 IBM DB2 は、IBM によって開発されたリレーショナルデータベース管理システムです。IBM DB2 ユーザーであれば、Amazon Kendra を使用して IBM DB2 データソースのインデックスを作成できます。データソースコネクタはAmazon KendraIBM DB2 DB2 11.5.7 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してIBM DB2データソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraIBM DB2トラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-ibm-db2) + [ ## 前提条件 ](#prerequisites-ibm-db2) + [ ## 接続手順 ](#data-source-procedure-ibm-db2) + [ ## 注意事項 ](#ibm-db2-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してIBM DB2データソースAmazon Kendraのインデックスを作成する前に、 IBM DB2および AWSアカウントでこれらの変更を行います。 **IBM DB2 で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが IBM DB2 および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + IBM DB2 の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、IBM DB2データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 IBM DB2 データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、IBM DB2認証情報の詳細を指定する必要があります。をまだ設定していない場合は、IBM DB2Amazon Kendra「」を参照してください[前提条件](#prerequisites-ibm-db2)。 ------ #### [ Console ] **Amazon Kendraに接続するには IBM DB2** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[IBM DB2 コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[IBM DB2 コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、IBM DB2新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-IBM DB2-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** — タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには IBM DB2** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `db2` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — IBM DB2アカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、IBM DB2コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for IBM DB2 data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、IBM DB2 データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[IBM DB2 テンプレートスキーマ](ds-schemas.md#ds-ibm-db2-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックすると、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Jira Jira はソフトウェア開発、製品管理、バグ追跡のためのプロジェクト管理ツールです。Amazon Kendraを使用して、Jira プロジェクト、問題、コメント、添付ファイル、作業ログ、ステータスのインデックスを作成できます。 Amazon Kendra現在、 は Jira Cloud のみをサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [JiraConfiguration API を使用して Jira ](https://docs.aws.amazon.com/kendra/latest/APIReference/API_JiraConfiguration.html) データソースAmazon Kendraに接続できます。それぞれがサポートしている機能のリストについては、「[サポートされている機能](#supported-features-jira)」を参照してください。 Amazon KendraJira データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-jira) + [ ## 前提条件 ](#prerequisites-jira) + [ ## 接続手順 ](#data-source-procedure-jira) + [ ## 詳細はこちら ](#jira-learn-more) ## サポートされている機能 Amazon KendraJira データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Jira データソースのインデックスを作成する前に、Jira と AWSアカウントでこれらの変更を行います。 **Jira で以下を確認してください。** + Jira ID (ユーザー名または E メール) と Jira の認証情報 (Jira API トークン) を含む Jira API トークン認証情報を設定済み。「[API トークンの管理に関する Atlassian のドキュメント](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)」を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Jira アカウント設定の Jira アカウント URL を記録した。例えば、*https://company.atlassian.net/*。 + 各ドキュメントが Jira および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Jira の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Jira データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Jira データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Jira データソースの必要な詳細を指定する必要があります。Jira をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-jira)。 ------ #### [ Console ] **Jira Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Jira コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Jira コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[Jira アカウント URL]** - Jira アカウント URL を入力します。例えば、*https://company.atlassian.net/*。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Jira 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。プレフィックス 「AmazonKendra-Jira-」がシークレット名に自動的に追加されます。 1. **[Jira ID]** の場合 - Jira のユーザー名または E メールアドレスを入力します。 1. **[パスワード/トークン]** - Jira に設定されている Jira API トークンを入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[インデックスを作成する Jira プロジェクトを選択]** - すべてのプロジェクトをクロールするか、特定のプロジェクトをクロールするかを選択します。 1. **[追加設定]** — 特定のステータスと問題のタイプを指定します。コメント、添付ファイル、作業ログをクロールするかどうかを選択します。特定のコンテンツを含める、または除外するには、正規表現パターンを使用します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Jira Amazon Kendraに接続するには** [JiraConfiguration ](https://docs.aws.amazon.com/kendra/latest/APIReference/API_JiraConfiguration.html) API を使用して以下を指定する必要があります。 + **データソース URL** - Jira アカウントの URL を指定します。例えば、*company.atlassian.net*。 + **Secret Amazon Resource Name (ARN)** — Jira アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "jiraId": "Jira user name or email", "jiraCredential": "Jira API token" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Jira コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Jira data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - データソース設定の一部として `VpcConfiguration` を指定します。「[VPC を使用するための Amazon Kendra の設定](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 + **[変更ログ]** - インデックス内でドキュメントを更新する必要があるかどうかを判断するために、Amazon Kendra が Jira データソースの変更ログメカニズムを使用するかどうか。 **注記** Amazon Kendra にすべてのドキュメントをスキャンさせない場合は、変更ログを使用します。変更ログが大きい場合、変更ログを処理するよりも、Jira データソース内のドキュメントのスキャンにかかる時間がAmazon Kendra短くなる場合があります。Jira データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 + **[包含フィルターと除外フィルター]** - 特定のコンテンツを含める、または除外するように指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[コメント、添付ファイル、作業ログ]** — 問題の特定のコメント、添付ファイル、作業ログをクロールするかどうかを指定できます。 + **[プロジェクト、問題、ステータス]** — 特定のプロジェクト ID、問題のタイプ、ステータスをクロールするかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Jira データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 ------ ## 詳細はこちら Amazon Kendraと Jira データソースの統合の詳細については、以下を参照してください。 + [Jira Cloud コネクタを使用して Amazon KendraJira プロジェクトをインテリジェントに検索する](https://aws.amazon.com/blogs/machine-learning/intelligently-search-your-jira-projects-with-amazon-kendra-jira-cloud-connector/) # Microsoft Exchange Microsoft Exchange は、メッセージング、会議、ファイル共有のためのエンタープライズコラボレーションツールです。Microsoft Exchange ユーザーの場合は、 Amazon Kendraを使用して Microsoft Exchange データソースのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して、Microsoft Exchange データソースAmazon Kendraに接続できます。 Amazon KendraMicrosoft Exchange データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Microsoft Exchange データソースのインデックスを作成する前に、Microsoft Exchange と AWSアカウントでこれらの変更を行います。 **Microsoft Exchange で以下を確認してください。** + Office 365 で Microsoft Exchange アカウントを作成しました。 + Microsoft 365 のテナント ID を記録しました。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + Azure portal で OAuth アプリケーションを設定し、クライアント ID、クライアントシークレット、またはクライアント認証情報を書き留めました。詳細については、[Microsoft のチュートリアル](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory)と[アプリケーションの登録の例](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)を参照してください。 **注記** Azure portal でアプリを作成または登録すると、シークレット ID は実際のシークレット値を表します。シークレットとアプリを作成するときに、実際のシークレット値を書き留めるか保存しておく必要があります。シークレットにアクセスするには、Azure portal でアプリケーションの名前を選択し、証明書とシークレットのメニューオプションに移動します。 クライアント ID にアクセスするには、Azure portal でアプリケーションの名前を選択し、概要ページに移動します。アプリケーション (クライアント) ID は、クライアント ID です。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + コネクタアプリケーションに次のアクセス許可を追加しました。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-exchange.html) + 各ドキュメントが Microsoft Exchange および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Microsoft Exchange の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、コンソールを使用して、Microsoft Exchange データソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Microsoft Exchange データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Microsoft Exchange データソースの必要な詳細を指定する必要があります。Microsoft Exchange をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-exchange)。 ------ #### [ Console ] **Microsoft Exchange Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[Microsoft Exchange コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Microsoft Exchange コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[テナント ID]** - Microsoft 365 のテナント ID を入力します。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Microsoft Exchange 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。プレフィックス 'AmazonKendra-Microsoft Exchange 1. **[クライアント ID]**、**[クライアントシークレット]** - Azure portal の Microsoft Exchange で設定した認証情報を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[ユーザー ID]** - 特定の E メールでコンテンツをフィルタリングする場合は、ユーザーの E メールを指定します。 1. **[追加設定]** - クロールするコンテンツタイプを指定します。 + **[エンティティタイプ]** — カレンダー、OneNotes、または連絡先のコンテンツをクロールするかを選択できます。 + **[カレンダーのクローリング]** — 特定の日付間のコンテンツをクロールするように、開始日と終了日を入力します。 + **[E メールを含める]** — クロールする特定の E メールをフィルタリングする場合は、[宛先]、[差出人]、および E メールの件名を入力します。 + **[共有フォルダアクセス]** — Microsoft Exchange データソースのアクセスコントロールのアクセスコントロールリストをクローリングする場合に選択します。 + **[ドメインの正規表現]** - 特定の E メールドメインを含める、または除外するための正規表現パターンを追加します。 + **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターンを追加します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 **注記** Amazon KendraMicrosoft Exchange データソースコネクタは、カスタムフィールドマッピングをサポートしていません。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Microsoft Exchange Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msexchange-schema.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `MSEXCHANGE` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **テナント ID** - テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — Microsoft Exchange アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "clientId": "client ID", "clientSecret": "client secret" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Microsoft Exchange コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Microsoft Exchange data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のコンテンツを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[アクセスコントロールリスト (ACL)]** - ACL があり、それをアクセスコントロールに使用したい場合に、ドキュメントの ACL 情報をクロールするかどうかを指定します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 + **フィールドマッピング** - 選択すると、Microsoft Exchange データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Microsoft Exchange テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msexchange-schema)」を参照してください。 ------ ## 詳細はこちら Microsoft Exchange データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Amazon Kendra の Exchange コネクタを使用して Microsoft Exchange コンテンツのインデックスを作成する](https://aws.amazon.com/blogs/machine-learning/index-your-microsoft-exchange-content-using-the-exchange-connector-for-amazon-kendra/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Microsoft Exchange API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用できません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # Microsoft OneDrive Microsoft OneDrive は、コンテンツの保存、共有、およびホストに使用できるクラウドベースのストレージサービスです。 Amazon Kendra を使用して OneDrive データソースのインデックスを作成できます。 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)と OneDrive [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html) データソース Amazon Kendra に接続できます。 Amazon Kendra には OneDrive コネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **Microsoft OneDrive コネクタ V1.0/[OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html) API** + フィールドマッピング + 包含/除外フィルター **Microsoft OneDrive コネクタ V2.0/[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API** + ユーザーコンテキストフィルタリング + ユーザー ID クローラー + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) **注記** OneDrive コネクタ V1.0/OneDriveConfiguration API のサポートは、2023 年 6 月までに終了する予定です。OneDrive コネクタ V2.0/TemplateConfiguration API を使用することをお勧めします。 Amazon Kendra OneDrive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # Microsoft OneDrive コネクタ V1.0 ](data-source-v1-onedrive.md) + [ # Microsoft OneDrive コネクタ V2.0 ](data-source-v2-onedrive.md) + [ ## 詳細情報 ](#onedrive-learn-more) + [ ## 注意事項 ](#onedrive-notes) # Microsoft OneDrive コネクタ V1.0 Microsoft OneDrive は、コンテンツの保存、共有、およびホストに使用できるクラウドベースのストレージサービスです。 Amazon Kendra を使用して Microsoft OneDrive データソースのインデックスを作成できます。 **注記** OneDrive コネクタ V1.0/Microsft OneDrive API のサポートは、2023 年 6 月までに終了する予定です。OneDrive コネクタ V2.0/TemplateConfiguration API を使用することをお勧めします。 Amazon Kendra OneDrive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-onedrive) + [ ## 前提条件 ](#prerequisites-v1-onedrive) + [ ## 接続手順 ](#data-source-v1-procedure-onedrive) ## サポートされている機能 + フィールドマッピング + 包含/除外フィルター ## 前提条件 Amazon Kendra を使用して OneDrive データソースのインデックスを作成する前に、OneDrive と AWS アカウントでこれらの変更を行います。 **Azure Active Directory (AD) で、以下を確認します。** + Azure Active Directory (AD) アプリケーションを作成しました。 + AD アプリケーション ID を使用して AD サイト上のアプリケーションのシークレットキーを登録しました。シークレットキーには、アプリケーション ID とシークレットキーが含まれている必要があります。 + 組織の AD ドメインをコピーしました。 + Microsoft Graph オプションで、AD アプリケーションに次のアプリケーションアクセス権限を追加しました。 + すべてのサイトコレクション内のファイルを読み取る (File.Read.All) + すべてのユーザーの完全なプロフィールを読み取る (User.Read.All) + ディレクトリデータを読み取る (Directory.Read.All) + すべてのグループを読み取る (Group.Read.All) + すべてのサイトコレクションの項目の読み取り (Site.Read.All) + インデックスを作成する必要があるドキュメントを持つユーザーのリストをコピーしました。ユーザー名のリストを指定するか、 Amazon S3に保存されているファイルにユーザー名を指定できます。データソースを作成すると、次のことが行なえます。 + ユーザーのリストを変更します。 + ユーザーのリストから Amazon S3 バケットに保存されているリストに変更します。 + ユーザーのリストの Amazon S3 バケットの場所を変更します。バケットの場所を変更する場合は、データソースの IAM ロールを更新して、バケットにアクセスできるようにする必要があります。 **注記** ユーザー名のリストを Amazon S3 バケットに保存する場合、データソースの IAM ポリシーは、バケットへのアクセスと、バケットが暗号化されたキーへのアクセスを提供する必要があります。 + 各ドキュメントが OneDrive および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + OneDrive の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、OneDrive データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 OneDrive データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、OneDrive 認証情報の詳細を指定する必要があります。OneDrive をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v1-onedrive)。 ------ #### [ Console ] **OneDrive Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[OneDrive コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[OneDrive コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **OneDrive テナント ID** - OneDrive テナント ID をプロトコルなしで入力します。 1. **[認証のタイプ]** の場合 - **[新規]** と **[既存]** を選択します。 1. 1. **[既存]** を選択した場合は、**[シークレットを選択]** で既存のシークレットを選択します。 1. **[新規]** を選択した場合は、**[新規の AWS Secrets Manager シークレット]** セクションに次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-OneDrive-」が自動的に追加されます。 1. **[アプリケーション ID]** ** および [アプリケーションパスワード]** - OneDrive アカウントの認証情報の値を入力し、**[認証を保存]** を選択します。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. ユースケースに基づいて、**[リストファイル]** と **[名前リスト]** のどちらかを選択します。 1. **[リストファイル]** を選択した場合は、次の情報を入力します。 1. **[場所を選択する]** - Amazon S3 バケットへのパスを入力します。 **ユーザーリストファイルを に追加する Amazon S3** — ユーザーリストファイルを Amazon S3 バケットに追加する場合に選択します。 **[ユーザーローカルグループマッピング]** - ローカルグループマッピングを使用してコンテンツをフィルタリングします。 1. **[名前リスト]** を選択した場合は、次の情報を入力します。 1. **ユーザー名** - インデックスを作成するユーザードライブを最大 10 件入力します。10 件以上のユーザーを追加するには、名前を含むファイルを作成します。 **[別のものを追加]** - さらにユーザーを追加します。 **[ユーザーローカルグループマッピング]** - ローカルグループマッピングを使用してコンテンツをフィルタリングします。 1. **[追加設定]** の場合 - 特定のファイルを含めるか除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **同期実行スケジュール**で**、頻度** - Amazon Kendra がデータソースと同期する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド**と**追加の推奨フィールドマッピング**の場合 - インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **OneDrive Amazon Kendra に接続するには** [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_OneDriveConfiguration.html) API を使用して以下を指定する必要があります。 + **テナント ID** - 組織の Azure Active Directory ドメインを指定します。 + **OneDrive ユーザー** - インデックスを作成する必要があるドキュメントを持つユーザーアカウントのリストを指定します。 + **Secret Amazon Resource Name (ARN)** — OneDrive アカウントの認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "OAuth client ID", "password": "client secret" } ``` + **IAM role** — を呼び出し`CreateDataSource`て、 Secrets Manager シークレットにアクセスするためのアクセス許可を IAM ロールに提供し、OneDrive コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for OneDrive data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **包含フィルターと除外フィルター** - 特定のドキュメントを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、OneDrive データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ # Microsoft OneDrive コネクタ V2.0 Microsoft OneDrive は、コンテンツの保存、共有、およびホストに使用できるクラウドベースのストレージサービスです。 Amazon Kendra を使用して OneDrive データソースのインデックスを作成できます。 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)と OneDrive [OneDriveConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/OneDriveConfiguration.html) データソース Amazon Kendra に接続できます。 **注記** OneDrive コネクタ V1.0/OneDriveConfiguration API のサポートは、2023 年 6 月までに終了する予定です。OneDrive コネクタ V2.0/TemplateConfiguration API を使用することをお勧めします。バージョン 2.0 では、ACL と ID クローラー機能が追加されています。 Amazon Kendra OneDrive データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-onedrive) + [ ## 前提条件 ](#prerequisites-v2-onedrive) + [ ## 接続手順 ](#data-source-procedure-v2-onedrive) ## サポートされている機能 Amazon Kendra OneDrive データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して OneDrive データソースのインデックスを作成する前に、OneDrive と AWS アカウントでこれらの変更を行います。 **OneDrive で以下を確認してください。** + Office 365 で OneDrive アカウントを作成しました。 + Microsoft 365 のテナント ID を記録しました。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + Azure ポータルに OAuth アプリケーションを作成し、 シークレットによる認証に使用されるクライアント ID とクライアント AWS Secrets Manager シークレット、またはクライアント認証情報を記録しました。詳細については、[Microsoft のチュートリアル](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory)と[アプリケーションの登録の例](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)を参照してください。 **注記** Azure portal でアプリを作成または登録すると、シークレット ID は実際のシークレット値を表します。シークレットとアプリを作成するときに、実際のシークレット値を書き留めるか保存しておく必要があります。シークレットにアクセスするには、Azure portal でアプリケーションの名前を選択し、証明書とシークレットのメニューオプションに移動します。 クライアント ID にアクセスするには、Azure portal でアプリケーションの名前を選択し、概要ページに移動します。アプリケーション (クライアント) ID は、クライアント ID です。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + AD アプリケーション ID を使用して AD サイト上のアプリケーションのシークレットキーを登録しました。シークレットキーには、アプリケーション ID とシークレットキーが含まれている必要があります。 + 組織の AD ドメインをコピーしました。 + Microsoft Graph オプションで、AD アプリケーションに次アクセス許可を追加しました。 + すべてのサイトコレクション内のファイルを読み取る (File.Read.All) + すべてのユーザーの完全なプロフィールを読み取る (User.Read.All) + すべてのグループを読み取る (Group.Read.All) + すべてのメモを読む (Notes.Read.All) + インデックスを作成する必要があるドキュメントを持つユーザーのリストをコピーしました。ユーザー名のリストを指定するか、 Amazon S3に保存されているファイルにユーザー名を指定できます。データソースを作成すると、次のことが行なえます。 + ユーザーのリストを変更します。 + ユーザーのリストから Amazon S3 バケットに保存されているリストに変更します。 + ユーザーのリストの Amazon S3 バケットの場所を変更します。バケットの場所を変更する場合は、データソースの IAM ロールを更新して、バケットにアクセスできるようにする必要があります。 **注記** ユーザー名のリストを Amazon S3 バケットに保存する場合、データソースの IAM ポリシーは、バケットへのアクセスと、バケットが暗号化されたキーへのアクセスを提供する必要があります。 OneDrive コネクタは、**[OneDrive ユーザープロパティ]**にある **[連絡先情報からの E メール]** を使用します。データをクロールするユーザーの **[連絡先情報]** ページの E メールフィールドが設定されていることを確認します。新規ユーザーの場合は、このフィールドは空白になる場合があります。 ** AWS アカウントで、以下があることを確認します。** + Amazon Kendra インデックスを作成し、 API を使用している場合はインデックス ID を記録しました。 + データソースの IAM ロールを作成し、 API を使用している場合はロールの ARN を記録しました IAM 。 + OneDrive の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合はシークレットの ARN を記録済み。 既存の IAM ロールまたはシークレットがない場合は、OneDrive データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 OneDrive データソース Amazon Kendra に接続するには、 がデータ Amazon Kendra にアクセスできるように、OneDrive 認証情報の詳細を指定する必要があります。OneDrive をまだ設定していない場合は Amazon Kendra、「」を参照してください[前提条件](#prerequisites-v2-onedrive)。 ------ #### [ Console ] **OneDrive Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[OneDrive コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[OneDrive コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **OneDrive テナント ID** - OneDrive テナント ID をプロトコルなしで入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** - **[新規]** または **[既存]** を選択します。 1. 1. **[既存]** を選択した場合は、**[シークレットを選択]** で既存のシークレットを選択します。 1. **[新規]** を選択した場合は、**[新規の AWS Secrets Manager シークレット]** セクションに次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-OneDrive-」が自動的に追加されます。 1. **[クライアント ID]** と**[クライアントシークレット]** - クライアント ID とクライアントシークレットを入力します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. 1. **[同期の範囲]** の場合 - インデックスを作成するユーザーの OneDrive データを選択します。最大 10 のユーザーを手動で追加できます。 1. **[追加設定]** の場合 - 特定のコンテンツを含めるか除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **OneDrive Amazon Kendra に接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-onedrive-schema)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `ONEDRIVEV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **テナント ID** - Microsoft 365 テナント ID を指定します。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — OneDrive アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。 OAuth 2.0 認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "clientId": "client ID", "clientSecret": "client secret" } ``` + **IAM role** — を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、OneDrive コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for OneDrive data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のファイル、OneNote セクション、および OneNote ページを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** — Amazon Kendra OneDrive コネクタの組み込みインデックスフィールドまたは共通インデックスフィールドのみをマッピングできます。API の制限により、OneDrive コネクタではカスタムフィールドマッピングは使用できません。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 設定が必要なその他の重要な JSON キーのリストについては、「[OneDrive テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-onedrive-schema)」を参照してください。 ------ ## 詳細情報 OneDrive データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [Amazon Kendra用の更新された Microsoft OneDrive コネクタ (V2) を発表します](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-microsoft-onedrive-connector-v2-for-amazon-kendra/)。 ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、OneDrive API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用することができません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # Microsoft SharePoint SharePoint は、ウェブコンテンツをカスタマイズしたり、ページ、サイト、ドキュメントライブラリ、リストを作成したりできる、コラボレーション用ウェブサイト構築サービスです。 Amazon Kendra を使用して SharePoint データソースのインデックスを作成できます。 Amazon Kendra は現在、SharePoint Online と SharePoint Server (バージョン 2013、2016、2019、サブスクリプションエディション) をサポートしています。 コンソール、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API[Amazon Kendra](https://console.aws.amazon.com/kendra/)、または [SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html) API を使用して、SharePoint データソース Amazon Kendra に接続できます。 Amazon Kendra には SharePoint コネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **SharePoint Connector V1.0/[SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 変更ログ + Virtual Private Cloud (VPC) **SharePoint Connector V2.0 / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) **注記** SharePoint コネクタ V1.0/SharePointConfiguration API のサポートは 2023 年に終了しました。SharePoint コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra SharePoint データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # SharePoint コネクタ V1.0 ](data-source-v1-sharepoint.md) + [ # SharePoint コネクタ V2.0 ](data-source-v2-sharepoint.md) # SharePoint コネクタ V1.0 SharePoint は、ウェブコンテンツをカスタマイズしたり、ページ、サイト、ドキュメントライブラリ、リストを作成したりできる、コラボレーション用ウェブサイト構築サービスです。SharePoint ユーザーの場合は、 Amazon Kendra を使用して SharePoint データソースのインデックスを作成できます。 **注記** SharePoint コネクタ V1.0/SharePointConfiguration API のサポートは 2023 年に終了しました。SharePoint コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra SharePoint データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-sharepoint) + [ ## 前提条件 ](#prerequisites-v1-sharepoint) + [ ## 接続手順 ](#data-source-procedure-v1-sharepoint) + [ ## 詳細情報 ](#sharepoint-v1-learn-more) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 変更ログ + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して SharePoint データソースのインデックスを作成する前に、SharePoint と AWS アカウントでこれらの変更を行います。 シー AWS Secrets Manager クレットに安全に保存されている認証情報を指定する必要があります。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 **SharePoint では、次のものがあることを確認してください。** + インデックスを作成する SharePoint サイトの URL を記録しました。 + **SharePoint オンラインの場合:** + サイト管理者権限を持つユーザー名とパスワードを含む基本認証資格情報を記録しました。 + **オプション:** ユーザー名、パスワード、クライアント ID、クライアントシークレットを含む OAuth 2.0 認証情報を生成しました。 + 管理者ユーザーを使用して Azure Portal の **[セキュリティデフォルト]** を無効にしました。Azure Portal でのセキュリティのデフォルト設定の管理の詳細については、[セキュリティのデフォルトを有効または無効にする方法に関する Microsoft のドキュメント](https://learn.microsoft.com/en-us/microsoft-365/business-premium/m365bp-conditional-access?view=o365-worldwide&tabs=secdefaults#security-defaults-1)を参照してください。 + **SharePoint Server の場合:** + SharePoint Server のドメイン名 (アクティブディレクトリの NetBIOS 名) を記録しました。これを SharePoint 基本認証のユーザー名とパスワードとともに使用して、SharePoint Server を Amazon Kendraに接続します。 **注記** SharePoint Server を使用し、ユーザーコンテキストでフィルタリングするためにアクセスコントロールリスト (ACL) を E メール形式に変換する必要がある場合は、LDAP サーバーの URL と LDAP 検索ベースを指定します。または、ディレクトリドメインの上書きを使用することもできます。LDAP サーバーの URL は、完全なドメイン名およびポート番号 (例えば、ldap://example.com:389) です。LDAP 検索ベースは、ドメインコントローラの「example」と「com」です。ディレクトリドメインの上書きでは、LDAP サーバーの URL と LDAP 検索ベースを使用する代わりに、E メールドメインを使用できます。例えば、「username@example.com」の E メールドメインは「example.com」です。この上書きは、ドメインの検証について心配がなく、単に E メールドメインを使用する場合に使用できます。 + SharePoint アカウントに次のアクセス許可を追加しました。 **SharePoint リストの場合** + アイテムを開く - サーバー側のファイルハンドラを使用してドキュメントのソースを表示します。 + アプリケーションページの表示 - フォーム、ビュー、およびアプリケーションページを表示します。リストを一覧表示します。 + アイテムの表示 - リスト内のアイテムとドキュメントライブラリ内のドキュメントを表示します。 + バージョンの表示 - リスト項目またはドキュメントの過去のバージョンを表示します。 **SharePoint ウェブサイトの場合** + ディレクトリの参照 - SharePoint Designer および Web DAV インターフェイスを使用してウェブサイトのファイルとフォルダを一覧表示します。 + ユーザー情報の参照 - ウェブサイトのユーザーに関する情報を表示します。 + アクセス許可の一覧表示 - ウェブサイト、リスト、フォルダ、ドキュメント、またはリスト項目に対する許可を一覧表示します。 + 開く - ウェブサイト、リスト、またはフォルダを開き、コンテナ内のアイテムにアクセスします。 + クライアント統合機能の使用 - SOAP、WebDAV、クライアントオブジェクトモデル、または SharePoint Designer インターフェイスを使用してウェブサイトにアクセスします。 + リモートインターフェイスの使用 - クライアントアプリケーションを起動する機能を使用します。 + ページの表示 - ウェブサイトのページを表示します。 + 各ドキュメントが SharePoint および同じインデックスを使用予定の他のデータソース間で一意であることを確認します。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + SharePoint の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、SharePoint データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 SharePoint データソース Amazon Kendra に接続するには、 がデータにアクセスできるように Amazon Kendra 、SharePoint 認証情報の詳細を指定する必要があります。SharePoint をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v1-sharepoint)。 ------ #### [ Console ] **SharePoint Amazon Kendra に接続するには** 1. AWS マネジメントコンソールにサインインし、[Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[SharePoint connector v1.0]** を選択し、**[データソースを追加]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ホスティング方法]** の場合 - **[SharePoint Online]** と **[SharePoint Server]** のどちらかを選択します。 1. **[SharePoint Online]** の場合 - **SharePoint リポジトリ固有のサイト URL** を入力します。 1. **SharePoint Server** の場合 - **SharePoint バージョン**を選択し、**SharePoint リポジトリに固有のサイト URLs **を入力し、**SSL 証明書の場所**への Amazon S3 パスを入力します。 1. (SharePoint Server のみ) **[Web プロキシ]** の場合 - 内部 SharePoint インスタンスの **[ホスト名]** と **[ポート番号]** を入力します。ポート番号は 0～65535 の数字である必要があります。 1. **[認証]** の場合 - ユースケースに基づいて以下のオプションから選択してください。 1. SharePoint Online の場合:**[基本認証]** と **[OAuth 2.0 認証]** のどちらかを選択します。 1. SharePoint Server の場合 - **[なし]**、**[LDAP]**、**[手動]** のいずれかを選択します。 1. **AWS Secrets Manager シークレット**の場合 — 既存のシークレットを選択するか、SharePoint 認証情報を保存する新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、 AWS Secrets Manager シークレットウィンドウが開きます。**[シークレット名]** を入力する必要があります。シークレット名に、プレフィックス「AmazonKendra-SharePoint-」が自動的に追加されます。 1. **[ AWS Secrets Manager シークレットウィンドウを作成]** に次のその他の情報を入力します。 1. ユースケースに基づいて、次の SharePoint Cloud 認証オプションから選択してください。 1. **[基本認証]** - SharePoint アカウントのユーザー名を **[ユーザー名]** に、SharePoint アカウントのパスワードを **[パスワード]** に入力します。 1. **[OAuth 2.0 認証]** - SharePoint アカウントのユーザー名を **[ユーザー名]** に、SharePoint アカウントのパスワードを **[パスワード]** に、自動生成された一意の SharePoint ID を **[クライアント ID]** として、SharePoint と Amazon Kendra の両方で **[クライアントシークレット]** として使用される共有シークレット文字列を入力します。 1. ユースケースに基づいて、次の SharePoint Server 認証オプションから選択してください。 1. **[なし]** - SharePoint アカウントのユーザー名を **[ユーザー名]** に、SharePoint アカウントのパスワードを **[パスワード]** に入力し、**[サーバーのドメイン名]** を入力します。 1. **[LDAP]** -SharePoint アカウントのユーザー名を **[ユーザー名]** に、SharePoint アカウントのパスワードを **[パスワード]** に入力し、**[LDAP サーバーエンドポイント]** (プロトコルとポート番号を含む。例えば、*ldap://example.com:389*)、**[LDAP 検索ベース]** (例えば、*dc=example, dc=com*) を入力します。 1. **[手動]** - SharePoint アカウントのユーザー名を **[ユーザー名]** に、SharePoint アカウントのパスワードを **[パスワード]** に入力し、**[E メールドメインの上書き]** (ディレクトリユーザーまたはグループの E メールドメイン) を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - **[サブネット]** と **[VPC セキュリティグループ]** も追加する必要があります。 **注記** SharePoint Server を使用する場合は、VPC を使用する必要があります。 Amazon VPC は他の SharePoint バージョンではオプションです。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[変更ログを使用]** - 選択すると、すべてのファイルを同期する代わりにインデックスを更新できます。 1. **[添付ファイルをクロール]** - 選択すると添付ファイルがクロールされます。 1. **[ローカルグループマッピングを使用]** - 選択すると、ドキュメントが適切にフィルター処理されます。 1. **[追加設定]** - 特定のファイルを含めるか除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **Amazon Kendra デフォルトフィールドマッピング** — インデックスにマッピングする Amazon Kendra 生成されたデフォルトデータソースフィールドから選択します。 1. **[カスタムフィールドマッピング]** の場合 - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **SharePoint Amazon Kendra に接続するには** [SharePointConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SharePointConfiguration.html) API を使用して以下を指定する必要があります。 + **SharePoint バージョン** - SharePoint を構成するときに使用する SharePoint バージョンを指定します。これは、SharePoint Server 2013、SharePoint Server 2016、SharePoint Server 2019、または SharePoint Online のどれを使用していても当てはまります。 + **シークレット Amazon リソースネーム (ARN)** — SharePoint アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。シークレットは JSON 構造に保存されます。 **SharePoint Online 基本認証**の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。 ``` { "userName": "user name", "password": "password" } ``` **SharePoint Online OAuth 2.0 認証**の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。 ``` { "userName": "SharePoint account user name"", "password": "SharePoint account password", "clientId": "SharePoint auto-generated unique client id", "clientSecret": "secret string shared by Amazon Kendra and SharePoint to authorize communications" } ``` **SharePoint Server 基本認証**の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。 ``` { "userName": "user name", "password": "password", "domain": "server domain name" } ``` **SharePoint Server の LDAP 認証の場合** (ユーザーコンテキストでフィルタリングするためにアクセスコントロールリスト (ACL) を E メール形式に変換する必要がある場合は、シークレットに LDAP サーバーの URL と LDAP 検索ベースを含めることができます)、シークレットに含める必要がある最小の JSON 構造は次のとおりです。 ``` { "userName": "user name", "password": "password", "domain": "server domain name" "ldapServerUrl": "ldap://example.com:389", "ldapSearchBase": "dc=example,dc=com" } ``` **SharePoint Server 手動認証**の場合、シークレットに含める必要がある最小の JSON 構造は次のとおりです。 ``` { "userName": "user name", "password": "password", "domain": "server domain name", "emailDomainOverride": "example.com" } ``` + **IAM role** — を呼び出し`CreateDataSource`て IAM ロールに Secrets Manager シークレットへのアクセス許可を付与し、SharePoint コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for SharePoint data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 + **Amazon VPC** - SharePoint Server を使用する場合は、データソース構成の一部として `VpcConfiguration` を指定してください。[「VPC を使用する Amazon Kendra ように を設定する](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 オプションで、次の機能を追加することもできます。 + **ウェブプロキシ** - ウェブプロキシ経由で SharePoint サイトの URL に接続するかどうか。このオプションは SharePoint Server でのみ使用できます。 + **インデックス作成リスト** — が添付ファイルの内容を SharePoint リスト項目にインデックス Amazon Kendra 作成するかどうか。 + **変更ログ** - インデックス内でドキュメントを更新する必要があるかどうかを判断するために、 Amazon Kendra が SharePoint データソース変更ログメカニズムを使用するかどうか。 **注記** Amazon Kendra にすべてのドキュメントをスキャンさせない場合は、変更ログを使用します。変更ログが大きい場合、SharePoint データソース内のドキュメントのスキャンには、変更ログの処理よりも Amazon Kendra 時間がかかる場合があります。SharePoint データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 + **包含フィルターと除外フィルター** - 特定のコンテンツを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、SharePoint データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ ## 詳細情報 SharePoint データソース Amazon Kendra との統合の詳細については、以下を参照してください。 + [Amazon Kendra SharePoint Online コネクタの開始方法](https://aws.amazon.com/blogs/machine-learning/getting-started-with-the-amazon-kendra-sharepoint-online-connector/) # SharePoint コネクタ V2.0 SharePoint は、ウェブコンテンツをカスタマイズしたり、ページ、サイト、ドキュメントライブラリ、リストを作成したりできる、コラボレーション用ウェブサイト構築サービスです。 Amazon Kendra を使用して SharePoint データソースのインデックスを作成できます。 Amazon Kendra は現在、SharePoint Online と SharePoint Server (2013、2016、2019、サブスクリプションエディション) をサポートしています。 **注記** SharePoint コネクタ V1.0/SharePointConfiguration API のサポートは 2023 年に終了しました。SharePoint コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon Kendra SharePoint データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-sharepoint) + [ ## 前提条件 ](#prerequisites-v2-sharepoint) + [ ## 接続手順 ](#data-source-procedure-v2-sharepoint) + [ ## 注意事項 ](#sharepoint-notes) ## サポートされている機能 Amazon Kendra SharePoint データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendra を使用して SharePoint データソースのインデックスを作成する前に、SharePoint と AWS アカウントでこれらの変更を行います。 シー AWS Secrets Manager クレットに安全に保存されている認証情報を指定する必要があります。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 **SharePoint Online では、次のものがあることを確認してください。** + SharePoint インスタンスの URL をコピーしました。入力したホスト URL の形式は *https://yourdomain.com/sites/mysite* です。URL は `https` で始まる必要があります。 + SharePoint インスタンス URL のドメイン名をコピーしました。 + SharePoint Online に接続するためのサイト管理者権限を持つユーザー名とパスワードを含む基本認証資格情報を記録しました。 + 管理者ユーザーを使用して Azure Portal の **[セキュリティデフォルト]** を無効にした。Azure Portal でのセキュリティのデフォルト設定の管理の詳細については、[セキュリティのデフォルトを有効または無効にする方法に関する Microsoft のドキュメント](https://learn.microsoft.com/en-us/microsoft-365/business-premium/m365bp-conditional-access?view=o365-worldwide&tabs=secdefaults#security-defaults-1)を参照してください。 + SharePoint アカウントの多要素認証 (MFA) を非アクティブ化し、 Amazon Kendra が SharePoint コンテンツのクロールをブロックしないようにします。 + **基本認証以外の認証タイプを使用している場合:** SharePoint インスタンスのテナント ID をコピーしました。テナント ID を確認する方法の詳細については、「[Find your Microsoft 365 tenant ID](https://learn.microsoft.com/en-us/sharepoint/find-your-office-365-tenant-id)」を参照してください。 + Microsoft Entra を使用してクラウドユーザー認証に移行する必要がある場合は、[クラウド認証に関する Microsoft のドキュメント](https://learn.microsoft.com/en-us/entra/identity/hybrid/connect/migrate-from-federation-to-cloud-authentication)を参照してください。 + **OAuth 2.0 認証および OAuth 2.0 更新トークン認証の場合:** SharePoint Online への接続に使用するユーザー名とパスワード、および SharePoint を Azure AD に登録した後に生成されたクライアント ID とクライアントシークレットを含む **[基本認証]** の認証情報を書き留めました。 + **ACL を使用していない場合は**、次のアクセス許可が追加されました。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-v2-sharepoint.html) **注記** Note.Read.All と Site.Read.All は OneNote ドキュメントをクロールする場合のみ必要です。 特定のサイトをクロールする場合は、ドメインで利用可能なすべてのサイトではなく、特定のサイトへのアクセス許可を制限するようにできます。**Site.Selected (アプリケーション)** アクセス許可を設定します。この API アクセス許可では、Microsoft Graph API を介してすべてのサイトにアクセス許可を明示的に設定する必要があります。詳細については、[Sites.Selected アクセス許可に関する Microsoft のブログ](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476)を参照してください。 + **ACL を使用している場合は**、次のアクセス許可を追加した。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-v2-sharepoint.html) **注記** GroupMember.read.all と User.Read.All は **[ID クローラー]** がアクティブ化されている場合にのみ必要です。 特定のサイトをクロールする場合は、ドメインで利用可能なすべてのサイトではなく、特定のサイトへのアクセス許可を制限するようにできます。**Site.Selected (アプリケーション)** アクセス許可を設定します。この API アクセス許可では、Microsoft Graph API を介してすべてのサイトにアクセス許可を明示的に設定する必要があります。詳細については、[Sites.Selected アクセス許可に関する Microsoft のブログ](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476)を参照してください。 + **Azure AD アプリ専用認証の場合:** SharePoint を Azure AD に登録した後に生成したプライベートキーとクライアント ID。また、X.509 証明書も書き留めます。 + **ACL を使用していない場合は**、次のアクセス許可が追加されました。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-v2-sharepoint.html) **注記** 特定のサイトをクロールする場合は、ドメインで利用可能なすべてのサイトではなく、特定のサイトへのアクセス許可を制限するようにできます。**Site.Selected (アプリケーション)** アクセス許可を設定します。この API アクセス許可では、Microsoft Graph API を介してすべてのサイトにアクセス許可を明示的に設定する必要があります。詳細については、[Sites.Selected アクセス許可に関する Microsoft のブログ](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476)を参照してください。 + **ACL を使用している場合は**、次のアクセス許可を追加した。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-v2-sharepoint.html) **注記** 特定のサイトをクロールする場合は、ドメインで利用可能なすべてのサイトではなく、特定のサイトへのアクセス許可を制限するようにできます。**Site.Selected (アプリケーション)** アクセス許可を設定します。この API アクセス許可では、Microsoft Graph API を介してすべてのサイトにアクセス許可を明示的に設定する必要があります。詳細については、[Sites.Selected アクセス許可に関する Microsoft のブログ](https://techcommunity.microsoft.com/t5/microsoft-sharepoint-blog/develop-applications-that-use-sites-selected-permissions-for-spo/ba-p/3790476)を参照してください。 + **SharePoint アプリ専用認証の場合:** SharePoint アプリのみに権限を付与する際に生成された SharePoint クライアント ID とクライアントシークレット、および SharePoint アプリを Azure AD に登録したときに生成されたクライアント ID とクライアントシークレットを記録しました。 **注記** SharePoint アプリ専用認証は、SharePoint 2013 バージョンではサポートされて*いません*。 + **(オプション) OneNote ドキュメントをクロールしていて **[ID クローラー]** を使用している場合、次のアクセス許可が追加されました**。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-v2-sharepoint.html) **注記** **[基本認証]** と SharePoint **アプリ専用認証**を使用してエンティティをクロールする場合、API アクセス許可は必要ありません。 **SharePoint Server では、次のものがあることを確認してください。** + SharePoint インスタンス URL と SharePoint URL のドメイン名をコピーしました。入力したホスト URL の形式は *https://yourcompany/sites/mysite* です。URL は `https` で始まる必要があります。 **注記** (オンプレミス/サーバー) Amazon Kendra AWS Secrets Manager は、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。[混乱する代理問題](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、 Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。 + SharePoint アカウントの多要素認証 (MFA) を非アクティブ化し、 Amazon Kendra が SharePoint コンテンツのクロールをブロックしないようにします。 + アクセス制御に **[SharePoint アプリ専用認証]** を使用する場合: + サイトレベルでアプリのみを登録したときに生成された SharePoint クライアント ID をコピーしました。クライアント ID 形式は ClientId@TenantId です。例: *ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*。 + サイトレベルでアプリのみを登録したときに生成された SharePoint クライアントシークレットをコピーしました。 **注:** クライアント ID とクライアントシークレットは、SharePoint Server をアプリ専用認証に登録した場合にのみ単一サイト用に生成されるため、SharePoint アプリ専用認証でサポートされるサイト URL は 1 つだけです。 **注記** SharePoint アプリ専用認証は、SharePoint 2013 バージョンではサポートされて*いません*。 + **[カスタムドメイン付き E メール ID]** をアクセス制御に使用する場合: + カスタムメールドメインの値 (例: *"amazon.com"*) を記録しました。 + **[IDP からのドメインを使った E メール ID]** 承認を使用している場合は、以下をコピーしました。 + LDAP サーバーエンドポイント (プロトコルとポート番号を含む LDAP サーバーのエンドポイント)。例: *ldap://example.com:389*。 + LDAP 検索ベース (LDAP ユーザーの検索ベース)。例: *CN=Users、DC=sharepoint、DC=com*. + LDAP ユーザー名と LDAP パスワード。 + 設定済みの NTLM 認証資格情報、**または**ユーザー名 (SharePoint アカウントユーザー名) とパスワード (SharePoint アカウントパスワード) を含む設定済みの Kerberos 認証資格情報のいずれか。 **で AWS アカウント、以下があることを確認します。** + [Amazon Kendra インデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAM ロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しました IAM 。 **注記** 認証タイプと認証情報を変更する場合は、 IAM ロールを更新して正しい AWS Secrets Manager シークレット ID にアクセスする必要があります。 + SharePoint の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存の IAM ロールまたはシークレットがない場合は、SharePoint データソースを接続するときに コンソールを使用して新しい IAM ロールと Secrets Manager シークレットを作成できます Amazon Kendra。API を使用している場合は、既存の IAM ロールと Secrets Manager シークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 SharePoint データソース Amazon Kendra に接続するには、 がデータにアクセスできるように Amazon Kendra 、SharePoint 認証情報の詳細を指定する必要があります。SharePoint をまだ設定していない場合は、 Amazon Kendra 「」を参照してください[前提条件](#prerequisites-v2-sharepoint)。 ------ #### [ Console: SharePoint Online ] **SharePoint Online Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[SharePoint コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[SharePoint コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ホスティング方法]** - **[SharePoint Online]** を選択します。 1. **[SharePoint リポジトリ固有のサイト URL]** - SharePoint ホストの URL を入力します。入力したホスト URL の形式は *https://yourdomain.sharepoint.com/sites/mysite* です。URL は `https` プロトコルで始まる必要があります。URL は改行で区切ります。最大 100 個の URL を追加できます。 1. **[ドメイン]** - SharePoint ドメインを入力します。例えば、URL *https://yourdomain.sharepoint.com/sites/mysite* のドメインは *yourdomain* です。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 また、ユーザー ID のタイプとして、Azure Portal から取得したユーザープリンシパル名かユーザーメールアドレスのいずれかを選択できます。指定しない場合は、デフォルトで E メールが使用されます。 1. **[認証]** - [基本]、[OAuth 2.0]、[Azure AD アプリケーション専用認証]、[SharePoint アプリケーション専用認証]、[OAuth 2.0 更新トークン認証] のいずれかを選択します。認証情報を保存するための既存の AWS Secrets Manager シークレットを選択するか、新しいシークレットを作成します。 1. **[基本認証]** を使用する場合は、シークレットにはシークレット名、および SharePoint のユーザー名とパスワードを含める必要があります。 1. **[OAuth 2.0 認証]** を使用する場合は、シークレットには、SharePoint テナント ID、シークレット名、SharePoint ユーザー名、パスワード、Azure AD に SharePoint を登録するときに生成される Azure AD クライアント ID、および Azure AD に SharePoint を登録するときに生成される Azure AD クライアントシークレットを含める必要があります。 1. **[Azure AD アプリ専用認証]** を使用する場合は、シークレットには、SharePoint テナント ID、Azure AD 自己署名 X.509 証明書、シークレット名、Azure AD に SharePoint を登録したときに生成された Azure AD クライアント ID、および Azure AD のコネクタを認証するためのプライベートキーを含める必要があります。 1. **[SharePoint アプリ専用認証]** を使用する場合は、シークレットには、SharePoint テナント ID、シークレット名、テナントレベルでアプリ専用を登録するときに生成された SharePoint クライアント ID、テナントレベルでアプリ専用を登録するときに生成された SharePoint クライアントシークレット、Azure AD に SharePoint を登録するときに生成された Azure AD クライアント ID、および Azure AD に SharePoint を登録するに生成された Azure AD クライアントシークレットを含める必要があります。 SharePoint クライアント ID 形式は *ClientID@TenantId* です。例: *ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*。 1. **OAuth 2.0 更新トークン認証**を使用する場合、シークレットには、SharePoint テナント ID、シークレット名、Azure AD に SharePoint を登録するときに生成された一意の Azure AD クライアント ID、SharePoint を Azure AD に登録するときに生成された Azure AD クライアントシークレット、SharePoint Amazon Kendra に接続するために生成された更新トークンを含める必要があります。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 また、ローカルグループマッピングをクロールするか、Azure Active Directory のグループマッピングをクロールするかを選択することもできます。 **注記** AD グループマッピングのクローリングは、OAuth 2.0、OAuth 2.0 更新トークン、SharePoint アプリ専用認証にのみ使用できます。 1. **IAM role** — 既存の IAM ロールを選択するか、新しい IAM ロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 1. **[エンティティの選択]** - クロールするエンティティを選択します。**[すべて]** のエンティティをクロールするか、**[ファイル]**、**[添付ファイル]**、**[リンク]**、**[ページ]**、**[イベント]**、**[コメント]**、**[リストデータ]** を組み合わせてクロールするかを選択できます。 1. **[追加の設定]** の **[エンティティ正規表現パターン]** - **[リンク]**、**[ページ]**、**[イベント]** に正規表現パターンを追加して、すべてのドキュメントを同期する代わりに特定のエンティティを含めます。 1. **[正規表現パターン]** - すべてのドキュメントを同期する代わりに、**[ファイルパス]**、**[ファイル名]**、**[ファイルタイプ]**、**[OneNote セクション名]**、**[OneNote ページ名]** でファイルを含めたり除外したりする正規表現パターンを追加します。最大 100 個を追加できます。 **注記** OneNote クローリングは、OAuth 2.0、OAuth 2.0 更新トークン、SharePoint アプリ専用認証にのみ使用できます。 1. **[同期モード]** では、データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツが同期されます。 + **[完全同期]** - 前回の同期ステータスに関係なく、すべてのコンテンツを同期します。 + **[新規または変更済みのドキュメントを同期]** - 新規または変更済みのドキュメントのみを同期します。 + **[新規、変更済み、または削除されたドキュメントを同期]** - 新規、変更済み、または削除されたドキュメントのみを同期します。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ Console: SharePoint Server ] **SharePoint Amazon Kendra に接続するには** 1. にサインイン AWS マネジメントコンソール し、 [Amazon Kendra コンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[SharePoint コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[SharePoint コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、 AWS コストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ホスティング方法]** - **[SharePoint Server]** を選択します。 1. **[SharePoint バージョンを選択]** - **[SharePoint 2013]**、**[SharePoint 2016]**、**[SharePoint 2019]**、**[SharePoint (サブスクリプションエディション)]** のいずれかを選択します。 1. **[SharePoint リポジトリ固有のサイト URL]** - SharePoint ホストの URL を入力します。入力したホスト URL の形式は *https://yourcompany/sites/mysite* です。URL は `https` プロトコルで始まる必要があります。URL は改行で区切ります。最大 100 個の URL を追加できます。 1. **[ドメイン]** - SharePoint ドメインを入力します。例えば、URL *https://yourcompany/sites/mysite* のドメインは *yourcompany* です 1. **SSL 証明書の場所** — SSL 証明書ファイルへの Amazon S3 パスを入力します。 1. (オプション) **[ウェブプロキシ]** の場合: ホスト名 (`http://` または `https://` プロトコルなし) と、ホスト URL トランスポートプロトコルで使用されるポート番号を入力します。ポート番号の数値は 0～65535 の間である必要があります。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 SharePoint Server の場合は、次の ACL オプションから選択できます。 1. **[IDP からのドメインを使った E メール ID]** - ユーザー ID は、基になる ID プロバイダー (IdP) から取得したドメインを使用した E メール ID に基づきます。**認証**の一環として、 Secrets Manager のシークレットに保存した IDP 接続の詳細を提供します。 1. **[カスタムドメインを使用した E メール ID]** - ユーザー ID はカスタム E メールドメイン値に基づきます。例: *"amazon.com"*。E メールドメインは、アクセス制御用の E メール ID の作成に使用されます。カスタム E メールドメインを入力する必要があります。 1. **[ドメインを使用したドメイン\$1ユーザー]** - ユーザー ID は、ドメイン\$1ユーザー ID 形式で構成されます。有効なドメイン名を指定する必要があります。例えば、アクセス制御を構築するには *"sharepoint2019"* と入力します。 1. **[認証]** では、[SharePoint アプリ専用認証]、[NTLM 認証]、[Kerberos 認証] のいずれかを選択します。認証情報を保存するための既存の AWS Secrets Manager シークレットを選択するか、新しいシークレットを作成します。 1. **[NTLM 認証]** または **[Kerberos 認証]** を使用する場合は、シークレットに、シークレット名、および SharePoint のユーザー名とパスワードを含める必要があります。 **[IDP からのドメイン付き E メール ID]** を使用している場合は、次の情報も入力してください。 + **[LDAP サーバーエンドポイント]** - プロトコルとポート番号を含む LDAP サーバーのエンドポイント。例: *ldap://example.com:389*。 + **[LDAP 検索ベース]** - LDAP ユーザーの検索ベース。例: *CN=Users、DC=sharepoint、DC=com*. + **[LDAP ユーザー名]** - LDAP ユーザー名。 + **[LDAP パスワード]** - LDAP パスワード。 1. **[SharePoint アプリ専用認証]** を使用する場合は、シークレットにはシークレット名、サイトレベルでアプリ専用を登録するときに生成された SharePoint クライアント ID、サイトレベルでアプリ専用を登録するときに生成された SharePoint クライアントシークレットを含める必要があります。 SharePoint クライアント ID 形式は *ClientID@TenantId* です。例: *ffa956f3-8f89-44e7-b0e4-49670756342c@888d0b57-69f1-4fb8-957f-e1f0bedf82fe*。 **注:** クライアント ID とクライアントシークレットは、SharePoint Server をアプリ専用認証に登録した場合にのみ単一サイト用に生成されるため、SharePoint アプリ専用認証でサポートされるサイト URL は 1 つだけです。 **[IDP からのドメイン付き E メール ID]** を使用している場合は、次の情報も入力してください。 + **[LDAP サーバーエンドポイント]** - プロトコルとポート番号を含む LDAP サーバーのエンドポイント。例: *ldap://example.com:389*。 + **[LDAP 検索ベース]** - LDAP ユーザーの検索ベース。例: *CN=Users、DC=sharepoint、DC=com*. + **[LDAP ユーザー名]** - LDAP ユーザー名。 + **[LDAP パスワード]** - LDAP パスワード。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 また、ローカルグループマッピングをクロールするか、Azure Active Directory のグループマッピングをクロールするかを選択することもできます。 **注記** AD グループマッピングのクローリングは、SharePoint アプリ専用認証にのみ使用できます。 1. **IAM role** — 既存の IAM ロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しい IAM ロールを作成します。 **注記** IAM インデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 1. **[エンティティの選択]** - クロールするエンティティを選択します。**[すべて]** のエンティティをクロールするか、**[ファイル]**、**[添付ファイル]**、**[リンク]**、**[ページ]**、**[イベント]**、**[リストデータ]** を組み合わせてクロールするかを選択できます。 1. **[追加の設定]** の **[エンティティ正規表現パターン]** - **[リンク]**、**[ページ]**、**[イベント]** に正規表現パターンを追加して、すべてのドキュメントを同期する代わりに特定のエンティティを含めます。 1. **[正規表現パターン]** - すべてのドキュメントを同期する代わりに、**[ファイルパス]**、**[ファイル名]**、**[ファイルタイプ]**、**[OneNote セクション名]**、**[OneNote ページ名]** でファイルを含めたり除外したりする正規表現パターンを追加します。最大 100 個を追加できます。 **注記** OneNote のクローリングは、SharePoint アプリ専用認証にのみ使用できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。 Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新しい変更された同期: データソースがインデックスと同期するたびに、新しいコンテンツと変更されたコンテンツのみをインデックス化します。 Amazon Kendra は、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 + 新規作成、変更、削除の同期: データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。 Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングする Amazon Kendra 生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **SharePoint Amazon Kendra に接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `SHAREPOINTV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **リポジトリエンドポイントメタデータ** - SharePoint インスタンスの `tenantID` `domain` と `siteUrls` を指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendra と初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendra は、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **[ID クローラー]** - Amazon Kendraの ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、 Amazon Kendra ID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 **注記** ID クローラーは、`crawlAcl` を `true` に設定した場合にのみ使用できます。 + **リポジトリの追加プロパティ** - 以下を指定します。 + (Azure AD のみ) Azure AD の自己署名 X.509 証明書を保存するために使用した `s3bucketName` と `s3certificateName`。 + 使用する認証タイプ (`auth_Type`) (`OAuth2`、`OAuth2App`、`OAuth2Certificate`、`Basic`、`OAuth2_RefreshToken`、`NTLM`、`Kerberos` など)。 + 使用するバージョン (`version`) (`Server` または `Online`)。`Server` を使用する場合、`onPremVersion` を `2013`、`2016`、`2019`、または `SubscriptionEdition` としてさらに指定できます。 + **シークレット Amazon リソースネーム (ARN)** — SharePoint アカウントで作成した認証情報を含む Secrets Manager シークレットの Amazon リソースネーム (ARN) を指定します。 SharePoint Online を使用している場合は、基本、OAuth 2.0、Azure AD アプリ専用、SharePoint アプリ専用の認証を選択できます。各認証オプションでシークレットに含める必要がある最小の JSON 構造を次に示します。 + **基本認証** ``` { "userName": "SharePoint account user name", "password": "SharePoint account password" } ``` + **OAuth 2.0 認証** ``` { "clientId": "client id generated when registering SharePoint with Azure AD", "clientSecret": "client secret generated when registering SharePoint with Azure AD", "userName": "SharePoint account user name", "password": "SharePoint account password" } ``` + **Azure AD アプリ専用認証** ``` { "clientId": "client id generated when registering SharePoint with Azure AD", "privateKey": "private key to authorize connection with Azure AD" } ``` + **SharePoint アプリ専用認証** ``` { "clientId": "client id generated when registering SharePoint for App Only at Tenant Level", "clientSecret": "client secret generated when registering SharePoint for App Only at Tenant Level", "adClientId": "client id generated while registering SharePoint with Azure AD", "adClientSecret": "client secret generated while registering SharePoint with Azure AD" } ``` + **OAuth 2.0 更新トークン認証** ``` { "clientId": "client id generated when registering SharePoint with Azure AD", "clientSecret": "client secret generated when registering SharePoint with Azure AD", "refreshToken": "refresh token generated to connect to SharePoint" } ``` SharePoint Server を使用している場合は、SharePoint アプリケーション専用認証、NTLM 認証、Kerberos 認証のいずれかを選択できます。各認証オプションでシークレットに含める必要がある最小の JSON 構造を次に示します。 + **SharePoint アプリ専用認証** ``` { "siteUrlsHash": "Hash representation of SharePoint site URLs", "clientId": "client id generated when registering SharePoint for App Only at Site Level", "clientSecret": "client secret generated when registering SharePoint for App Only at Site Level" } ``` + **IDP 認可からのドメインによる SharePoint アプリ専用認証** ``` { "siteUrlsHash": "Hash representation of SharePoint site URLs", "clientId": "client id generated when registering SharePoint for App Only at Site Level", "clientSecret": "client secret generated when registering SharePoint for App Only at Site Level", "ldapUrl": "LDAP Account url eg. ldap://example.com:389", "baseDn": "LDAP Account base dn eg. CN=Users,DC=sharepoint,DC=com", "ldapUser": "LDAP account user name", "ldapPassword": "LDAP account password" } ``` + **(サーバーのみ) NTLM または Kerberos 認証** ``` { "siteUrlsHash": "Hash representation of SharePoint site URLs", "userName": "SharePoint account user name", "password": "SharePoint account password" } ``` + **(サーバーのみ) IDP 認可からのドメインによる NTLM または Kerberos 認証** ``` { "siteUrlsHash": "Hash representation of SharePoint site URLs", "userName": "SharePoint account user name", "password": "SharePoint account password", "ldapUrl": "ldap://example.com:389", "baseDn": "CN=Users,DC=sharepoint,DC=com", "ldapUser": "LDAP account user name", "ldapPassword": "LDAP account password" } ``` + **IAM role** — を呼び出し`CreateDataSource`て、シー Secrets Manager クレットにアクセスするためのアクセス許可を IAM ロールに提供し、SharePoint コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定します Amazon Kendra。詳細については、「[IAM roles for SharePoint data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のファイル、OneNote、その他のコンテンツを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、SharePoint データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメント Amazon Kendra を検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[SharePoint テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-sharepoint)」を参照してください。 ------ ## 注意事項 + コネクタは **[ファイル]** エンティティのカスタムフィールドマッピングのみをサポートします。 + SharePoint Server のすべてのバージョンで、ACL トークンは小文字にする必要があります。**[IDP からのドメイン付き E メール ID]** および **[カスタムドメイン付き E メール ID]** の場合 (例: *user@sharepoint2019.com*)。**[ドメイン\$1ドメイン付きユーザー]** ACL の場合 (例: *sharepoint2013\$1user*)。 + アクセスコントロール (ACL) が有効になっている場合、SharePoint API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用することはできません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 + このコネクタは、SharePoint 2013 の変更ログモード/**新規または変更されたコンテンツの同期**をサポートしていません。 + エンティティ名の名前に `%` 文字が含まれている場合、API の制限によりコネクタはこれらのファイルをスキップします。 + OneNote をクロールできるのは、テナント ID を使用し、SharePoint Online で OAuth 2.0、OAuth 2.0 更新トークン、または SharePoint アプリケーション専用認証が有効になっているコネクタだけです。 + コネクタは、ドキュメントの名前が変更された場合でも、OneNote ドキュメントの最初のセクションを既定の名前のみでクロールします。 + コネクタは、SharePoint 2019、SharePoint Online、およびサブスクリプションエディションのリンクを、クロールするエンティティとして **[リンク]** に加えて **[ページ]** と **[ファイル]** が選択されている場合にのみクロールします。 + クロールするエンティティとしてリンクが選択されている場合、コネクタは SharePoint 2013 と SharePoint 2016 の **[リンク]** をクロールします。 + コネクタがリストの添付ファイルとコメントをクロールするのは、クロール対象のエンティティとして **[リストデータ]** も選択されている場合のみです。 + コネクタがイベント添付ファイルをクロールするのは、クロール対象のエンティティとして **[イベント]** も選択されている場合のみです。 + SharePoint Online バージョンの場合、ACL トークンは小文字になります。例えば、Azure ポータルの **[ユーザープリンシパル名]** が *MaryMajor@domain.com* の場合、SharePoint コネクタの ACL トークンは *marymajor@domain.com* になります。 + SharePoint Online および Server 用の **[ID クローラー]** では、ネストされたグループをクロールする場合、AD グループクローリングだけでなくローカルクローリングも有効にする必要があります。 + SharePoint Online を使用していて、Azure ポータルのユーザープリンシパル名が大文字と小文字の組み合わせである場合、SharePoint API は内部的にこれを小文字に変換します。このため、 Amazon Kendra SharePoint コネクタは ACL を小文字に設定します。 # Microsoft SQL Server **注記** Microsoft SQL Server コネクタは、2026 年 5 月 31 日まで、既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Microsoft SQL Server は、Microsoft が開発したリレーショナルデータベース管理システム (RDBMS) です。Microsoft SQL Server ユーザーの場合は、 Amazon Kendraを使用してMicrosoft SQL Serverデータソースのインデックスを作成できます。データソースコネクタはAmazon KendraMicrosoft SQL Server MS SQL Server 2019 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してMicrosoft SQL ServerデータソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraMicrosoft SQL Serverトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-ms-sql-server) + [ ## 前提条件 ](#prerequisites-ms-sql-server) + [ ## 接続手順 ](#data-source-procedure-ms-sql-server) + [ ## 注意事項 ](#ms-sql-server-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してMicrosoft SQL ServerデータソースAmazon Kendraのインデックスを作成する前に、 Microsoft SQL Serverおよび AWSアカウントでこれらの変更を行います。 **Microsoft SQL Server で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが Microsoft SQL Server および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Microsoft SQL Server の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、 コンソールを使用して、Microsoft SQL Serverデータソースを接続するときに新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Microsoft SQL Server データソースAmazon Kendraに接続するには、 がデータにアクセスできるようにAmazon Kendra、Microsoft SQL Server認証情報の詳細を指定する必要があります。をまだ設定していない場合は、Microsoft SQL ServerAmazon Kendra「」を参照してください[前提条件](#prerequisites-ms-sql-server)。 ------ #### [ Console ] **Amazon Kendraに接続するには Microsoft SQL Server** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Microsoft SQL Server コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Microsoft SQL Server コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** — SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Microsoft SQL Server新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Microsoft SQL Server-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 **注記** テーブル名に特殊文字 (英数字以外) が含まれている場合は、テーブル名の前後を角括弧で囲む必要があります。例: *select \$1 from [my-database-table]* + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** — タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Microsoft SQL Server** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `sqlserver` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 **注記** テーブル名に特殊文字 (英数字以外) が含まれている場合は、テーブル名の前後を角括弧で囲む必要があります。例: *select \$1 from [my-database-table]* + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Microsoft SQL Serverアカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** - を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Microsoft SQL Serverコネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Microsoft SQL Server data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Microsoft SQL Server データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Microsoft SQL サーバーテンプレートスキーマ](ds-schemas.md#ds-ms-sql-server-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックする場合、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Microsoft Teams Microsoft Teams は、メッセージング、会議、ファイル共有のためのエンタープライズコラボレーションツールです。Microsoft Teams ユーザーの場合は、 Amazon Kendraを使用して Microsoft Teams データソースのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して、Microsoft Teams データソースAmazon Kendraに接続できます。 Amazon KendraMicrosoft Teams データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-teams) + [ ## 前提条件 ](#prerequisites-teams) + [ ## 接続手順 ](#data-source-procedure-teams) + [ ## 詳細はこちら ](#teams-learn-more) + [ ## 注意事項 ](#teams-notes) ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Microsoft Teams データソースのインデックスを作成する前に、Microsoft Teams とAWSアカウントでこれらの変更を行います。 **Microsoft Teams で以下を確認してください。** + Office 365 で Microsoft Teams アカウントを作成しました。 + Microsoft 365 のテナント ID を記録しました。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + Azure portal で OAuth アプリケーションを設定し、クライアント ID、クライアントシークレット、またはクライアント認証情報を書き留めました。詳細については、[Microsoft のチュートリアル](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory)と[アプリケーションの登録の例](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)を参照してください。 **注記** Azure portal でアプリを作成または登録すると、シークレット ID は実際のシークレット値を表します。シークレットとアプリを作成するときに、実際のシークレット値を書き留めるか保存しておく必要があります。シークレットにアクセスするには、Azure portal でアプリケーションの名前を選択し、証明書とシークレットのメニューオプションに移動します。 クライアント ID にアクセスするには、Azure portal でアプリケーションの名前を選択し、概要ページに移動します。アプリケーション (クライアント) ID は、クライアント ID です。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + 必要なアクセス権限を追加しました。すべてのアクセス権限を追加できますが、クロールするエンティティに基づいて選択するアクセス権限を減らすことによって範囲を制限することもできます。次の表に、対応するエンティティ別のアプリケーションレベルのアクセス権限を示しています。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-teams.html) + 各ドキュメントが Microsoft Teams および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Microsoft Teams の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Microsoft Teams データソースを接続するときに、コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Microsoft Teams データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Microsoft Teams データソースの必要な詳細を指定する必要があります。Microsoft Teams をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-teams)。 ------ #### [ Console ] **Microsoft Teams Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[Microsoft Teams コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Microsoft Teams コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[テナント ID]** - Microsoft 365 のテナント ID を入力します。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Microsoft Teams 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Microsoft Teams-」が自動的に追加されます。 1. **[クライアント ID]** と **[クライアントシークレット]** - Azure portal の Microsoft Teams で設定した認証情報を入力します。 1. シークレットを保存して追加します。 1. **[支払いモデル]** - Microsoft Teams アカウントのライセンスと支払いモデルを選択できます。モデル A の支払いモデルは、セキュリティコンプライアンスを必要とするライセンスモデルと支払いモデルに限定されます。モデル B の支払いモデルは、セキュリティコンプライアンスを必要としないライセンスモデルや支払いモデルに適しています。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[コンテンツを同期]** - クロールするコンテンツのタイプを選択します。チャット、チーム、カレンダーのコンテンツをクロールできます。 1. **[追加設定]** — 特定のカレンダーの開始日と終了日、ユーザーの E メール、チーム名、チャネル名、添付ファイル、OneNotes を指定します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Microsoft Teams Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `MSTEAMS` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **テナント ID** - テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — Microsoft Teams アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "clientId": "client ID", "clientSecret": "client secret" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Microsoft Teams コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Microsoft Teams data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[ドキュメント/コンテンツタイプ]** - チャットのメッセージと添付ファイル、チャネルの投稿と添付ファイル、チャネルの Wiki、カレンダーのコンテンツ、会議のチャットおよびファイルとメモをクロールするかどうかを指定できます。 + **[カレンダーのコンテンツ]** — カレンダーのコンテンツをクロールする開始日時と終了日時を指定します。 + **包含フィルターと除外フィルター** - Microsoft Teams で特定のコンテンツを含めるか除外するかを指定します。チーム名、チャネル名、ファイル名とファイルタイプ、ユーザーの E メール、OneNote セクション、および OneNote ページを含めたり除外したりできます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして、検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Microsoft Teams データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Microsoft Teams テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-msteams-schema)」を参照してください。 ------ ## 詳細はこちら Microsoft Teams データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Microsoft Teams のAmazon Kendraコネクタを使用して組織の Microsoft Teams データソースをインテリジェントに検索する](https://aws.amazon.com/blogs/machine-learning/intelligently-search-your-organizations-microsoft-teams-data-source-with-the-amazon-kendra-connector-for-microsoft-teams/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Microsoft Teams API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用することができません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # Microsoft Yammer **注記** Microsoft Yammer コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。新規ユーザーがこのコネクタを使用することはできなくなりましたが、現在のユーザーは中断なく引き続きご使用いただけます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Microsoft Yammer は、メッセージング、会議、ファイル共有のためのエンタープライズコラボレーションツールです。Microsoft Yammer ユーザーの場合は、 Amazon Kendraを使用して Microsoft Yammer データソースのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して、Microsoft Yammer データソースAmazon Kendraに接続できます。 Amazon KendraMicrosoft Yammer データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 ## サポートされている機能 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Microsoft Yammer データソースのインデックスを作成する前に、Microsoft Yammer と AWSアカウントでこれらの変更を行います。 **Microsoft Yammer で以下を確認してください。** + Office 365 で Microsoft Yammer 管理者アカウントを作成しました。 + Microsoft Yammer のユーザー名とパスワードを記録しました。 + Microsoft 365 のテナント ID を記録しました。テナント ID は Azure Active Directory ポータルのプロパティまたは OAuth アプリケーションで確認できます。 + Azure portal で OAuth アプリケーションを設定し、クライアント ID、クライアントシークレット、またはクライアント認証情報を書き留めました。詳細については、[Microsoft のチュートリアル](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/walkthrough-register-app-azure-active-directory)と[アプリケーションの登録の例](https://learn.microsoft.com/en-us/azure/healthcare-apis/register-application)を参照してください。 **注記** Azure portal でアプリを作成または登録すると、シークレット ID は実際のシークレット値を表します。シークレットとアプリを作成するときに、実際のシークレット値を書き留めるか保存しておく必要があります。シークレットにアクセスするには、Azure portal でアプリケーションの名前を選択し、証明書とシークレットのメニューオプションに移動します。 クライアント ID にアクセスするには、Azure portal でアプリケーションの名前を選択し、概要ページに移動します。アプリケーション (クライアント) ID は、クライアント ID です。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + 各ドキュメントが Microsoft Yammer および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Microsoft Yammer の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Microsoft Yammer データソースを接続するときに、コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Microsoft Yammer データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Microsoft Yammer データソースの必要な詳細を指定する必要があります。Microsoft Yammer をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-yammer)。 ------ #### [ Console ] **Microsoft Yammer Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで、**[Microsoft Yammer コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Microsoft Yammer コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Microsoft Yammer 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Microsoft Yammer-」が自動的に追加されます。 1. **[ユーザー名]**、**[パスワード]** - Microsoft Yammer のユーザー名とパスワードを入力します。 1. **[クライアント ID]**、**[クライアントシークレット]** - Azure portal の Microsoft Yammer で設定した認証情報を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[開始日]** - Microsoft Yammer でデータのクローリングを開始する日付を指定します。 1. **[コンテンツを同期]** - クロールするコンテンツのタイプを選択します。例えば、公開メッセージ、非公開メッセージ、添付ファイルなどです。 1. **[追加設定]** — クロールする特定のコミュニティ名、および特定のコンテンツを含める、または除外するための正規表現パターンの使用をします。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Microsoft Yammer Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `YAMMER` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **Secret Amazon Resource Name (ARN)** — Microsoft Yammer アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password", "clientId": "client ID", "clientSecret": "client secret" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Microsoft Yammer コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Microsoft Yammer data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[ドキュメント/コンテンツタイプ]** — コミュニティコンテンツ、メッセージと添付ファイル、プライベートメッセージをクロールするかどうかを指定します。 + **包含フィルターと除外フィルター** - 特定のコンテンツを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Microsoft Yammer データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Microsoft Yammer テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-yammer)」を参照してください。 ------ ## 詳細はこちら Microsoft Yammer データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [の Yammer コネクタの発表Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-yammer-connector-for-amazon-kendra/) # MySQL **注記** MySQL コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 MySQL は、オープンソースのリレーショナルデータベース管理システムです。MySQL ユーザーの場合は、 Amazon Kendraを使用してMySQLデータソースのインデックスを作成できます。データソースコネクタはAmazon KendraMySQL MySQL 8.0 をサポートしています。21. [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してMySQLデータソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraMySQLトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-mysql) + [ ## 前提条件 ](#prerequisites-mysql) + [ ## 接続手順 ](#data-source-procedure-mysql) + [ ## 注意事項 ](#mysql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してMySQLデータソースAmazon Kendraのインデックスを作成する前に、 MySQLおよび AWSアカウントでこれらの変更を行います。 **MySQL で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが MySQL および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + MySQL の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、MySQLデータソースの接続時に コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 MySQL データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、MySQL認証情報の詳細を指定する必要があります。をまだ設定していない場合は、MySQLAmazon Kendra「」を参照してください[前提条件](#prerequisites-mysql)。 ------ #### [ Console ] **Amazon Kendraに接続するには MySQL** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[MySQL コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[MySQL コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** — SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、MySQL新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-MySQL-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **列の変更検出** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには MySQL** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `mySql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — MySQLアカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、MySQLコネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for MySQL data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、MySQL データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックする場合、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Oracle Database **注記** Oracle Database コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Oracle Database はデータベース管理システムです。Oracle Database ユーザーの場合は、 Amazon Kendraを使用してOracle Databaseデータソースのインデックスを作成できます。データソースコネクタはAmazon KendraOracle Database、Oracle Database 18c、19c、21c をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してOracle DatabaseデータソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraOracle Databaseトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-oracle-database) + [ ## 前提条件 ](#prerequisites-oracle-database) + [ ## 接続手順 ](#data-source-procedure-oracle-database) + [ ## 注意事項 ](#oracle-database-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してOracle DatabaseデータソースAmazon Kendraのインデックスを作成する前に、 Oracle Databaseおよび AWSアカウントでこれらの変更を行います。 **Oracle Database で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが Oracle Database および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Oracle Database の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Oracle Databaseデータソースの接続時に コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Oracle Database データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Oracle Database認証情報の詳細を指定する必要があります。をまだ設定していない場合は、Oracle DatabaseAmazon Kendra「」を参照してください[前提条件](#prerequisites-oracle-database)。 ------ #### [ Console ] **Amazon Kendraに接続するには Oracle Database** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Oracle Database コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Oracle Database コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、Oracle Database新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Oracle Database-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **列の変更検出** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** - タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには Oracle Database** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `oracle` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — Oracle Databaseアカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Oracle Databaseコネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Oracle Database data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Oracle Database データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[Oracle Database テンプレートスキーマ](ds-schemas.md#ds-oracle-database-schema)」を参照してください。 ------ ## 注意事項 + 削除されたデータベース行は、 が更新されたコンテンツAmazon Kendraをチェックするときに で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用データベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # PostgreSQL **注記** PostgreSQL コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 PostgreSQL は、オープンソースのデータベース管理システムです。PostgreSQL ユーザーの場合は、 Amazon Kendraを使用してPostgreSQLデータソースのインデックスを作成できます。データソースコネクタはAmazon KendraPostgreSQL PostgreSQL 9.6 をサポートしています。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用してPostgreSQLデータソースAmazon Kendraに接続できます。 データソースコネクタのAmazon KendraPostgreSQLトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-postgresql) + [ ## 前提条件 ](#prerequisites-postgresql) + [ ## 接続手順 ](#data-source-procedure-postgresql) + [ ## 注意事項 ](#postgresql-notes) ## サポートされている機能 + フィールドマッピング + ユーザーコンテキストフィルタリング + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 を使用してPostgreSQLデータソースAmazon Kendraのインデックスを作成する前に、 PostgreSQLおよび AWSアカウントでこれらの変更を行います。 **PostgreSQL で以下を確認してください。** + データベースユーザー名とパスワードを記録済み。 **重要** ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + コピーしたデータベースのホスト URL、ポート、インスタンス。 + 各ドキュメントが PostgreSQL および同じインデックスを使用予定の他のデータソース間で一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + PostgreSQL の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、PostgreSQLデータソースの接続時に コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 PostgreSQL データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、PostgreSQL認証情報の詳細を指定する必要があります。をまだ設定していない場合は、PostgreSQLAmazon Kendra「」を参照してください[前提条件](#prerequisites-postgresql)。 ------ #### [ Console ] **Amazon Kendraに接続するには PostgreSQL** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[PostgreSQL コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[PostgreSQL コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[ソース]** には、次の情報を入力します。 1. **[ホスト]** - データベースのホスト名を入力します。 1. **[ポート]** - データベースのポートを入力します。 1. **[インスタンス]** - データベースインスタンスを入力します。 1. **SSL 証明書の場所を有効にする** - SSL 証明書ファイルへのAmazon S3パスを入力する場合に選択します。 1. **[認証]** には、次の情報を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、PostgreSQL新しいSecrets Managerシークレットを作成して認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-PostgreSQL-」が自動的に追加されます。 1. **[データベースユーザー名]** と **[パスワード]** - データベースからコピーした認証情報の値を入力します。 1. **[保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[同期の範囲]** で、次のオプションから選択します。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **[プライマリキー列]** - データベーステーブルのプライマリキーを指定します。これにより、データベース内のテーブルが識別されます。 + **[タイトル列]** - データベーステーブル内のドキュメントタイトル列の名前を指定します。 + **[本文列]** - データベーステーブル内のドキュメント本文列の名前を指定します。 1. **[その他の設定 - オプション]** で、すべてのファイルを同期する代わりに特定のコンテンツを同期するには、次のオプションから選択します。** + **変更検出列** — コンテンツの変更を検出Amazon Kendraするために使用する列の名前を入力します。これらの列のいずれかに変更があると、 はコンテンツのインデックスを再Amazon Kendra作成します。 + **[ユーザー ID 列]** - コンテンツへのアクセスを許可するユーザー ID を含む列の名前を入力します。 + **[グループ列]** - コンテンツへのアクセスを許可するグループを含む列の名前を入力します。 + **[ソース URL 列]** - インデックスを作成するソース URL を含む列の名前を入力します。 + **タイムスタンプ列** — タイムスタンプを含む列の名前を入力します。 は、タイムスタンプ情報Amazon Kendraを使用してコンテンツの変更を検出し、変更されたコンテンツのみを同期します。 + **[タイムゾーン列]** - クロールするコンテンツのタイムゾーンを含む列の名前を入力します。 + **[タイムスタンプの形式]** - コンテンツの変更を検出してコンテンツを再同期するために使用するタイムスタンプの形式を含む列の名前を入力します。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - Amazon Kendra がデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする**ドキュメント IDs**、**ドキュメントタイトル**、**ソース URLs**など、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Amazon Kendraに接続するには PostgreSQL** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して、以下を指定する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `JDBC` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **データベースタイプ** - データベースタイプを `postgresql` として指定する必要があります。 + **[SQL クエリ]** - SELECT や JOIN オペレーションなどの SQL クエリステートメントを入力します。SQL クエリは 32 KB 未満にする必要があります。Amazon Kendra はクエリに一致するすべてのデータベースコンテンツをクロールします。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — PostgreSQLアカウントで作成した認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "user name": "database user name", "password": "password" } ``` **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、PostgreSQLコネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for PostgreSQL data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ユーザー ID、グループ、ソース URL、タイムスタンプ、タイムゾーンを使用して、特定のコンテンツを含めるかどうかを指定できます。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、PostgreSQL データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについての詳細は、「[PostgreSQL テンプレートスキーマ](ds-schemas.md#ds-postgresql-schema)」を参照してください。 ------ ## 注意事項 + が更新されたコンテンツAmazon Kendraをチェックすると、削除されたデータベース行は で追跡されません。 + データベースの 1 行のフィールド名と値のサイズは 400 KB を超えることはできません。 + データベースデータソースに大量のデータがあり、最初の同期後にすべてのデータベースコンテンツのAmazon Kendraインデックスを作成しない場合は、新規、変更、または削除されたドキュメントのみを同期できます。 + ベストプラクティスとして、 Amazon Kendraに読み取り専用のデータベース認証情報を指定します。 + ベストプラクティスとして、機密データや個人を特定できる情報 (PII) を含むテーブルを追加することは避けてください。 # Quip **注記** Quip コネクタは、2026 年 5 月 31 日まで既存のお客様を対象に引き続き完全にサポートされます。このコネクタは新規ユーザーには使用できなくなりますが、現在のユーザーは中断することなく引き続き使用できます。コネクタポートフォリオは、よりスケーラブルでカスタマイズ可能なソリューションを提供するために継続的に進化しています。今後の統合のために、柔軟性を高めながら、より広範なエンタープライズユースケースをサポートするように設計された、Amazon Kendra Custom Connector Framework[1] を検討いただくことをお勧めします。 Quip は、リアルタイムのドキュメント作成機能を提供する共同生産性向上ソフトウェアです。Amazon Kendraを使用して、Quip フォルダ、ファイル、ファイルコメント、チャットルーム、添付ファイルのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [QuipConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QuipConfiguration.html) API を使用して Quip データソースAmazon Kendraに接続できます。 Quip データソースコネクタAmazon Kendraのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-quip) + [ ## 前提条件 ](#prerequisites-quip) + [ ## 接続手順 ](#data-source-procedure-quip) + [ ## 詳細はこちら ](#quip-learn-more) ## サポートされている機能 Amazon KendraQuip データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Quip データソースのインデックスを作成する前に、Quip とAWSアカウントでこれらの変更を行います。 **Quip で以下を確認してください。** + 管理者アクセス許可を持つ Quip アカウント。 + 個人アクセストークンを含む Quip 認証情報の作成。トークンは、 AWS Secrets Managerシークレットに保存されている認証情報として使用されます。詳細については、[認証に関する Quip ドキュメント](https://quip.com/dev/admin/documentation/current#section/Authentication)を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Quip サイトドメインのコピー。例えば、*https://quip-company.quipdomain.com/browse* の場合、ドメインは *quipdomain* です。 + 各ドキュメントが Quip および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Quip の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Quip データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Quip データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Quip データソースの必要な詳細を指定する必要があります。Quip をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-quip)。 ------ #### [ Console ] **Quip Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Quip コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Quip コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **Quip ドメイン名** - Quip アカウントからコピーした Quip を入力します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Quip 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Quip-」が自動的に追加されます。 1. **[Quip トークン]** — Quip で設定した Quip の個人用アクセスを入力します。 1. シークレットを追加して保存します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **クロールする Quip フォルダ ID を追加** - クロールする Quip フォルダ ID。 **注記** すべてのサブフォルダとその中のドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を追加します。特定のサブフォルダをクロールするには、特定のサブフォルダ ID を追加します。 1. **追加設定 (コンテンツタイプ)** - クロールするコンテンツタイプを入力します。 1. **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターン。最大 100 のパターンを追加できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. Amazon Kendraインデックスにマッピングする、生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Quip Amazon Kendraに接続するには** [QuipConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_QuipConfiguration.html) API を使用して以下を指定する必要があります。 + **Quip サイトドメイン** - 例えば、*https://quip-company.quipdomain.com/browse* の場合、ドメインは *quipdomain* です。 + **Secret Amazon Resource Name (ARN)** — Quip アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "accessToken": "token" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、Secrets Managerシークレットにアクセスするためのアクセス許可を IAMロールに提供し、Quip コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[Quip データソースのための IAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - データソース設定の一部として `VpcConfiguration` を指定します。「[VPC を使用するための Amazon Kendra の設定](https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[フォルダ]** - インデックスを作成する Quip フォルダとサブフォルダを指定します。 **注記** すべてのサブフォルダとその中のドキュメントを含むルートフォルダをクロールするには、ルートフォルダ ID を入力します。特定のサブフォルダをクロールするには、特定のサブフォルダ ID を追加します。 + **[添付ファイル、チャットルーム、ファイルのコメント]** — 添付ファイル、チャットルームのコンテンツ、ファイルのコメントのクローリングを含めるかどうかを選択します。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Quip データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 ------ ## 詳細はこちら Quip データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [の Quip コネクタを使用して、インテリジェント検索で Quip ドキュメントでナレッジを検索するAmazon Kendra](https://aws.amazon.com/blogs/machine-learning/search-for-knowledge-in-quip-documents-with-intelligent-search-using-the-quip-connector-for-amazon-kendra/) # Salesforce Salesforce は、サポート、営業、マーケティングの各チームを管理するための顧客関係管理 (CRM) ツールです。を使用してAmazon Kendra、Salesforce 標準オブジェクトやカスタムオブジェクトのインデックスを作成できます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API、または [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html) API を使用して、Salesforce データソースAmazon Kendraに接続できます。 Amazon Kendraには Salesforce コネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **Salesforce コネクタ V1.0 / [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター **Salesforce コネクタ V2.0 / [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) **注記** Salesforce コネクタ V1.0 / SalesforceConfiguration API のサポートは 2023 年に終了しました。Salesforce コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon KendraSalesforce データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # Salesforce コネクタ V1.0 ](data-source-v1-salesforce.md) + [ # Salesforce コネクタ V2.0 ](data-source-v2-salesforce.md) # Salesforce コネクタ V1.0 Salesforce は、サポート、営業、マーケティングの各チームを管理するための顧客関係管理 (CRM) ツールです。を使用してAmazon Kendra、Salesforce 標準オブジェクトやカスタムオブジェクトのインデックスを作成できます。 **重要** Amazon Kendraは Salesforce API バージョン 48 を使用します。Salesforce API は、1 日あたりに可能なリクエストの数を制限します。Salesforce がこれらのリクエストを超えると、続行できるまで再試行されます。 **注記** Salesforce コネクタ V1.0 / SalesforceConfiguration API のサポートは 2023 年に終了しました。Salesforce コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon KendraSalesforce データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-salesforce) + [ ## 前提条件 ](#prerequisites-v1-salesforce) + [ ## 接続手順 ](#data-source-procedure-v1-salesforce) ## サポートされている機能 Amazon KendraSalesforce データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター ## 前提条件 Amazon Kendraを使用して Salesforce データソースのインデックスを作成する前に、Salesforce とAWSアカウントでこれらの変更を行います。 **Salesforce で、次の作業を行ったことを確認してください。** + Salesforce アカウントを作成し、Salesforce への接続に使用するユーザー名とパスワードをメモすること。 + OAuth を有効にした Salesforce 接続アプリケーションアカウントを作成し、Salesforce 接続アプリケーションに割り当てられたコンシューマーキー (クライアント ID) とコンシューマーシークレット (クライアントシークレット) をコピーすること。クライアント ID とクライアントシークレットは、 AWS Secrets Managerシークレットに保存されている認証情報として使用されます。詳細については、[接続アプリケーションに関する Salesforce のドキュメント](https://help.salesforce.com/s/articleView?id=sf.connected_app_overview.htm&type=5)を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Salesforce への接続に使用されるアカウントに関連付けられた Salesforce セキュリティトークンをコピーすること。 + インデックスを作成する Salesforce インスタンスの URL をコピーすること。通常、URL は *https://.salesforce.com/* です。サーバーは Salesforce 接続アプリケーションを実行している必要があります。 + ReadOnly プロファイルのクローンを作成し、すべてのデータの表示権限および記事の管理権限を追加して、Salesforce への読み取り専用アクセス権を持つユーザーに対する認証情報を Salesforce サーバーに追加すること。これらの認証情報は、接続を行うユーザーと、 Amazon Kendraが接続する Salesforce 接続アプリケーションを識別します。 + 各ドキュメントが Salesforce および同じインデックスに使用する予定の他のデータソース間で一意であると確認すること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Salesforce の認証資格情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Salesforce データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Salesforce データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Salesforce データソースの必要な詳細を指定する必要があります。Salesforce をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-v1-salesforce)。 ------ #### [ Console ] **Salesforce Amazon Kendraに接続するには** 1. AWSマネジメントコンソールにサインインし、[Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[Salesforce コネクタ V1.0]** を選択し、**[コネクタを追加]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[データソース名]** - データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックスのドキュメントをフィルターする言語。特に指定しない限り、言語はデフォルトで英語に設定されます。メタデータで指定された言語は、選択した言語よりも優先されます。 1. **[新しいタグを追加]** - リソースの検索とフィルタリング、共有コストの追跡を行うためのタグ。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[Salesforce URL]** - インデックスを作成する Salesforce サイトのインスタンス URL を入力します。 1. **[認証のタイプ]** で **[既存]** または **[新規]** を選択して Salesforce 認証情報を保存します。新しいシークレットを作成すると、AWSSecrets Managerシークレットウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Salesforce-」が自動的に追加されます。 1. **[ユーザー名]**、**[パスワード]**、**[セキュリティトークン]**、**[コンシューマーキー]**、**[コンシューマーシークレット]**、**[認証 URL]** - Salesforce アカウントで作成した認証情報の値を入力します。 1. **[認証を保存]** を選択します。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[添付ファイルのクロール]** - 選択すると、添付されたすべてのオブジェクト、記事、フィードがクロールされます。 1. **[標準オブジェクト]**、**[ナレッジ記事]**、**[Chatter フィード]** - クロールする Salesforce エンティティまたはコンテンツタイプを選択します。 **注記** インデックス作成には、標準オブジェクト、ナレッジ記事、または Chatter フィードのうち少なくとも 1 つの設定情報を入力する必要があります。**[ナレッジ記事]** をクロールすると選択した場合は、インデックスを作成するナレッジ記事のタイプ、記事の名前、すべてのナレッジ記事の標準フィールドをインデックス化するのか、カスタム記事タイプのフィールドのみをインデックス化するのかを指定する必要があります。カスタム記事のインデックスを作成する場合は、記事タイプの内部名を指定する必要があります。最大 10 個の記事タイプを指定できます。 1. **頻度** — Amazon Kendraがデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **標準ナレッジ記事**、**標準オブジェクトアタッチメント**、および**追加の推奨フィールドマッピング** - インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 **注記** `_document_body` へのインデックスマッピングが必要です。`Salesforce ID` フィールドと Amazon Kendra `_document_id ` フィールド間のマッピングは変更できません。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Salesforce Amazon Kendraに接続するには** [SalesforceConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_SalesforceConfiguration.html) API では以下を指定する必要があります。 + **サーバー URL** - インデックスを作成する Salesforce サイトのインスタンス URL。 + **Secret Amazon Resource Name (ARN)** — Salesforce アカウントの認証情報を含む 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" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Salesforce コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[Salesforce データソースの IAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 + インデックス作成には、標準オブジェクト、ナレッジ記事、または Chatter フィードのうち少なくとも 1 つの設定情報を入力する必要があります。 + **標準オブジェクト** - **[標準オブジェクト]** のクロールを選択した場合は、標準オブジェクトの名前と、ドキュメントコンテンツを含む標準オブジェクトテーブル内のフィールドの名前を指定する必要があります。 + **ナレッジ記事** - **[ナレッジ記事]** をクロールすると選択した場合は、インデックスを作成するナレッジ記事のタイプ、インデックスを作成するナレッジの状態、すべてのナレッジ記事の標準フィールドをインデックス化するのか、カスタム記事タイプのフィールドのみをインデックス化するのかを指定する必要があります。 + **Chatter フィード** - **[Chatter フィード]** のクロールを選択した場合は、インデックスを作成するコンテンツが含まれている Salesforce FeedItem テーブルの列の名前を指定する必要があります。 オプションで、次の機能を追加することもできます。 + **包含フィルターと除外フィルター** - 特定の添付ファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、Salesforce データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 ------ # Salesforce コネクタ V2.0 Salesforce は、サポート、営業、マーケティングの各チームを管理するための顧客関係管理 (CRM) ツールです。を使用してAmazon Kendra、Salesforce 標準オブジェクトやカスタムオブジェクトのインデックスを作成できます。 Amazon KendraSalesforce データソースコネクタは、Developer Edition と Enterprise Edition の Salesforce エディションをサポートしています。 **注記** Salesforce コネクタ V1.0 / SalesforceConfiguration API のサポートは 2023 年に終了しました。Salesforce コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon KendraSalesforce データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-salesforce) + [ ## 前提条件 ](#prerequisites-v2-salesforce) + [ ## 接続手順 ](#data-source-procedure-v2-salesforce) + [ ## 詳細はこちら ](#salesforce-v2-learn-more) + [ ## 注意事項 ](#salesforce-notes) ## サポートされている機能 Amazon KendraSalesforce データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Salesforce データソースのインデックスを作成する前に、Salesforce とAWSアカウントでこれらの変更を行います。 **Salesforce で、次の作業を行ったことを確認してください。** + Salesforce 管理アカウントを作成し、Salesforce への接続に使用するユーザー名とパスワードをメモすること。 + Salesforce への接続に使用されるアカウントに関連付けられた Salesforce セキュリティトークンをコピーすること。 + OAuth を有効にした Salesforce 接続アプリケーションアカウントを作成し、Salesforce 接続アプリケーションに割り当てられたコンシューマーキー (クライアント ID) とコンシューマーシークレット (クライアントシークレット) をコピーすること。クライアント ID とクライアントシークレットは、 AWS Secrets Managerシークレットに保存されている認証情報として使用されます。詳細については、[接続アプリケーションに関する Salesforce のドキュメント](https://help.salesforce.com/s/articleView?id=sf.connected_app_overview.htm&type=5)を参照してください。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + インデックスを作成する Salesforce インスタンスの URL をコピーすること。通常、URL は *https://.salesforce.com/* です。サーバーは Salesforce 接続アプリケーションを実行している必要があります。 + ReadOnly プロファイルのクローンを作成し、すべてのデータの表示権限および記事の管理権限を追加して、Salesforce への読み取り専用アクセス権を持つユーザーに対する認証情報を Salesforce サーバーに追加すること。これらの認証情報は、接続を行うユーザーと、 Amazon Kendraが接続する Salesforce 接続アプリケーションを識別します。 + 各ドキュメントが Salesforce および同じインデックスに使用する予定の他のデータソース間で一意であると確認すること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Salesforce の認証資格情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Salesforce データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Salesforce データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Salesforce データソースの必要な詳細を指定する必要があります。Salesforce をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-v2-salesforce)。 ------ #### [ Console ] **Salesforce Amazon Kendraに接続するには**: 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Salesforce コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Salesforce コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[Salesforce URL]** - インデックスを作成する Salesforce サイトのインスタンス URL を入力します。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. 既存のシークレットを入力するか、新しいシークレットを作成すると、AWS Secrets Manager シークレットウィンドウが開きます。 1. **[認証]** - **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Salesforce-」が自動的に追加されます。 1. **[ユーザー名]**、**[パスワード]**、**[セキュリティトークン]**、**[コンシューマーキー]**、**[コンシューマーシークレット]**、**[認証 URL]** - Salesforce アカウントで生成してダウンロードした認証情報の値を入力します。 **注記** Salesforce Developer Edition を使用の場合は、`https://login.salesforce.com/services/oauth2/token` またはマイドメインのログイン URL (例: * https://MyCompany.my.salesforce.com*) を **[認証 URL]** として使用します。Salesforce Sandbox Edition を使用する場合は、`https://test.salesforce.com/services/oauth2/token ` またはマイドメインのログイン URL (例: * MyDomainName--SandboxName.sandbox.my.salesforce.com*) を **[認証 URL]** として使用します。 1. **[認証を保存]** を選択します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[添付ファイルのクロール]** - 選択すると、添付されたすべての Salesforce オブジェクトがクロールされます。 1. **[標準オブジェクト]**、**[添付ファイル付き標準オブジェクト]**、**[添付ファイルなしの標準オブジェクト]**、**[ナレッジ記事]** - クロールする Salesforce エンティティまたはコンテンツタイプを選択します。 1. インデックス作成には、標準オブジェクト、ナレッジ記事、または Chatter フィードのうち少なくとも 1 つの設定情報を入力する必要があります。**[ナレッジ記事]** のクロールを選択した場合は、インデックスを作成するナレッジ記事の種類を指定する必要があります。公開済み、アーカイブ済み、ドラフト、添付ファイルを選択できます。 **[正規表現フィルター]** - 特定のカタログアイテムを含む正規表現パターンを指定します。 1. **[追加の設定]**: + **[ACL 情報]** デフォルトでは、すべてのアクセスコントロールリストが含まれます。アクセスコントロールリストを選択解除すると、そのカテゴリのファイルがすべて公開されます。 + **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新しい、変更された同期: データソースがインデックスと同期するたびに、新規および変更されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **標準ナレッジ記事**、**標準オブジェクトアタッチメント**、および**追加の推奨フィールドマッピング** - インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 **注記** `_document_body` へのインデックスマッピングが必要です。`Salesforce ID` フィールドと Amazon Kendra `_document_id ` フィールド間のマッピングは変更できません。任意の Salesforce フィールドを、ドキュメントタイトルまたはドキュメント本文の Amazon Kendra の予約済み/デフォルトのインデックスフィールドにマッピングできます。 Salesforce フィールドを Amazon Kendra のドキュメントタイトルフィールドとドキュメント本文フィールドにマッピングすると、Amazon Kendra で、検索のレスポンスにドキュメントのタイトルと本文のフィールドが使用されます。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Salesforce Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `SALESFORCEV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **ホスト URL** - Salesforce インスタンスのホスト URL を指定します。 + **[同期モード]** - データソースのコンテンツが変更されたときに、Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規および変更されたコンテンツのみをインデックス化します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツをインデックス化できます。 + **Secret Amazon Resource Name (ARN)** — Salesforce アカウントの認証情報を含む 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" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て IAMロールにSecrets Managerシークレットへのアクセス許可を付与し、Salesforce コネクタと に必要なパブリック APIsを呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[Salesforce データソースの IAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - 特定のドキュメント、アカウント、キャンペーン、ケース、連絡先、リード、機会、ソリューション、タスク、グループ、Chatter、カスタムエンティティファイルを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、Salesforce データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 **注記** `_document_body` へのインデックスマッピングが必要です。`Salesforce ID` フィールドと Amazon Kendra `_document_id ` フィールド間のマッピングは変更できません。任意の Salesforce フィールドを、ドキュメントタイトルまたはドキュメント本文の Amazon Kendra の予約済み/デフォルトのインデックスフィールドにマッピングできます。 Salesforce フィールドを Amazon Kendra のドキュメントタイトルフィールドとドキュメント本文フィールドにマッピングすると、Amazon Kendra で、検索のレスポンスにドキュメントのタイトルと本文のフィールドが使用されます。 設定が必要なその他の重要な JSON キーのリストについては、「[Salesforce テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-salesforce-schema)」を参照してください。 ------ ## 詳細はこちら Salesforce データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [の更新された Salesforce コネクタ (V2) の発表Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-salesforce-connector-v2-for-amazon-kendra/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Salesforce API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用することができません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # ServiceNow ServiceNow は、IT サービス、チケットシステム、サポートなど、組織レベルのワークフローを作成および管理するためのクラウドベースのサービス管理システムを提供します。Amazon Kendra を使用して ServiceNow カタログ、ナレッジ記事、インシデント、および添付ファイルのインデックスを作成できます。 コンソール、[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API[Amazon Kendra](https://console.aws.amazon.com/kendra/)、または [ServiceNowConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html) API を使用して、ServiceNow データソースAmazon Kendraに接続できます。 Amazon Kendraには ServiceNow コネクタの 2 つのバージョンがあります。各バージョンでサポートされる機能は次のとおりです。 **ServiceNow コネクタ V1.0/[ServiceNowConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html) API** + フィールドマッピング + ServiceNow インスタンスバージョン: London、その他 + 包含/除外フィルター **ServiceNow コネクタ V2.0/[TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API** + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + ServiceNow インスタンスバージョン: Rome、Sandiego、Tokyo、その他 + Virtual Private Cloud (VPC) **注記** ServiceNow コネクタ V1.0/ServiceNowConfiguration API のサポートは 2023 年に終了しました。ServiceNow コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon KendraServiceNow データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ # ServiceNow コネクタ V1.0 ](data-source-v1-servicenow.md) + [ # ServiceNow コネクタ V2.0 ](data-source-v2-servicenow.md) + [ # クエリでインデックス作成するドキュメントを指定する ](servicenow-query.md) # ServiceNow コネクタ V1.0 ServiceNow は、IT サービス、チケットシステム、サポートなど、組織レベルのワークフローを作成および管理するためのクラウドベースのサービス管理システムを提供します。Amazon Kendra を使用して、ServiceNow カタログ、ナレッジ記事、それらの添付ファイルのインデックスを作成できます。 **注記** ServiceNow コネクタ V1.0/ServiceNowConfiguration API のサポートは 2023 年に終了しました。ServiceNow コネクタ V2.0/TemplateConfiguration API に移行するか、こちらを使用することをお勧めします。 Amazon KendraServiceNow データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v1-servicenow) + [ ## 前提条件 ](#prerequisites-v1-servicenow) + [ ## 接続手順 ](#data-source-procedure-v1-servicenow) + [ ## 詳細はこちら ](#servicenow-v1-learn-more) ## サポートされている機能 Amazon KendraServiceNow データソースコネクタは、次の機能をサポートしています。 + ServiceNow インスタンスバージョン: London、その他 + 包含/除外パターン: サービスカタログ、ナレッジ記事、およびその添付ファイル ## 前提条件 Amazon Kendraを使用して ServiceNow データソースのインデックスを作成する前に、ServiceNow とAWSアカウントでこれらの変更を行います。 **ServiceNow で、次のものがあることを確認してください。** + ServiceNow 管理者アカウントを作成し、ServiceNow インスタンスを作成しました。 + ServiceNow インスタンス URL のホストをコピーしました。例えば、インスタンスの URL が *https://your-domain.service-now.com* の場合、入力するホスト URL の形式は *your-domain.service-now.com* です。 + ServiceNow インスタンスへの Amazon Kendra の接続を許可するユーザー名とパスワードを含む基本認証情報を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション:** ユーザー名、パスワード、クライアント ID、クライアントシークレットを識別Amazon Kendraして生成できる OAuth 2.0 認証情報トークンを設定しました。ユーザー名とパスワードは、ServiceNow ナレッジベースとサービスカタログへのアクセスを提供する必要があります。詳細については、[OAuth 2.0 認証に関する ServiceNow のドキュメント](https://www.servicenow.com/docs/bundle/utah-platform-security/page/integrate/single-sign-on/concept/c_Authentication.html)を参照してください。 + 以下のアクセス許可を追加しました。 + kb\$1category + kb\$1knowledge + kb\$1knowledge\$1base + kb\$1uc\$1cannot\$1read\$1mtom + kb\$1uc\$1can\$1read\$1mtom + sc\$1catalog + sc\$1category + sc\$1cat\$1item + sys\$1attachment + sys\$1attachment\$1doc + sys\$1user\$1role + ServiceNow で、また同じインデックスに使用する予定の他のデータソースでも、各ドキュメントが一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + ServiceNow の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済みです。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、ServiceNow データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 ServiceNow データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、ServiceNow データソースの必要な詳細を指定する必要があります。ServiceNow をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-v1-servicenow)。 ------ #### [ Console ] **ServiceNow Amazon Kendraに接続するには** 1. AWSマネジメントコンソールにサインインし、[Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加する]** ページで **[ServiceNow コネクタ V1.0]** を選択し、**[データソースを追加する]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **ServiceNow ホスト** - ServiceNow ホスト URL を入力します。 1. **ServiceNow バージョン** - ServiceNow バージョンを選択します。 1. ユースケースに基づいて、**[基本認証]** と **[Oauth 2.0 認証]** のどちらかを選択します。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、ServiceNow 認証情報を保存する新しいSecrets Managerシークレットを作成します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-ServiceNow-」が自動的に追加されます。 1. 基本認証を使用している場合-ServiceNow アカウントの **[シークレット名]**、**[ユーザー名]**、**[パスワード]** を入力します。 OAuth2 認証を使用する場合 - ServiceNow アカウントで作成した **[シークレット名]**、**[ユーザー名]**、**[パスワード]**、**[クライアント ID]**、**[クライアントシークレット]** を入力します。 1. **[シークレットを保存して追加する]** を選択します。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[ナレッジ記事を含める]** - ナレッジ記事にインデックスを作成することを選択します。 1. **[ナレッジ記事のタイプ]** - ユースケースに基づいて、**[パブリック記事のみを含める]** または **[ServiceNow フィルタークエリに基づいて記事を含める]** を選択します。**[ServiceNow フィルタークエリに基づいて記事を含める]** を選択した場合は、ServiceNow アカウントからコピーした **[フィルタークエリ]** を入力する必要があります。 1. **[ナレッジ記事の添付ファイルを含める]** - ナレッジ記事の添付ファイルにインデックスを作成することを選択します。特定のファイルタイプを選択してインデックスを作成することもできます。 1. **[カタログ項目を含める]** - カタログ項目のインデックスを作成することを選択します。 1. **[カタログ項目の添付ファイルを含める]** - カタログ項目の添付ファイルのインデックスを作成することを選択します。特定のファイルタイプを選択してインデックスを作成することもできます。 1. **頻度** — Amazon Kendraがデータソースと同期する頻度。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **ナレッジ記事**と**サービスカタログ** — Amazon Kendra生成されたデフォルトのデータソースフィールドと、インデックスにマッピングする追加の推奨フィールドマッピングから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **ServiceNow Amazon Kendraに接続するには** [ServiceNowConfiguration API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_ServiceNowConfiguration.html) を使用して以下を指定する必要があります。 + **データソース URL** - ServiceNow URL を指定します。ホストエンドポイントは、*your-domain.service-now.com* のようになります。 + **データソースホストインスタンス** - ServiceNow ホストインスタンスのバージョンを `LONDON` または `OTHERS` として指定します。 + **シークレット Amazon リソースネーム (ARN)** — ServiceNow アカウントで作成した認証情報を含むSecrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。 基本認証を使用している場合、シークレットは以下のキーを持つ JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` OAuth 2.0 認証を使用している場合、シークレットは以下のキーを持つ JSON 構造に保存されます。 ``` { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、Secrets Managerシークレットにアクセスするためのアクセス許可を IAMロールに提供し、ServiceNow コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for ServiceNow data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **フィールドマッピング** - 選択すると、ServiceNow データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 + **包含フィルターと除外フィルター** - カタログとナレッジ記事の特定の添付ファイルを含めるか除外するかを指定します。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **インデックスパラメータ** - 次のことを行うかどうかも指定できます。 + ナレッジ記事とサービスカタログ、またはその両方にインデックスを作成します。ナレッジ記事とサービスカタログ項目のインデックスを作成する場合は、Amazon Kendra インデックスのインデックスドキュメントコンテンツフィールドにマッピングする ServiceNow フィールドの名前を指定する必要があります。 + ナレッジ記事とカタログ項目へのインデックス添付ファイル。 + 1 つ以上のナレッジベースからドキュメントを選択する ServiceNow クエリを使用します。ナレッジベースは、パブリックまたはプライベートのいずれかです。詳細については、[クエリでインデックス作成するドキュメントを指定する](https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html)を参照してください。 ------ ## 詳細はこちら ServiceNow データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Amazon KendraServiceNow Online コネクタの開始方法](https://aws.amazon.com/blogs/machine-learning/getting-started-with-amazon-kendra-servicenow-online-connector/) # ServiceNow コネクタ V2.0 ServiceNow は、IT サービス、チケットシステム、サポートなど、組織レベルのワークフローを作成および管理するためのクラウドベースのサービス管理システムを提供します。Amazon Kendra を使用して ServiceNow カタログ、ナレッジ記事、インシデント、および添付ファイルのインデックスを作成できます。 Amazon KendraServiceNow データソースコネクタのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-v2-servicenow) + [ ## 前提条件 ](#prerequisites-v2-servicenow) + [ ## 接続手順 ](#data-source-procedure-v2-servicenow) + [ ## 詳細はこちら ](#servicenow-learn-more) ## サポートされている機能 Amazon KendraServiceNow データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + ServiceNow インスタンスバージョン: Rome、Sandiego、Tokyo、その他 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して ServiceNow データソースのインデックスを作成する前に、ServiceNow とAWSアカウントでこれらの変更を行います。 **ServiceNow で、次のものがあることを確認してください。** + パーソナルまたはエンタープライズデベロッパーインスタンスを作成し、管理者ロールを持つ ServiceNow インスタンスを作成しました。 + ServiceNow インスタンス URL のホストをコピーしました。入力するホスト URL の形式は *your-domain.service-now.com* です。Amazon Kendra に接続するには、ServiceNow インスタンス URL が必要です。 + が ServiceNow インスタンスAmazon Kendraに接続できるように、ユーザー名とパスワードの基本的な認証情報を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション:** ユーザー名、パスワード、生成されたクライアント ID、およびクライアントシークレットAmazon Kendraを使用して を識別できる OAuth 2.0 クライアント認証情報を設定しました。詳細については、[OAuth 2.0 認証に関する ServiceNow のドキュメント](https://www.servicenow.com/docs/bundle/utah-platform-security/page/integrate/single-sign-on/concept/c_Authentication.html)を参照してください。 + 以下のアクセス許可を追加しました。 + kb\$1category + kb\$1knowledge + kb\$1knowledge\$1base + kb\$1uc\$1cannot\$1read\$1mtom + kb\$1uc\$1can\$1read\$1mtom + sc\$1catalog + sc\$1category + sc\$1cat\$1item + sys\$1attachment + sys\$1attachment\$1doc + sys\$1user\$1role + ServiceNow で、また同じインデックスに使用する予定の他のデータソースでも、各ドキュメントが一意であることが確認されていること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + ServiceNow の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済みです。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、ServiceNow データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 ServiceNow データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、ServiceNow データソースの必要な詳細を指定する必要があります。ServiceNow をまだ設定していない場合は、Amazon Kendra「」を参照してください[前提条件](#prerequisites-v2-servicenow)。 ------ #### [ Console ] **ServiceNow Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[ServiceNow コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[ServiceNow コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **ServiceNow ホスト** - ServiceNow ホスト URL を入力します。入力するホスト URL の形式は *your-domain.service-now.com* です。 1. **[ServiceNow バージョン]** - ServiceNow インスタンスのバージョンを選択します。Rome、Sandiego、Tokyo、その他から選択できます。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **[認証]** - **[基本認証]** と **[OAuth 2.0 認証]** のいずれかを選択します。 1. **[AWS Secrets Manager シークレット]** - ServiceNow の認証情報を保存する既存のシークレットを選択するか、新しい Secrets Manager シークレットを作成します。新しいシークレットの作成を選択すると、AWS Secrets Manager シークレットウィンドウが開きます。ウィンドウで、以下の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-ServiceNow-」が自動的に追加されます。 1. 基本認証を使用している場合-ServiceNow アカウントの **[シークレット名]**、**[ユーザー名]**、**[パスワード]** を入力します。 OAuth2.0 認証を使用する場合 - ServiceNow アカウントで作成した **[シークレット名]**、**[ユーザー名]**、**[パスワード]**、**[クライアント ID]**、**[クライアントシークレット]** を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[ナレッジ記事]** の場合は、以下のオプションから選択してください。 + **[ナレッジ記事]** - ナレッジ記事にインデックスを作成することを選択します。 + **[ナレッジ記事の添付ファイル]** - ナレッジ記事の添付ファイルにインデックスを作成することを選択します。 + **[ナレッジ記事のタイプ]** - ユースケースに基づいて、**[パブリック記事のみ]** または **[ServiceNow フィルタークエリに基づくナレッジ記事]** を選択します。**[ServiceNow フィルタークエリに基づいて記事を含める]** を選択した場合は、ServiceNow アカウントからコピーした **[フィルタークエリ]** を入力する必要があります。フィルタークエリの例には、*workflow\$1state=draft^EQ*、*kb\$1knowledge\$1base=dfc19531bf2021003f07e2c1ac0739ab^text ISNOTEMPTY^EQ*、*article\$1type=text^active=true^EQ* などがあります。 **重要** **パブリック記事のみ**のクロールを選択した場合、 は ServiceNow でパブリックアクセスロールが割り当てられたナレッジ記事のみをAmazon Kendraクロールします。 + **[簡単な説明フィルターに基づいて記事を含める]** - 特定の記事を含めるか除外する正規表現パターンを指定します。 1. **[サービスカタログ項目]** の場合: + **[サービスカタログ項目]** - サービスカタログ項目のインデックスを作成することを選択します。 + **[サービスカタログ項目の添付ファイル]** - サービスカタログ項目の添付ファイルのインデックスを作成することを選択します。 + **[アクティブなサービスカタログ項目]** - アクティブなサービスカタログ項目のインデックスを作成することを選択します。 + **[非アクティブなサービスカタログ項目]** - 非アクティブなサービスカタログ項目のインデックスを作成することを選択します。 + **[フィルタークエリ]** - ServiceNow インスタンスで定義されたフィルターに基づいてサービスカタログ項目を含めることを選択します。フィルタークエリの例としては、*short\$1descriptionLIKEAccess^category=2809952237b1300054b6a3549dbe5dd4^EQ*、*nameSTARTSWITHService^active=true^EQ* などがあります。 + **[簡潔な説明フィルターに基づいてサービスカタログ項目を含める]** - 特定のカタログ項目を含めるための正規表現パターンを指定します。 1. **[インシデント]** の場合: + **[インシデント]** - サービスインシデントのインデックスを作成することを選択します。 + **[インシデント添付ファイル]** - インシデント添付ファイルのインデックスを作成することを選択します。 + **[アクティブなインシデント]** - アクティブなインシデントのインデックスを作成することを選択します。 + **[非アクティブなインシデント]** - 非アクティブなインシデントのインデックスを作成することを選択します。 + **[アクティブなインシデントタイプ]** - ユースケースに応じて、**[すべてのインシデント]**、**[未解決のインシデント]**、**[オープン - 未割り当てのインシデント]**、**[解決済みのインシデント]** から選択します。 + **[フィルタークエリ]** - ServiceNow インスタンスで定義されたフィルターに基づいてインシデントを含めることを選択します。フィルタークエリの例には、*short\$1descriptionLIKETest^urgency=3^state=1^EQ*、*priority=2^category=software^EQ* などがあります。 + **[簡単な説明フィルターに基づいてインシデントを含める]** -特定のインシデントを含む正規表現パターンを指定します。 1. **[追加の設定]**: + **[ACL 情報]** - 選択したエンティティのアクセス制御リストがデフォルトで含まれます。アクセスコントロールリストを選択解除すると、そのカテゴリのファイルがすべて公開されます。選択されていないエンティティの ACL オプションは自動的に無効になります。パブリック記事には ACL は適用されません。 + **最大ファイルサイズ** - Amazon Kendra がクロールするファイルサイズの上限を MB 単位で指定します。Amazon Kendra は、ユーザーが定義したサイズ制限内のファイルのみをクロールします。デフォルトのファイルサイズは 50MB です。最大ファイルサイズは 0 MB より大きくし、50 MB 以下にする必要があります。 + **[添付ファイルの正規表現パターン]** - カタログ、ナレッジ記事、インシデントの特定の添付ファイルを含めたり除外したりする正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのフィールドマッピング** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **ServiceNow Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `SERVICENOWV2` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **ホスト URL** - ServiceNow ホストインスタンスのバージョンを指定します。例えば、*your-domain.service-now.com* です。 + **認証タイプ** - ServiceNow インスタンスの認証のタイプに、`basicAuth` または `OAuth2` を指定します。 + **[ServiceNow インスタンスのバージョン]** - 使用する ServiceNow インスタンスを、`Tokyo`、`Sandiego`、`Rome`、または `Others` のいずれかに指定します。 + **[同期モード]** - データソースのコンテンツが変更されたときに、Amazon Kendra がインデックスを更新する方法を指定します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、コンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **シークレット Amazon リソースネーム (ARN)** — ServiceNow アカウントで作成した認証情報を含むSecrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。 基本認証を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password" } ``` + OAuth2 クライアント認証情報を使用する場合、シークレットは以下のキーを含む JSON 構造に保存されます。 ``` { "username": "user name", "password": "password", "clientId": "client id", "clientSecret": "client secret" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、Secrets Managerシークレットにアクセスするためのアクセス許可を IAMロールに提供し、ServiceNow コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for ServiceNow data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **包含フィルターと除外フィルター** - ナレッジ記事、サービスカタログ、インシデントのファイル名とファイルタイプを使用して、特定の添付ファイルを含めるか除外するかを指定できます。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[インデックスを作成する特定のドキュメント]** - ServiceNow クエリを使用して、プライベートナレッジベースを含む 1 つ以上のナレッジベースから、インデックスを作成するドキュメントを指定できます。ナレッジベースへのアクセスは、ServiceNow インスタンスへの接続に使用するユーザーによって決定されます。詳細については、[クエリでインデックス作成するドキュメントを指定する](https://docs.aws.amazon.com//kendra/latest/dg/servicenow-query.html)を参照してください。 + **インデックスパラメータ** - 次のことを行うかどうかも指定できます。 + ナレッジ記事、サービスカタログ、インシデントまたはそのすべてにインデックスを作成します。ナレッジ記事、サービスカタログ項目、インシデントのインデックスを作成する場合は、Amazon Kendraインデックスのインデックスドキュメントの内容フィールドにマッピングされている ServiceNow フィールドの名前を指定する必要があります。 + ナレッジ記事、サービスカタログ項目、インシデントへのインデックス添付ファイル。 + `short description` フィルターパターンに基づいてナレッジ記事、サービスカタログ項目、インシデントを含めます。 + アクティブと非アクティブなサービスカタログ項目とインシデントをフィルタリングすることを選択できます。 + インシデントタイプに基づいてインシデントをフィルタリングすることを選択します。 + ACL をクロールするエンティティを選択します。 + ServiceNow クエリを使用して、プライベートナレッジベースを含む 1 つ以上のナレッジベースから必要なドキュメントを指定できます。ナレッジベースへのアクセスは、ServiceNow インスタンスへの接続に使用するユーザーによって決定されます。詳細については、[クエリでインデックス作成するドキュメントを指定する](https://docs.aws.amazon.com//kendra/latest/dg/servicenow-query.html)を参照してください。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **フィールドマッピング** - 選択すると、ServiceNow データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[ServiceNow テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-servicenow-schema)」を参照してください。 ------ ## 詳細はこちら ServiceNow データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [の更新された ServiceNow コネクタ (V2) Amazon Kendraの発表の開始方法Amazon Kendra](https://aws.amazon.com/blogs/machine-learning/announcing-the-updated-servicenow-connector-v2-for-amazon-kendra/) # クエリでインデックス作成するドキュメントを指定する クエリでドキュメントを指定する ServiceNow クエリを使用して、Amazon Kendra インデックスに含めるドキュメントを指定できます。クエリを使用する場合、プライベートナレッジベースを含む複数のナレッジベースを指定できます。ナレッジベースへのアクセスは、ServiceNow インスタンスへの接続に使用するユーザーによって決定されます。 クエリを構築するには、ServiceNow クエリビルダーを使用します。ビルダーを使用して、クエリを作成し、クエリが正しいドキュメントのリストを返すことをテストできます。 **ServiceNow コンソールを使用してクエリを作成するには** 1. ServiceNow コンソールにログインします。 1. 左側のメニューで、**[Knowledge]** (ナレッジ)、**[Article]** (記事)、**[All]** (すべて) の順に選択します。 1. ページの上部で、フィルターのアイコンをクリックします。 1. クエリビルダーを使用してクエリを作成します。 1. クエリが完了したら、クエリを右クリックし、**[Copy query]** (クエリのコピー) を選択して、クエリビルダーからクエリをコピーします。このクエリを保存して を使用しますAmazon Kendra。 ![\[Query builder interface showing Knowledge base filters with options to run, save, and copy query.\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/images/ServiceNowQuery.png) クエリをコピーするときに、クエリパラメータを変更しないように注意してください。クエリパラメータのいずれかが認識されない場合、ServiceNow はパラメータを空として扱い、結果をフィルタリングするために使用しません。 # Slack Slack は、ユーザーがさまざまなパブリックチャネルやプライベートチャネルを通じてメッセージや添付ファイルを送信できる、エンタープライズコミュニケーションアプリです。Amazon Kendraを使用して、Slack のパブリックチャネルとプライベートチャネル、ボットとアーカイブのメッセージ、ファイルと添付ファイル、ダイレクトメッセージとグループメッセージのインデックスを作成できます。また、フィルタリングする特定のコンテンツを選択することもできます。 **注記** Amazon Kendraがアップグレードされた Slack コネクタをサポートするようになりました。 コンソールは自動的にアップグレードされています。コンソールで新しくコネクタを作成すると、コネクタにはアップグレードされたアーキテクチャが使用されます。API を使用する場合は、`SlackConfiguration` オブジェクトではなく [https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) オブジェクトを使用してコネクタを設定する必要があります。 古いコンソールと API アーキテクチャを使用して設定されたコネクタは、引き続き設定どおりに機能します。ただし、それらを編集したり更新したりすることはできません。コネクタ設定を編集または更新する場合は、新しいコネクタを作成する必要があります。 コネクタワークフローをアップグレードされたバージョンに移行することをお勧めします。古いアーキテクチャを使用して設定されたコネクタのサポートは、2024 年 6 月までに終了する予定です。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)または [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して Slack データソースAmazon Kendraに接続できます。 Slack データソースコネクタAmazon Kendraのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-slack) + [ ## 前提条件 ](#prerequisites-slack) + [ ## 接続手順 ](#data-source-procedure-slack) + [ ## 詳細はこちら ](#slack-learn-more) ## サポートされている機能 Amazon KendraSlack データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Slack データソースのインデックスを作成する前に、Slack と AWSアカウントでこれらの変更を行います。 **Slack で、次の作業を行ったことを確認してください。** + Slack Bot User OAuth トークンまたは Slack User OAuth トークンを設定済みであること。いずれかのトークンを選択して Slack データソースAmazon Kendraに接続できます。トークンは、認証情報として使用するために必要です。詳しくは、[アクセストークンに関する Slack のドキュメント](https://api.slack.com/authentication/token-types)をご覧ください。 **注記** Slack 認証情報の一部としてボットトークンを使用する場合、ダイレクトメッセージやグループメッセージのインデックスを作成できないため、インデックスを作成するチャネルにボットトークンを追加する必要があります。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + Slack ワークスペースのメインページ URL にある Slack ワークスペースチーム ID をメモすること。例えば、*https://app.slack.com/client/T0123456789/...* の *T0123456789* がチーム ID です。 + 次の Oauth スコープ/アクセス権限を追加済みであること。 [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/kendra/latest/dg/data-source-slack.html) + 各ドキュメントが Slack および同じインデックスに使用する予定の他のデータソース間で一意であると確認すること。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、 API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Slack の認証資格情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録済み。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Slack データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Slack データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Slack データソースの必要な詳細を指定する必要があります。Slack をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-slack)。 ------ #### [ Console ] **Slack Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Slack コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Slack コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で、**新しいタグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **[Slack ワークスペースチーム ID]** - Slack ワークスペースのチーム ID。チーム ID は、Slack ワークスペースのメインページの URL で確認できます。例えば、*https://app.slack.com/client/T0123456789/...* の *T0123456789* がチーム ID です。 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Slack 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. **[AWS Secrets Manager シークレットウィンドウを作成]** に次の情報を入力します。 1. **[シークレット名]** - シークレットの名前。シークレット名に、プレフィックス「AmazonKendra-Slack-」が自動的に追加されます。 1. **[Slack トークン]** - Slack で設定した認証情報の値を入力します。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、新しいIAMロールを作成してリポジトリの認証情報とインデックスコンテンツにアクセスします。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[コンテンツタイプを選択]** - クロールする Slack エンティティまたはコンテンツタイプを選択します。すべてのコンテンツ、パブリックチャネル、プライベートチャネル、グループメッセージ、プライベートメッセージから選択できます。 1. **[クロール開始日を選択]** - コンテンツのクローリングを開始する日付を入力します。 1. **[追加設定]** - ボットメッセージとアーカイブ済みメッセージを含める場合、および特定のコンテンツを含める、または除外するための正規表現パターンを使用する場合に選択します。 **注記** チャネル IDs とチャネル名の両方に を含めることを選択した場合、Slack コネクタはチャネル名よりもチャネル IDs Amazon Kendraを優先します。 特定のプライベートメッセージとグループメッセージを含めることを選択した場合は、Amazon Kendra Slack コネクタではすべてのプライベートメッセージとグループメッセージが無視され、指定したプライベートメッセージとグループメッセージのみがクロールされます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Slack Amazon Kendraに接続するには** [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-slack)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `SLACK` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **Slack ワークスペースチーム ID** - Slack のメインページ URL からコピーした Slack チーム ID。 + **[開始日]** - Slack ワークスペースチームからのデータのクローリングを開始する日付。日付は yyyy-mm-dd の形式にする必要があります。 + **同期モード** — データソースコンテンツが変更されたときに Amazon Kendraがインデックスを更新する方法を指定します。Amazon Kendra でデータソースを初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。以下のいずれかから選択できます。 + `FORCED_FULL_CRAWL` は、データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + `FULL_CRAWL` は、データソースがインデックスと同期するたびに、新規作成、変更、削除されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + `CHANGE_LOG` は、データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのインデックスのみを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成できます。 + **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 + **Secret Amazon Resource Name (ARN)** — Slack アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "slackToken": "token" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Slack コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[Slack データソースの IAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **[特定のチャネル]** — パブリックチャネルまたはプライベートチャネルでフィルタリングし、特定のチャネルを ID で指定します。 + **[チャネルとメッセージのタイプ]** — Amazon Kendra が、パブリックチャネルとプライベートチャネル、グループメッセージとダイレクトメッセージ、ボットメッセージとアーカイブ済みメッセージのインデックスを作成するかどうか。Slack 認証情報の一部としてボットトークンを使用する場合、インデックスを作成するチャネルにボットトークンを追加する必要があります。ボットトークンを使用してダイレクトメッセージやグループメッセージのインデックスを作成することはできません。 + **[ルックバック]** — Slack コネクタが、最後のコネクタ同期までの指定された時間の間、更新または削除されたコンテンツをクロールするように、`lookBack` パラメータを設定できます。 + **[包含フィルターと除外フィルター]** - Slack の特定のコンテンツを含める、または除外するように指定できます。Slack 認証情報の一部としてボットトークンを使用する場合、インデックスを作成するチャネルにボットトークンを追加する必要があります。ボットトークンを使用してダイレクトメッセージやグループメッセージのインデックスを作成することはできません。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **フィールドマッピング** - 選択すると、Slack データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Slack template schema](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-slack)」を参照してください。 ------ ## 詳細はこちら Slack データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Unravel the knowledge in Slack workspaces with intelligent search using the Amazon Kendra Slack connector](https://aws.amazon.com/blogs/machine-learning/unravel-the-knowledge-in-slack-workspaces-with-intelligent-search-using-the-amazon-kendra-slack-connector/) # Zendesk Zendesk は、企業がカスタマーサポートのやり取りを自動化および強化するのに役立つ顧客関係管理システムです。Amazon Kendraを使用して、Zendesk サポートチケット、チケットコメント、チケット添付ファイル、ヘルプセンター記事、記事コメント、記事コメント添付ファイル、ガイドコミュニティトピック、コミュニティ投稿、コミュニティ投稿コメントのインデックスを作成できます。 特定の組織内のチケットのみにインデックスを付ける場合は、組織名でフィルタリングできます。Zendesk からのデータのクローリングを開始するタイミングに合わせて、クロール日を設定することもできます。 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)と [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して Zendesk データソースAmazon Kendraに接続できます。 Zendesk データソースコネクタAmazon Kendraのトラブルシューティングについては、「」を参照してください[データソースのトラブルシューティング](troubleshooting-data-sources.md)。 **Topics** + [ ## サポートされている機能 ](#supported-features-zendesk) + [ ## 前提条件 ](#prerequisites-zendesk) + [ ## 接続手順 ](#data-source-procedure-zendesk) + [ ## 詳細はこちら ](#zendesk-learn-more) + [ ## 注意事項 ](#zendesk-notes) ## サポートされている機能 Amazon KendraZendesk データソースコネクタは、次の機能をサポートしています。 + フィールドマッピング + ユーザーアクセスコントロール + 包含/除外フィルター + 変更ログ、完全および増分コンテンツ同期 + Virtual Private Cloud (VPC) ## 前提条件 Amazon Kendraを使用して Zendesk データソースのインデックスを作成する前に、Zendesk および AWSアカウントでこれらの変更を行います。 **Zendesk で以下を確認してください。** + Zendesk Suite (Professional/Enterprise) の管理者アカウントを作成しました。 + Zendesk のホスト URL を書き留めました。例: *https://\$1sub-domain\$1.zendesk.com/* **注記** (オンプレミス/サーバー) Amazon KendraAWS Secrets Managerは、 に含まれるエンドポイント情報が、データソース設定の詳細で指定されたエンドポイント情報と同じかどうかを確認します。[混乱する代理問題](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)は、ユーザーがアクションを実行するアクセス許可がないにもかかわらず、Amazon Kendra をプロキシとして使用して設定された秘密にアクセスし、アクションを実行するセキュリティの問題です。後でエンドポイント情報を変更する場合は、新しいシークレットを作成してこの情報を同期する必要があります。 + 認可コード付与フローを使用して OAuth 2.0 認証を設定します。 1. [管理センター] で、[アプリと統合] > [API] > [Zendesk API] に移動します。 1. [OAuth クライアント] タブを選択し、[OAuth クライアントを追加] をクリックします。 1. OAuth クライアントの詳細を設定します。[クライアント名] と [説明] を設定します。[クライアントの種類] を [機密] に設定します。適切なリダイレクト URLs を追加します (テスト用に https://localhost/callback など)。生成されたクライアント ID とクライアントシークレットを保存し、安全な状態で保管します。 1. OAuth クライアントに必要な「読み取り」スコープ (または書き込みアクセスが必要な場合は「読み取り書き込み」) があることを確認します。 1. 認可コード付与フローを使用してアクセストークンを生成します。 + ブラウザで、次の URL に移動します: `https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code&client_id={your_client_id}&redirect_uri={your_redirect_uri}&scope=read` + プロンプトが表示されたら、アプリケーションを認証と認可を行います。 + 認可後、Zendesk はコードパラメータ (例: https://localhost/callback?code=\$1authorization\$1code\$1) を使用して redirect\$1uri にリダイレクトします。認可コードをコピーします。 + Zendesk のトークンエンドポイントに POST リクエストを送信して、認可コードをアクセストークンと交換します。 ``` curl -X POST https://{subdomain}.zendesk.com/oauth/tokens \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code&code={authorization_code}&client_id={your_client_id}&client_secret={your_client_secret}&redirect_uri={your_redirect_uri}&scope=read" ``` + Zendesk は access\$1token を含む JSON オブジェクトで応答します。このアクセストークンを抽出して安全に保管します。 1. 生成されたアクセストークンを安全な状態で保管します。このアクセストークンは Kendra の統合に使用されます。 + **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 + **オプション:** Amazon Kendra による接続を許可する SSL 証明書をインストールしました。 + 各ドキュメントが Zendesk および同じインデックスを使用予定の他のデータソース間で一意であることを確認しました。インデックスに使用する各データソースには、データソース全体に同じドキュメントが含まれていてはなりません。ドキュメント ID はインデックス全体に適用され、インデックスごとに一意である必要があります。 **でAWS アカウント、以下があることを確認します。** + [Amazon Kendraインデックスを作成し](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)、API を使用している場合はインデックス ID を記録しました。 + データソースの [IAMロールを作成し](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)、 API を使用している場合はロールの ARN を記録しましたIAM。 **注記** 認証タイプと認証情報を変更する場合は、IAMロールを更新して正しいAWS Secrets Managerシークレット ID にアクセスする必要があります。 + Zendesk の認証情報を AWS Secrets Manager シークレットに保存し、API を使用している場合は、シークレットの ARN を記録しました。 **注記** 認証情報とシークレットは、定期的に更新またはローテーションすることをお勧めします。セキュリティに必要なアクセスレベルのみを提供してください。認証情報とシークレットを、データソース、コネクタバージョン 1.0 と 2.0 (該当する場合) で再利用することは推奨**しません**。 既存のIAMロールまたはシークレットがない場合は、Zendesk データソースを接続するときに コンソールを使用して新しいIAMロールとSecrets Managerシークレットを作成できますAmazon Kendra。API を使用している場合は、既存のIAMロールとSecrets Managerシークレットの ARN とインデックス ID を指定する必要があります。 ## 接続手順 Zendesk データソースAmazon Kendraに接続するには、 がデータAmazon Kendraにアクセスできるように、Zendesk データソースの必要な詳細を指定する必要があります。Zendesk をまだ設定していない場合はAmazon Kendra、「」を参照してください[前提条件](#prerequisites-zendesk)。 ------ #### [ Console ] **Zendesk Amazon Kendraに接続するには** 1. にサインインAWS マネジメントコンソールし、 [Amazon Kendraコンソール](https://console.aws.amazon.com/kendra/)を開きます。 1. 左側のナビゲーションペインで、**[インデックス]** を選択し、インデックスのリストから使用するインデックスを選択します。 **注記** **[インデックスの設定]** で、**[ユーザーアクセスコントロール]** 設定を設定または編集できます。 1. **[使用開始]** ページで、**[データソースを追加]** を選択します。 1. **[データソースを追加]** ページで **[Zendesk コネクタ]** を選択し、**[コネクタを追加]** を選択します。バージョン 2 (該当する場合) を使用している場合は、「V2.0」タグが付いた **[Zendesk コネクタ]** を選択します。 1. **[データソースの詳細を指定]** ページで、次の情報を入力します。 1. **[名前と説明]** の **[データソース名]** に、データソースの名前を入力します。ハイフン (-) は使用できますが、スペースは使用できません。 1. (オプション) **[説明]** - オプションで、データソースの説明を入力します。 1. **[デフォルト言語]** - インデックス用にドキュメントをフィルターするための言語。特に指定しない限り、言語はデフォルトで英語に設定されます。ドキュメントのメタデータで指定された言語は、選択した言語よりも優先されます。 1. **タグ**で新しい**タグを追加する** - リソースを検索してフィルタリングしたり、AWSコストを追跡したりするためのオプションのタグを含めます。 1. [**次へ**] を選択します。 1. **[アクセスとセキュリティの定義]** ページで、次の情報を入力します。 1. **Zendesk URL** - Zendesk URL を入力します。例: *https://\$1sub-domain\$1.zendesk.com/* 1. **[承認]** - アクセスコントロールリスト (ACL) があり、それをアクセスコントロールに使用する場合に、ドキュメントの ACL 情報を有効にするか無効にするかを選択します。ACL では、ユーザーとグループがアクセスできるドキュメントを指定します。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)」を参照してください。 1. **AWS Secrets Managersecret** — 既存のシークレットを選択するか、新しいSecrets Managerシークレットを作成して Zendesk 認証情報を保存します。新しいシークレットの作成を選択すると、[AWS Secrets Manager シークレット] ウィンドウが開きます。 1. 次のような構造でシークレットを作成します。 ``` { "hostUrl": "https://yoursubdomain.zendesk.com/", "accessToken": "your_access_token" } ``` **注記** Kendra の統合用に、シークレット名は「AmazonKendra-Zendesk-」で始まり、その後に任意の識別子 (例: AmazonKendra-Zendesk-MyConnector) を付けます。 1. シークレットを保存して追加します。 1. **[仮想プライベートクラウド (VPC)]** - VPC の使用を選択できます。選択する場合は、**[サブネット]** と **[VPC セキュリティグループ]** を追加する必要があります。 1. **[ID クローラー]** - Amazon Kendra の ID クローラーを有効にするかどうかを指定します。ID クローラーは、ドキュメントのアクセスコントロールリスト (ACL) 情報を使用して、ユーザーまたはそのグループのドキュメントへのアクセス権に基づいて検索結果をフィルタリングします。ドキュメントの ACL があり、ACL を使用することを選択した場合は、Amazon KendraID クローラをオンにして検索結果の[ユーザーコンテキストフィルタリング](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources)を設定することもできます。それ以外の場合は、ID クローラーがオフになっている場合、すべてのドキュメントは公開され検索可能になります。ID クローラーがオフになっているときにドキュメントのアクセスコントロールを使用する場合は、代わりに [PutPrincipalMapping](https://docs.aws.amazon.com/kendra/latest/APIReference/API_PutPrincipalMapping.html) API を使用して、ユーザーコンテキストフィルタリング用にユーザーとグループのアクセス情報をアップロードすることができます。 1. **IAMrole** — 既存のIAMロールを選択するか、リポジトリの認証情報とインデックスコンテンツにアクセスするための新しいIAMロールを作成します。 **注記** IAMインデックスに使用される ロールは、データソースには使用できません。インデックスやよくある質問に既存のロールが使用されているかどうかが不明な場合は、エラーを避けるため、**[新しいロールを作成]** を選択してください。 1. [**次へ**] を選択します。 1. **[同期設定の構成]** ページで、次の情報を入力します。 1. **[コンテンツを選択]** - チケット、ヘルプセンターの記事、コミュニティのトピックなどから、クロールするコンテンツのタイプを選択します。 1. **[組織名]** — Zendesk の組織名を入力して同期をフィルタリングします。 1. **[同期開始日]** - コンテンツのクローリングを開始する日付を入力します。 1. **[正規表現パターン]** - 特定のファイルを含めるまたは除外する正規表現パターンを追加します。最大 100 のパターンを追加できます。 1. **[同期モード]** - データソースのコンテンツが変更されたときのインデックスの更新方法を選択します。データソースを Amazon Kendraと初めて同期すると、デフォルトですべてのコンテンツがクロールされ、インデックスが作成されます。同期モードオプションとして完全同期を選択していない場合でも、最初の同期が失敗した場合は、データの完全同期を実行する必要があります。 + 完全同期: データソースがインデックスと同期されるたびに、既存のコンテンツを置き換えて、すべてのコンテンツのインデックスを新たに作成します。 + 新規作成、変更の同期: データソースがインデックスと同期するたびに、新規作成および変更されたコンテンツのみのインデックスを作成します。Amazon Kendra は、データソースのメカニズムを利用してコンテンツの変更を追跡し、前回の同期以降に変更されたコンテンツのインデックスを作成することができます。 + 新規、変更、削除された同期: データソースがインデックスと同期するたびに、新規、変更、削除されたコンテンツのインデックスのみを作成します。 Amazon Kendraは、データソースのメカニズムを使用して、前回の同期以降に変更されたコンテンツの変更とインデックスコンテンツを追跡できます。 1. **[同期実行スケジュール]** の **[頻度]** - データソースコンテンツを同期してインデックスを更新する頻度を選択します。 1. [**次へ**] を選択します。 1. **[フィールドマッピングを設定]** ページで、次の情報を入力します。 1. **デフォルトのデータソースフィールド** — インデックスにマッピングするAmazon Kendra生成されたデフォルトのデータソースフィールドから選択します。 1. **[フィールドを追加]** - カスタムデータソースフィールドを追加して、マッピング先のインデックスフィールド名とフィールドデータタイプを作成します。 1. [**次へ**] を選択します。 1. **[確認と作成]** ページで、入力した情報が正しいことを確認し、**[データソースを追加]** を選択します。このページで情報の編集を選択することもできます。データソースが正常に追加されると、データソースが **[データソース]** ページに表示されます。 ------ #### [ API ] **Zendesk Amazon Kendraに接続するには** [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) API を使用して[データソーススキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html)の JSON を指定する必要があります。これには、以下の情報を入力する必要があります。 + **[データソース]** — [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) JSON スキーマを使用する場合は、データソースタイプを `ZENDESK` と指定します。また、[https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html) API を呼び出す場合は、データソースを `TEMPLATE` と指定します。 + **ホスト URL** - 接続設定またはリポジトリエンドポイントの詳細の一部として Zendesk ホスト URL を提供します。例えば、* https://yoursubdomain.zendesk.com* です。 + **変更ログ** - インデックス内でドキュメントを更新する必要があるかどうかを判断するために、Amazon Kendra が Zendesk データソース変更ログメカニズムを使用するかどうか。 **注記** Amazon Kendra にすべてのドキュメントをスキャンさせない場合は、変更ログを使用します。変更ログが大きい場合、変更ログを処理するよりも、Zendesk データソース内のドキュメントのスキャンにAmazon Kendra時間がかかる場合があります。Zendesk データソースをインデックスに初めて同期する場合は、すべてのドキュメントがスキャンされます。 + **Secret Amazon Resource Name (ARN)** — Zendesk アカウントの認証情報を含む Secrets Managerシークレットの Amazon リソースネーム (ARN) を指定します。シークレットは、次のキーを含む JSON 構造に保存されます。 ``` { "hostUrl": "https://yoursubdomain.zendesk.com", "clientId": "client ID", "clientSecret": "Zendesk client secret", "userName": "Zendesk user name", "password": "Zendesk password" } ``` + **IAMrole** — を呼び出し`CreateDataSource`て、シーSecrets Managerクレットにアクセスするためのアクセス許可を IAMロールに提供し、Zendesk コネクタと に必要なパブリック APIs を呼び出す`RoleArn`タイミングを指定しますAmazon Kendra。詳細については、「[IAM roles for Zendesk data sources](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds)」を参照してください。 オプションで、次の機能を追加することもできます。 + **[仮想プライベートクラウド (VPC)]** - `VpcConfiguration` で `CreateDataSource` を呼び出すタイミングを指定します。詳細については、「[を使用する Amazon Kendra ように を設定する Amazon VPC](vpc-configuration.md)」を参照してください。 + **ドキュメント/コンテンツタイプ** — 以下をクロールするかどうかを指定します。 + サポートチケット、チケットコメント、チケットコメントの添付ファイル + ヘルプセンターの記事、記事の添付ファイル、記事のコメント + コミュニティトピック、投稿、投稿コメントのガイド + **[包含フィルターと除外フィルター]** - Slack の特定のコンテンツを含める、または除外するように指定できます。Slack 認証情報の一部としてボットトークンを使用する場合、インデックスを作成するチャネルにボットトークンを追加する必要があります。ボットトークンを使用してダイレクトメッセージやグループメッセージのインデックスを作成することはできません。 **注記** ほとんどのデータソースは、フィルターと呼ばれる包含または除外パターンである正規表現パターンを使用しています。包含フィルターを指定すると、包含フィルターに一致するコンテンツのみのインデックスが作成されます。包含フィルターに一致しないドキュメントのインデックスは作成されません。包含フィルターと除外フィルターを指定した場合、除外フィルターに一致するドキュメントは、包含フィルターと一致してもインデックスは作成されません。 + **[ユーザーコンテキストのフィルタリングとアクセスコントロール]** — ドキュメントの ACL がある場合は、Amazon Kendra がドキュメントのアクセスコントロールリスト (ACL) をクロールします。ACL 情報は、ユーザーまたはそのグループのドキュメントへのアクセスに基づいて、検索結果をフィルタリングするために使用されます。詳細については、「[User context filtering](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#datasource-context-filter)」を参照してください。 + **フィールドマッピング** - 選択すると、Zendesk データソースフィールドを Amazon Kendra インデックスフィールドにマッピングします。詳細については、「[データソースフィールドのマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」を参照してください。 **注記** がドキュメントAmazon Kendraを検索するには、ドキュメント本文フィールドまたはドキュメントと同等のドキュメント本文が必要です。データソースのドキュメント本文フィールド名をインデックスフィールド名 `_document_body` にマッピングする必要があります。その他のすべてのフィールドはオプションです。 設定が必要なその他の重要な JSON キーのリストについては、「[Zendesk テンプレートスキーマ](https://docs.aws.amazon.com/kendra/latest/dg/ds-schemas.html#ds-schema-zendesk)」を参照してください。 ------ ## 詳細はこちら Zendesk データソースAmazon Kendraとの統合の詳細については、以下を参照してください。 + [Amazon Kendraインテリジェント検索で Zendesk のインサイトを発見する](https://aws.amazon.com/blogs/machine-learning/discover-insights-from-zendesk-with-amazon-kendra-intelligent-search/) ## 注意事項 + アクセスコントロール (ACL) が有効になっている場合、Zendesk API の制限により、[新規または変更されたコンテンツのみを同期] オプションを使用できません。この同期モードを使用する必要がある場合は、代わりに「完全同期」または「新規、変更済み、または削除済みコンテンツ同期」モードを使用するか、ACL を無効にすることをお勧めします。 # データソースフィールドのマッピング Amazon Kendra データソースコネクタは、ドキュメントまたはコンテンツフィールドをデータソースから Amazon Kendra インデックスのフィールドにマッピングできます。デフォルトでは、各コネクタは特定のデータソースフィールドをクロールするように設計されています。既定のデータソースフィールドとそのプロパティは変更またはカスタマイズできません。 Amazon Kendra コンソールでは、編集できないデフォルトのフィールドとデフォルトのフィールドプロパティはグレー表示されます。 Amazon Kendra コネクタを使用すると、データソースのカスタムドキュメントまたはコンテンツフィールドをインデックスのカスタムフィールドにマッピングすることもできます。例えば、データソースにドキュメントの部門情報を含む「dept」というフィールドがある場合、それを「Department」というインデックスフィールドにマッピングできます。そうすれば、ドキュメントをクエリするときにフィールドを使用できます。 などの Amazon Kendra リザーブドフィールドまたは共通フィールドをマッピングすることもできます`_created_at`。データソースに「creation\$1date」というフィールドがある場合は、これを という同等の Amazon Kendra 予約済みフィールドにマッピングできます`_created_at`。 Amazon Kendra 予約フィールドの詳細については、[「ドキュメント属性またはフィールド](https://docs.aws.amazon.com/kendra/latest/dg/hiw-document-attributes.html)」を参照してください。 ほとんどのデータソースのフィールドをマッピングできます。次のデータソースのフィールドマッピングを作成できます。 + Adobe Experience Manager + Alfresco + Aurora (MySQL) + Aurora (PostgreSQL) + Amazon FSx (Windows) + Amazon FSx (NetApp ONTAP) + Amazon RDS/Aurora + Amazon RDS (Microsoft SQL Server) + Amazon RDS (MySQL) + Amazon RDS (Oracle) + Amazon RDS (PostgreSQL) + Amazon Kendra ウェブクローラー + WorkDocs + Box + Confluence + Dropbox + Drupal + GitHub + Google Workspace ドライブ + Gmail + IBM DB2 + Jira + Microsoft Exchange + Microsoft OneDrive + Microsoft SharePoint + Microsoft Teams + Microsoft SQL Server + Microsoft Yammer + MySQL + Oracle Database + [PostgreSQL] + Quip + Salesforce + ServiceNow + Slack + Zendesk S3 バケットまたは S3 データソースにドキュメントを保存する場合、JSON メタデータファイルを使用してフィールドを指定します。詳細については、「[S3 data source connector](https://docs.aws.amazon.com/kendra/latest/dg/data-source-s3.html)」を参照してください。 データソースフィールドをインデックスフィールドにマッピングするには、次の 3 つの手順を実行します。 1. インデックスを作成します。詳細については、[インデックスの作成](https://docs.aws.amazon.com/kendra/latest/dg/create-index.html)を参照してください。 1. インデックスを更新して、フィールドを追加します。 1. データソースを作成し、リザーブドフィールドとカスタムフィールドを Amazon Kendra インデックスフィールドにマッピングするフィールドマッピングを含めます。 インデックスを更新してカスタムフィールドを追加するには、コンソールを使用してデータソースフィールドマッピングを編集し、カスタムフィールドを追加するか、[UpdateIndex API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html) を使用します。合計 500 のカスタムフィールドをインデックスに追加できます。 データベースデータソースの場合、データベース列の名前が予約フィールドの名前と一致する場合、フィールドと列は自動的にマッピングされます。 [UpdateIndex](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html) API では、`DocumentMetadataConfigurationUpdates` を使用して予約済みフィールドとカスタムフィールドを追加します。 次の JSON の例では、`DocumentMetadataConfigurationUpdates` を使用して「Department」というフィールドをインデックスに追加します。 ``` "DocumentmetadataConfigurationUpdates": [ { "Name": "Department", "Type": "STRING_VALUE" } ] ``` フィールドを作成するときに、検索でのフィールドの使用方法を設定するオプションがあります。次から選択できます。 + **表示可能** - クエリレスポンスでフィールドを返すかどうかを指定します。デフォルトは `true` です。 + **ファセット可能** - フィールドを使用してファセットを作成できることを示します。デフォルトは `false` です。 + **検索可能** - 検索でフィールドを使用するかどうかを指定します。デフォルトは、文字列フィールドに対しては `true`、数値フィールドと日付フィールドに対しては `false` です。 + **ソート可能** - フィールドを使用して検索結果をソートできることを示します。日付、数値、および文字列フィールドに対してのみ設定できます。文字列リストフィールドには設定できません。 次の JSON 例では、`DocumentMetadataConfigurationUpdates` を使用して「Department」というフィールドをインデックスに追加し、それをファセット可能としてマークします。 ``` "DocumentMetadataConfigurationUpdates": [ { "Name": "Department", "Type": "STRING_VALUE", "Search": { "Facetable": true } } ] ``` ## Amazon Kendra 予約済みまたは共通ドキュメントフィールドの使用 [UpdateIndex API](https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateIndex.html) では、`DocumentMetadataConfigurationUpdates` を使用して Amazon Kendra 予約済みインデックスフィールド名を指定することにより、予約フィールドまたは共通フィールドを作成し、対応するドキュメント属性/フィールド名にマッピングできます。カスタムフィールドも作成できます。データソースコネクタを使用する場合、データソースドキュメントフィールドを Amazon Kendra インデックスフィールドにマッピングするフィールドマッピングがほとんど含まれます。コンソールを使用する場合は、データソースを選択し、編集アクションを選択してから、フィールドマッピングセクションの横に進んでデータソースを設定して、フィールドを更新します。 `Search` オブジェクトを設定して、フィールドを表示可能、ファセット可能、検索可能、ソート可能のいずれかに設定できます。特定のフィールド値にマッピングされたブースト、新しさ、重要度の値に適用するフィールドのランク順序、ブースト期間、または期間を設定するように `Relevance` オブジェクトを設定できます。コンソールを使用する場合は、ナビゲーションメニューのファセットオプションを選択して、フィールドの検索設定をセットできます。関連性調整を設定するには、ナビゲーションメニューでインデックスを検索するオプションを選択し、クエリを入力し、サイドパネルのオプションを使用して検索の関連性を調整します。フィールドを作成すると、フィールドタイプを変更することはできません。 Amazon Kendra には、使用できる以下の予約済みまたは共通ドキュメントフィールドがあります。 + `_authors` - ドキュメントの内容を担当する 1 人以上の作成者のリスト。 + `_category` - ドキュメントを特定のグループに配置するカテゴリ。 + `_created_at` - ドキュメントが作成された ISO 8601 形式の日付と時刻。例えば、2012-03-25T12:30:10\$101:00 は、中央ヨーロッパ時間の 2012 年 3 月 25 日午後 12 時 30 分 (プラス 10 秒) の ISO 8601 の日付/時刻形式です。 + `_data_source_id` - ドキュメントを含むデータソースの識別子。 + `_document_body` - ドキュメントのコンテンツ。 + `_document_id` - ドキュメントの一意の識別子。 + `_document_title` - ドキュメントのタイトル。 + `_excerpt_page_number` - ドキュメントの抜粋が表示される PDF ファイルのページ番号。2020 年 9 月 8 日より前にインデックスが作成された場合、この属性を使用する前に、ドキュメントのインデックスを再作成する必要があります。 + `_faq_id` - これが質疑応答タイプのドキュメント (よくある質問) の場合、よくある質問の固有識別子です。 + `_file_type` - pdf や doc など、ドキュメントのファイルタイプ。 + `_last_updated_at` - ドキュメントが最後に更新された ISO 8601 形式の日付と時刻。例えば、2012-03-25T12:30:10\$101:00 は、中央ヨーロッパ時間の 2012 年 3 月 25 日午後 12 時 30 分 (プラス 10 秒) の ISO 8601 の日付/時刻形式です。 + `_source_uri` - ドキュメントが利用可能な URI。例えば、会社のウェブサイト上のドキュメントの URI などです。 + `_version` - ドキュメントの特定のバージョンの識別子。 + `_view_count` - ドキュメントが表示された回数。 + `_language_code` (文字列) - ドキュメントに適用される言語のコード。言語を指定しないと、デフォルトで英語になります。コードを含む、サポートされている言語の詳細については、[英語以外の言語でドキュメントを追加する](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html)を参照してください。 カスタムフィールドの場合、予約フィールドまたは共通フィールドを作成する場合と同じように、`UpdateIndex` API で `DocumentMetadataConfigurationUpdates` を使用してこれらのフィールドを作成します。カスタムフィールドには適切なデータタイプを設定する必要があります。コンソールを使用する場合は、データソースを選択し、編集アクションを選択してから、フィールドマッピングセクションの横に進んでデータソースを設定して、フィールドを更新します。一部のデータソースは、新しいフィールドやカスタムフィールドの追加をサポートしていません。フィールドを作成すると、フィールドタイプを変更することはできません。 カスタムフィールドには以下のタイプを設定できます。 + 日付 + Number + String + 文字列リスト [BatchPutDocument](https://docs.aws.amazon.com/kendra/latest/APIReference/API_BatchPutDocument.html) API を使用してインデックスにドキュメントを追加した場合、`Attributes` は、ドキュメントのフィールド/属性を一覧表示し、`DocumentAttribute` オブジェクトを使用してフィールドを作成します。 Amazon S3 データソースからインデックス付けされたドキュメントの場合、フィールド情報を含む [JSON メタデータファイル](https://docs.aws.amazon.com/kendra/latest/dg/s3-metadata.html)を使用してフィールドを作成します。 サポートされているデータベースをデータソースとして使用する場合は、[フィールドマッピングオプション](https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html#data-source-procedure-database)を使用してフィールドを設定できます。 # 英語以外の言語でドキュメントを追加する ドキュメントは、複数の言語でインデックス作成できます。言語を指定しない場合、 Amazon Kendra はデフォルトで英語でドキュメントをインデックス作成します。ドキュメントの言語コードをドキュメントメタデータにフィールドとして含めます。ドキュメントの `_language_code` フィールドの詳細については、「[フィールドマッピング](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html)」と「[カスタム属性](https://docs.aws.amazon.com/kendra/latest/dg/custom-attributes.html)」を参照してください。 [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) を呼び出すときに、データソース内のすべてのドキュメントの言語コードを指定できます。ドキュメントにメタデータフィールドで指定された言語コードがない場合、データソースレベルですべてのドキュメントに指定された言語コードを使用して、ドキュメントのインデックスが作成されます。コンソールでは、データソースレベルでのみ、サポートされている言語でドキュメントのインデックス作成ができます。**[Data sources]** (データソース) へ移動し、**[Specify data source details]** (データソースの詳細を指定) ページで、**[Language]** (言語) のドロップダウンから言語を選択します。 サポートされている言語でドキュメントを検索またはクエリできます。詳細については、「[各言語での検索](https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-languages)」を参照してください。 以下の言語とそのコードがサポートされています (言語を指定しない場合、英語または `en` はデフォルトでサポートされています。) この表には、フルセマンティック検索で Amazon Kendra がサポートする言語と、単純なキーワードマッチングのみをサポートする言語が含まれています。次の表では、完全なセマンティック検索をサポートする言語にはアスタリスクが付いており、太字で示されています。英語 (デフォルト言語) は完全セマンティック検索でもサポートされています。 | **言語名** | **言語コード** | | --- | --- | | アラビア語 | ar | | アルメニア語 | hy | | バスク語 | eu | | ベンガル語 | bn | | ブルガリア語 | bg | | カタロニア語 | ca | | 中国語 - 簡体字と繁体字\$1 | zh | | チェコ語 | cs | | Danish | da | | Dutch | nl | | Finnish | fi | | フランス語 - フランス語 (カナダ) を含む\$1 | fr | | ガリシア語 | gl | | ドイツ語\$1 | de | | Greek | el | | ヒンディー語 | hi | | Hungarian | hu | | Indonesian | id | | Irish | ga | | Italian | it | | 日本語\$1 | ja | | 韓国語\$1 | ko | | ラトビア語 | lv | | リトアニア語 | lt | | Norwegian | no | | ペルシャ語 | fa | | Portuguese | pt | | ポルトガル語 (ブラジル)\$1 | pt-BR | | Romanian | ro | | Russian | ru | | ソラニ語 | ckb | | スペイン語 - スペイン語 (メキシコ) を含む\$1 | es | | スウェーデン語 | sv | | トルコ語 | tr | *\$1その言語ではセマンティック検索がサポートされています。* セマンティック検索をサポートする言語では、以下の機能がサポートされます。 + 単純なキーワードマッチングを超えるドキュメントの関連性。 + 単純なキーワードマッチング以外のよくある質問。 + 読み取りの理解に基づいてドキュメントから回答 Amazon Kendraを抽出する。 + 検索結果の信頼バケット (非常に高い、高い、中程度、低いなど) です。 セマンティック検索をサポートしていない言語では、ドキュメントの関連性やよくある質問に関する単純なキーワードマッチングがサポートされています。 [シノニム](https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms.html) (カスタムシノニムを含む)、[増分学習とフィードバック](https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html)、および[クエリの提案](https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html)は、英語 (デフォルト言語) でのみサポートされています。 # を使用する Amazon Kendra ように を設定する Amazon VPC Amazon Kendra は、 で作成した仮想プライベートクラウド (VPC) に接続 Amazon Virtual Private Cloud して、プライベートクラウドで実行されているデータソースに保存されているコンテンツのインデックスを作成できます。データソースコネクタを作成する場合、データソースを含むサブネットのセキュリティグループとサブネット識別子を指定できます。この情報を使用して、 は VPC 内のデータソースと安全に通信するために使用する Elastic Network Interface Amazon Kendra を作成します。 で Amazon Kendra データソースコネクタを設定するには Amazon VPC、 AWS マネジメントコンソール または [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) API オペレーションを使用できます。コンソールを使用する場合は、コネクタ設定プロセス中に VPC を接続します。 **注記** データソースコネクタを設定する場合、 Amazon VPC Amazon Kendra この機能はオプションです。パブリックインターネットからデータソースにアクセスできる場合は、 Amazon VPC この機能を有効にする必要はありません。すべての Amazon Kendra データソースコネクタが Amazon VPCをサポートしているわけではありません。 データソースが で実行されておらず Amazon VPC 、パブリックインターネットからアクセスできない場合は、まず仮想プライベートネットワーク (VPN) を使用してデータソースを VPC に接続します。次に、 Amazon VPC と の組み合わせ Amazon Kendra を使用して、データソースを に接続できます AWS Virtual Private Network。VPN の設定の詳細については、[Site-to-Site VPN ドキュメント](https://docs.aws.amazon.com/vpn/)を参照してください。 **Topics** + [ # Amazon Kendra コネクタ Amazon VPC のサポートの設定 ](connector-vpc-steps.md) + [ # データソースをセットアップ Amazon Kendra して に接続する Amazon VPC ](connector-vpc-setup.md) + [ # VPC のデータベースに接続する ](vpc-example.md) + [ # VPC 接続の問題のトラブルシューティング ](vpc-connector-troubleshoot.md) # Amazon Kendra コネクタ Amazon VPC のサポートの設定 の設定 Amazon VPC Amazon Kendra コネクタで使用する Amazon VPC ように を設定するには、次の手順を実行します。 **Topics** + [ ## ステップ 1. の Amazon VPC サブネットを作成する Amazon Kendra ](#connector-vpc-prerequisites-1) + [ ## ステップ 2. Amazon VPC のセキュリティグループを作成する Amazon Kendra ](#connector-vpc-prerequisites-2) + [ ## ステップ 3. 外部データソースと Amazon VPC ](#connector-vpc-prerequisites-3) ## ステップ 1. の Amazon VPC サブネットを作成する Amazon Kendra データソースへのアクセスに使用できる既存の Amazon VPC サブネット Amazon Kendra を作成または選択します。準備されたサブネットは、次のいずれかのアベイラビリティーゾーン AWS リージョン とアベイラビリティーゾーンにある必要があります。 + 米国西部 (オレゴン)/us-west-2-usw2-az1, usw2-az2, usw2-az3 + 米国東部 (バージニア北部)/us-east-1-use1-az1, use1-az2, use1-az4 + 米国東部 (オハイオ)/us-east-2-use2-az1, use2-az2, use2-az3 + アジアパシフィック (東京)/ap-northeast-1-apne1-az1, apne1-az2, apne1-az4 + アジアパシフィック (ムンバイ)/ap-south-1-aps1-az1, aps1-az2, aps1-az3 + アジアパシフィック (シンガポール)/ap-southeast-1-apse1-az1, apse1-az2, apse1-az3 + アジアパシフィック (シドニー)/ap-southeast-2-apse2-az1, apse2-az2, apse2-az3 + カナダ (中部)/ca-central-1-cac1-az1, cac1-az2, cac1-az4 + 欧州 (アイルランド)/eu-west-1-euw1-az1, uew1-az2, euw1-az3 + 欧州 (ロンドン)/eu-west-2—euw2-az1、euw2-az2、euw2-az3 データソースは、 Amazon Kendra コネクタに提供したサブネットからアクセス可能である必要があります。 Amazon VPC サブネットの設定方法の詳細については、*「Amazon VPC ユーザーガイド*[」の「 のサブネット Amazon VPC](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html)」を参照してください。 Amazon Kendra が 2 つ以上のサブネット間で接続をルーティングする必要がある場合は、複数のサブネットを準備できます。例えば、データソースを含むサブネットが IP アドレスの範囲外にあると仮定してみましょう。この場合、十分な IP アドレスを持ち、最初のサブネットに接続されている追加のサブネットを Amazon Kendra に提供できます。複数のサブネットを一覧表示する場合、サブネットは相互に通信できる必要があります。 ## ステップ 2. Amazon VPC のセキュリティグループを作成する Amazon Kendra Amazon Kendra データソースコネクタを に接続するには Amazon VPC、VPC から に割り当てる 1 つ以上のセキュリティグループを準備する必要があります Amazon Kendra。セキュリティグループは、 Amazon Kendraによって作成された Elastic Network Interface に関連付けられます。このネットワークインターフェイスは、 Amazon VPC サブネットへのアクセス Amazon Kendra 時に送受信されるトラフィックを制御します。 セキュリティグループのアウトバウンドルールで、 Amazon Kendra データソースコネクタからのトラフィックが、同期するサブネットとデータソースにアクセスすることを許可していることを確認します。例えば、MySQL コネクタを使用して MySQL データベースから同期できます。デフォルトのポートを使用している場合、セキュリティグループは、データベースを実行するホストのポート 3306 へのアクセス Amazon Kendra を に許可する必要があります。 Amazon Kendra 次の値を使用するデフォルトのセキュリティグループを設定することをお勧めします。 + **インバウンドルール** – これを空のままにすると、すべてのインバウンドトラフィックがブロックされます。 + **アウトバウンドルール** – がデータソースからの同期リクエスト Amazon Kendra を開始できるように、すべてのアウトバウンドトラフィックを許可する 1 つのルールを追加します。 + **IP バージョン** – IPv4 + **タイプ** - すべてのトラフィック + **プロトコル** – すべてのトラフィック + **ポート範囲** – すべて + **送信先** - 0.0.0.0/0 Amazon VPC セキュリティグループの設定方法の詳細については、*「Amazon VPC ユーザーガイド*」の[「セキュリティグループルール](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html)」を参照してください。 ## ステップ 3. 外部データソースと Amazon VPC 外部データソースにアクセス Amazon Kendra するための適切なアクセス許可設定とネットワーク設定があることを確認します。データソースの設定方法の詳細については、各コネクタページの前提条件セクションを参照してください。 また、 Amazon VPC 設定を確認し、外部データソースが、割り当てるサブネットから到達可能であることを確認します Amazon Kendra。これを行うには、同じセキュリティグループを持つ同じサブネットに Amazon EC2 インスタンスを作成し、この Amazon EC2 インスタンスからデータソースへのアクセスをテストすることをお勧めします。詳細については、[Amazon VPC 「接続のトラブルシューティング](https://docs.aws.amazon.com/kendra/latest/dg/vpc-connector-troubleshoot.html)」を参照してください。 # データソースをセットアップ Amazon Kendra して に接続する Amazon VPC への接続 Amazon VPC に新しいデータソースを追加するときに Amazon Kendra、選択したデータソースコネクタがこの機能をサポート Amazon VPC している場合は、この機能を使用できます。 AWS マネジメントコンソール または Amazon Kendra API を使用して、 を有効にして新しい Amazon Kendra データソース Amazon VPC を設定できます。具体的には、[https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html) API オペレーションを使用してから、`VpcConfiguration` パラメータを使用して次の情報を指定します。 + `SubnetIds` – Amazon VPC サブネットの識別子のリスト + `SecurityGroupIds` – Amazon VPC セキュリティグループの識別子のリスト コンソールを使用する場合は、コネクタの設定中に Amazon VPC 必要な情報を入力します。コンソールを使用してコネクタの Amazon VPC 機能を有効にするには、まず Amazon VPC を選択します。次に、Amazon VPC サブネットの識別子と Amazon VPC セキュリティグループの識別子を指定します。「[Configuring Amazon VPC](https://docs.aws.amazon.com/kendra/latest/dg/connector-vpc-steps.html)」で作成した Amazon VPC サブネットと Amazon VPC セキュリティグループを選択することも、既存のものを使用することもできます。 **Topics** + [ ## Amazon VPC 識別子の表示 ](#viewing-vpc-identifiers) + [ ## データソース IAM ロールの確認 ](#vpc-iam-roles) ## Amazon VPC 識別子の表示 サブネットとセキュリティグループの識別子は、 Amazon VPC コンソールで設定されます。識別子を表示するには、次の手順を使用します。 **サブネット識別子を表示するには** 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/) で Amazon VPC コンソールを開きます。 1. ナビゲーションペインで、**[Subnets]** (サブネット) を選択します。 1. **[サブネット]** リストから、データベースサーバーを含むサブネットを選択します。 1. **[詳細]** タブで、**[サブネット ID]** フィールドに表示される識別子を書き留めます。 **セキュリティグループ識別子を表示するには** 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/) で Amazon VPC コンソールを開きます。 1. ナビゲーションペインで [**セキュリティグループ**] を選択します。 1. セキュリティグループリストで、識別子の対象となるグループを選択します。 1. **[詳細]** タブで、**[セキュリティグループ ID]** フィールドに表示される識別子を書き留めます。 ## データソース IAM ロールの確認 データソースコネクタ AWS Identity and Access Management IAM) ロールに、 へのアクセス許可が含まれていることを確認します Amazon VPC。 コンソールを使用してロールの新しいロールを作成すると IAM 、 はユーザーに代わって IAM ロールに正しいアクセス許可 Amazon Kendra を自動的に追加します。API を使用する場合、または既存の IAM ロールを使用する場合は、ロールにアクセスするためのアクセス許可が含まれていることを確認します Amazon VPC。適切なアクセス許可があることを確認するには、「[VPC 用のIAM ロール](https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-vpc)」を参照してください。 別の Amazon VPC サブネットを使用するように既存のデータソースを変更できます。ただし、データソースの IAM ロールを確認し、必要に応じて Amazon Kendra データソースコネクタが正しく動作するように変更します。 # VPC のデータベースに接続する データベースへの接続 次の例は、仮想プライベートクラウド (VPC) で実行されている MySQL データベースに接続する方法を示しています。この例では、デフォルトの VPC で開始し、MySQL データベースを作成する必要があることを前提としています。VPC がすでに作成されている場合は、次に示すように設定されていることを確認します。MySQL データベースがある場合は、新しいデータベースを作成する代わりにそれを使用できます。 **Topics** + [ ## ステップ 1: VPC を設定する ](#vpc-example-1) + [ ## ステップ 2: セキュリティグループを作成して設定する ](#vpc-example-2) + [ ## ステップ 3: データベースを作成する ](#vpc-example-3) + [ ## ステップ 4: データソースコネクタを作成する ](#vpc-example-4) ## ステップ 1: VPC を設定する Amazon Kendra がサブネットで実行されている MySQL データベースにアクセスできるようにするための、プライベートサブネットとセキュリティグループを持つように VPC を設定します。VPC 設定で指定するサブネットは、米国西部 (オレゴン) リージョン、米国東部 (バージニア北部) リージョン、または欧州 (アイルランド) リージョンに存在する必要があります。 **を使用して VPC を設定するには Amazon VPC** 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/) で Amazon VPC コンソールを開きます。 1. ナビゲーションペインで **[Route tables]** (ルートテーブル) を選択して、**[Create route table]** (ルートテーブルの作成) を選択します。 1. **[名前]** フィールドに **Private subnet route table** と入力します。**[VPC]** ドロップダウンから [VPC] を選択し、**[ルートテーブルを作成]** を選択します。**[Close]** (閉じる) をクリックして、ルートテーブルのリストに戻ります。 1. ナビゲーションペインで、**[NAT ゲートウェイ]**、**[NAT ゲートウェイの作成]** の順に選択します。 1. **[サブネット]** ドロップダウンから、パブリックサブネットであるサブネットを選択します。サブネット ID をメモしておきます。 1. Elastic IP アドレスを持っていない場合は、**[Create New EIP]** (新しい EIP の作成) で、**[Create a NAT Gateway]** (NAT ゲートウェイの作成) を選択してから、**[Close]** (閉じる) をクリックします。 1. ナビゲーションペインから、**[ルートテーブル]** を選択します。 1. ルートテーブルリストから、ステップ 3 で作成した **[Private subnet route table]** (プライベートサブネットルートテーブル) を選択します。**[アクション]** で、**[ルートの編集]** を選択します。 1. **[Add Rule]** (ルートの追加) を選択します。送信先に「**0.0.0.0/0**」を入力して、インターネットへのすべての発信トラフィックを許可します。**[ターゲット]** で、**[NAT ゲートウェイ]** を選択し、次に、ステップ 4 で作成したゲートウェイを選択します。[**変更を保存**]、[**閉じる**] の順に選択します。 1. **[Actions]** (アクション) から、**[Edit subnet associations]** (サブネットの関連付けの編集) を選択します。 1. プライベートにするサブネットを選択します。上記で書き留めた NAT ゲートウェイを持つサブネットを選択しないでください。完了したら、**[関連付けを保存]** を選択します。 ## ステップ 2: セキュリティグループを作成して設定する 次に、データベースのセキュリティグループを設定します。 **セキュリティグループを作成して設定するには** 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/vpc/](https://console.aws.amazon.com/vpc/) で Amazon VPC コンソールを開きます。 1. VPC の説明から、IPv4 CIDR を書き留めます。 1. ナビゲーションペインで、**[セキュリティグループ]** を選択して、**[セキュリティグループを作成]** を選択します。 1. **[Security group name]** (セキュリティグループ名) に **DataSourceInboundSecurityGroup** と入力します。説明を入力し、リストから VPC を選択します。**[セキュリティグループを作成]** を選択してから、**[閉じる]** を選択します。 1. **[Inbound rules]** (インバウンドルール) タブを開きます。 1. **[インバウンドルールの編集]**、**[ルールの追加]** の順に選択します。 1. データベースの場合は、**[ポート範囲]** のポート番号を入力します。例えば、MySQL の場合は **3306** で、HTTPS の場合は **443** です。**[Source]** (ソース) に、VPC のクラスレスドメイン間ルーティング (CIDR) を入力します。**[Save rules]** (ルールの保存) を選択し、**[Close]** (閉じる) をクリックします。 セキュリティグループでは、VPC 内のすべてのユーザーがデータベースに接続でき、インターネットへのアウトバウンド接続が許可されます。 ## ステップ 3: データベースを作成する ドキュメントを保持するデータベースを作成します。または、既存のデータベースを使用できます。 MySQL データベースの作成方法の詳細については、「[https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html](https://docs.aws.amazon.com/kendra/latest/dg/data-source-mysql.html)」を参照してください。 ## ステップ 4: データソースコネクタを作成する VPC を設定してデータベースを作成したら、データベースのデータソースコネクタを作成できます。が Amazon Kendra サポートするデータベースコネクタの詳細については、[「サポートされているコネクタ](https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html)」を参照してください。 データベースで、VPC、および VPC で作成したプライベートサブネットとセキュリティグループが設定されていることを確認してください。 # VPC 接続の問題のトラブルシューティング Virtual Private Cloud (VPC) 接続で問題が発生した場合は、アクセス IAM 許可、セキュリティグループ設定、サブネットのルートテーブルが正しく設定されていることを確認します。 データソースコネクタの同期が失敗する原因の 1 つは、割り当てたサブネットからデータソースにアクセスできない可能性があることです Amazon Kendra。この問題のトラブルシューティングを行うには、同じ Amazon VPC 設定の Amazon EC2 インスタンスを作成することをお勧めします。次に、REST API コールまたは他の方法 (データソースの特定のタイプに基づく) を使用して、この Amazon EC2 インスタンスからデータソースにアクセスしてみてください。 作成した Amazon EC2 インスタンスからデータソースに正常にアクセスすると、このサブネットからデータソースにアクセスできることを意味します。したがって、同期の問題は、 がデータソースにアクセスできないことに関連していません Amazon VPC。 VPC 設定から Amazon EC2 インスタンスにアクセスして、作成した Amazon EC2 インスタンスで検証できない場合は、さらにトラブルシューティングを行う必要があります。例えば、接続の問題に関するエラーで同期に失敗した Amazon S3 コネクタがある場合、 Amazon S3 コネクタに割り当てた設定と同じ Amazon VPC 設定で Amazon EC2 インスタンスを設定できます。次に、この Amazon EC2 インスタンスを使用して、 Amazon VPC が正しく設定されているかどうかをテストします。 以下は、 Amazon S3 データソースと Amazon VPC の接続をトラブルシューティングするための Amazon EC2 インスタンスの設定例です。 **Topics** + [ ## ステップ 1: Amazon EC2 インスタンスを起動する ](#vpc-connector-troubleshoot-1) + [ ## ステップ 2: Amazon EC2 インスタンスに接続する ](#vpc-connector-troubleshoot-2) + [ ## ステップ 3: Amazon S3 アクセスをテストする ](#vpc-connector-troubleshoot-3) ## ステップ 1: Amazon EC2 インスタンスを起動する 1. にサインイン AWS マネジメントコンソール し、[https://console.aws.amazon.com/ec2/](https://console.aws.amazon.com/ec2/) で Amazon EC2 コンソールを開きます。 1. **[インスタンスを起動]** を選択します。 1. **[ネットワーク設定]** セクションで、**[編集]** を選択し、次の操作を行います。 1. 割り当てたのと同じ VPC と**サブネット**を選択します Amazon Kendra。 1. **[ファイアウォール (セキュリティグループ)]** で、**[既存のセキュリティグループを選択する]** を選択してください。次に、割り当てたセキュリティグループを選択します Amazon Kendra。 **注記** セキュリティグループでは、 Amazon S3へのアウトバウンドトラフィックを許可する必要があります。 1. **[パブリック IP の自動割り当て]** を **[無効]** に設定します。 1. **[高度な詳細]** で以下を実行します。 + **IAM インスタンスプロファイル**で、インスタンスプロファイルを作成して IAM インスタンスにアタッチする**新しい IAM** プロファイルの作成を選択します。プロファイルに Amazon S3へのアクセス許可があることを確認してください。詳細については、[「」の「 Amazon S3 バケットへのアクセス権を Amazon EC2 インスタンスに付与するにはどうすればよいですか?](https://repost.aws/knowledge-center/ec2-instance-access-s3-bucket)」を参照してください AWS re:Post。 + 他の設定はすべてデフォルトのままにしておきます。 1. Amazon EC2 インスタンスを確認して起動します。 ## ステップ 2: Amazon EC2 インスタンスに接続する Amazon EC2 インスタンスが実行されたら、インスタンスの詳細ページに移動し、インスタンスに接続します。これを行うには、*Amazon EC2 ユーザーガイド* の[パブリック IPv4 アドレスを必要とすることなく EC2 インスタンス接続エンドポイントを使用してインスタンスに接続する方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/connect-with-ec2-instance-connect-endpoint.html)の記事で、Linux インスタンスに関する手順に従います。 ## ステップ 3: Amazon S3 アクセスをテストする Amazon EC2 インスタンスターミナルに接続したら、 AWS CLI コマンドを実行して、このプライベートサブネットから Amazon S3 バケットへの接続をテストします。 Amazon S3 アクセスをテストするには、 AWS CLI で次のコマンドを入力します AWS CLI。 `aws s3 ls` AWS CLI コマンドを実行したら、以下を確認します。 + 必要な IAM アクセス許可を正しく設定し、 Amazon S3 設定が正しい場合は、 Amazon S3 バケットのリストが表示されます。 + などのアクセス許可エラーが表示された場合は`Access Denied`、yourVPC 設定が正しい可能性がありますが、 IAM アクセス許可または Amazon S3 バケットポリシーに問題がある可能性があります。 コマンドがタイムアウトしている場合は、VPC が正しく設定されておらず、Amazon EC2 インスタンスがサブネットから Amazon S3 にアクセスできないため、接続がタイムアウトしている可能性があります。VPC を再度設定して、もう一度試してください。