create-data-source

Описание

Создаёт соединитель источника данных, который вы хотите использовать с индексом Amazon Kendra.

Вы указываете имя, тип соединителя источника данных и описание для своего источника данных. Вы также указываете конфигурационную информацию для соединителя источника данных.

CreateDataSource является синхронной операцией. Операция возвращает 200, если источник данных был успешно создан. В противном случае генерируется исключение.

Пример создания индекса и источника данных с использованием Python SDK см. в разделе Начало работы с Python SDK . Пример создания индекса и источника данных с использованием Java SDK см. в разделе Начало работы с Java SDK .

См. также: Документация API AWS

create-data-source использует значения типов документов. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая запись не поддерживает типы документов.

Синтаксис

  create-data-source
--name <value>
--index-id <value>
--type <value>
[--configuration <value>]
[--vpc-configuration <value>]
[--description <value>]
[--schedule <value>]
[--role-arn <value>]
[--tags <value>]
[--client-token <value>]
[--language-code <value>]
[--custom-document-enrichment-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

Имя соединителя источника данных.

--index-id (строка)

Идентификатор индекса, который вы хотите использовать с соединителем источника данных.

--type (строка)

Тип хранилища источника данных. Например, SHAREPOINT .

Возможные значения:

S3
SHAREPOINT
DATABASE
SALESFORCE
ONEDRIVE
SERVICENOW
CUSTOM
CONFLUENCE
GOOGLEDRIVE
WEBCRAWLER
WORKDOCS
FSX
SLACK
BOX
QUIP
JIRA
GITHUB
ALFRESCO
TEMPLATE

--configuration (структура)

Конфигурационная информация для подключения к вашему хранилищу источника данных.

Вы не можете указать параметр Configuration, когда параметр Type установлен на CUSTOM . В противном случае вы получите исключение ValidationException.

Параметр Configuration требуется для всех остальных источников данных.

S3Configuration -> (структура)

Предоставляет конфигурационную информацию для подключения к ведру Amazon S3 в качестве источника данных.

Примечание

Amazon Kendra теперь поддерживает обновлённый соединитель Amazon S3.

Теперь вы должны использовать объект TemplateConfiguration вместо объекта S3DataSourceConfiguration для настройки соединителя.

Соединители, настроенные с использованием более старой архитектуры консоли и API, будут продолжать работать в соответствии с текущей настройкой. Однако вы не сможете их редактировать или обновлять. Если вы хотите редактировать или обновлять конфигурацию соединителя, вы должны создать новый соединитель.

Мы рекомендуем мигрировать ваш рабочий процесс соединителя на обновлённую версию. Поддержка соединителей, настроенных с использованием более старой архитектуры, будет прекращена к июню 2024 года.

BucketName -> (строка)

Имя ведра, содержащего документы.

InclusionPrefixes -> (список)

Список префиксов S3 для документов, которые должны быть включены в индекс.

(строка)

InclusionPatterns -> (список)

Список шаблонов glob (шаблоны, которые могут расширить шаблон подстановки на список имён путей, соответствующих данному шаблону) для определённых имён файлов и типов файлов, которые нужно включить в индекс. Если документ соответствует как префиксу или шаблону включения, так и исключения, префикс исключения имеет приоритет, и документ не индексируется. Примеры шаблонов glob включают:

/myapp/config/* —Все файлы внутри каталога config.
/*.png* —Все файлы .png во всех каталогах.
/*.{png, ico, md}* —Все файлы .png, .ico или .md во всех каталогах.
/myapp/src/*/*.ts —Все файлы .ts внутри каталога src (и всех его подкаталогов).
/!(.module).ts* —Все файлы .ts, кроме .module.ts.
.png, .jpg —Все файлы изображений PNG и JPEG в каталоге (файлы с расширениями .png и .jpg).
internal —Все файлы в каталоге, содержащие «internal» в имени файла, такие как «internal», «internal_only», «company_internal».
*/*internal —Все файлы, относящиеся к внутреннему пользованию, в каталоге и его подкаталогах.

Для получения дополнительных примеров см. Использование фильтров исключения и включения в справке по командам Amazon Web Services CLI.

(строка)

ExclusionPatterns -> (список)

Список шаблонов glob (шаблоны, которые могут расширить шаблон подстановки на список имён путей, соответствующих данному шаблону) для определённых имён файлов и типов файлов, которые нужно исключить из индекса. Если документ соответствует как префиксу или шаблону включения, так и исключения, префикс исключения имеет приоритет, и документ не индексируется. Примеры шаблонов glob включают:

/myapp/config/* —Все файлы внутри каталога config.
/*.png* —Все файлы .png во всех каталогах.
/*.{png, ico, md}* —Все файлы .png, .ico или .md во всех каталогах.
/myapp/src/*/*.ts —Все файлы .ts внутри каталога src (и всех его подкаталогов).
/!(.module).ts* —Все файлы .ts, кроме .module.ts.
.png, .jpg —Все файлы изображений PNG и JPEG в каталоге (файлы с расширениями .png и .jpg).
internal —Все файлы в каталоге, содержащие «internal» в имени файла, такие как «internal», «internal_only», «company_internal».
*/*internal —Все файлы, относящиеся к внутреннему пользованию, в каталоге и его подкаталогах.

(строка)

DocumentsMetadataConfiguration -> (структура)

Файлы метаданных документов, содержащие информацию, такую как сведения об управлении доступом к документу, исходный URI, автор документа и пользовательские атрибуты. Каждый файл метаданных содержит метаданные об одном документе.

S3Prefix -> (строка)

Префикс, используемый для фильтрации файлов конфигурации метаданных в ведре Amazon Web Services S3. Ведро S3 может содержать несколько файлов метаданных. Используйте S3Prefix, чтобы включить только необходимые файлы метаданных.

AccessControlListConfiguration -> (структура)

Предоставляет путь к ведру S3, содержащему файлы фильтрации контекста пользователя для источника данных. Формат файла см. в разделе Управление доступом к источникам данных S3 .

KeyPath -> (строка)

Путь к ведру Amazon S3, содержащему файлы ACL.

SharePointConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Microsoft SharePoint в качестве источника данных.

SharePointVersion -> (строка)

Версия Microsoft SharePoint, которую вы используете.

Urls -> (список)

URL-адреса сайтов Microsoft SharePoint для документов, которые вы хотите проиндексировать.

(строка)

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, содержащего имя пользователя и пароль, необходимые для подключения к экземпляру SharePoint. Дополнительную информацию см. в разделе Microsoft SharePoint.

CrawlAttachments -> (булево)

TRUE для индексирования вложений документов.

UseChangeLog -> (булево)

TRUE для использования журнала изменений SharePoint для определения документов, которые требуют обновления в индексе. В зависимости от размера журнала изменений Amazon Kendra может тратить больше времени на использование журнала изменений, чем на сканирование всех ваших документов в SharePoint.

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных документов в ваш SharePoint. Документы, соответствующие шаблонам, включаются в индекс. Документы, не соответствующие шаблонам, исключаются из индекса. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.

Регулярное выражение применяется к URL-адресу отображения документа SharePoint.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных документов в вашем SharePoint. Документы, соответствующие шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.

Регулярное выражение применяется к URL-адресу отображения документа SharePoint.

(строка)

VpcConfiguration -> (структура)

Конфигурационная информация для Amazon Virtual Private Cloud для подключения к вашему Microsoft SharePoint. Дополнительную информацию см. в разделе Настройка VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь исходящий доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешить Amazon Kendra подключаться к источнику данных.

(строка)

FieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей источника данных SharePoint с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями SharePoint. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных SharePoint должны существовать в вашей пользовательской метаданных SharePoint.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.

IndexFieldName -> (строка)

Имя поля индекса, которое нужно сопоставить с полем источника данных. Тип поля индекса должен соответствовать типу поля источника данных.

DocumentTitleFieldName -> (строка)

Поле атрибута Microsoft SharePoint, содержащее заголовок документа.

DisableLocalGroups -> (булево)

TRUE для отключения информации о локальных группах.

SslCertificateS3Path -> (структура)

Путь к сертификату SSL, хранящемуся в ведре Amazon S3. Используется для подключения к SharePoint Server, если требуется защищенное SSL-соединение.

Вы можете сгенерировать самозаверяющий X509-сертификат на любом компьютере, используя OpenSSL. Пример использования OpenSSL для создания X509-сертификата см. в разделе Создание и подписание X509-сертификата.

Bucket -> (строка)

Имя ведра S3, содержащего файл.

Key -> (строка)

Имя файла.

AuthenticationType -> (строка)

Тип подключения к SharePoint Online: базовая аутентификация (имя пользователя и пароль), OAuth-аутентификация (имя пользователя, пароль, идентификатор клиента и секрет клиента) или аутентификация приложения AD (секрет клиента).

ProxyConfiguration -> (структура)

Конфигурационная информация для подключения к вашим URL-адресам сайта Microsoft SharePoint через веб-прокси. Можно использовать для SharePoint Server.

Необходимо указать имя хоста веб-сайта и номер порта. Например, имя хоста https://a.example.com/page1.html — “a.example.com”, порт — 443 (стандартный порт HTTPS).

Учетные данные прокси-сервера необязательны и могут использоваться для подключения к веб-прокси-серверу, требующему базовой аутентификации (имя пользователя и пароль). Для хранения учетных данных прокси-сервера используется секрет в Secrets Manager.

Рекомендуется соблюдать лучшие практики безопасности при настройке веб-прокси, включая настройку ограничения скорости, ведение журнала и мониторинг, а также регулярное применение обновлений безопасности. Если вы используете веб-прокси с несколькими источниками данных, одновременные задачи синхронизации могут нагрузить прокси-сервер. Рекомендуется заранее подготовить прокси к любым требованиям безопасности и нагрузки.

Host -> (строка)

Имя хоста веб-сайта, к которому нужно подключиться через веб-прокси-сервер.

Например, имя хоста https://a.example.com/page1.html — “a.example.com”.

Port -> (целое число)

Номер порта хоста веб-сайта, к которому нужно подключиться через веб-прокси-сервер.

Например, порт для https://a.example.com/page1.html — 443 (стандартный порт HTTPS).

Credentials -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager. Создайте секрет для хранения учетных данных в Secrets Manager.

Учетные данные необязательны. Используйте секрет, если для подключения к хосту веб-сайта требуются учетные данные прокси-сервера. Amazon Kendra в настоящее время поддерживает базовую аутентификацию для подключения к веб-прокси-серверу. Секрет хранит ваши учетные данные.

DatabaseConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к базе данных в качестве источника данных.

DatabaseEngineType -> (строка)

Тип движка базы данных, который выполняет базу данных.

ConnectionConfiguration -> (структура)

Конфигурационная информация, необходимая для подключения к базе данных.

DatabaseHost -> (строка)

Имя хоста базы данных. Может быть либо строкой (host.subdomain.domain.tld), либо IPv4 или IPv6-адресом.

DatabasePort -> (целое число)

Порт, используемый базой данных для подключений.

DatabaseName -> (строка)

Имя базы данных, содержащей данные документа.

TableName -> (строка)

Имя таблицы, содержащей данные документа.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, хранящего учетные данные. Учетные данные должны быть парой «имя пользователя — пароль». Дополнительную информацию см. в разделе Использование источника данных базы данных. Дополнительную информацию о Secrets Manager см. в руководстве пользователя Secrets Manager.

VpcConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Amazon VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключаться друг к другу в VPC и должны иметь доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключение к источнику данных.

(строка)

ColumnConfiguration -> (структура)

Информация о том, откуда индекс должен получать информацию о документе из базы данных.

DocumentIdColumnName -> (строка)

Столбец, предоставляющий идентификатор документа.

DocumentDataColumnName -> (строка)

Столбец, содержащий содержимое документа.

DocumentTitleColumnName -> (строка)

Столбец, содержащий заголовок документа.

FieldMappings -> (список)

Массив объектов, сопоставляющих имена столбцов базы данных соответствующим полям в индексе. Сначала вы должны создать поля в индексе с помощью API UpdateIndex.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала вы должны создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вам необходимо указать формат даты. Если поле не является полем даты, генерируется исключение.

IndexFieldName -> (строка)

ChangeDetectingColumns -> (список)

От одного до пяти столбцов, указывающих, когда документ в базе данных был изменен.

(строка)

AclConfiguration -> (структура)

Информация о столбце базы данных, который предоставляет информацию для фильтрации по контексту пользователя.

AllowedGroupsColumnName -> (строка)

Список групп, разделенных точкой с запятой, которые фильтруют ответ запроса на основе контекста пользователя. Документ возвращается только пользователям, которые входят в одну из групп, указанных в поле UserContext API Query.

SqlConfiguration -> (структура)

Предоставляет информацию о том, как Amazon Kendra использует кавычки вокруг идентификаторов SQL при запросе к источнику данных базы данных.

QueryIdentifiersEnclosingOption -> (строка)

Определяет, заключает ли Amazon Kendra идентификаторы SQL для таблиц и имен столбцов в двойные кавычки (”) при выполнении запроса к базе данных.

По умолчанию Amazon Kendra передает идентификаторы SQL так, как они введены в конфигурацию источника данных. Он не изменяет регистр идентификаторов и не заключает их в кавычки.

Система PostgreSQL преобразует заглавные буквы в строчные в идентификаторах, если они не заключены в кавычки. Выбор этого параметра заключит идентификаторы в кавычки, чтобы PostgreSQL не преобразовывал регистр символов.

Для баз данных MySQL необходимо включить параметр ansi_quotes, когда это поле установлено в значение DOUBLE_QUOTES.

SalesforceConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Salesforce в качестве источника данных.

ServerUrl -> (строка)

URL экземпляра сайта Salesforce, который вы хотите проиндексировать.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета из Secrets Manager, содержащего пары ключ/значение, необходимые для подключения к вашему экземпляру Salesforce. Секрет должен содержать JSON-структуру со следующими ключами:

authenticationUrl - Конечная точка OAUTH, к которой Amazon Kendra подключается для получения токена OAUTH.
consumerKey - Открытый ключ приложения, сгенерированный при создании вашего приложения Salesforce.
consumerSecret - Закрытый ключ приложения, сгенерированный при создании вашего приложения Salesforce.
password - Пароль, связанный с пользователем, который входит в экземпляр Salesforce.
securityToken - Токен, связанный с пользователем, который входит в экземпляр Salesforce.
username - Имя пользователя пользователя, который входит в экземпляр Salesforce.

StandardObjectConfigurations -> (список)

Настройка стандартных объектов Salesforce, которые индексирует Amazon Kendra.

(структура)

Предоставляет конфигурационную информацию для индексирования одного стандартного объекта.

Name -> (строка)

Имя стандартного объекта.

DocumentDataFieldName -> (строка)

Имя поля в таблице стандартного объекта, содержащего содержимое документа.

DocumentTitleFieldName -> (строка)

Имя поля в таблице стандартного объекта, содержащего заголовок документа.

FieldMappings -> (список)

Сопоставляет атрибуты или имена полей стандартного объекта с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.

IndexFieldName -> (строка)

Имя поля индекса для сопоставления с полем источника данных. Тип поля индекса должен совпадать с типом поля источника данных.

KnowledgeArticleConfiguration -> (структура)

Конфигурационная информация для типов статей базы знаний, которые индексирует Amazon Kendra. Amazon Kendra индексирует стандартные статьи базы знаний и стандартные поля статей базы знаний или пользовательские поля пользовательских статей базы знаний, но не оба.

IncludedStates -> (список)

Указывает состояния документов, которые следует включать при индексировании Amazon Kendra статей базы знаний. Вы должны указать по крайней мере одно состояние.

(строка)

StandardKnowledgeArticleTypeConfiguration -> (структура)

Конфигурационная информация для стандартных статей базы знаний Salesforce.

DocumentDataFieldName -> (строка)

Имя поля, содержащего данные документа для индексации.

DocumentTitleFieldName -> (строка)

Имя поля, содержащего заголовок документа.

FieldMappings -> (список)

Сопоставляет атрибуты или имена полей статьи базы знаний с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

CustomKnowledgeArticleTypeConfigurations -> (список)

Конфигурационная информация для пользовательских статей базы знаний Salesforce.

(структура)

Предоставляет конфигурационную информацию для индексирования пользовательских статей Salesforce.

Name -> (строка)

Имя конфигурации.

DocumentDataFieldName -> (строка)

Имя поля в пользовательской статье базы знаний, содержащей данные документа для индексации.

DocumentTitleFieldName -> (строка)

Имя поля в пользовательской статье базы знаний, содержащей заголовок документа.

FieldMappings -> (список)

Сопоставляет атрибуты или имена полей пользовательской статьи базы знаний с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

ChatterFeedConfiguration -> (структура)

Конфигурационная информация для лент обмена Salesforce.

DocumentDataFieldName -> (строка)

Имя столбца в таблице Salesforce FeedItem, содержащее содержимое для индексации. Обычно это столбец Body.

DocumentTitleFieldName -> (строка)

Имя столбца в таблице Salesforce FeedItem, содержащее заголовок документа. Обычно это столбец Title.

FieldMappings -> (список)

Сопоставляет поля из ленты обмена Salesforce с полями индекса Amazon Kendra.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IncludeFilterTypes -> (список)

Фильтрует документы в ленте на основе статуса пользователя. При указании ACTIVE_USERS индексируются только документы пользователей с активным аккаунтом. При указании STANDARD_USER документируются только документы стандартных пользователей Salesforce. Вы можете указать оба.

(строка)

CrawlAttachments -> (булево)

Указывает, должен ли Amazon Kendra индексировать вложения к объектам Salesforce.

StandardObjectAttachmentConfiguration -> (структура)

Конфигурационная информация для обработки вложений к стандартным объектам Salesforce.

DocumentTitleFieldName -> (строка)

Имя поля, используемого для заголовка документа.

FieldMappings -> (список)

Один или несколько объектов, которые сопоставляют поля вложений с полями индекса Amazon Kendra.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IncludeAttachmentFilePatterns -> (список)

Список шаблонов регулярных выражений для включения определенных документов в Salesforce. Документы, соответствующие шаблонам, включаются в индекс. Документы, не соответствующие шаблонам, исключаются из индекса. Если документ соответствует как включению, так и исключению, шаблон исключения имеет приоритет, и документ не включается в индекс.

Шаблон применяется к имени прикрепленного файла.

(строка)

ExcludeAttachmentFilePatterns -> (список)

Список регулярных выражений, исключающих определенные документы в Salesforce. Документы, соответствующие шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.

Шаблон применяется к имени прикрепленного файла.

(строка)

OneDriveConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Microsoft OneDrive в качестве источника данных.

TenantDomain -> (строка)

Домен Azure Active Directory организации.

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, содержащий имя пользователя и пароль для подключения к OneDrive. Имя пользователя должно быть идентификатором приложения OneDrive, а пароль — ключом приложения OneDrive.

OneDriveUsers -> (структура)

Список учетных записей пользователей, документы которых должны быть проиндексированы.

OneDriveUserList -> (список)

Список пользователей, чьи документы должны быть проиндексированы. Укажите имена пользователей в формате электронной почты, например, username@tenantdomain. Если вам нужно проиндексировать документы более чем 10 пользователей, используйте поле OneDriveUserS3Path для указания расположения файла, содержащего список пользователей.

(строка)

OneDriveUserS3Path -> (структура)

Расположение в S3-бакете файла, содержащего список пользователей, чьи документы должны быть проиндексированы.

Bucket -> (строка)

Имя S3-бакета, содержащего файл.

Key -> (строка)

Имя файла.

InclusionPatterns -> (список)

Список регулярных выражений, включающих определенные документы в OneDrive. Документы, соответствующие шаблонам, включаются в индекс. Документы, не соответствующие шаблонам, исключаются из индекса. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.

Шаблон применяется к имени файла.

(строка)

ExclusionPatterns -> (список)

Список регулярных выражений, исключающих определенные документы в OneDrive. Документы, соответствующие шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.

Шаблон применяется к имени файла.

(строка)

FieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей источника OneDrive с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями OneDrive. Дополнительная информация см. в разделе Сопоставление полей источника данных. Имена полей источника OneDrive должны существовать в пользовательских метаданных OneDrive.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, возникает исключение.

IndexFieldName -> (строка)

Имя поля индекса, сопоставляемого с полем источника данных. Тип поля индекса должен соответствовать типу поля источника данных.

DisableLocalGroups -> (булево)

TRUE для отключения информации о локальных группах.

ServiceNowConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к ServiceNow в качестве источника данных.

HostUrl -> (string)

Инстанция ServiceNow, к которой подключается источник данных. Конечная точка хоста должна выглядеть следующим образом: {instance}.service-now.com.

SecretArn -> (string)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего имя пользователя и пароль, необходимые для подключения к инстанции ServiceNow. Вы также можете предоставить учетные данные аутентификации OAuth с именем пользователя, паролем, идентификатором клиента и секретом клиента. Дополнительную информацию см. в разделе Использование источника данных ServiceNow.

ServiceNowBuildVersion -> (string)

Идентификатор релиза, на котором работает хост ServiceNow. Если хост не работает на релизе LONDON, используйте OTHERS.

KnowledgeArticleConfiguration -> (structure)

Конфигурационная информация для сканирования статей базы знаний на сайте ServiceNow.

CrawlAttachments -> (boolean)

TRUE для индексирования вложений к статьям базы знаний.

IncludeAttachmentFilePatterns -> (list)

Список шаблонов регулярных выражений, применяемых для включения вложений к статьям базы знаний. Вложения, соответствующие шаблонам, включаются в индекс. Элементы, не соответствующие шаблонам, исключаются из индекса. Если элемент соответствует как включению, так и исключению, шаблон исключения имеет приоритет, и элемент не включается в индекс.

(string)

ExcludeAttachmentFilePatterns -> (list)

Список шаблонов регулярных выражений, применяемых для исключения определенных вложений к статьям базы знаний. Вложения, соответствующие шаблонам, исключаются из индекса. Элементы, не соответствующие шаблонам, включаются в индекс. Если элемент соответствует как включению, так и исключению, шаблон исключения имеет приоритет, и элемент не включается в индекс.

(string)

DocumentDataFieldName -> (string)

Имя поля ServiceNow, сопоставленного с полем содержимого документа индекса в индексе Amazon Kendra.

DocumentTitleFieldName -> (string)

Имя поля ServiceNow, сопоставленного с полем заголовка документа индекса.

FieldMappings -> (list)

Сопоставляет атрибуты или имена полей статей базы знаний с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями ServiceNow. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных ServiceNow должны существовать в вашей пользовательской метаданных ServiceNow.

(structure)

DataSourceFieldName -> (string)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (string)

IndexFieldName -> (string)

Имя поля индекса, которое необходимо сопоставить с полем источника данных. Тип поля индекса должен совпадать с типом поля источника данных.

FilterQuery -> (string)

Запрос, выбирающий статьи базы знаний для индексирования. Запрос может возвращать статьи из нескольких баз знаний, которые могут быть общедоступными или частными.

Строка запроса должна быть сгенерирована консолью ServiceNow. Дополнительную информацию см. в разделе Указание индексируемых документов с помощью запроса.

ServiceCatalogConfiguration -> (structure)

Конфигурационная информация для сканирования каталогов услуг на сайте ServiceNow.

CrawlAttachments -> (boolean)

TRUE для индексирования вложений к элементам каталога услуг.

IncludeAttachmentFilePatterns -> (list)

Список шаблонов регулярных выражений для включения определенных вложений каталогов в вашей ServiceNow. Элементы, соответствующие шаблонам, включаются в индекс. Элементы, не соответствующие шаблонам, исключаются из индекса. Если элемент соответствует как включению, так и исключению, шаблон исключения имеет приоритет, и элемент не включается в индекс.

Регулярное выражение применяется к имени файла вложения.

(string)

ExcludeAttachmentFilePatterns -> (list)

Список шаблонов регулярных выражений для исключения определенных вложений каталогов в вашей ServiceNow. Элементы, соответствующие шаблонам, исключаются из индекса. Элементы, не соответствующие шаблонам, включаются в индекс. Если элемент соответствует как включению, так и исключению, шаблон исключения имеет приоритет, и элемент не включается в индекс.

Регулярное выражение применяется к имени файла вложения.

(string)

DocumentDataFieldName -> (string)

Имя поля ServiceNow, сопоставленного с полем содержимого документа индекса в индексе Amazon Kendra.

DocumentTitleFieldName -> (string)

Имя поля ServiceNow, сопоставленного с полем заголовка документа индекса.

FieldMappings -> (list)

Сопоставляет атрибуты или имена полей каталогов с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями ServiceNow. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных ServiceNow должны существовать в вашей пользовательской метаданных ServiceNow.

(structure)

DataSourceFieldName -> (string)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (string)

IndexFieldName -> (string)

AuthenticationType -> (string)

Тип аутентификации, используемой для подключения к инстанции ServiceNow. Если вы выберете HTTP_BASIC, Amazon Kendra аутентифицируется с помощью имени пользователя и пароля, предоставленных в секрете Secrets Manager в поле SecretArn. Если вы выберете OAUTH2, Amazon Kendra аутентифицируется с использованием учетных данных идентификатора клиента, секрета клиента, имени пользователя и пароля.

При использовании аутентификации OAUTH2 необходимо сгенерировать токен и секрет клиента с помощью консоли ServiceNow. Дополнительную информацию см. в разделе Использование источника данных ServiceNow.

ConfluenceConfiguration -> (structure)

Предоставляет конфигурационную информацию для подключения к Confluence в качестве источника данных.

ServerUrl -> (строка)

URL вашего экземпляра Confluence. Используйте полный URL сервера. Например, https://server.example.com:port/ . Вы также можете использовать IP-адрес, например, https://192.168.1.113/ .

SecretArn -> (строка)

Идентификатор ресурса Amazon (ARN) секрета Secrets Manager, содержащего имя пользователя и пароль, необходимые для подключения к экземпляру Confluence. Если вы используете Confluence Cloud, в качестве пароля используется сгенерированный API-токен.

Вы также можете указать учетные данные для аутентификации в виде личного токена доступа. Дополнительные сведения см. в разделе Использование источника данных Confluence.

Version -> (строка)

Версия или тип установки Confluence для подключения.

SpaceConfiguration -> (структура)

Конфигурационная информация для индексирования пространств Confluence.

CrawlPersonalSpaces -> (булево)

TRUE для индексирования личных пространств. Вы можете добавить ограничения к элементам в личных пространствах. Если личные пространства индексируются, запросы без информации о контексте пользователя могут возвращать ограниченные элементы из личного пространства в результатах. Дополнительные сведения см. в разделе Фильтрация по контексту пользователя.

CrawlArchivedSpaces -> (булево)

TRUE для индексирования архивированных пространств.

IncludeSpaces -> (список)

Список ключей пространств Confluence. Если вы включаете ключ, блоги, документы и вложения в пространстве индексируются. Пространства, которые не включены в список, не индексируются. Пространство в списке должно существовать. В противном случае Amazon Kendra запишет ошибку при синхронизации источника данных. Если пространство находится как в списке IncludeSpaces, так и в списке ExcludeSpaces, пространство исключается.

(строка)

ExcludeSpaces -> (список)

Список ключей пространств Confluence. Если вы включаете ключ, блоги, документы и вложения в пространстве не индексируются. Если пространство находится как в списке ExcludeSpaces, так и в списке IncludeSpaces, пространство исключается.

(строка)

SpaceFieldMappings -> (список)

Сопоставляет атрибуты или имена полей пространств Confluence с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.

Если вы укажете параметр SpaceFieldMappings, вы должны указать как минимум одно сопоставление полей.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

Имя поля индекса для сопоставления с полем источника данных Confluence. Тип поля индекса должен соответствовать типу поля Confluence.

PageConfiguration -> (структура)

Конфигурационная информация для индексирования страниц Confluence.

PageFieldMappings -> (список)

Сопоставляет атрибуты или имена полей страниц Confluence с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.

Если вы укажете параметр PageFieldMappings, вы должны указать как минимум одно сопоставление полей.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

BlogConfiguration -> (структура)

Конфигурационная информация для индексирования блогов Confluence.

BlogFieldMappings -> (список)

Сопоставляет атрибуты или имена полей блогов Confluence с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.

Если вы укажете параметр BlogFieldMappings, вы должны указать как минимум одно сопоставление полей.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

AttachmentConfiguration -> (структура)

Конфигурационная информация для индексирования вложений к блогам и страницам Confluence.

CrawlAttachments -> (булево)

TRUE для индексирования вложений к страницам и блогам в Confluence.

AttachmentFieldMappings -> (список)

Сопоставляет атрибуты или имена полей вложений Confluence с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.

Если вы укажете параметр AttachentFieldMappings, вы должны указать как минимум одно сопоставление полей.

(структура)

Сопоставляет атрибуты или имена полей вложений Confluence с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Confuence должны существовать в вашей пользовательской метаданных Confluence.

DataSourceFieldName -> (строка)

Имя поля в источнике данных.

Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

VpcConfiguration -> (структура)

Конфигурационная информация для виртуальной частной сети Amazon (VPC) для подключения к вашей Confluence. Дополнительные сведения см. в разделе Настройка VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей VPC Amazon. Подсети должны иметь возможность подключения друг к другу в VPC, и у них должен быть внешний доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей VPC Amazon. Группы безопасности должны разрешать Amazon Kendra подключение к источнику данных.

(строка)

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных сообщений блога, страниц, пространств или вложений в вашем Confluence. Контент, соответствующий шаблонам, включается в индекс. Контент, не соответствующий шаблонам, исключается из индекса. Если контент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и контент не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных сообщений блога, страниц, пространств или вложений в вашем Confluence. Контент, соответствующий шаблонам, исключается из индекса. Контент, не соответствующий шаблонам, включается в индекс. Если контент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и контент не включается в индекс.

(строка)

ProxyConfiguration -> (структура)

Информация о конфигурации для подключения к вашему экземпляру Confluence URL через веб-прокси. Вы можете использовать этот параметр для Confluence Server.

Вы должны указать имя хоста сайта и номер порта. Например, имя хоста https://a.example.com/page1.html — это “a.example.com”, а порт — 443, стандартный порт для HTTPS.

Веб-прокси-кредиты необязательны, и вы можете использовать их для подключения к веб-прокси-серверу, который требует базовой аутентификации по имени пользователя и паролю. Для хранения веб-прокси-кредитов используйте секрет в Secrets Manager.

Рекомендуется соблюдать лучшие практики безопасности при настройке веб-прокси. Это включает настройку ограничения, настройку ведения журнала и мониторинга, а также регулярное применение обновлений безопасности. Если вы используете свой веб-прокси с несколькими источниками данных, синхронизационные задачи, которые выполняются одновременно, могут перегрузить прокси. Рекомендуется предварительно подготовить свой прокси к любым требованиям безопасности и нагрузки.

Host -> (строка)

Имя хоста веб-сайта, к которому вы хотите подключиться через веб-прокси-сервер.

Например, имя хоста https://a.example.com/page1.html — “a.example.com”.

Port -> (целое число)

Номер порта хоста веб-сайта, к которому вы хотите подключиться через веб-прокси-сервер.

Например, порт для https://a.example.com/page1.html — 443, стандартный порт для HTTPS.

Credentials -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager. Вы создаёте секрет для хранения ваших учетных данных в Secrets Manager.

Учетные данные необязательны. Вы используете секрет, если для подключения к хосту веб-сайта требуются веб-прокси-кредиты. Amazon Kendra в настоящее время поддерживает базовая аутентификация для подключения к веб-прокси-серверу. Секрет хранит ваши учетные данные.

AuthenticationType -> (строка)

Вы хотите подключиться к Confluence с помощью базовой аутентификации по имени пользователя и паролю или личного токена доступа. Для Confluence Server можно использовать личный токен доступа.

GoogleDriveConfiguration -> (структура)

Предоставляет информацию о конфигурации для подключения к Google Диску в качестве источника данных.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего учетные данные, необходимые для подключения к Google Диску. Дополнительную информацию см. в разделе Использование источника данных Google Workspace Drive.

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных элементов в вашем Google Диске, включая общие диски и «Мои Драйвы» пользователей. Элементы, соответствующие шаблонам, включаются в индекс. Элементы, которые не соответствуют шаблонам, исключаются из индекса. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных элементов в вашем Google Диске, включая общие диски и «Мои Драйвы» пользователей. Элементы, соответствующие шаблонам, исключаются из индекса. Элементы, не соответствующие шаблонам, включаются в индекс. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.

(строка)

FieldMappings -> (список)

Сопоставляет атрибуты или имена полей источника данных Google Диска с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Google Диска. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных Google Диска должны существовать в вашей пользовательской метаданных Google Диска.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала вы должны создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

Имя поля индекса для сопоставления с полем источника данных. Тип поля индекса должен соответствовать типу поля источника данных.

ExcludeMimeTypes -> (список)

Список MIME-типов, которые следует исключить из индекса. Все документы, соответствующие указанному MIME-типу, исключаются.

Список MIME-типов см. в разделе Использование источника данных Google Workspace Drive.

(строка)

ExcludeUserAccounts -> (список)

Список адресов электронной почты пользователей. Документы, принадлежащие этим пользователям, исключаются из индекса. Документы, общие с исключенными пользователями, индексируются, если они не исключаются другим способом.

(строка)

ExcludeSharedDrives -> (список)

Список идентификаторов или общих дисков, которые следует исключить из индекса. Все файлы и папки, хранящиеся на общем диске, исключаются.

(строка)

WebCrawlerConfiguration -> (структура)

Предоставляет конфигурационную информацию, необходимую для веб-сканера Amazon Kendra.

Urls -> (структура)

Определяет начальные URL-адреса веб-сайтов или URL-адреса Sitemap веб-сайтов, которые вы хотите просканировать.

Вы можете включать поддомены веб-сайтов. Вы можете указать до 100 начальных URL-адресов и до трех URL-адресов Sitemap.

Вы можете сканировать только веб-сайты, использующие протокол защищенной связи Hypertext Transfer Protocol Secure (HTTPS). Если при сканировании веб-сайта возникает ошибка, это может означать, что доступ к нему для сканирования заблокирован.

При выборе веб-сайтов для индексирования необходимо соблюдать «Политику приемлемого использования Amazon» __ и все другие условия Amazon. Помните, что вы можете использовать Amazon Kendra Web Crawler только для индексирования собственных веб-страниц или веб-страниц, для индексирования которых у вас есть разрешение.

SeedUrlConfiguration -> (структура)

Настройка начальных URL-адресов веб-сайтов, которые вы хотите просканировать.

Вы можете выбрать сканирование только имен хостов веб-сайтов, или имен хостов веб-сайтов с поддоменами, или имен хостов веб-сайтов с поддоменами и другими доменами, к которым ссылаются веб-страницы.

Вы можете указать до 100 начальных URL-адресов.

SeedUrls -> (список)

Список начальных URL-адресов веб-сайтов, которые вы хотите просканировать.

Список может содержать не более 100 начальных URL-адресов.

(строка)

WebCrawlerMode -> (строка)

Вы можете выбрать один из следующих режимов:

HOST_ONLY —сканировать только имена хостов веб-сайтов. Например, если начальный URL-адрес — «abc.example.com», то сканируются только URL-адреса с именем хоста «abc.example.com».
SUBDOMAINS —сканировать имена хостов веб-сайтов с поддоменами. Например, если начальный URL-адрес — «abc.example.com», то также сканируются «a.abc.example.com» и «b.abc.example.com».
EVERYTHING —сканировать имена хостов веб-сайтов с поддоменами и другими доменами, к которым ссылаются веб-страницы.

По умолчанию режим установлен на HOST_ONLY.

SiteMapsConfiguration -> (структура)

Настройка URL-адресов Sitemap веб-сайтов, которые вы хотите просканировать.

Сканируются только URL-адреса, принадлежащие тем же именам хостов веб-сайтов. Вы можете указать до трех URL-адресов Sitemap.

SiteMaps -> (список)

Список URL-адресов Sitemap веб-сайтов, которые вы хотите просканировать.

Список может содержать не более трех URL-адресов Sitemap.

(строка)

CrawlDepth -> (целое число)

«Глубина» или количество уровней от начального уровня для сканирования. Например, страница с начальным URL-адресом имеет глубину 1, а любые гиперссылки на этой странице, которые также сканируются, имеют глубину 2.

MaxLinksPerPage -> (целое число)

Максимальное количество URL-адресов на веб-странице, которые следует включить при сканировании веб-сайта. Это число относится к каждой веб-странице.

При сканировании веб-страниц веб-сайта также сканируются все URL-адреса, к которым ссылаются эти страницы. URL-адреса на веб-странице сканируются в порядке их появления.

По умолчанию максимальное количество ссылок на страницу составляет 100.

MaxContentSizePerPageInMegaBytes -> (вещественное число)

Максимальный размер (в МБ) веб-страницы или вложения для сканирования.

Файлы, размер которых превышает этот размер (в МБ), пропускаются/не сканируются.

По умолчанию максимальный размер веб-страницы или вложения составляет 50 МБ.

MaxUrlsPerMinuteCrawlRate -> (целое число)

Максимальное количество URL-адресов, сканируемых в минуту на один хост веб-сайта.

Минимальное количество URL-адресов — один.

По умолчанию максимальное количество URL-адресов, сканируемых в минуту на один хост веб-сайта, составляет 300.

UrlInclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных URL-адресов для сканирования. URL-адреса, соответствующие шаблонам, включаются в индекс. URL-адреса, не соответствующие шаблонам, исключаются из индекса. Если URL-адрес соответствует как шаблону включения, так и шаблону исключения, шаблон исключения имеет приоритет, и файл URL-адреса не включается в индекс.

(строка)

UrlExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных URL-адресов для сканирования. URL-адреса, соответствующие шаблонам, исключаются из индекса. URL-адреса, не соответствующие шаблонам, включаются в индекс. Если URL-адрес соответствует как шаблону включения, так и шаблону исключения, шаблон исключения имеет приоритет, и файл URL-адреса не включается в индекс.

(строка)

ProxyConfiguration -> (структура)

Конфигурационная информация, необходимая для подключения к внутренним веб-сайтам через веб-прокси.

Вы должны указать имя хоста и номер порта веб-сайта. Например, имя хоста https://a.example.com/page1.html — «a.example.com», а порт — 443, стандартный порт для HTTPS.

Учётные данные прокси-сервера необязательны, и вы можете использовать их для подключения к прокси-серверу, который требует аутентификации по схеме basic. Для хранения учетных данных веб-прокси вы используете секрет в Secrets Manager.

Host -> (строка)

Имя хоста веб-сайта, к которому вы хотите подключиться через веб-прокси-сервер.

Например, имя хоста https://a.example.com/page1.html — «a.example.com».

Port -> (целое число)

Номер порта хоста веб-сайта, к которому вы хотите подключиться через веб-прокси-сервер.

Например, порт для https://a.example.com/page1.html — 443, стандартный порт для HTTPS.

Credentials -> (строка)

Amazon Resource Name (ARN) секрета из Secrets Manager. Вы создаете секрет для хранения учетных данных в Secrets Manager

Учетные данные необязательны. Вы используете секрет, если для подключения к хосту веб-сайта требуется аутентификация веб-прокси. Amazon Kendra в настоящее время поддерживает аутентификацию по схеме basic для подключения к веб-прокси-серверу. Секрет хранит ваши учетные данные.

AuthenticationConfiguration -> (структура)

Конфигурационная информация, необходимая для подключения к веб-сайтам с использованием аутентификации.

Вы можете подключаться к веб-сайтам с использованием базовой аутентификации по имени пользователя и паролю. Вы используете секрет в Secrets Manager для хранения учетных данных аутентификации.

BasicAuthentication -> (список)

Список конфигурационной информации, необходимой для подключения и сканирования хоста веб-сайта с использованием учетных данных базовой аутентификации.

Список включает имя и номер порта хоста веб-сайта.

(структура)

Предоставляет конфигурационную информацию для подключения к веб-сайтам, требующим базовой аутентификации пользователя.

Host -> (строка)

Имя хоста веб-сайта, к которому вы хотите подключиться с использованием учетных данных аутентификации.

Например, имя хоста https://a.example.com/page1.html — «a.example.com».

Port -> (целое число)

Номер порта хоста веб-сайта, к которому вы хотите подключиться с использованием учетных данных аутентификации.

Например, порт для https://a.example.com/page1.html — 443, стандартный порт для HTTPS.

Credentials -> (строка)

Amazon Resource Name (ARN) секрета из Secrets Manager. Вы создаете секрет для хранения учетных данных в Secrets Manager.

Вы используете секрет, если для подключения к веб-сайту требуется базовая аутентификация. Секрет хранит ваши учетные данные — имя пользователя и пароль.

WorkDocsConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Amazon WorkDocs в качестве источника данных.

OrganizationId -> (строка)

Идентификатор каталога, соответствующий хранилищу сайта Amazon WorkDocs.

Идентификатор организации можно найти в службе каталогов, перейдя в раздел Active Directory, а затем Directories. У вашего каталога сайта Amazon WorkDocs есть ID, который является идентификатором организации. Вы также можете создать новый каталог Amazon WorkDocs в консоли службы каталогов и включить сайт Amazon WorkDocs для этого каталога в консоли Amazon WorkDocs.

CrawlComments -> (булево)

TRUE чтобы включить комментарии к документам в вашем индексе. Включение комментариев в индекс означает, что каждый комментарий — это документ, который можно искать.

По умолчанию установлено значение FALSE.

UseChangeLog -> (булево)

TRUE чтобы использовать журнал изменений Amazon WorkDocs для определения документов, которые необходимо обновить в индексе. В зависимости от размера журнала изменений Amazon Kendra может потратить больше времени на использование журнала изменений, чем на сканирование всех ваших документов в Amazon WorkDocs.

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных файлов в хранилище вашего сайта Amazon WorkDocs. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и шаблону исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных файлов в хранилище вашего сайта Amazon WorkDocs. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и шаблону исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

FieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей источника данных Amazon WorkDocs с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Amazon WorkDocs. Дополнительные сведения см. в разделе Сопоставление полей источника данных. Имена полей источника данных Amazon WorkDocs должны существовать в вашей пользовательской метаданных Amazon WorkDocs.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительные сведения см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны предварительно создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

FsxConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Amazon FSx в качестве источника данных.

Примечание

Amazon Kendra теперь поддерживает обновленный соединитель Amazon FSx Windows.

Теперь для настройки вашего соединителя необходимо использовать объект TemplateConfiguration вместо объекта FsxConfiguration.

Соединители, настроенные с помощью более старой архитектуры консоли и API, будут продолжать функционировать в соответствии с настройками. Однако вы не сможете их редактировать или обновлять. Если вы хотите изменить или обновить конфигурацию своего соединителя, необходимо создать новый соединитель.

Мы рекомендуем мигрировать ваш рабочий процесс соединителей к обновленной версии. Поддержка соединителей, настроенных с использованием более старой архитектуры, будет прекращена к июню 2024 года.

FileSystemId -> (строка)

Идентификатор системы файлов Amazon FSx.

Вы можете найти идентификатор своей системы файлов на панели мониторинга системы файлов в консоли Amazon FSx. Для получения информации о том, как создать систему файлов в консоли Amazon FSx, используя Windows File Server в качестве примера, ознакомьтесь с руководством по началу работы с Amazon FSx.

FileSystemType -> (строка)

Тип системы файлов Amazon FSx. В настоящее время поддерживается только тип Windows.

VpcConfiguration -> (структура)

Конфигурационная информация для виртуальной частной сети Amazon (Amazon Virtual Private Cloud) для подключения к вашему Amazon FSx. Ваш экземпляр Amazon FSx должен находиться внутри вашей VPC.

SubnetIds -> (список)

Список идентификаторов подсетей внутри вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь исходящий доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности внутри вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.

(строка)

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашей системе файлов Amazon FSx. В настоящее время поддерживается только тип Windows. Секрет должен содержать JSON-структуру со следующими ключами:

username—Имя пользователя Active Directory вместе с доменом DNS. Например, user@corp.example.com . Аккаунт пользователя Active Directory должен иметь права чтения и подключения к системе файлов Amazon FSx для Windows.
password—Пароль учетной записи Active Directory пользователя с правами чтения и подключения к файловой системе Amazon FSx Windows.

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных файлов в вашей системе файлов Amazon FSx. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных файлов в вашей системе файлов Amazon FSx. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

FieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей источника данных Amazon FSx с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Amazon FSx. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Amazon FSx должны существовать в ваших пользовательских метаданных Amazon FSx.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей необходимо использовать API UpdateIndex для предварительного создания поля индекса, а затем сопоставить его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.

IndexFieldName -> (строка)

SlackConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Slack в качестве источника данных.

Примечание

Amazon Kendra теперь поддерживает обновленный коннектор Slack.

Теперь вы должны использовать объект TemplateConfiguration вместо объекта SlackConfiguration для настройки своего коннектора.

Коннекторы, настроенные с использованием более старой архитектуры консоли и API, будут продолжать работать в соответствии с текущей настройкой. Однако вы не сможете их редактировать или обновлять. Если вы хотите редактировать или обновлять конфигурацию своего коннектора, вы должны создать новый коннектор.

Рекомендуется мигрировать свой рабочий процесс коннектора к обновленной версии. Поддержка коннекторов, настроенных с использованием более старой архитектуры, завершится к июню 2024 года.

TeamId -> (строка)

Идентификатор команды в рабочем пространстве Slack. Например, T0123456789.

Вы можете найти свой идентификатор команды в URL-адресе главной страницы вашего рабочего пространства Slack. При входе в Slack через браузер вы перенаправляетесь на URL-адрес главной страницы. Например, https://app.slack.com/client/**T0123456789* /…*.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашей команде в рабочем пространстве Slack. Секрет должен содержать JSON-структуру со следующими ключами:

slackToken — маркер пользователя или бота, созданный в Slack. Дополнительную информацию о создании маркера в Slack см. в разделе Аутентификация для источника данных Slack.

VpcConfiguration -> (структура)

Конфигурационная информация для виртуальной частной сети Amazon для подключения к вашему Slack. Дополнительную информацию см. в разделе Настройка VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей виртуальной частной сети Amazon. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь внешний доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей виртуальной частной сети Amazon. Группы безопасности должны позволять Amazon Kendra подключаться к источнику данных.

(строка)

SlackEntityList -> (список)

Укажите, следует ли индексировать публичные каналы, частные каналы, групповые сообщения и прямые сообщения. Вы можете указать один или несколько из этих вариантов.

(строка)

UseChangeLog -> (булево)

TRUE для использования журнала изменений Slack для определения документов, требующих обновления в индексе. В зависимости от размера журнала изменений Slack у Amazon Kendra может уйти больше времени на использование журнала изменений, чем на сканирование всех ваших документов в Slack.

CrawlBotMessage -> (булево)

TRUE для индексирования сообщений ботов из вашей команды в рабочем пространстве Slack.

ExcludeArchived -> (булево)

TRUE для исключения архивированных сообщений для индексирования из вашей команды в рабочем пространстве Slack.

SinceCrawlDate -> (строка)

Дата начала сканирования данных из вашей команды в рабочем пространстве Slack. Дата должна соответствовать следующему формату: yyyy-mm-dd .

LookBackPeriod -> (целое число)

Количество часов, за которые журнал изменений должен искать данные с момента последней синхронизации ваших данных. Вы можете искать данные за период до 7 дней или 168 часов.

Журнал изменений обновляет ваш индекс только в том случае, если с момента последней синхронизации данных были добавлены новые данные. Обновленные или удаленные данные, существовавшие до последней синхронизации, не обновляются в индексе. Чтобы включить обновленные или удаленные данные, существовавшие до последней синхронизации, установите LookBackPeriod в количество часов, за которое журнал изменений должен искать данные.

PrivateChannelFilter -> (список)

Список имен частных каналов из вашей команды в рабочем пространстве Slack. Используется, если вы хотите индексировать только определенные частные каналы, а не все. Также можно использовать шаблоны регулярных выражений для фильтрации частных каналов.

(строка)

PublicChannelFilter -> (список)

Список имен общедоступных каналов для индексирования из вашей команды в рабочем пространстве Slack. Используется, если вы хотите индексировать только определенные общедоступные каналы, а не все. Также можно использовать шаблоны регулярных выражений для фильтрации общедоступных каналов.

(строка)

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных прикрепленных файлов в вашей команде в рабочем пространстве Slack. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных прикрепленных файлов в вашей команде в рабочем пространстве Slack. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

FieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей источника данных Slack с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Slack. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей дат в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вам необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.

IndexFieldName -> (строка)

BoxConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Box в качестве источника данных.

EnterpriseId -> (строка)

Идентификатор платформы Box Enterprise. Вы можете найти идентификатор предприятия в настройках консоли разработчика Box или при создании приложения в Box и загрузке учетных данных для аутентификации. Например, 801234567.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашей платформе Box. Секрет должен содержать JSON-структуру со следующими ключами:

clientID—Идентификатор приложения аутентификации OAuth 2.0 клиента, созданного в Box.
clientSecret—Набор символов, известных только приложению аутентификации OAuth 2.0, созданному в Box.
publicKeyId—Идентификатор открытого ключа, содержащегося в сертификате удостоверения.
privateKey—Набор символов, составляющих криптографический ключ.
passphrase—Набор символов, выполняющих функцию пароля.

Вы создаете приложение в Box для генерации ключей или учетных данных, необходимых для секрета. Дополнительная информация находится в разделе Использование источника данных Box.

UseChangeLog -> (логическое значение)

TRUE для использования журнала изменений Slack для определения документов, требующих обновления в индексе. В зависимости от размера журнала изменений источника данных Amazon Kendra может тратить больше времени на использование журнала изменений, чем на сканирование всех документов.

CrawlComments -> (логическое значение)

TRUE для индексирования комментариев.

CrawlTasks -> (логическое значение)

TRUE для индексирования содержимого задач.

CrawlWebLinks -> (логическое значение)

TRUE для индексирования веб-ссылок.

FileFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей файлов Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительная информация находится в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставление полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вам необходимо предварительно создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, выбрасывается исключение.

IndexFieldName -> (строка)

TaskFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей задач Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительная информация находится в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вам необходимо предварительно создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

CommentFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей комментариев Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительная информация находится в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вам необходимо предварительно создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

WebLinkFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей веб-ссылок Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительная информация находится в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вам необходимо предварительно создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

Список шаблонов регулярных выражений для включения определенных файлов и папок в вашей платформе Box. Файлы и папки, соответствующие шаблонам, включаются в индекс. Файлы и папки, не соответствующие шаблонам, исключаются из индекса. Если файл или папка соответствуют как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл или папка не включаются в индекс.

(строка)

ExclusionPatterns -> (список)

Список шаблонов регулярных выражений для исключения определенных файлов и папок из вашей платформы Box. Файлы и папки, соответствующие шаблонам, исключаются из индекса. Файлы и папки, не соответствующие шаблонам, включаются в индекс. Если файл или папка соответствуют как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл или папка не включаются в индекс.

(строка)

VpcConfiguration -> (структура)

Конфигурационная информация для Amazon VPC для подключения к вашему Box. Дополнительная информация в разделе Настройка VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.

(строка)

QuipConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Quip в качестве источника данных.

Domain -> (string)

Домен сайта Quip. Например, https://quip-company.quipdomain.com/browse. В этом примере домен — “quipdomain”.

SecretArn -> (string)

Идентификатор Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашему Quip. Секрет должен содержать JSON-структуру со следующими ключами:

accessToken—Токен, созданный в Quip. Дополнительную информацию см. в разделе Использование источника данных Quip .

CrawlFileComments -> (boolean)

TRUE для индексации комментариев к файлам.

CrawlChatRooms -> (boolean)

TRUE для индексации содержимого чатов.

CrawlAttachments -> (boolean)

TRUE для индексации вложений.

FolderIds -> (list)

Идентификаторы папок Quip, которые вы хотите индексировать. Идентификатор папки можно найти в адресе URL вашего браузера при доступе к папке в Quip. Например, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. В этом примере идентификатор папки — “zlLuOVNSarTL”.

(string)

ThreadFieldMappings -> (list)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей потоков Quip с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте UpdateIndex API перед сопоставлением с полями Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.

(structure)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте UpdateIndex API для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (string)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью UpdateIndex API.

DateFieldFormat -> (string)

Формат полей дат в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.

IndexFieldName -> (string)

MessageFieldMappings -> (list)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей сообщений Quip с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте UpdateIndex API перед сопоставлением с полями Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.

(structure)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте UpdateIndex API для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (string)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью UpdateIndex API.

DateFieldFormat -> (string)

IndexFieldName -> (string)

AttachmentFieldMappings -> (list)

Список DataSourceToIndexFieldMapping объектов, сопоставляющих атрибуты или имена полей вложений Quip с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте UpdateIndex API перед сопоставлением с полями Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.

(structure)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте UpdateIndex API для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (string)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью UpdateIndex API.

DateFieldFormat -> (string)

IndexFieldName -> (string)

InclusionPatterns -> (list)

Список регулярных выражений, включающих определенные файлы в вашей файловой системе Quip. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(string)

ExclusionPatterns -> (list)

Список регулярных выражений, исключающих определенные файлы в вашей файловой системе Quip. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(string)

VpcConfiguration -> (structure)

Конфигурационная информация для Amazon Virtual Private Cloud (VPC) для подключения к вашему Quip. Дополнительную информацию см. в разделе Настройка VPC .

SubnetIds -> (list)

(string)

SecurityGroupIds -> (list)

Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешить Amazon Kendra подключение к источнику данных.

(string)

JiraConfiguration -> (structure)

Предоставляет конфигурационную информацию для подключения к Jira в качестве источника данных.

JiraAccountUrl -> (строка)

URL учетной записи Jira. Например, company.atlassian.net .

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета в Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к источнику данных Jira. Секрет должен содержать JSON-структуру со следующими ключами:

jiraId—Имя пользователя Jira или адрес электронной почты.
jiraCredentials—Токен API Jira. Дополнительная информация приведена в разделе Использование источника данных Jira .

UseChangeLog -> (логическое значение)

TRUE для использования журнала изменений Jira, чтобы определить, какие документы требуют обновления в индексе. В зависимости от размера журнала изменений Amazon Kendra может тратить больше времени на использование журнала изменений, чем на сканирование всех ваших документов в Jira.

Project -> (список)

Укажите проекты, которые необходимо просканировать в вашем источнике данных Jira. Вы можете указать один или несколько идентификаторов проектов Jira.

(строка)

IssueType -> (список)

Укажите типы задач, которые необходимо просканировать в вашем источнике данных Jira. Вы можете указать один или несколько из этих вариантов для сканирования.

(строка)

Status -> (список)

Укажите статусы, которые необходимо просканировать в вашем источнике данных Jira. Вы можете указать один или несколько из этих вариантов для сканирования.

(строка)

IssueSubEntityFilter -> (список)

Укажите, нужно ли сканировать комментарии, вложения и журналы работы. Вы можете указать один или несколько из этих вариантов.

(строка)

AttachmentFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей вложений Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных . Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.

IndexFieldName -> (строка)

CommentFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей комментариев Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных . Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IssueFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей задач Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных . Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

ProjectFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей проектов Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных . Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

WorkLogFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей журналов работы Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных . Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных .

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса, используя API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

Список регулярных выражений, которые включают определенные пути, имена и типы файлов в вашем источнике данных Jira. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует и включению, и исключению, то исключение имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список регулярных выражений, которые исключают определенные пути, имена и типы файлов в вашем источнике данных Jira. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует и включению, и исключению, то исключение имеет приоритет, и файл не включается в индекс.

(строка)

VpcConfiguration -> (структура)

Конфигурационная информация для виртуальной частной облачной сети Amazon для подключения к вашему Jira. Дополнительная информация приведена в разделе Настройка VPC .

SubnetIds -> (список)

Список идентификаторов подсетей в вашей виртуальной частной сети Amazon. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь доступ за пределы VPC к интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

(строка)

GitHubConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к GitHub в качестве источника данных.

Примечание

Amazon Kendra теперь поддерживает обновленный соединитель GitHub.

Теперь вы должны использовать объект TemplateConfiguration вместо объекта GitHubConfiguration для настройки своего соединителя.

Соединители, настроенные с использованием более старой архитектуры консоли и API, будут продолжать работать в соответствии с настройками. Однако вы не сможете их редактировать или обновлять. Если вы хотите отредактировать или обновить конфигурацию вашего соединителя, вы должны создать новый соединитель.

Мы рекомендуем мигрировать ваш рабочий процесс соединителя на обновлённую версию. Поддержка соединителей, настроенных с использованием более старой архитектуры, завершится к июню 2024 года.

SaaSConfiguration -> (структура)

Конфигурационная информация для подключения к GitHub Enterprise Cloud (SaaS).

OrganizationName -> (строка)

Имя организации учётной записи GitHub Enterprise Cloud (SaaS), с которой вы хотите подключиться. Вы можете найти имя вашей организации, войдя в GitHub desktop и выбрав Ваши организации в раскрывающемся списке под вашей фотографией профиля.

HostUrl -> (строка)

URL хоста GitHub или URL конечной точки API. Например, https://api.github.com.

OnPremiseConfiguration -> (структура)

Конфигурационная информация для подключения к GitHub Enterprise Server (локальный сервер).

HostUrl -> (строка)

URL хоста GitHub или URL конечной точки API. Например, https://on-prem-host-url/api/v3/

OrganizationName -> (строка)

Имя организации учётной записи GitHub Enterprise Server (локальный сервер), с которой вы хотите подключиться. Вы можете найти имя вашей организации, войдя в GitHub desktop и выбрав Ваши организации в раскрывающемся списке под вашей фотографией профиля.

SslCertificateS3Path -> (структура)

Путь к сертификату SSL, хранящемуся в ведре Amazon S3. Используется для подключения к GitHub, если требуется безопасное SSL-соединение.

Вы можете просто сгенерировать самозаверяющий X509-сертификат на любом компьютере с помощью OpenSSL. Пример использования OpenSSL для создания X509-сертификата см. в Create and sign an X509 certificate.

Bucket -> (строка)

Имя ведра S3, содержащего файл.

Key -> (строка)

Имя файла.

Type -> (строка)

Тип службы GitHub, к которой вы хотите подключиться — GitHub Enterprise Cloud (SaaS) или GitHub Enterprise Server (локальный сервер).

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашему GitHub. Секрет должен содержать JSON-структуру с ключами:

personalToken—Токен доступа, созданный в GitHub. Подробнее о создании токена в GitHub см. в Using a GitHub data source.

UseChangeLog -> (булево)

TRUE для использования журнала изменений GitHub для определения документов, требующих обновления в индексе. В зависимости от размера журнала изменений GitHub, Amazon Kendra может потратить больше времени на использование журнала изменений, чем на сканирование всех ваших документов в GitHub.

GitHubDocumentCrawlProperties -> (структура)

Конфигурационная информация для включения определённых типов контента GitHub. Вы можете настроить индексацию только файлов репозитория или также включить задачи, запросы на вытягивание, комментарии и вложения к комментариям.

CrawlRepositoryDocuments -> (булево)

TRUE для индексации всех файлов с репозиторием.

CrawlIssue -> (булево)

TRUE для индексации всех задач в репозитории.

CrawlIssueComment -> (булево)

TRUE для индексации всех комментариев к задачам.

CrawlIssueCommentAttachment -> (булево)

TRUE для включения всех вложений к комментариям к задачам.

CrawlPullRequest -> (булево)

TRUE для индексации всех запросов на вытягивание в репозитории.

CrawlPullRequestComment -> (булево)

TRUE для индексации всех комментариев к запросам на вытягивание.

CrawlPullRequestCommentAttachment -> (булево)

TRUE для включения всех вложений к комментариям к запросам на вытягивание.

RepositoryFilter -> (список)

Список имён конкретных репозиториев, которые вы хотите проиндексировать.

(строка)

InclusionFolderNamePatterns -> (список)

Список шаблонов регулярных выражений для включения определённых имён папок в ваш репозиторий или репозитории GitHub. Имена папок, соответствующие шаблонам, включаются в индекс. Имена папок, не соответствующие шаблонам, исключаются из индекса. Если папка соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и папка не включается в индекс.

(строка)

InclusionFileTypePatterns -> (список)

Список шаблонов регулярных выражений для включения определённых типов файлов в ваш репозиторий или репозитории GitHub. Типы файлов, соответствующие шаблонам, включаются в индекс. Типы файлов, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

InclusionFileNamePatterns -> (список)

Список шаблонов регулярных выражений для включения определённых имён файлов в ваш репозиторий или репозитории GitHub. Имена файлов, соответствующие шаблонам, включаются в индекс. Имена файлов, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionFolderNamePatterns -> (список)

Список шаблонов регулярных выражений для исключения определённых имён папок в вашем репозитории или репозиториях GitHub. Имена папок, соответствующие шаблонам, исключаются из индекса. Имена папок, не соответствующие шаблонам, включаются в индекс. Если папка соответствует как шаблону исключения, так и включения, шаблон исключения имеет приоритет, и папка не включается в индекс.

(строка)

ExclusionFileTypePatterns -> (список)

Список шаблонов регулярных выражений для исключения определённых типов файлов в вашем репозитории или репозиториях GitHub. Типы файлов, соответствующие шаблонам, исключаются из индекса. Типы файлов, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону исключения, так и включения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionFileNamePatterns -> (список)

Список шаблонов регулярных выражений для исключения определённых имён файлов в вашем репозитории или репозиториях GitHub. Имена файлов, соответствующие шаблонам, исключаются из индекса. Имена файлов, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону исключения, так и включения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

VpcConfiguration -> (структура)

Конфигурационная информация виртуальной частной облака Amazon для подключения к вашему GitHub. Дополнительные сведения см. в Configuring a VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей виртуальной частной сети Amazon. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь исходящий доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей виртуальной частной сети Amazon. Группы безопасности должны позволить Amazon Kendra подключаться к источнику данных.

(строка)

GitHubRepositoryConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей репозитория GitHub с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительные сведения см. в Mapping data source fields. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительные сведения см. в Mapping data source fields.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

Формат полей даты в источнике данных. Если поле, указанное в DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, генерируется исключение.

IndexFieldName -> (строка)

GitHubCommitConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей GitHub commits с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительные сведения см. в Mapping data source fields. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительные сведения см. в Mapping data source fields.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubIssueDocumentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей GitHub-вопросов с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubIssueCommentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей комментариев к GitHub-вопросам с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubIssueAttachmentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей приложений к GitHub-вопросам с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestCommentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей комментариев к GitHub-запросам на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestDocumentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей GitHub-запросов на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestDocumentAttachmentConfigurationFieldMappings -> (список)

Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей приложений к GitHub-запросам на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных GitHub должны существовать в вашей пользовательской метаданных GitHub.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

AlfrescoConfiguration -> (структура)

Предоставляет конфигурационную информацию для подключения к Alfresco в качестве источника данных.

Примечание

Поддержка AlfrescoConfiguration завершилась в мае 2023 года. Рекомендуется мигрировать или использовать шаблон схемы источника данных Alfresco / API TemplateConfiguration.

SiteUrl -> (строка)

URL сайта Alfresco. Например, https://hostname:8080.

SiteId -> (строка)

Идентификатор сайта Alfresco. Например, my-site.

SecretArn -> (строка)

Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашему источнику данных Alfresco. Секрет должен содержать JSON-структуру с указанными ключами:

username—Имя пользователя учетной записи Alfresco.
password—Пароль учетной записи Alfresco.

SslCertificateS3Path -> (структура)

Путь к сертификату SSL, хранящемуся в Amazon S3 bucket. Используется для подключения к Alfresco, если требуется безопасное SSL-соединение.

Вы можете просто сгенерировать самоподписанный сертификат X509 на любом компьютере с помощью OpenSSL. Пример использования OpenSSL для создания сертификата X509 см. в Create and sign an X509 certificate.

Bucket -> (строка)

Название S3 bucket, содержащего файл.

Key -> (строка)

Имя файла.

CrawlSystemFolders -> (логическое значение)

TRUE для индексации общих файлов.

CrawlComments -> (логическое значение)

TRUE для индексации комментариев блогов и других контента.

EntityFilter -> (список)

Укажите, нужно ли индексировать библиотеки документов, вики или блоги. Можно указать один или несколько из этих вариантов.

(строка)

DocumentLibraryFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей библиотек документов Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительная информация в Mapping data source fields. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.

(структура)

Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Настройка сопоставления полей для каждого источника данных выполняется при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация в Mapping data source fields.

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

BlogFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей блогов Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительная информация в Mapping data source fields. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

WikiFieldMappings -> (список)

Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей вики Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительная информация в Mapping data source fields. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.

(структура)

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Сначала необходимо создать поле индекса с помощью API UpdateIndex.

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

Список регулярных выражений для включения определенных файлов в ваш источник данных Alfresco. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует шаблону включения и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

ExclusionPatterns -> (список)

Список регулярных выражений для исключения определенных файлов из вашего источника данных Alfresco. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует шаблону включения и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.

(строка)

VpcConfiguration -> (структура)

Конфигурационная информация для виртуальной частной сети Amazon для подключения к Alfresco. Дополнительная информация в Configuring a VPC.

SubnetIds -> (список)

Список идентификаторов подсетей в вашей VPC Amazon. Подсети должны иметь возможность соединяться друг с другом в VPC и иметь исходящий доступ к Интернету через устройство NAT.

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей VPC Amazon. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.

(строка)

TemplateConfiguration -> (структура)

Предоставляет шаблон конфигурации для подключения к вашему источнику данных.

Template -> (документ)

Схема шаблона, используемая для источника данных, где поддерживаются шаблоны схем.

См. Data source template schemas.

JSON синтаксис:

{
  "S3Configuration": {
    "BucketName": "string",
    "InclusionPrefixes": ["string", ...],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "DocumentsMetadataConfiguration": {
      "S3Prefix": "string"
    },
    "AccessControlListConfiguration": {
      "KeyPath": "string"
    }
  },
  "SharePointConfiguration": {
    "SharePointVersion": "SHAREPOINT_2013"|"SHAREPOINT_2016"|"SHAREPOINT_ONLINE"|"SHAREPOINT_2019",
    "Urls": ["string", ...],
    "SecretArn": "string",
    "CrawlAttachments": true|false,
    "UseChangeLog": true|false,
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "DocumentTitleFieldName": "string",
    "DisableLocalGroups": true|false,
    "SslCertificateS3Path": {
      "Bucket": "string",
      "Key": "string"
    },
    "AuthenticationType": "HTTP_BASIC"|"OAUTH2",
    "ProxyConfiguration": {
      "Host": "string",
      "Port": integer,
      "Credentials": "string"
    }
  },
  "DatabaseConfiguration": {
    "DatabaseEngineType": "RDS_AURORA_MYSQL"|"RDS_AURORA_POSTGRESQL"|"RDS_MYSQL"|"RDS_POSTGRESQL",
    "ConnectionConfiguration": {
      "DatabaseHost": "string",
      "DatabasePort": integer,
      "DatabaseName": "string",
      "TableName": "string",
      "SecretArn": "string"
    },
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "ColumnConfiguration": {
      "DocumentIdColumnName": "string",
      "DocumentDataColumnName": "string",
      "DocumentTitleColumnName": "string",
      "FieldMappings": [
        {
          "DataSourceFieldName": "string",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ],
      "ChangeDetectingColumns": ["string", ...]
    },
    "AclConfiguration": {
      "AllowedGroupsColumnName": "string"
    },
    "SqlConfiguration": {
      "QueryIdentifiersEnclosingOption": "DOUBLE_QUOTES"|"NONE"
    }
  },
  "SalesforceConfiguration": {
    "ServerUrl": "string",
    "SecretArn": "string",
    "StandardObjectConfigurations": [
      {
        "Name": "ACCOUNT"|"CAMPAIGN"|"CASE"|"CONTACT"|"CONTRACT"|"DOCUMENT"|"GROUP"|"IDEA"|"LEAD"|"OPPORTUNITY"|"PARTNER"|"PRICEBOOK"|"PRODUCT"|"PROFILE"|"SOLUTION"|"TASK"|"USER",
        "DocumentDataFieldName": "string",
        "DocumentTitleFieldName": "string",
        "FieldMappings": [
          {
            "DataSourceFieldName": "string",
            "DateFieldFormat": "string",
            "IndexFieldName": "string"
          }
          ...
        ]
      }
      ...
    ],
    "KnowledgeArticleConfiguration": {
      "IncludedStates": ["DRAFT"|"PUBLISHED"|"ARCHIVED", ...],
      "StandardKnowledgeArticleTypeConfiguration": {
        "DocumentDataFieldName": "string",
        "DocumentTitleFieldName": "string",
        "FieldMappings": [
          {
            "DataSourceFieldName": "string",
            "DateFieldFormat": "string",
            "IndexFieldName": "string"
          }
          ...
        ]
      },
      "CustomKnowledgeArticleTypeConfigurations": [
        {
          "Name": "string",
          "DocumentDataFieldName": "string",
          "DocumentTitleFieldName": "string",
          "FieldMappings": [
            {
              "DataSourceFieldName": "string",
              "DateFieldFormat": "string",
              "IndexFieldName": "string"
            }
            ...
          ]
        }
        ...
      ]
    },
    "ChatterFeedConfiguration": {
      "DocumentDataFieldName": "string",
      "DocumentTitleFieldName": "string",
      "FieldMappings": [
        {
          "DataSourceFieldName": "string",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ],
      "IncludeFilterTypes": ["ACTIVE_USER"|"STANDARD_USER", ...]
    },
    "CrawlAttachments": true|false,
    "StandardObjectAttachmentConfiguration": {
      "DocumentTitleFieldName": "string",
      "FieldMappings": [
        {
          "DataSourceFieldName": "string",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "IncludeAttachmentFilePatterns": ["string", ...],
    "ExcludeAttachmentFilePatterns": ["string", ...]
  },
  "OneDriveConfiguration": {
    "TenantDomain": "string",
    "SecretArn": "string",
    "OneDriveUsers": {
      "OneDriveUserList": ["string", ...],
      "OneDriveUserS3Path": {
        "Bucket": "string",
        "Key": "string"
      }
    },
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "DisableLocalGroups": true|false
  },
  "ServiceNowConfiguration": {
    "HostUrl": "string",
    "SecretArn": "string",
    "ServiceNowBuildVersion": "LONDON"|"OTHERS",
    "KnowledgeArticleConfiguration": {
      "CrawlAttachments": true|false,
      "IncludeAttachmentFilePatterns": ["string", ...],
      "ExcludeAttachmentFilePatterns": ["string", ...],
      "DocumentDataFieldName": "string",
      "DocumentTitleFieldName": "string",
      "FieldMappings": [
        {
          "DataSourceFieldName": "string",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ],
      "FilterQuery": "string"
    },
    "ServiceCatalogConfiguration": {
      "CrawlAttachments": true|false,
      "IncludeAttachmentFilePatterns": ["string", ...],
      "ExcludeAttachmentFilePatterns": ["string", ...],
      "DocumentDataFieldName": "string",
      "DocumentTitleFieldName": "string",
      "FieldMappings": [
        {
          "DataSourceFieldName": "string",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "AuthenticationType": "HTTP_BASIC"|"OAUTH2"
  },
  "ConfluenceConfiguration": {
    "ServerUrl": "string",
    "SecretArn": "string",
    "Version": "CLOUD"|"SERVER",
    "SpaceConfiguration": {
      "CrawlPersonalSpaces": true|false,
      "CrawlArchivedSpaces": true|false,
      "IncludeSpaces": ["string", ...],
      "ExcludeSpaces": ["string", ...],
      "SpaceFieldMappings": [
        {
          "DataSourceFieldName": "DISPLAY_URL"|"ITEM_TYPE"|"SPACE_KEY"|"URL",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "PageConfiguration": {
      "PageFieldMappings": [
        {
          "DataSourceFieldName": "AUTHOR"|"CONTENT_STATUS"|"CREATED_DATE"|"DISPLAY_URL"|"ITEM_TYPE"|"LABELS"|"MODIFIED_DATE"|"PARENT_ID"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "BlogConfiguration": {
      "BlogFieldMappings": [
        {
          "DataSourceFieldName": "AUTHOR"|"DISPLAY_URL"|"ITEM_TYPE"|"LABELS"|"PUBLISH_DATE"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "AttachmentConfiguration": {
      "CrawlAttachments": true|false,
      "AttachmentFieldMappings": [
        {
          "DataSourceFieldName": "AUTHOR"|"CONTENT_TYPE"|"CREATED_DATE"|"DISPLAY_URL"|"FILE_SIZE"|"ITEM_TYPE"|"PARENT_ID"|"SPACE_KEY"|"SPACE_NAME"|"URL"|"VERSION",
          "DateFieldFormat": "string",
          "IndexFieldName": "string"
        }
        ...
      ]
    },
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "ProxyConfiguration": {
      "Host": "string",
      "Port": integer,
      "Credentials": "string"
    },
    "AuthenticationType": "HTTP_BASIC"|"PAT"
  },
  "GoogleDriveConfiguration": {
    "SecretArn": "string",
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "ExcludeMimeTypes": ["string", ...],
    "ExcludeUserAccounts": ["string", ...],
    "ExcludeSharedDrives": ["string", ...]
  },
  "WebCrawlerConfiguration": {
    "Urls": {
      "SeedUrlConfiguration": {
        "SeedUrls": ["string", ...],
        "WebCrawlerMode": "HOST_ONLY"|"SUBDOMAINS"|"EVERYTHING"
      },
      "SiteMapsConfiguration": {
        "SiteMaps": ["string", ...]
      }
    },
    "CrawlDepth": integer,
    "MaxLinksPerPage": integer,
    "MaxContentSizePerPageInMegaBytes": float,
    "MaxUrlsPerMinuteCrawlRate": integer,
    "UrlInclusionPatterns": ["string", ...],
    "UrlExclusionPatterns": ["string", ...],
    "ProxyConfiguration": {
      "Host": "string",
      "Port": integer,
      "Credentials": "string"
    },
    "AuthenticationConfiguration": {
      "BasicAuthentication": [
        {
          "Host": "string",
          "Port": integer,
          "Credentials": "string"
        }
        ...
      ]
    }
  },
  "WorkDocsConfiguration": {
    "OrganizationId": "string",
    "CrawlComments": true|false,
    "UseChangeLog": true|false,
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ]
  },
  "FsxConfiguration": {
    "FileSystemId": "string",
    "FileSystemType": "WINDOWS",
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "SecretArn": "string",
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ]
  },
  "SlackConfiguration": {
    "TeamId": "string",
    "SecretArn": "string",
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "SlackEntityList": ["PUBLIC_CHANNEL"|"PRIVATE_CHANNEL"|"GROUP_MESSAGE"|"DIRECT_MESSAGE", ...],
    "UseChangeLog": true|false,
    "CrawlBotMessage": true|false,
    "ExcludeArchived": true|false,
    "SinceCrawlDate": "string",
    "LookBackPeriod": integer,
    "PrivateChannelFilter": ["string", ...],
    "PublicChannelFilter": ["string", ...],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "FieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ]
  },
  "BoxConfiguration": {
    "EnterpriseId": "string",
    "SecretArn": "string",
    "UseChangeLog": true|false,
    "CrawlComments": true|false,
    "CrawlTasks": true|false,
    "CrawlWebLinks": true|false,
    "FileFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "TaskFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "CommentFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "WebLinkFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
  },
  "QuipConfiguration": {
    "Domain": "string",
    "SecretArn": "string",
    "CrawlFileComments": true|false,
    "CrawlChatRooms": true|false,
    "CrawlAttachments": true|false,
    "FolderIds": ["string", ...],
    "ThreadFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "MessageFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "AttachmentFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
  },
  "JiraConfiguration": {
    "JiraAccountUrl": "string",
    "SecretArn": "string",
    "UseChangeLog": true|false,
    "Project": ["string", ...],
    "IssueType": ["string", ...],
    "Status": ["string", ...],
    "IssueSubEntityFilter": ["COMMENTS"|"ATTACHMENTS"|"WORKLOGS", ...],
    "AttachmentFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "CommentFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "IssueFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "ProjectFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "WorkLogFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
  },
  "GitHubConfiguration": {
    "SaaSConfiguration": {
      "OrganizationName": "string",
      "HostUrl": "string"
    },
    "OnPremiseConfiguration": {
      "HostUrl": "string",
      "OrganizationName": "string",
      "SslCertificateS3Path": {
        "Bucket": "string",
        "Key": "string"
      }
    },
    "Type": "SAAS"|"ON_PREMISE",
    "SecretArn": "string",
    "UseChangeLog": true|false,
    "GitHubDocumentCrawlProperties": {
      "CrawlRepositoryDocuments": true|false,
      "CrawlIssue": true|false,
      "CrawlIssueComment": true|false,
      "CrawlIssueCommentAttachment": true|false,
      "CrawlPullRequest": true|false,
      "CrawlPullRequestComment": true|false,
      "CrawlPullRequestCommentAttachment": true|false
    },
    "RepositoryFilter": ["string", ...],
    "InclusionFolderNamePatterns": ["string", ...],
    "InclusionFileTypePatterns": ["string", ...],
    "InclusionFileNamePatterns": ["string", ...],
    "ExclusionFolderNamePatterns": ["string", ...],
    "ExclusionFileTypePatterns": ["string", ...],
    "ExclusionFileNamePatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    },
    "GitHubRepositoryConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubCommitConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubIssueDocumentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubIssueCommentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubIssueAttachmentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubPullRequestCommentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubPullRequestDocumentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "GitHubPullRequestDocumentAttachmentConfigurationFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ]
  },
  "AlfrescoConfiguration": {
    "SiteUrl": "string",
    "SiteId": "string",
    "SecretArn": "string",
    "SslCertificateS3Path": {
      "Bucket": "string",
      "Key": "string"
    },
    "CrawlSystemFolders": true|false,
    "CrawlComments": true|false,
    "EntityFilter": ["wiki"|"blog"|"documentLibrary", ...],
    "DocumentLibraryFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "BlogFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "WikiFieldMappings": [
      {
        "DataSourceFieldName": "string",
        "DateFieldFormat": "string",
        "IndexFieldName": "string"
      }
      ...
    ],
    "InclusionPatterns": ["string", ...],
    "ExclusionPatterns": ["string", ...],
    "VpcConfiguration": {
      "SubnetIds": ["string", ...],
      "SecurityGroupIds": ["string", ...]
    }
  },
  "TemplateConfiguration": {
    "Template": {...}
  }
}

--vpc-configuration (структура)

Конфигурационная информация для виртуальной частной сети Amazon для подключения к вашему источнику данных. Дополнительная информация в Configuring a VPC.

SubnetIds -> (список)

(строка)

SecurityGroupIds -> (список)

(строка)

Сокращенный синтаксис:

SubnetIds=string,string,SecurityGroupIds=string,string

JSON синтаксис:

{
  "SubnetIds": ["string", ...],
  "SecurityGroupIds": ["string", ...]
}

--description (строка)

Описание коннектора источника данных.

--schedule (строка)

Устанавливает частоту проверки Amazon Kendra документов в вашем репозитории источника данных и обновления индекса. Если вы не зададите расписание, Amazon Kendra не будет периодически обновлять индекс. Вы можете вызвать API StartDataSourceSyncJob для обновления индекса.

Укажите расписание в формате cron- или пустую строку, чтобы указать, что индекс обновляется по требованию.

Вы не можете указать параметр Schedule, когда параметр Type установлен на CUSTOM. В противном случае произойдет исключение ValidationException.

--role-arn (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями доступа к источнику данных и необходимым ресурсам. Дополнительная информация в IAM access roles for Amazon Kendra. .

Вы не можете указать параметр RoleArn, когда параметр Type установлен на CUSTOM. В противном случае произойдет исключение ValidationException.

Параметр RoleArn обязателен для всех других источников данных.

--tags (список)

Список пар ключ-значение, которые идентифицируют или категоризируют коннектор источника данных. Вы также можете использовать теги для управления доступом к коннектору источника данных. Ключи и значения тегов могут содержать буквы, цифры, пробелы Unicode и следующие символы: _ . : / = + - @.

(структура)

Пара ключ-значение, которая идентифицирует или категоризирует индекс, FAQ, источник данных или другой ресурс. Ключ и значение тега могут содержать буквы, цифры, пробелы Unicode и следующие символы: _ . : / = + - @.

Key -> (строка)

Ключ тега. Ключи не чувствительны к регистру и должны быть уникальными для индекса, FAQ, источника данных или другого ресурса.

Value -> (строка)

Значение, связанное с тегом. Значение может быть пустой строкой, но не может быть null.

Сокращенный синтаксис:

Key=string,Value=string ...

JSON синтаксис:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--client-token (строка)

Токен, который вы предоставляете для идентификации запроса на создание коннектора источника данных. Несколько вызовов API CreateDataSource с одним и тем же токеном клиента создадут только один коннектор источника данных.

--language-code (строка)

Код языка. Это позволяет поддерживать язык для всех документов при создании подключения к источнику данных. По умолчанию поддерживается английский язык. Более подробную информацию о поддерживаемых языках, включая их коды, см. в разделе Добавление документов на языках, отличных от английского.

--custom-document-enrichment-configuration (структура)

Информация о конфигурации для изменения метаданных и содержимого документа во время процесса загрузки документа.

Дополнительную информацию о том, как создавать, изменять и удалять метаданные документов или вносить другие изменения в содержимое при загрузке документов в Amazon Kendra, см. в разделе Настройка метаданных документов во время процесса загрузки.

InlineConfigurations -> (список)

Информация о конфигурации для изменения атрибутов документов или полей метаданных и содержимого при загрузке документов в Amazon Kendra.

(структура)

Предоставляет информацию о конфигурации для применения базовой логики изменения метаданных и содержимого документа при загрузке документов в Amazon Kendra. Чтобы применить расширенную логику, выходящую за рамки базовой логики, см. HookConfiguration.

Дополнительную информацию см. в разделе Настройка метаданных документов во время процесса загрузки.

Condition -> (структура)

Конфигурация условия, используемого для целевого атрибута документа или поля метаданных при загрузке документов в Amazon Kendra.

ConditionDocumentAttributeKey -> (строка)

Идентификатор атрибута документа, используемого для условия.

Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.

В настоящее время Amazon Kendra не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

Operator -> (строка)

Оператор условия.

Например, вы можете использовать ‘Contains’ для частичного соответствия строке.

ConditionOnValue -> (структура)

Значение, используемое оператором.

Например, вы можете указать значение ‘financial’ для строк в поле ‘Source_URI’, которые частично совпадают или содержат это значение.

StringValue -> (строка)

Строка, например, “department”.

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

LongValue -> (целое число)

Целое значение типа long.

DateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центрально-европейскому времени.

Target -> (структура)

Конфигурация целевого атрибута документа или поля метаданных при загрузке документов в Amazon Kendra. Вы также можете включить значение.

TargetDocumentAttributeKey -> (строка)

Идентификатор целевого атрибута документа или поля метаданных.

Например, ‘Department’ может быть идентификатором целевого атрибута или поля метаданных, содержащего имена отделов, связанные с документами.

TargetDocumentAttributeValueDeletion -> (булево)

TRUE для удаления существующего целевого значения для указанного целевого ключа атрибута. Вы не можете создать целевое значение и установить это значение в TRUE. Чтобы создать целевое значение (TargetDocumentAttributeValue), установите это значение в FALSE.

TargetDocumentAttributeValue -> (структура)

Целевое значение, которое вы хотите создать для целевого атрибута.

Например, ‘Finance’ может быть целевым значением для целевого ключа атрибута ‘Department’.

StringValue -> (строка)

Строка, например, “department”.

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

LongValue -> (целое число)

Целое значение типа long.

DateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

DocumentContentDeletion -> (булево)

TRUE для удаления содержимого, если выполнено условие, используемое для целевого атрибута.

PreExtractionHookConfiguration -> (структура)

Информация о конфигурации для вызова функции Lambda в Lambda на исходных или необработанных документах перед извлечением их метаданных и текста. Вы можете использовать функцию Lambda для применения расширенной логики создания, изменения или удаления метаданных и содержимого документов. Дополнительную информацию см. в разделе Расширенная обработка данных.

InvocationCondition -> (структура)

Условие, используемое для вызова функции Lambda.

Например, вы можете указать условие, при котором, если есть пустые значения даты и времени, Amazon Kendra должен вызвать функцию, которая вставит текущую дату и время.

ConditionDocumentAttributeKey -> (строка)

Идентификатор атрибута документа, используемого для условия.

В настоящее время Amazon Kendra не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

Operator -> (строка)

Оператор условия.

Например, вы можете использовать ‘Contains’ для частичного соответствия строке.

ConditionOnValue -> (структура)

Значение, используемое оператором.

StringValue -> (строка)

Строка, например, “department”.

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

LongValue -> (целое число)

Целое значение типа long.

DateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

LambdaArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями на запуск функции Lambda во время загрузки. Дополнительную информацию см. в разделе Роли IAM для Amazon Kendra.

S3Bucket -> (строка)

Хранит исходные, необработанные документы или структурированные, разобранные документы до и после их изменения. Дополнительную информацию см. в разделе Договоры о данных для функций Lambda.

PostExtractionHookConfiguration -> (структура)

Информация о конфигурации для вызова функции Lambda в Lambda на структурированных документах с извлеченными метаданными и текстом. Вы можете использовать функцию Lambda для применения расширенной логики создания, изменения или удаления метаданных и содержимого документов. Дополнительную информацию см. в разделе Расширенная обработка данных.

InvocationCondition -> (структура)

Условие, используемое для вызова функции Lambda.

ConditionDocumentAttributeKey -> (строка)

Идентификатор атрибута документа, используемого для условия.

В настоящее время Amazon Kendra не поддерживает _document_body в качестве ключа атрибута, используемого для условия.

Operator -> (строка)

Оператор условия.

Например, вы можете использовать ‘Contains’ для частичного соответствия строке.

ConditionOnValue -> (структура)

Значение, используемое оператором.

StringValue -> (строка)

Строка, например, “department”.

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

LongValue -> (целое число)

Целое значение типа long.

DateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

LambdaArn -> (строка)

S3Bucket -> (строка)

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями на запуск PreExtractionHookConfiguration и PostExtractionHookConfiguration для изменения метаданных и содержимого документа во время загрузки документа. Дополнительную информацию см. в разделе Роли IAM для Amazon Kendra.

Синтаксис JSON:

{
  "InlineConfigurations": [
    {
      "Condition": {
        "ConditionDocumentAttributeKey": "string",
        "Operator": "GreaterThan"|"GreaterThanOrEquals"|"LessThan"|"LessThanOrEquals"|"Equals"|"NotEquals"|"Contains"|"NotContains"|"Exists"|"NotExists"|"BeginsWith",
        "ConditionOnValue": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "Target": {
        "TargetDocumentAttributeKey": "string",
        "TargetDocumentAttributeValueDeletion": true|false,
        "TargetDocumentAttributeValue": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "DocumentContentDeletion": true|false
    }
    ...
  ],
  "PreExtractionHookConfiguration": {
    "InvocationCondition": {
      "ConditionDocumentAttributeKey": "string",
      "Operator": "GreaterThan"|"GreaterThanOrEquals"|"LessThan"|"LessThanOrEquals"|"Equals"|"NotEquals"|"Contains"|"NotContains"|"Exists"|"NotExists"|"BeginsWith",
      "ConditionOnValue": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "LambdaArn": "string",
    "S3Bucket": "string"
  },
  "PostExtractionHookConfiguration": {
    "InvocationCondition": {
      "ConditionDocumentAttributeKey": "string",
      "Operator": "GreaterThan"|"GreaterThanOrEquals"|"LessThan"|"LessThanOrEquals"|"Equals"|"NotEquals"|"Contains"|"NotContains"|"Exists"|"NotExists"|"BeginsWith",
      "ConditionOnValue": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "LambdaArn": "string",
    "S3Bucket": "string"
  },
  "RoleArn": "string"
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения будут перезаписывать значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята дословно. Это может не быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команд и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Общие параметры

--debug (boolean)

Включить отладку.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использование определенного профиля из файла учетных данных.

--region (string)

Используемый регион. Переопределяет настройки из конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить вывод пагинатора.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматическое запросы параметров CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI User Guide.

Если не указано иное, во всех примерах используются правила цитирования, характерные для Unix. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в AWS CLI User Guide.

Создание подключения к Amazon Kendra

Следующий пример создает и настраивает подключение к источнику данных Amazon Kendra. Вы можете использовать describe-data-source для просмотра статуса подключения к источнику данных и чтения любых сообщений об ошибках, если статус подключения к источнику данных показывает «НЕУДАЧА» при полном создании.

aws kendra create-data-source \
    --name "example data source 1" \
    --description "Example data source 1 for example index 1 contains the first set of example documents" \
    --tags '{"Key": "test resources", "Value": "kendra"}, {"Key": "test resources", "Value": "aws"}' \
    --role-arn "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource" \
    --index-id exampleindex1 \
    --language-code "es" \
    --schedule "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *" \
    --configuration '{"TemplateConfiguration": {"Template": file://s3schemaconfig.json}}' \
    --type "TEMPLATE" \
    --custom-document-enrichment-configuration '{"PostExtractionHookConfiguration": {"LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs", "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs"}, "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"}' \
    --vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'

Вывод:

{
    "Id": "exampledatasource1"
}

Для получения дополнительной информации см. раздел Начало работы с индексом и источником данных Amazon Kendra в Руководстве разработчика Amazon Kendra.

Вывод

Id -> (строка)

Идентификатор подключения к источнику данных.