{
"username": "user@corp.example.com",
"password": "password"
} Jika Anda menggunakan protokol NFS untuk sistem Amazon FSx file Anda, rahasianya disimpan dalam struktur JSON dengan kunci berikut: {
"leftId": "left ID",
"rightId": "right ID",
"preSharedKey": "pre-shared key"
} |
### Amazon FSx (NetApp ONTAP) Skema 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"
]
}
```
## Alfrescoskema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) Anda memberikan ID Alfresco situs, URL repositori, URL antarmuka pengguna, jenis autentikasi, apakah Anda menggunakan cloud atau lokal, dan jenis konten yang ingin dirayapi. Anda memberikan ini sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`ALFRESCO`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [AlfrescoSkema JSON](#alfresco-json).
Tabel berikut menjelaskan parameter skema Alfresco JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| SiteID | Pengidentifikasi situs Alfresco. |
| Repourl | URL Alfresco repositori Anda. Anda bisa mendapatkan URL repositori dari administrator AndaAlfresco. Misalnya, jika Anda menggunakan Alfresco Cloud (PaaS), URL repositori bisa jadi. https://company.alfrescocloud.com Atau, jika Anda menggunakan Alfresco Lokal, URL repositori bisa jadi. https://company-alfresco-instance.company-domain.suffix:port |
| webAppUrl | URL antarmuka Alfresco pengguna Anda. Anda bisa mendapatkan URL antarmuka Alfresco pengguna dari Alfresco administrator Anda. Misalnya, URL antarmuka pengguna dapat berupa https://example.com. |
| repositoryAdditionalProperties | Properti tambahan untuk terhubung dengan titik akhir repository/data sumber. |
| authType | Jenis otentikasi yang Anda gunakan, apakah OAuth2 atauBasic. |
| jenis (penyebaran) | Jenis Alfresco yang Anda gunakan, apakah PAAS atauON-PREM. |
| CrawlType | Jenis konten yang ingin dirayapi, baik ASPECT (konten yang ditandai dengan 'Aspek' diAlfresco), SITE\$1ID (konten dalam Alfresco situs tertentu), atau ALL\$1SITES (konten di semua Alfresco situs Anda). |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang dokumen Alfresco Anda dan komentar untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| AspectName | Nama 'Aspek' tertentu yang ingin Anda indeks. |
| AspectProperties | Daftar properti konten 'Aspek' tertentu yang ingin Anda indeks. |
| enableFineGrainedKontrol | `true`untuk merangkak 'Aspek'. |
| isCrawlComment | `true`untuk merayapi komentar. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan file tertentu dalam sumber Alfresco data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber Alfresco data Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan ALFRESCO sebagai tipe sumber data Anda. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. Alfresco Rahasianya harus berisi struktur JSON dengan kunci berikut: Jika menggunakan otentikasi dasar: {
"username": "user name",
"password": "password"
} Jika menggunakan otentikasi OAuth 2.0: {
"clientId": "client ID",
"clientSecret": "client secret",
"tokenUrl": "token URL"
} |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| versi | Versi template ini yang saat ini didukung. |
### AlfrescoSkema 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 Skema templat (MySQL)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`mysql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Aurora (MySQL) skema JSON](#aurora-mysql-json).
Tabel berikut menjelaskan parameter skema Aurora (MySQL) JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Aurora (MySQL) skema 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) skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`postgresql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Aurora (PostgreSQL) Skema JSON](#aurora-postgresql-json).
Tabel berikut menjelaskan parameter skema JSON Aurora (PostgreSQL).
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Aurora (PostgreSQL) Skema 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 Skema templat (Microsoft SQL Server)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`sqlserver`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Amazon RDS (Microsoft SQL Server) Skema JSON](#rds-ms-sql-server-json).
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (Microsoft SQL Server).
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Amazon RDS (Microsoft SQL Server) Skema 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 Skema templat (MySQL)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`mysql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Amazon RDS (MySQL) skema JSON](#rds-mysql-json).
Tabel berikut menjelaskan parameter skema Amazon RDS (MySQL) JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Amazon RDS (MySQL) skema 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 Skema templat (Oracle)
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`oracle`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Amazon RDS (Oracle) Skema JSON](#rds-oracle-json).
Tabel berikut menjelaskan parameter skema Amazon RDS (Oracle) JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Amazon RDS (Oracle) Skema 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) skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`postgresql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Amazon RDS (PostgreSQL) Skema JSON](#rds-postgresql-json).
Tabel berikut menjelaskan parameter skema JSON Amazon RDS (PostgreSQL).
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Amazon RDS (PostgreSQL) Skema 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 skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari konfigurasi template. Anda memberikan nama bucket S3 sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`S3`, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema S3 JSON](#s3-json).
Tabel berikut menjelaskan parameter skema Amazon S3 JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| BucketName | Nama Amazon S3 ember Anda. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan atau mengecualikan file tertentu dalam sumber Amazon S3 data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| aclConfigurationFileJalan | Jalur file yang mengontrol akses ke dokumen dalam Amazon Kendra indeks. |
| metadataFilesPrefix | Lokasi dalam bucket Anda untuk file metadata. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| jenis | Jenis sumber data. Tentukan S3 sebagai tipe sumber data Anda. |
| versi | Versi template yang didukung. |
### Skema 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 Skema Templat Perayap Web
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html)
Anda memberikan benih atau titik awal URLs, atau Anda dapat memberikan peta situs URLs, sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Alih-alih mencantumkan semua file Anda secara manual URLs, Anda dapat memberikan jalur ke Amazon S3 bucket yang menyimpan file teks untuk daftar file XHTML seed URLs atau sitemap Anda, yang dapat Anda gabungkan bersama dalam file ZIP di S3.
Anda juga menentukan jenis sumber data sebagai`WEBCRAWLERV2`, kredensi otentikasi situs web dan jenis otentikasi jika situs web Anda memerlukan otentikasi, dan konfigurasi lain yang diperlukan.
Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
**penting**
Pembuatan konektor Web Crawler v2.0 tidak didukung oleh. CloudFormation Gunakan konektor Web Crawler v1.0 jika Anda memerlukan CloudFormation dukungan.
*Saat memilih situs web untuk diindeks, Anda harus mematuhi [Kebijakan Penggunaan yang Diterima Amazon](https://aws.amazon.com/aup/) dan semua syarat Amazon lainnya. Ingat bahwa Anda hanya harus menggunakan Amazon Kendra Web Crawler untuk mengindeks halaman web Anda sendiri, atau halaman web yang Anda memiliki otorisasi untuk indeks. Untuk mempelajari cara menghentikan Amazon Kendra Web Crawler dari mengindeks situs web Anda, lihat. [Mengkonfigurasi `robots.txt` file untuk Amazon Kendra Web Crawler](stop-web-crawler.md)*
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Amazon Kendra Skema JSON Web Crawler](#web-crawler-json).
Tabel berikut menjelaskan parameter skema Amazon Kendra Web Crawler JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| siteMapUrls | Daftar peta situs URLs untuk situs web yang ingin Anda jelajahi. Anda dapat membuat daftar hingga tiga URLs sitemap. |
| s3 SeedUrl | Jalur S3 ke file teks yang menyimpan daftar benih atau titik URLs awal. Misalnya, s3://bucket-name/directory/. Setiap URL dalam file teks harus diformat pada baris terpisah. Anda dapat mencantumkan hingga 100 benih URLs dalam satu file. |
| s3 SiteMapUrl | Jalur S3 ke file XMLpeta situs. Misalnya, s3://bucket-name/directory/. Anda dapat membuat daftar hingga tiga file XHTML sitemap. Anda dapat menggabungkan beberapa file peta situs ke dalam file ZIP dan menyimpan file ZIP di bucket Anda Amazon S3 . |
| seedUrlConnections | Daftar benih atau titik awal URLs untuk situs web yang ingin Anda jelajahi. Anda dapat membuat daftar hingga 100 benih. URLs |
| SeedURL | URL benih atau titik awal. |
| autentikasi | Jenis otentikasi jika situs web Anda memerlukan otentikasi yang sama, jika tidak, tentukan. NoAuthentication |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang halaman web dan file halaman web Anda untuk Amazon Kendra mengindeks nama bidang. Misalnya, tag judul halaman web HTML dapat dipetakan ke bidang \$1document\$1title indeks. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| RateLimit | Jumlah maksimum URLs crawled per host situs web per menit. |
| maxFileSize | Ukuran maksimum (dalam MB) halaman web atau lampiran untuk dirayapi. |
| CrawlDepth | Jumlah level dari URL seed yang akan dirayapi. Misalnya, halaman URL benih adalah kedalaman 1 dan hyperlink apa pun di halaman ini yang juga dirayapi adalah kedalaman 2. |
| maxLinksPerUrl | Jumlah maksimum URLs pada halaman web untuk disertakan saat merayapi situs web. Nomor ini per halaman web. Saat halaman web situs web dirayapi, semua URLs yang ditautkan ke halaman web juga dirayapi. URLs pada halaman web dirayapi dalam urutan penampilan. |
| crawlSubDomain | trueuntuk merayapi domain situs web dengan subdomain. Misalnya, jika URL benih adalah "abc.example.com“, maka" "dana.abc.example.com" b.abc.example.com "juga dirayapi. Jika Anda tidak menyetel crawlSubDomain atau crawlAllDomain ketrue, maka Amazon Kendra hanya merayapi domain situs web yang ingin Anda jelajahi. |
| crawlAllDomain | trueuntuk merayapi domain situs web dengan subdomain dan domain lain yang ditautkan halaman web. Jika Anda tidak menyetel crawlSubDomain atau crawlAllDomain ketrue, maka Amazon Kendra hanya merayapi domain situs web yang ingin Anda jelajahi. |
| HonorRobots | trueuntuk menghormati arahan robots.txt dari situs web yang ingin Anda jelajahi. Arahan ini mengontrol cara Amazon Kendra Web Crawler merayapi situs web, apakah hanya Amazon Kendra dapat merayapi konten tertentu atau tidak merayapi konten apa pun. |
| CrawlatTachments | trueuntuk merayapi file yang ditautkan ke halaman web. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan crawling tertentu URLs dan mengindeks hyperlink apa pun di halaman web URL ini. URLs yang cocok dengan pola termasuk dalam indeks. URLs yang tidak cocok dengan pola dikecualikan dari indeks. Jika URL cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan halaman web URL/situs web tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan perayapan tertentu URLs dan mengindeks hyperlink apa pun di halaman web URL ini. URLs yang cocok dengan pola dikecualikan dari indeks. URLs yang tidak cocok dengan pola yang termasuk dalam indeks. Jika URL cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan halaman web URL/situs web tidak disertakan dalam indeks. |
| inclusionFileIndexPola | Daftar pola ekspresi reguler untuk menyertakan file halaman web tertentu. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tidak disertakan dalam indeks. |
| exclusionFileIndexPola | Daftar pola ekspresi reguler untuk mengecualikan file halaman web tertentu. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tidak disertakan dalam indeks. |
| implicitWaitDuration | implicitWaitDuration menentukan berapa lama konektor akan menunggu, dalam hitungan detik, sebelum merayapi halaman web. Rentang: 0-10 misalnya. “implicitWaitDuration“: “5" |
| proxy | Informasi konfigurasi diperlukan untuk terhubung ke situs web internal Anda melalui proxy web. |
| host | Nama host dari proxy sever yang ingin Anda gunakan untuk terhubung ke situs web internal. Misalnya, nama host https://a.example.com/page1.htmladalah "a.example.com”. |
| port | Nomor port dari pemutus proxy yang ingin Anda gunakan untuk terhubung ke situs web internal. Misalnya, 443 adalah port standar untuk HTTPS. |
| sekretarn (proxy) | Jika kredensyal proxy web diperlukan untuk terhubung ke host situs web, Anda dapat membuat AWS Secrets Manager rahasia yang menyimpan kredensialnya. Berikan Nama Sumber Daya Amazon (ARN) rahasia tersebut. |
| jenis | Jenis sumber data. Tentukan WEBCRAWLERV2 sebagai tipe sumber data Anda. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang digunakan jika situs web Anda memerlukan otentikasi untuk mengakses situs web. Anda menyimpan kredensi otentikasi untuk situs web dalam rahasia yang berisi pasangan nilai kunci JSON. Jika Anda menggunakan dasar, atau NTML/KerberOS, masukkan nama pengguna dan kata sandi. Kunci JSON dalam rahasia harus `userName` dan`password`. Protokol otentikasi NTLM mencakup hashing kata sandi, dan protokol otentikasi Kerberos mencakup enkripsi kata sandi. Jika Anda menggunakan SAFL atau otentikasi formulir, masukkan nama pengguna dan kata sandi, XPath untuk bidang nama pengguna (dan tombol nama pengguna jika menggunakan SAFL), XPaths untuk bidang dan tombol kata sandi, dan URL halaman login. Kunci JSON dalam rahasia harus`userName`,,, `password``userNameFieldXpath`,`userNameButtonXpath`, `passwordFieldXpath``passwordButtonXpath`, dan`loginPageUrl`. Anda dapat menemukan elemen XPaths (XMLPath Language) menggunakan alat pengembang browser web Anda. XPaths biasanya mengikuti format ini:`//tagname[@Attribute='Value']`. Amazon Kendra juga memeriksa apakah informasi titik akhir (seed URLs) yang disertakan dalam rahasia sama dengan informasi titik akhir yang ditentukan dalam detail konfigurasi titik akhir sumber data Anda. |
| versi | Versi template ini yang saat ini didukung. |
### Amazon Kendra Skema JSON Web Crawler
```
{
"$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"
]
}
```
## Skema templat pertemuan
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL host Confluence, metode hosting, dan jenis otentikasi sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`CONFLUENCEV2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Confluence JSON](#confluence-json).
Tabel berikut menjelaskan parameter skema Confluence JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL untuk instance Confluence Anda. Misalnya, https://example.confluence.com. |
| jenis | Metode hosting untuk instance Confluence Anda, apakah SAAS dan. ON\$1PREM |
| authType | Metode otentikasi untuk instance Confluence Anda, apakahBasic, OAuth2 atau. Personal-token |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang ruang Confluence Anda, halaman, blog, komentar, dan lampiran untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). Nama bidang sumber data Confluence harus ada di metadata kustom Confluence Anda. |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| isCrawlAcl | Konfigurasikan true untuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. Perhatikan bahwa ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Ini berarti bahwa jika isCrawlACL dimatikan, dokumen dapat dicari secara publik. Untuk informasi selengkapnya, lihat [Pemfilteran konteks pengguna](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| fieldForUserId | Tentukan email apakah Anda ingin menggunakan email pengguna untuk ID pengguna. emaildigunakan secara default dan saat ini satu-satunya tipe ID pengguna yang didukung. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan and/or mengecualikan file tertentu dalam sumber data Confluence Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| ProxyHost | Nama host dari proxy web yang Anda gunakan, tanpa https:// protokol http:// atau. |
| ProxyPort | Nomor port yang digunakan oleh protokol transport URL host. Harus berupa nilai numerik antara 0 dan 65535. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi file di ruang pribadi Confluence Anda, halaman, blog, komentar halaman, lampiran halaman, komentar blog, dan lampiran blog. |
| maxFileSizeInMegaBytes | Tentukan batas ukuran file MBs yang Amazon Kendra dapat dirayapi. Amazon Kendra hanya merayapi file dalam batas ukuran yang Anda tentukan. Ukuran file default adalah 50MB. Ukuran file maksimum harus lebih besar dari 0MB dan kurang dari atau sama dengan 50MB. |
| jenis | Jenis sumber data. Tentukan CONFLUENCEV2 sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Confluence Anda. Untuk informasi tentang pasangan nilai kunci ini, lihat [Instruksi koneksi untuk](https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-confluence.html#data-source-procedure-v2-confluence) Confluence. |
| versi | Versi template ini yang saat ini didukung. |
### Skema 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"
]
}
```
## Skema templat Dropbox
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan kunci aplikasi Dropbox, rahasia aplikasi, dan token akses sebagai bagian dari rahasia Anda yang menyimpan kredensyal otentikasi Anda. Juga tentukan jenis sumber data sebagai`DROPBOX`, jenis token akses yang ingin Anda gunakan (sementara atau permanen), dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Dropbox JSON](#dropbox-json).
Tabel berikut menjelaskan parameter skema Dropbox JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi termasuk dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang file Dropbox, Dropbox Paper, dan pintasan untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan nilai kunci yang diperlukan untuk terhubung ke Dropbox Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"appKey": "Dropbox app key",
"appSecret": "Dropbox app secret",
"accesstoken": "temporary access token or refresh access token"
} |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| isCrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat [Pemfilteran konteks pengguna](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/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan nama dan jenis file tertentu di sumber data Dropbox Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan nama dan jenis file tertentu di sumber data Dropbox Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi file di Dropbox, dokumen Dropbox Paper, templat Dropbox Paper, dan pintasan halaman web yang disimpan di Dropbox Anda. |
| jenis | Jenis sumber data. Tentukan DROPBOX sebagai tipe sumber data Anda. |
| TokenType | Tentukan jenis token akses Anda: token akses permanen atau sementara. Anda disarankan untuk membuat token akses penyegaran yang tidak pernah kedaluwarsa di Dropbox daripada mengandalkan token akses satu kali yang kedaluwarsa setelah 4 jam. Anda membuat aplikasi dan token akses refresh di konsol pengembang Dropbox dan menyediakan token akses dalam rahasia Anda. |
| versi | Versi template ini yang saat ini didukung. |
### Skema 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"
]
}
```
## Skema template Drupal
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) Anda memberikan URL host Drupal dan jenis otentikasi sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai DRUPAL, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema JSON Drupal](#drupal-json).
Tabel berikut menjelaskan parameter skema JSON Drupal.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL host situs web Drupal Anda. Misalnya, https://{
"username": "user name",
"passwords": "password"
} **Jika menggunakan otentikasi OAuth 2.0:**{
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
} |
| versi | Versi template ini yang saat ini didukung. |
### Skema JSON Drupal
```
{
"$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 skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/dg/API_TemplateConfiguration.html) Anda memberikan URL GitHub host, nama organisasi, dan apakah Anda menggunakan GitHub GitHub cloud atau lokal sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`GITHUB`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/dg/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [GitHub Skema JSON](#github-json).
Tabel berikut menjelaskan parameter skema GitHub JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| jenis | Tentukan jenisnya sebagai salah satu SAAS atauON\$1PREMISE. |
| HostURL | URL GitHub host. Misalnya, jika Anda menggunakan GitHub SaaS/Enterprise Cloud:. https://api.github.com Atau, jika Anda menggunakan GitHub On-Premises/Enterprise Server:. https://on-prem-host-url/api/v3/ |
| Nama Organisasi | Anda dapat menemukan nama organisasi Anda ketika Anda masuk ke GitHub desktop dan pergi ke Organisasi Anda di bawah dropdown gambar profil Anda. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang GitHub konten Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| isCrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat [Pemfilteran konteks pengguna](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| fieldForUserId | Tentukan jenis ID pengguna yang ingin Anda gunakan untuk perayapan ACL. Tentukan email apakah Anda ingin menggunakan email pengguna untuk ID pengguna, atau username jika Anda ingin menggunakan nama pengguna untuk ID pengguna. Jika Anda tidak menentukan opsi maka email digunakan secara default. |
| RepositoryFilter | Daftar nama repositori tertentu dan nama cabang yang ingin Anda indeks. |
| CrawlRepository | trueuntuk merayapi repositori. |
| crawlRepositoryDocuments | trueuntuk merayapi dokumen repositori. |
| CrawlIssue | trueuntuk merayapi masalah. |
| crawlIssueComment | trueuntuk merayapi komentar masalah. |
| crawlIssueCommentLampiran | trueuntuk merayapi lampiran komentar masalah. |
| crawlPullRequest | trueuntuk merayapi permintaan tarik. |
| crawlPullRequestKomentar | trueuntuk merayapi komentar permintaan tarik. |
| crawlPullRequestCommentAttachment | trueuntuk merayapi lampiran komentar permintaan tarik. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan konten tertentu dalam sumber GitHub data Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan konten tertentu dalam sumber GitHub data Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan GITHUB sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. GitHub Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"personalToken": "token"
} |
| versi | Versi template ini yang saat ini didukung. |
### GitHub Skema JSON
Berikut ini adalah skema 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"
]
}
```
## Skema template Gmail
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`GMAIL`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema JSON Gmail](#gmail-json).
Tabel berikut menjelaskan parameter skema JSON Gmail.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi termasuk dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang pesan dan lampiran Gmail Anda ke nama bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan atau mengecualikan pesan dengan nama subjek tertentu di sumber data Gmail Anda. File yang cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| beforeDateFilter | Tentukan pesan dan lampiran yang akan disertakan sebelum tanggal tertentu. |
| afterDateFilter | Tentukan pesan dan lampiran yang akan disertakan setelah tanggal tertentu. |
| isCrawlAttachment | Nilai Boolean untuk memilih apakah Anda ingin meng-crawl lampiran. Pesan dirayapi secara otomatis. |
| jenis | Jenis sumber data. Tentukan GMAIL sebagai tipe sumber data Anda. |
| shouldCrawlDraftPesan | Nilai Boolean untuk memilih apakah Anda ingin merayapi pesan draf. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) Karena tidak ada API untuk memperbarui pesan Gmail yang dihapus secara permanen, sinkronisasi konten baru, dimodifikasi, atau dihapus: Tidak akan menghapus pesan yang dihapus secara permanen dari Gmail dari Amazon Kendra indeks Anda Tidak akan menyinkronkan perubahan pada label email Gmail Untuk menyinkronkan perubahan label sumber data Gmail dan pesan email yang dihapus secara permanen ke Amazon Kendra indeks, Anda harus menjalankan crawl penuh secara berkala. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi pasangan nilai kunci yang diperlukan untuk terhubung ke Gmail Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"adminAccountEmailId": "service account email",
"clientEmailId": "user account email",
"privateKey": "private key"
} |
| versi | Versi template yang saat ini didukung. |
### Skema JSON Gmail
```
{
"$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"
]
}
```
## Skema templat Google Drive
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`GOOGLEDRIVE2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Google Drive JSON](#googledrive-json).
Tabel berikut menjelaskan parameter skema Google Drive JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir. Anda memilih jenis otentikasi Anda: serviceAccount danOAuth2. Informasi koneksi termasuk dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| authType | Pilih antara serviceAccount dan OAuth2 berdasarkan kasus penggunaan Anda. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang Google Drive Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Tentukan batas ukuran file MBs yang Amazon Kendra seharusnya dirayapi. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi komentar di sumber data Google Drive Anda. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk meng-crawl MyDrive dan Shared With Me Drive di sumber data Google Drive Anda. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi Drive Bersama di sumber data Google Drive Anda. |
| isCrawlAcl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat [Pemfilteran konteks pengguna](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/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber data Google Drive Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan file tertentu di sumber data Google Drive Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| jenis | Jenis sumber data. Tentukan GOOOGLEDRIVEV2 sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Google Drive Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: ****Jika menggunakan otentikasi Akun Layanan Google:{
"clientEmail": "user account email",
"adminAccountEmail": "service account email",
"privateKey": "private key"
} ****Jika menggunakan otentikasi OAuth 2.0: {
"clientID": "OAuth client ID",
"clientSecret": "client secret",
"refreshToken": "refresh token"
} |
| versi | Versi template ini yang saat ini didukung. |
### Skema 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"
]
}
```
## Skema DB2 templat IBM
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`db2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [IBM DB2 JSON skema](#ibm-db2-json).
Tabel berikut menjelaskan parameter skema IBM DB2 JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### IBM DB2 JSON skema
```
{
"$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"
]
}
```
## Skema templat Microsoft Exchange
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`MSEXCHANGE`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Microsoft Exchange JSON](#msexchange-json).
Tabel berikut menjelaskan parameter skema Microsoft Exchange JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenanID | ID penyewa Microsoft 365. Anda dapat menemukan ID penyewa Anda di Properti Portal Direktori Aktif Azure Anda atau di aplikasi Anda OAuth . |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang sumber data Microsoft Exchange Anda ke bidang Amazon Kendra indeks. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten di sumber data Anda |
| Pola Inklusi | Daftar pola ekspresi reguler untuk menyertakan file tertentu di sumber data Microsoft Exchange Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| Pola Pengecualian | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber data Microsoft Exchange Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan pengguna dan file pengguna tertentu di sumber data Microsofot Exchange Anda. Pengguna yang cocok dengan pola disertakan dalam indeks. Pengguna yang tidak cocok dengan pola dikecualikan dari indeks. Jika pengguna cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan pengguna tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan pengguna dan file pengguna tertentu di sumber data Microsoft Exchange Anda. Pengguna yang cocok dengan pola dikecualikan dari indeks. Pengguna yang tidak cocok dengan pola disertakan dalam indeks. Jika pengguna cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan dan pengguna tidak disertakan dalam indeks. |
| S3BucketName | Nama bucket S3 Anda jika ingin Anda gunakan. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi jenis konten ini dan informasi kontrol akses sumber data Microsoft Exchange Anda. |
| startCalendarDateWaktu | Anda dapat mengonfigurasi tanggal-waktu mulai tertentu untuk konten kalender Anda. |
| endCalendarDateWaktu | Anda dapat mengonfigurasi tanggal-waktu akhir tertentu untuk konten kalender. |
| subjek | Anda dapat mengonfigurasi baris subjek tertentu untuk konten email Anda. |
| EmailDari | Anda dapat mengonfigurasi email tertentu untuk konten email 'Dari' atau pengirim. |
| EmailTo | Anda dapat mengonfigurasi email tertentu untuk konten email 'Kepada' atau penerima. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| jenis | Jenis sumber data. Tentukan MSEXCHANGE sebagai tipe sumber data Anda. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Exchange Anda. Ini termasuk ID klien Anda dan rahasia klien Anda yang dihasilkan saat Anda membuat OAuth aplikasi di portal Azure. |
| versi | Versi template ini yang saat ini didukung. |
### Skema 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"
]
}
```
## OneDrive Skema templat Microsoft
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`ONEDRIVEV2`, dan rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Microsoft OneDrive JSON skema](#onedrive-json).
Tabel berikut menjelaskan parameter skema Microsoft OneDrive JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenanID | ID penyewa Microsoft 365. Anda dapat menemukan ID penyewa Anda di Properti Portal Direktori Aktif Azure Anda atau di aplikasi Anda OAuth . |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| file | Daftar objek yang memetakan atribut atau nama bidang OneDrive file Microsoft Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Anda dapat memilih untuk mengindeks file, OneNote bagian, OneNote halaman, dan filter tertentu berdasarkan nama pengguna. |
| isUserNameOnS3 | trueuntuk memberikan daftar nama pengguna dalam file yang disimpan dalam file Amazon S3. |
| jenis | Jenis sumber data. Tentukan ONEDRIVEV2 sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| jenis | Jenis sumber data. Tentukan ONEDRIVEV2 sebagai tipe sumber data Anda. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Anda. OneDrive Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"clientId": "client ID",
"clientSecret": "client secret"
} |
| versi | Versi template ini yang saat ini didukung. |
### Microsoft OneDrive JSON skema
```
{
"$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"
]
}
```
## SharePoint Skema templat Microsoft
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL SharePoint situs/URLs, domain, dan juga ID penyewa jika diperlukan sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`SHAREPOINTV2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai **Tipe** saat Anda memanggil [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [SharePoint Skema JSON](#sharepoint-json).
Tabel berikut menjelaskan parameter skema Microsoft SharePoint JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data |
| TenanID | ID penyewa SharePoint akun Anda. |
| domain | Domain SharePoint akun Anda. |
| SiteURLS | Tuan rumah URLs SharePoint akun Anda. |
| repositoryAdditionalProperties | Properti tambahan untuk terhubung dengan titik akhir repository/data sumber. |
| S3BucketName | Nama Amazon S3 bucket yang menyimpan sertifikat X.509 yang ditandatangani sendiri Azure AD Anda. |
| S3CertificateName | Nama sertifikat X.509 yang ditandatangani sendiri Azure AD disimpan di bucket Anda. Amazon S3 |
| authType | Jenis otentikasi yang Anda gunakan, apakah,OAuth2,OAuth2Certificate,OAuth2App,Basic, OAuth2\$1RefreshTokenNTLM, atauKerberos. |
| versi | SharePoint Versi yang Anda gunakan, apakah Server atauOnline. |
| onPremVersion | Versi SharePoint Server yang Anda gunakan, apakah 2013 20162019, atauSubscriptionEdition. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang SharePoint konten Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler ke konten include/exclude tertentu di sumber SharePoint data Anda. Item konten yang cocok dengan pola inklusi disertakan dalam indeks. Item konten yang tidak cocok dengan pola inklusi dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi jenis konten ini. |
| CrawlaCl | trueuntuk merayapi informasi daftar kontrol akses (ACL) untuk dokumen Anda, jika Anda memiliki ACL dan ingin menggunakannya untuk kontrol akses. ACL menentukan dokumen mana yang dapat diakses dan dicari oleh pengguna dan grup. Informasi ACL digunakan untuk memfilter hasil pencarian berdasarkan pengguna atau akses grup mereka ke dokumen. Untuk informasi selengkapnya, lihat [Pemfilteran konteks pengguna](https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html#context-filter-user-incl-datasources). |
| fieldForUserId | Tentukan email apakah Anda ingin menggunakan email pengguna untuk ID pengguna, atau userPrincipalName jika Anda ingin menggunakan nama pengguna untuk ID pengguna. Jika Anda tidak menentukan opsi maka email digunakan secara default. |
| ACLConfiguration | Tentukan salah satu ACLWithLDAPEmailFmtACLWithManualEmailFmt,, atauACLWithUsernameFmtM. |
| EmailDomain | Domain email. Misalnya, "amazon.com”. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi informasi pemetaan grup. |
| ProxyHost | Nama host dari proxy web yang Anda gunakan, tanpa protokol http://atau https://. |
| ProxyPort | Nomor port yang digunakan oleh protokol transport URL host. Harus berupa nilai numerik antara 0 dan 65535. |
| jenis | Tentukan SHAREPOINTV2 sebagai tipe sumber data Anda |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan cara Amazon Kendra memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. SharePoint Untuk informasi tentang pasangan nilai kunci ini, lihat [Petunjuk koneksi untuk SharePoint Online dan SharePoint Server](https://docs.aws.amazon.com/kendra/latest/dg/data-source-v2-sharepoint.html#data-source-procedure-v2-sharepoint). |
| versi | Versi template ini yang saat ini didukung. |
## SharePoint Skema 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"
]
}
```
## Skema templat Microsoft SQL Server
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`sqlserver`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Microsoft SQL Server JSON](#ms-sql-server-json).
Tabel berikut menjelaskan parameter skema Micorosft SQL Server JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Skema 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"
]
}
```
## Skema templat Microsoft Teams
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan ID penyewa sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`MSTEAMS`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Microsoft Teams JSON skema](#msteams-json).
Tabel berikut menjelaskan parameter skema Microsoft Teams JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| TenanID | ID penyewa Microsoft 365. Anda dapat menemukan ID penyewa Anda di Properti Portal Direktori Aktif Azure Anda atau di aplikasi Anda OAuth . |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang konten Microsoft Teams Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| PembayaranModel | Menentukan jenis model pembayaran yang akan digunakan dengan sumber data Microsoft Teams Anda. Model pembayaran Model A dibatasi untuk lisensi dan model pembayaran yang memerlukan kepatuhan keamanan. Model pembayaran Model B cocok untuk lisensi dan model pembayaran yang tidak memerlukan kepatuhan keamanan. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan konten tertentu di sumber data Microsoft Teams Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika konten cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan konten tertentu di sumber data Microsoft Teams Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika konten cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi jenis konten ini di sumber data Microsoft Teams Anda. |
| startCalendarDateWaktu | Anda dapat mengonfigurasi tanggal-waktu mulai tertentu untuk konten kalender Anda. |
| endCalendarDateWaktu | Anda dapat mengonfigurasi tanggal-waktu akhir tertentu untuk konten kalender. |
| jenis | Jenis sumber data. Tentukan MSTEAMS sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Tim Microsoft Anda. Ini termasuk ID klien dan rahasia klien Anda yang dihasilkan saat Anda membuat OAuth aplikasi di portal Azure. |
| versi | Versi template ini yang saat ini didukung. |
### Microsoft Teams JSON skema
```
{
"$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"
]
}
```
## Skema templat Microsoft Yammer
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`YAMMER`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai **Tipe** saat Anda memanggil [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini.
Tabel berikut menjelaskan parameter skema Microsoft Yammer JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. Sumber data ini tidak menentukan titik akhir direpositoryEndpointMetadata. Sebaliknya, informasi koneksi termasuk dalam AWS Secrets Manager rahasia yang Anda berikansecretArn. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang konten Microsoft Yammer ke nama bidang indeks Amazon Kendra. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| Pola Inklusi | Daftar pola ekspresi reguler untuk menyertakan file tertentu di sumber data Microsoft Yammer Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| Pola Pengecualian | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber data Microsoft Yammer Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| Sejak Date | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga konektor Microsoft Yammer merayapi konten berdasarkan spesifik. sinceDate |
| communityNameFilter | Anda dapat memilih untuk mengindeks konten komunitas tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi pesan, lampiran pesan, dan pesan pribadi. |
| jenis | Tentukan YAMMER sebagai tipe sumber data Anda. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Microsoft Yammer Anda. Ini termasuk nama pengguna dan kata sandi Microsoft Yammer Anda, serta ID klien dan rahasia klien yang dihasilkan saat Anda membuat OAuth aplikasi di portal Azure. |
| useChangeLog | trueuntuk menggunakan log perubahan Microsoft Yammer untuk menentukan dokumen mana yang perlu diperbarui dalam indeks. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
### Microsoft Yammer JSON skema
```
{
"$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"
]
}
```
## Skema templat MySQL
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`mysql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [MySQL JSON skema](#mysql-json).
Tabel berikut menjelaskan parameter skema MySQL JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### MySQL JSON skema
```
{
"$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"
]
}
```
## Skema templat Oracle Database
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`oracle`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema JSON Database Oracle](#oracle-database-json).
Tabel berikut menjelaskan parameter skema Oracle Database JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### Skema JSON Database Oracle
```
{
"$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"
]
}
```
## Skema Templat PostgreSQL
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Tentukan jenis sumber data sebagai`JDBC`, tipe database sebagai`postgresql`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [PostgreSQL JSON skema](#postgresql-json).
Tabel berikut menjelaskan parameter skema PostgreSQL JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi konfigurasi yang diperlukan untuk menghubungkan sumber data Anda.[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. Tentukan jenis sumber data dan ARN rahasia. |
| dokumen | Daftar objek yang memetakan atribut atau nama bidang konten database Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. Gunakan untuk menyertakan atau mengecualikan konten tertentu dalam sumber data database Anda. |
| PrimaryKey | Berikan kunci utama untuk tabel database. Detail ini mengidentifikasi tabel di dalam basis data Anda. |
| Judul Kolom | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| BodyColumn | Berikan nama kolom judul dokumen dalam tabel database Anda. |
| SqlQuery | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| TimestampColumn | Masukkan nama kolom yang berisi stempel waktu. Amazon Kendra menggunakan informasi cap waktu untuk mendeteksi perubahan dalam konten Anda dan hanya menyinkronkan konten yang diubah. |
| TimestampFormat | Masukkan nama kolom yang berisi format cap waktu yang akan digunakan untuk mendeteksi perubahan konten dan menyinkronkan ulang konten Anda. |
| timezone | Masukkan nama kolom yang berisi zona waktu untuk konten yang akan dirayapi. |
| changeDetectingColumns | Masukkan nama kolom yang Amazon Kendra akan digunakan untuk mendeteksi perubahan konten. Amazon Kendra akan mengindeks ulang konten ketika ada perubahan di salah satu kolom ini |
| allowedUsersColumns | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| allowedGroupsColumn | Masukkan nama kolom yang berisi Pengguna IDs untuk diizinkan mengakses konten. |
| sumber URIColumn | Masukkan nama kolom yang berisi Sumber yang akan URLs diindeks. |
| isSslEnabled | Masukkan pernyataan kueri SQL seperti operasi SELECT dan JOIN. Kueri SQL harus kurang dari 32KB. Amazon Kendra akan merayapi semua konten database yang cocok dengan kueri Anda. |
| jenis | Jenis sumber data. Tentukan JDBC sebagai tipe sumber data Anda. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari rahasia Secrets Manager yang berisi nama pengguna dan kata sandi yang diperlukan untuk terhubung ke database Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"user name": "database user name",
"password": "password"
} |
| versi | Versi template yang saat ini didukung. |
### PostgreSQL JSON skema
```
{
"$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"
]
}
```
## Skema templat Salesforce
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL host Salesforce sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`SALESFORCEV2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema JSON Salesforce](#salesforce-json).
Tabel berikut menjelaskan parameter skema JSON Salesforce.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL instance Salesforce yang akan diindeks. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang entitas Salesforce Anda untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Salesforce Anda. Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"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 | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Kumpulan string yang menentukan entitas mana yang akan difilter. |
| Pola Inklusi [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan file tertentu dalam sumber data Salesforce Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| Pola Pengecualian [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber data Salesforce Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi jenis file ini di akun Salesforce Anda. |
| jenis | Jenis sumber data. Tentukan SALESFORCEV2 sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| versi | Versi template ini yang saat ini didukung. |
### Skema JSON Salesforce
```
{
"$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 skema templat
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL ServiceNow host, jenis otentikasi, dan versi instans sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`SERVICENOWV2`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [ServiceNow Skema JSON](#servicenow-json).
Tabel berikut menjelaskan parameter skema ServiceNow JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL ServiceNow host. Misalnya, your-domain.service-now.com. |
| authType | Jenis otentikasi yang Anda gunakan, apakah basicAuth atauOAuth2. |
| servicenowInstanceVersion | ServiceNow Versi yang Anda gunakan. Anda dapat memilih antaraTokyo,Sandiego,Rome, danOthers. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang artikel ServiceNow pengetahuan Anda, lampiran, katalog layanan, dan insiden untuk Amazon Kendra mengindeks nama bidang. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). Nama bidang sumber ServiceNow data harus ada di metadata ServiceNow kustom Anda. |
| properti tambahan | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| maxFileSizeInMegaBytes | Tentukan batas ukuran file di Amazon Kendra MBs yang akan dirayapi. Amazon Kendra hanya akan merayapi file dalam batas ukuran yang Anda tentukan. Ukuran file default adalah 50MB. Ukuran file maksimum harus lebih besar dari 0MB dan kurang dari atau sama dengan 50MB. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar pola ekspresi reguler untuk menyertakan and/or mengecualikan file tertentu dalam sumber ServiceNow data Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan dan file tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | trueuntuk merayapi artikel ServiceNow pengetahuan, katalog layanan, insiden, dan lampiran. |
| jenis | Jenis sumber data. Tentukan SERVICENOWV2 sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. ServiceNow Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"username": "user name",
"password": "password"
} Jika Anda menggunakan OAuth2 otentikasi, rahasia Anda harus berisi struktur JSON dengan kunci berikut: {
"username": "user name",
"password": "password",
"clientId": "client id",
"clientSecret": "client secret"
} |
| versi | Versi template yang saat ini didukung. |
### ServiceNow Skema 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"
]
}
```
## Skema template kendur
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL host sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`SLACK`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Slack JSON skema](#slack-json).
Tabel berikut menjelaskan parameter skema Slack JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| TeamID | ID tim Slack yang Anda salin dari URL halaman utama Slack Anda. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| Semua | Daftar objek yang memetakan atribut atau nama bidang Slack konten Anda untuk Amazon Kendra mengindeks nama bidang. |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data Anda. |
| Pola Inklusi | Daftar pola ekspresi reguler untuk menyertakan konten tertentu dalam sumber Slack data Anda. Konten yang cocok dengan pola disertakan dalam indeks. Konten yang tidak cocok dengan pola dikecualikan dari indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| Pola Pengecualian | Daftar pola ekspresi reguler untuk mengecualikan konten tertentu di sumber Slack data Anda. Konten yang cocok dengan pola dikecualikan dari indeks. Konten yang tidak cocok dengan pola disertakan dalam indeks. Jika ada konten yang cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan konten tidak disertakan dalam indeks. |
| crawlBotMessages | trueuntuk merayapi pesan bot. |
| dikecualikanDiarsipkan | trueuntuk mengecualikan perayapan pesan yang diarsipkan. |
| ConversationType | Jenis percakapan yang ingin Anda indeks apakahPUBLIC\$1CHANNEL,PRIVATE\$1CHANNEL, GROUP\$1MESSAGE danDIRECT\$1MESSAGE. |
| Filter Saluran | Jenis saluran yang ingin Anda indeks apakah private\$1channel ataupublic\$1channel. |
| Sejak Date | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga Slack konektor merayapi konten berdasarkan spesifiksinceDate. |
| Lookback | Anda dapat memilih untuk mengonfigurasi lookBack parameter sehingga Slack konektor merayapi konten yang diperbarui atau dihapus hingga jumlah jam tertentu sebelum sinkronisasi konektor terakhir Anda. |
| SyncMode | Tentukan bagaimana Amazon Kendra seharusnya memperbarui indeks Anda saat konten sumber data Anda berubah. Anda dapat memilih antara: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) |
| jenis | Jenis sumber data. Tentukan SLACK sebagai tipe sumber data Anda. |
| enableIdentityCrawler | trueuntuk menggunakan Amazon Kendra crawler identitas untuk menyinkronkan identity/principal informasi pada pengguna dan grup dengan akses ke dokumen tertentu. Jika perayap identitas dimatikan, semua dokumen dapat dicari secara publik. Jika Anda ingin menggunakan kontrol akses untuk dokumen dan crawler identitas dimatikan, Anda dapat menggunakan [https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html](https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html)API untuk mengunggah informasi akses pengguna dan grup. |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Anda. Slack Rahasianya harus berisi struktur JSON dengan kunci berikut: {
"slackToken": "token"
} |
| versi | Versi template ini yang saat ini didukung. |
### Slack JSON skema
```
{
"$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"
]
}
```
## Skema template Zendesk
Anda menyertakan JSON yang berisi skema sumber data sebagai bagian dari objek. [TemplateConfiguration](https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html) Anda memberikan URL host sebagai bagian dari konfigurasi koneksi atau detail titik akhir repositori. Juga tentukan jenis sumber data sebagai`ZENDESK`, rahasia untuk kredensyal otentikasi Anda, dan konfigurasi lain yang diperlukan. Anda kemudian menentukan `TEMPLATE` sebagai `Type` saat Anda menelepon [CreateDataSource](https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html).
Anda dapat menggunakan template yang disediakan dalam panduan pengembang ini. Lihat [Skema Zendesk JSON](#zendesk-json).
Tabel berikut menjelaskan parameter skema Zendesk JSON.
| Konfigurasi | Deskripsi |
| --- | --- |
| ConnectionConfiguration | Informasi konfigurasi untuk titik akhir untuk sumber data. |
| repositoryEndpointMetadata | Informasi titik akhir untuk sumber data. |
| HostURL | URL host Zendesk. Misalnya, https://yoursubdomain.zendesk.com. |
| RepositoryConfigurations | Informasi konfigurasi untuk konten sumber data. Misalnya, mengonfigurasi jenis konten dan pemetaan bidang tertentu. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Daftar objek yang memetakan atribut atau nama bidang tiket Zendesk ke nama bidang indeks Amazon Kendra. Untuk informasi lebih lanjut, lihat [Memetakan bidang sumber data](https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html). |
| Sekretarn | Nama Sumber Daya Amazon (ARN) dari AWS Secrets Manager rahasia yang berisi pasangan kunci-nilai yang diperlukan untuk terhubung ke Zendesk Anda. Rahasia harus berisi struktur JSON dengan kunci berikut: URL host, ID klien, rahasia klien, nama pengguna, dan kata sandi. |
| AdditionalProperties | Opsi konfigurasi tambahan untuk konten Anda di sumber data |
| organizationNameFilter | Anda dapat memilih untuk mengindeks tiket yang ada dalam Organisasi tertentu. |
| Sejak Date | Anda dapat memilih untuk mengonfigurasi sinceDate parameter sehingga konektor Zendesk merayapi konten berdasarkan spesifik. sinceDate |
| Pola Inklusi | Daftar pola ekspresi reguler untuk menyertakan file tertentu dalam sumber data Zendesk Anda. File yang cocok dengan pola disertakan dalam indeks. File yang tidak cocok dengan pola dikecualikan dari indeks. Jika file cocok dengan pola inklusi dan pengecualian, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| Pola Pengecualian | Daftar pola ekspresi reguler untuk mengecualikan file tertentu di sumber data Zendesk Anda. File yang cocok dengan pola dikecualikan dari indeks. File yang tidak cocok dengan pola disertakan dalam indeks. Jika file cocok dengan pola pengecualian dan inklusi, pola pengecualian akan diutamakan, dan file tersebut tidak disertakan dalam indeks. |
| [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/id_id/kendra/latest/dg/ds-schemas.html) | Masukkan "true" untuk merayapi jenis konten ini. |
| jenis | Tentukan ZENDESK sebagai tipe sumber data Anda. |
| useChangeLog | Masukkan "true" untuk menggunakan log perubahan Zendesk untuk menentukan dokumen mana yang perlu diperbarui dalam indeks. Tergantung pada ukuran log perubahan, mungkin lebih cepat untuk memindai dokumen di Zendesk. Jika Anda menyinkronkan sumber data Zendesk Anda dengan indeks Anda untuk pertama kalinya, semua dokumen dipindai. |
### Skema 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"
]
}
```