обновить-источник-данных
Описание
Обновляет соединитель источника данных Amazon Kendra.
См. также: Документация API AWS
update-data-source использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для ввода команды, опций и вложенных параметров, помеченных типом document, необходимо указать значения в формате JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
update-data-source
--id <value>
[--name <value>]
--index-id <value>
[--configuration <value>]
[--vpc-configuration <value>]
[--description <value>]
[--schedule <value>]
[--role-arn <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]
Параметры
--id (строка)
--name (строка)
--index-id (строка)
--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 —Все файлы, связанные с 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 —Все файлы, связанные с internal, в каталоге и его подкаталогах.
Дополнительные примеры можно найти в разделе «Использование фильтров исключения и включения» в справочнике команд Amazon Web Services CLI.
(строка)
DocumentsMetadataConfiguration -> (структура)
Файлы метаданных документов, содержащие информацию, такую как информация об управлении доступом к документу, исходный URI, автор документа и пользовательские атрибуты. Каждый файл метаданных содержит метаданные об одном документе.
S3Prefix -> (строка)
S3Prefix для включения только необходимых файлов метаданных.AccessControlListConfiguration -> (структура)
Предоставляет путь к ведру S3, содержащему файлы фильтрации контекста пользователя для источника данных. Формат файла см. в разделе Управление доступом к источникам данных S3.
KeyPath -> (строка)
SharePointConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Microsoft SharePoint в качестве источника данных.
SharePointVersion -> (string)
Urls -> (list)
URL-адреса сайтов Microsoft SharePoint для документов, которые вы хотите индексировать.
(string)
SecretArn -> (string)
CrawlAttachments -> (boolean)
TRUE для индексирования приложений к документам.UseChangeLog -> (boolean)
TRUE для использования журнала изменений SharePoint, чтобы определить, какие документы требуют обновления в индексе. В зависимости от размера журнала изменений, Amazon Kendra может затратить больше времени на использование журнала изменений, чем на сканирование всех ваших документов в SharePoint.InclusionPatterns -> (list)
Список шаблонов регулярных выражений для включения определенных документов в вашу систему SharePoint. Документы, соответствующие шаблонам, включаются в индекс. Документы, не соответствующие шаблонам, исключаются из индекса. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Регулярное выражение применяется к URL-адресу отображения документа SharePoint.
(string)
ExclusionPatterns -> (list)
Список шаблонов регулярных выражений для исключения определенных документов в вашей системе SharePoint. Документы, соответствующие шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Регулярное выражение применяется к URL-адресу отображения документа SharePoint.
(string)
VpcConfiguration -> (structure)
Конфигурационная информация для виртуальной частной сети Amazon (Amazon VPC) для подключения к вашей системе Microsoft SharePoint. Дополнительная информация доступна в разделе Настройка VPC.
SubnetIds -> (list)
Список идентификаторов подсетей в вашей виртуальной частной сети Amazon (VPC). Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь возможность выхода в Интернет через устройство NAT.
(string)
SecurityGroupIds -> (list)
Список идентификаторов групп безопасности в вашей виртуальной частной сети Amazon (VPC). Группы безопасности должны разрешать Amazon Kendra подключение к источнику данных.
(string)
FieldMappings -> (list)
Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей источника данных SharePoint с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями SharePoint. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей источника данных SharePoint должны существовать в вашей пользовательской метаданных SharePoint.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, генерируется исключение.IndexFieldName -> (string)
DocumentTitleFieldName -> (string)
DisableLocalGroups -> (boolean)
TRUE для отключения информации о локальных группах.SslCertificateS3Path -> (structure)
Путь к сертификату SSL, хранящемуся в ведре Amazon S3. Используется для подключения к SharePoint Server, если требуется безопасное SSL-соединение.
Вы можете сгенерировать самозаверяющий сертификат X509 на любом компьютере, используя OpenSSL. Пример использования OpenSSL для создания сертификата X509 см. в разделе Создание и подписание сертификата X509.
Bucket -> (string)
Key -> (string)
AuthenticationType -> (string)
ProxyConfiguration -> (structure)
Конфигурационная информация для подключения к URL-адресам вашего сайта Microsoft SharePoint через веб-прокси. Может использоваться для SharePoint Server.
Необходимо указать имя хоста и номер порта веб-сайта. Например, имя хоста https://a.example.com/page1.html — «a.example.com», порт — 443, стандартный порт для HTTPS.
Учетные данные веб-прокси необязательны и могут использоваться для подключения к серверу веб-прокси, требующему базовой аутентификации (имя пользователя и пароль). Для хранения учетных данных веб-прокси используется секрет в хранилище секретов.
Рекомендуется следовать лучшим практикам безопасности при настройке веб-прокси. Это включает настройку ограничения скорости, настройку ведения журнала и мониторинга, а также регулярное применение обновлений безопасности. Если вы используете веб-прокси с несколькими источниками данных, одновременные задачи синхронизации могут нагрузить прокси. Рекомендуется заранее подготовить прокси к любым требованиям безопасности и нагрузки.
Host -> (string)
Имя хоста веб-сайта, к которому вы хотите подключиться через сервер веб-прокси.
Например, имя хоста https://a.example.com/page1.html — «a.example.com».
Port -> (integer)
Номер порта хоста веб-сайта, к которому вы хотите подключиться через сервер веб-прокси.
Например, порт для https://a.example.com/page1.html — 443, стандартный порт для HTTPS.
Credentials -> (string)
Идентификатор ресурса Amazon (ARN) секрета хранилища секретов. Создайте секрет для хранения учетных данных в хранилище секретов.
Учетные данные необязательны. Используйте секрет, если для подключения к хосту веб-сайта требуется аутентификация веб-прокси. Amazon Kendra в настоящее время поддерживает базовую аутентификацию для подключения к серверу веб-прокси. Секрет хранит ваши учетные данные.
DatabaseConfiguration -> (structure)
Предоставляет конфигурационную информацию для подключения к базе данных в качестве источника данных.
DatabaseEngineType -> (строка)
ConnectionConfiguration -> (структура)
Конфигурационная информация, необходимая для подключения к базе данных.
DatabaseHost -> (строка)
DatabasePort -> (целое число)
DatabaseName -> (строка)
TableName -> (строка)
SecretArn -> (строка)
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 -> (строка)
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 -> (string)
SecretArn -> (string)
Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ/значение, необходимые для подключения к вашему экземпляру Salesforce. Секрет должен содержать JSON-структуру со следующими ключами:
- authenticationUrl - Конечная точка OAUTH, к которой Amazon Kendra подключается для получения токена OAUTH.
- consumerKey - Открытый ключ приложения, сгенерированный при создании приложения Salesforce.
- consumerSecret - Закрытый ключ приложения, сгенерированный при создании приложения Salesforce.
- password - Пароль пользователя, который входит в экземпляр Salesforce.
- securityToken - Токен, связанный с пользователем, который входит в экземпляр Salesforce.
- username - Имя пользователя, который входит в экземпляр Salesforce.
StandardObjectConfigurations -> (list)
Конфигурация стандартных объектов Salesforce, которые Amazon Kendra индексирует.
(structure)
Предоставляет конфигурационную информацию для индексирования одного стандартного объекта.
Name -> (string)
DocumentDataFieldName -> (string)
DocumentTitleFieldName -> (string)
FieldMappings -> (list)
Сопоставляет атрибуты или имена полей стандартного объекта с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
KnowledgeArticleConfiguration -> (structure)
Конфигурационная информация для типов статей базы знаний, которые Amazon Kendra индексирует. Amazon Kendra индексирует стандартные статьи базы знаний и стандартные поля статей базы знаний или пользовательские поля пользовательских статей базы знаний, но не оба.
IncludedStates -> (list)
Указывает состояния документов, которые должны быть включены при индексировании статей базы знаний Amazon Kendra. Необходимо указать хотя бы одно состояние.
(string)
StandardKnowledgeArticleTypeConfiguration -> (structure)
Конфигурационная информация для стандартных статей базы знаний Salesforce.
DocumentDataFieldName -> (string)
DocumentTitleFieldName -> (string)
FieldMappings -> (list)
Сопоставляет атрибуты или имена полей статьи базы знаний с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
CustomKnowledgeArticleTypeConfigurations -> (list)
Конфигурационная информация для пользовательских статей базы знаний Salesforce.
(structure)
Предоставляет конфигурационную информацию для индексирования пользовательских статей Salesforce.
Name -> (string)
DocumentDataFieldName -> (string)
DocumentTitleFieldName -> (string)
FieldMappings -> (list)
Сопоставляет атрибуты или имена полей пользовательской статьи базы знаний с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Salesforce. Дополнительную информацию см. в разделе Сопоставление полей источника данных . Имена полей источника данных Salesforce должны существовать в вашей пользовательской метаданных Salesforce.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
ChatterFeedConfiguration -> (structure)
Конфигурационная информация для лент Salesforce chatter.
DocumentDataFieldName -> (string)
Body.DocumentTitleFieldName -> (string)
Title.FieldMappings -> (list)
Сопоставляет поля из ленты Salesforce chatter с полями индекса Amazon Kendra.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
IncludeFilterTypes -> (list)
Фильтры документы в ленте на основе состояния пользователя. При указании ACTIVE_USERS индексируются только документы от пользователей с активным аккаунтом. При указании STANDARD_USER индексируются только документы стандартных пользователей Salesforce. Вы можете указать оба.
(string)
CrawlAttachments -> (boolean)
StandardObjectAttachmentConfiguration -> (structure)
Конфигурационная информация для обработки вложений к стандартным объектам Salesforce.
DocumentTitleFieldName -> (string)
FieldMappings -> (list)
Один или несколько объектов, которые сопоставляют поля вложения с полями индекса Amazon Kendra.
(structure)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (string)
UpdateIndex.DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
IncludeAttachmentFilePatterns -> (list)
Список шаблонов регулярных выражений для включения определенных документов в вашу Salesforce. Документы, которые соответствуют шаблонам, включаются в индекс. Документы, которые не соответствуют шаблонам, исключаются из индекса. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Шаблон применяется к имени прикрепленного файла.
(string)
ExcludeAttachmentFilePatterns -> (list)
Список шаблонов регулярных выражений для исключения определённых документов в Salesforce. Документы, соответствующие этим шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Шаблон применяется к имени прикреплённого файла.
(строка)
OneDriveConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Microsoft OneDrive в качестве источника данных.
TenantDomain -> (строка)
SecretArn -> (строка)
OneDriveUsers -> (структура)
Список учётных записей пользователей, документы которых должны быть проиндексированы.
OneDriveUserList -> (список)
Список пользователей, чьи документы должны быть проиндексированы. Укажите имена пользователей в формате электронной почты, например, username@tenantdomain. Если вам необходимо проиндексировать документы более чем 10 пользователей, используйте поле OneDriveUserS3Path для указания местоположения файла, содержащего список пользователей.
(строка)
OneDriveUserS3Path -> (структура)
Местоположение в S3-ведре файла, содержащего список пользователей, чьи документы должны быть проиндексированы.
Bucket -> (строка)
Key -> (строка)
InclusionPatterns -> (список)
Список шаблонов регулярных выражений для включения определённых документов в OneDrive. Документы, соответствующие этим шаблонам, включаются в индекс. Документы, не соответствующие шаблонам, исключаются из индекса. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Шаблон применяется к имени файла.
(строка)
ExclusionPatterns -> (список)
Список шаблонов регулярных выражений для исключения определённых документов в OneDrive. Документы, соответствующие этим шаблонам, исключаются из индекса. Документы, не соответствующие шаблонам, включаются в индекс. Если документ соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и документ не включается в индекс.
Шаблон применяется к имени файла.
(строка)
FieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей источника данных OneDrive с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями OneDrive. Дополнительная информация — в разделе Сопоставление полей источника данных. Имена полей источника данных OneDrive должны существовать в пользовательских метаданных OneDrive.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация — в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
DisableLocalGroups -> (булево)
TRUE для отключения информации о локальных группах.ServiceNowConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к ServiceNow в качестве источника данных.
HostUrl -> (строка)
SecretArn -> (строка)
ServiceNowBuildVersion -> (строка)
LONDON, используйте OTHERS.KnowledgeArticleConfiguration -> (структура)
Конфигурационная информация для сканирования статей по знаниям на сайте ServiceNow.
CrawlAttachments -> (логическое значение)
TRUE для индексации вложений к статьям по знаниям.IncludeAttachmentFilePatterns -> (список)
Список шаблонов регулярных выражений, применяемых для включения вложений к статьям по знаниям. Вложения, соответствующие шаблонам, включаются в индекс. Элементы, которые не соответствуют шаблонам, исключаются из индекса. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
(строка)
ExcludeAttachmentFilePatterns -> (список)
Список шаблонов регулярных выражений, применяемых для исключения определенных вложений к статьям по знаниям. Вложения, соответствующие шаблонам, исключаются из индекса. Элементы, которые не соответствуют шаблонам, включаются в индекс. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
(строка)
DocumentDataFieldName -> (строка)
DocumentTitleFieldName -> (строка)
FieldMappings -> (список)
Сопоставляет атрибуты или имена полей статей по знаниям с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями ServiceNow. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных ServiceNow должны существовать в вашей пользовательской метаданных ServiceNow.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
FilterQuery -> (строка)
Запрос, выбирающий статьи по знаниям для индексации. Запрос может возвращать статьи из нескольких баз знаний, и базы знаний могут быть общедоступными или закрытыми.
Строка запроса должна быть сгенерирована в консоли ServiceNow. Дополнительную информацию см. в разделе Указание индексируемых документов с помощью запроса.
ServiceCatalogConfiguration -> (структура)
Конфигурационная информация для сканирования каталогов услуг на сайте ServiceNow.
CrawlAttachments -> (логическое значение)
TRUE для индексации вложений к элементам каталога услуг.IncludeAttachmentFilePatterns -> (список)
Список шаблонов регулярных выражений для включения определенных вложений каталогов в вашем ServiceNow. Элементы, соответствующие шаблонам, включаются в индекс. Элементы, которые не соответствуют шаблонам, исключаются из индекса. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
Регулярное выражение применяется к имени файла вложения.
(строка)
ExcludeAttachmentFilePatterns -> (список)
Список шаблонов регулярных выражений для исключения определенных вложений каталогов в вашем ServiceNow. Элементы, соответствующие шаблонам, исключаются из индекса. Элементы, которые не соответствуют шаблонам, включаются в индекс. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
Регулярное выражение применяется к имени файла вложения.
(строка)
DocumentDataFieldName -> (строка)
DocumentTitleFieldName -> (строка)
FieldMappings -> (список)
Сопоставляет атрибуты или имена полей каталогов с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями ServiceNow. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных ServiceNow должны существовать в вашей пользовательской метаданных ServiceNow.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
AuthenticationType -> (строка)
Тип аутентификации, используемый для подключения к инстансу ServiceNow. Если выбран HTTP_BASIC, Amazon Kendra аутентифицируется с использованием имени пользователя и пароля, предоставленных в секрете Secrets Manager в поле SecretArn. Если выбран OAUTH2, Amazon Kendra аутентифицируется с использованием учетных данных идентификатора клиента, секрета клиента, имени пользователя и пароля.
При использовании аутентификации OAUTH2 необходимо сгенерировать токен и секрет клиента с помощью консоли ServiceNow. Дополнительную информацию см. в разделе Использование источника данных ServiceNow.
ConfluenceConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Confluence в качестве источника данных.
ServerUrl -> (string)
SecretArn -> (string)
Amazon Resource Name (ARN) секрета из Secrets Manager, содержащего имя пользователя и пароль, необходимые для подключения к экземпляру Confluence. Если вы используете Confluence Cloud, в качестве пароля используется сгенерированный API-токен.
Вы также можете предоставить учетные данные для аутентификации в виде личного доступа токена. Дополнительная информация приведена в разделе Использование источника данных Confluence.
Version -> (string)
SpaceConfiguration -> (structure)
Конфигурационная информация для индексирования пространств Confluence.
CrawlPersonalSpaces -> (boolean)
TRUE для индексирования личных пространств. Вы можете добавить ограничения к элементам в личных пространствах. Если личные пространства индексируются, запросы без информации о контексте пользователя могут возвращать ограниченные элементы из личного пространства в своих результатах. Дополнительная информация приведена в разделе Фильтрация по контексту пользователя.CrawlArchivedSpaces -> (boolean)
TRUE для индексирования архивированных пространств.IncludeSpaces -> (list)
Список ключей пространств Confluence. Если вы включаете ключ, блоги, документы и вложения в пространстве индексируются. Пространства, которые не включены в список, не индексируются. Пространство в списке должно существовать. В противном случае Amazon Kendra регистрирует ошибку при синхронизации источника данных. Если пространство присутствует как в списке IncludeSpaces, так и в списке ExcludeSpaces, пространство исключается.
(string)
ExcludeSpaces -> (list)
Список ключей пространств Confluence. Если вы включаете ключ, блоги, документы и вложения в пространстве не индексируются. Если пространство присутствует как в списке ExcludeSpaces, так и в списке IncludeSpaces, пространство исключается.
(string)
SpaceFieldMappings -> (list)
Сопоставляет атрибуты или имена полей пространств Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
Если вы укажете параметр SpaceFieldMappings, вы должны указать хотя бы одно сопоставление полей.
(structure)
Сопоставляет атрибуты или имена полей пространств Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
DataSourceFieldName -> (string)
DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
PageConfiguration -> (structure)
Конфигурационная информация для индексирования страниц Confluence.
PageFieldMappings -> (list)
Сопоставляет атрибуты или имена полей страниц Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
Если вы укажете параметр PageFieldMappings, вы должны указать хотя бы одно сопоставление полей.
(structure)
Сопоставляет атрибуты или имена полей страниц Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
DataSourceFieldName -> (string)
DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
BlogConfiguration -> (structure)
Конфигурационная информация для индексирования блогов Confluence.
BlogFieldMappings -> (list)
Сопоставляет атрибуты или имена полей блогов Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
Если вы укажете параметр BlogFieldMappings, вы должны указать хотя бы одно сопоставление полей.
(structure)
Сопоставляет атрибуты или имена полей блогов Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
DataSourceFieldName -> (string)
DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
AttachmentConfiguration -> (structure)
Конфигурационная информация для индексирования вложений к блогам и страницам Confluence.
CrawlAttachments -> (boolean)
TRUE для индексирования вложений страниц и блогов в Confluence.AttachmentFieldMappings -> (list)
Сопоставляет атрибуты или имена полей вложений Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confluence должны существовать в вашей пользовательской метаданных Confluence.
Если вы укажете параметр AttachentFieldMappings, вы должны указать хотя бы одно сопоставление полей.
(structure)
Сопоставляет атрибуты или имена полей вложений Confluence с именами полей индекса Amazon Kendra. Чтобы создать пользовательские поля, используйте API UpdateIndex перед сопоставлением с полями Confluence. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Confuence должны существовать в вашей пользовательской метаданных Confluence.
DataSourceFieldName -> (string)
Имя поля в источнике данных.
Сначала необходимо создать поле индекса, используя API UpdateIndex.
DateFieldFormat -> (string)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (string)
VpcConfiguration -> (structure)
Конфигурационная информация для виртуальной частной сети Amazon для подключения к вашему Confluence. Дополнительная информация приведена в разделе Настройка VPC.
SubnetIds -> (list)
Список идентификаторов подсетей в вашей виртуальной частной сети Amazon. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь доступ к Интернету через устройство NAT.
(string)
SecurityGroupIds -> (list)
Список идентификаторов групп безопасности в вашей виртуальной частной сети Amazon. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.
(string)
InclusionPatterns -> (list)
Список шаблонов регулярных выражений для включения определенных блогов, страниц, пространств или вложений в вашем Confluence. Контент, соответствующий шаблонам, включается в индекс. Контент, не соответствующий шаблонам, исключается из индекса. Если контент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и контент не включается в индекс.
(string)
ExclusionPatterns -> (list)
Список шаблонов регулярных выражений для исключения определенных блогов, страниц, пространств или вложений в вашем Confluence. Контент, соответствующий шаблонам, исключается из индекса. Контент, не соответствующий шаблонам, включается в индекс. Если контент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и контент не включается в индекс.
(string)
ProxyConfiguration -> (structure)
Информация о конфигурации для подключения к вашему экземпляру 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 (ARN) секрета Secrets Manager. Вы создаете секрет для хранения учетных данных в Secrets Manager.
Учетные данные являются необязательными. Вы используете секрет, если для подключения к хосту веб-сайта требуются учетные данные веб-прокси. Amazon Kendra в настоящее время поддерживает базовые средства проверки подлинности для подключения к серверу веб-прокси. Секрет хранит ваши учетные данные.
AuthenticationType -> (строка)
GoogleDriveConfiguration -> (структура)
Предоставляет информацию о конфигурации для подключения к Google Диску в качестве источника данных.
SecretArn -> (строка)
InclusionPatterns -> (список)
Список шаблонов регулярных выражений для включения определенных элементов в вашем Google Диске, включая общие диски и личные диски пользователей. Элементы, соответствующие шаблонам, включаются в индекс. Элементы, не соответствующие шаблонам, исключаются из индекса. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
(строка)
ExclusionPatterns -> (список)
Список шаблонов регулярных выражений для исключения определенных элементов в вашем Google Диске, включая общие диски и личные диски пользователей. Элементы, соответствующие шаблонам, исключаются из индекса. Элементы, не соответствующие шаблонам, включаются в индекс. Если элемент соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и элемент не включается в индекс.
(строка)
FieldMappings -> (список)
Сопоставляет атрибуты или имена полей источника данных Google Диск с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Google Диска. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных Google Диска должны существовать в ваших пользовательских метаданных Google Диска.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, генерируется исключение.IndexFieldName -> (строка)
ExcludeMimeTypes -> (список)
Список типов MIME для исключения из индекса. Все документы, соответствующие указанному типу MIME, исключаются.
Список типов MIME см. в разделе Использование источника данных Google Workspace Drive.
(строка)
ExcludeUserAccounts -> (список)
Список адресов электронной почты пользователей. Документы, принадлежащие этим пользователям, исключаются из индекса. Документы, общие с исключенными пользователями, индексируются, если они не исключены другим способом.
(строка)
ExcludeSharedDrives -> (список)
Список идентификаторов или общих дисков для исключения из индекса. Все файлы и папки, хранящиеся на общем диске, исключаются.
(строка)
WebCrawlerConfiguration -> (структура)
Предоставляет конфигурационную информацию, необходимую для веб-краулера Amazon Kendra.
Urls -> (структура)
Указывает URL-адреса семян или начальные URL-адреса веб-сайтов или URL-адреса карты сайта веб-сайтов, которые вы хотите проиндексировать.
Вы можете включить поддомены веб-сайтов. Вы можете указать до 100 URL-адресов семян и до трех URL-адресов карты сайта.
Вы можете проиндексировать только веб-сайты, использующие протокол защищенной связи Hypertext Transfer Protocol Secure (HTTPS). Если при сканировании веб-сайта возникает ошибка, возможно, веб-сайт заблокирован для сканирования.
SeedUrlConfiguration -> (структура)
Конфигурация URL-адресов семян или начальных URL-адресов веб-сайтов, которые вы хотите проиндексировать.
Вы можете выбрать, сканировать только имена хостов веб-сайтов, или имена хостов веб-сайтов с поддоменами, или имена хостов веб-сайтов с поддоменами и другими доменами, к которым ведут ссылки веб-страниц.
Вы можете указать до 100 URL-адресов семян.
SeedUrls -> (список)
Список URL-адресов семян или начальных 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-адресов карт сайта веб-сайтов, которые вы хотите проиндексировать.
Сканируются только URL-адреса, принадлежащие тем же именам хостов веб-сайтов. Вы можете указать до трех URL-адресов карт сайта.
SiteMaps -> (список)
Список URL-адресов карт сайта веб-сайтов, которые вы хотите проиндексировать.
Список может содержать не более трех URL-адресов карт сайта.
(строка)
CrawlDepth -> (целое число)
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 (ARN) секрета Secrets Manager. Вы создаете секрет для хранения учетных данных в Secrets Manager.
Учетные данные необязательны. Используйте секрет, если для подключения к хосту веб-сайта необходимы учетные данные веб-прокси. Amazon Kendra в настоящее время поддерживает аутентификацию по протоколу Basic для подключения к серверу веб-прокси. Секрет хранит ваши учетные данные.
AuthenticationConfiguration -> (структура)
Конфигурационная информация, необходимая для подключения к веб-сайтам с использованием аутентификации.
Вы можете подключиться к веб-сайтам с использованием аутентификации по протоколу Basic с использованием имени пользователя и пароля. Вы используете секрет в Secrets Manager для хранения учетных данных аутентификации.
Вы должны указать имя хоста веб-сайта и номер порта. Например, имя хоста https://a.example.com/page1.html — “a.example.com”, а порт — 443, стандартный порт для HTTPS.
BasicAuthentication -> (список)
Список конфигурационной информации, необходимой для подключения и сканирования хоста веб-сайта с использованием учетных данных аутентификации по протоколу Basic.
Список включает имя и номер порта хоста веб-сайта.
(структура)
Предоставляет конфигурационную информацию для подключения к веб-сайтам, требующим аутентификации пользователя по протоколу Basic.
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.
Вы используете секрет, если для подключения к веб-сайту требуется аутентификация по протоколу Basic. Секрет хранит ваши учетные данные — имя пользователя и пароль.
WorkDocsConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Amazon WorkDocs в качестве источника данных.
OrganizationId -> (строка)
Идентификатор каталога, соответствующего вашему хранилищу сайта Amazon WorkDocs.
Вы можете найти идентификатор организации в службе каталогов, перейдя в раздел Активный каталог, а затем Каталоги. У вашего каталога сайта Amazon WorkDocs есть идентификатор — идентификатор организации. Вы также можете настроить новый каталог 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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, генерируется исключение.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 -> (строка)
VpcConfiguration -> (структура)
Конфигурационная информация для виртуальной частной сети Amazon Virtual Private Cloud для подключения к Amazon FSx. Ваш экземпляр Amazon FSx должен находиться внутри вашей VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь исходящий доступ к Интернету через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов сетевых групп в вашей Amazon VPC. Сетевые группы должны разрешать Amazon Kendra подключаться к источнику данных.
(строка)
SecretArn -> (строка)
Идентификатор ресурса Amazon (ARN) секрета в Secrets Manager, содержащего пары «ключ-значение», необходимые для подключения к вашей файловой системе Amazon FSx. В настоящее время поддерживается только тип Windows. Секрет должен содержать JSON-структуру со следующими ключами:
- username—Имя пользователя Active Directory вместе с доменным именем DNS. Например, user@corp.example.com. Учётная запись пользователя Active Directory должна иметь права чтения и доступа к файловой системе Amazon FSx для Windows.
- password—Пароль учётной записи пользователя Active Directory с правами чтения и доступа к файловой системе Windows Amazon FSx.
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 -> (строка)
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 -> (строка)
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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет сгенерировано исключение.IndexFieldName -> (строка)
BoxConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Box в качестве источника данных.
EnterpriseId -> (строка)
SecretArn -> (строка)
Идентификатор ресурса Amazon (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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
TaskFieldMappings -> (список)
Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей задач Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, используйте API UpdateIndex для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
CommentFieldMappings -> (список)
Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей комментариев Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, используйте API UpdateIndex для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
WebLinkFieldMappings -> (список)
Список DataSourceToIndexFieldMapping объектов, которые сопоставляют атрибуты или имена полей веб-ссылок Box с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Box. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Box должны существовать в вашей пользовательской метаданных Box.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, используйте API UpdateIndex для предварительного создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
InclusionPatterns -> (список)
Список шаблонов регулярных выражений для включения определенных файлов и папок в вашей платформе Box. Файлы и папки, соответствующие шаблонам, включаются в индекс. Файлы и папки, не соответствующие шаблонам, исключаются из индекса. Если файл или папка соответствуют как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл или папка не включаются в индекс.
(строка)
ExclusionPatterns -> (список)
Список шаблонов регулярных выражений для исключения определенных файлов и папок из вашей платформы Box. Файлы и папки, соответствующие шаблонам, исключаются из индекса. Файлы и папки, не соответствующие шаблонам, включаются в индекс. Если файл или папка соответствуют как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл или папка не включаются в индекс.
(строка)
VpcConfiguration -> (структура)
Конфигурационная информация для Amazon VPC для подключения к вашей Box. Дополнительную информацию см. в разделе Настройка VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь доступ вовне к Интернету через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.
(строка)
QuipConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Quip в качестве источника данных.
Domain -> (строка)
SecretArn -> (строка)
Идентификатор Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашей учетной записи Quip. Секрет должен содержать JSON-структуру со следующими ключами:
- accessToken—Токен, созданный в Quip. Дополнительную информацию см. в разделе Использование источника данных Quip.
CrawlFileComments -> (логическое значение)
TRUE для индексирования комментариев к файлам.CrawlChatRooms -> (логическое значение)
TRUE для индексирования содержимого чатов.CrawlAttachments -> (логическое значение)
TRUE для индексирования вложений.FolderIds -> (список)
Идентификаторы папок Quip, которые вы хотите проиндексировать. Идентификатор папки можно найти в строке URL вашего браузера при доступе к папке в Quip. Например, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. В данном примере идентификатор папки — “zlLuOVNSarTL”.
(строка)
ThreadFieldMappings -> (список)
Список объектов, отображающих атрибуты или имена полей нитей Quip в имена полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед отображением на поля Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.
(структура)
Отображает атрибуты или имена полей документов, синхронизированных из источника данных, в имена полей индекса Amazon Kendra. Настройки сопоставления полей для каждого источника данных можно задать при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
MessageFieldMappings -> (список)
Список объектов, отображающих атрибуты или имена полей сообщений Quip в имена полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед отображением на поля Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.
(структура)
Отображает атрибуты или имена полей документов, синхронизированных из источника данных, в имена полей индекса Amazon Kendra. Настройки сопоставления полей для каждого источника данных можно задать при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
AttachmentFieldMappings -> (список)
Список объектов, отображающих атрибуты или имена полей вложений Quip в имена полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед отображением на поля Quip. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей Quip должны существовать в вашей пользовательской метаданных Quip.
(структура)
Отображает атрибуты или имена полей документов, синхронизированных из источника данных, в имена полей индекса Amazon Kendra. Настройки сопоставления полей для каждого источника данных можно задать при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
InclusionPatterns -> (список)
Список регулярных выражений, включающих определенные файлы в вашей файловой системе Quip. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
ExclusionPatterns -> (список)
Список регулярных выражений, исключающих определенные файлы в вашей файловой системе Quip. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
VpcConfiguration -> (структура)
Конфигурационная информация для виртуальной частной сети Amazon (VPC) для подключения к вашей учетной записи Quip. Дополнительную информацию см. в разделе Настройка VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и иметь внешний доступ к интернету через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны позволять Amazon Kendra подключаться к источнику данных.
(строка)
JiraConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Jira в качестве источника данных.
JiraAccountUrl -> (строка)
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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
CommentFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей комментариев Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
IssueFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей задач Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
ProjectFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей проектов Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
WorkLogFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, сопоставляющих атрибуты или имена полей журналов работы Jira с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Jira. Дополнительная информация приведена в разделе Сопоставление полей источника данных. Имена полей источника данных Jira должны существовать в вашей пользовательской метаданных Jira.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей используйте API UpdateIndex, чтобы сначала создать поле индекса, а затем сопоставить его с полем источника данных. Дополнительная информация приведена в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если это не поле даты, будет выброшено исключение.IndexFieldName -> (строка)
InclusionPatterns -> (список)
Список шаблонов регулярных выражений для включения определенных путей файлов, имен файлов и типов файлов в вашем источнике данных Jira. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
ExclusionPatterns -> (список)
Список шаблонов регулярных выражений для исключения определенных путей файлов, имен файлов и типов файлов в вашем источнике данных Jira. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует как шаблону включения, так и исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
VpcConfiguration -> (структура)
Конфигурационная информация для Amazon Virtual Private Cloud для подключения к вашему Jira. Дополнительная информация приведена в разделе Настройка VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC и должны иметь исходящий доступ к Интернету через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны позволить Amazon Kendra подключаться к источнику данных.
(строка)
GitHubConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к GitHub в качестве источника данных.
Примечание
Amazon Kendra теперь поддерживает обновленный коннектор GitHub.
Теперь вы должны использовать объект TemplateConfiguration вместо объекта GitHubConfiguration для настройки своего коннектора.
Коннекторы, настроенные с помощью более старой архитектуры консоли и API, будут продолжать функционировать в соответствии с настройками. Однако вы не сможете их редактировать или обновлять. Если вы хотите изменить или обновить конфигурацию своего коннектора, вы должны создать новый коннектор.
Мы рекомендуем мигрировать ваш рабочий процесс коннектора к обновленной версии. Поддержка коннекторов, настроенных с использованием более старой архитектуры, прекратится к июню 2024 года.
SaaSConfiguration -> (структура)
Конфигурационная информация для подключения к GitHub Enterprise Cloud (SaaS).
OrganizationName -> (строка)
HostUrl -> (строка)
OnPremiseConfiguration -> (структура)
Конфигурационная информация для подключения к GitHub Enterprise Server (на предприятии).
HostUrl -> (строка)
OrganizationName -> (строка)
SslCertificateS3Path -> (структура)
Путь к сертификату SSL, хранящемуся в ведре Amazon S3. Используется для подключения к GitHub, если требуется защищённое SSL-соединение.
Вы можете просто сгенерировать самозаверяющий X509-сертификат на любом компьютере с помощью OpenSSL. Пример создания X509-сертификата с помощью OpenSSL см. в Create and sign an X509 certificate.
Bucket -> (строка)
Key -> (строка)
Type -> (строка)
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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
GitHubCommitConfigurationFieldMappings -> (список)
Список объектов 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 -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, вы должны указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
GitHubIssueDocumentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей GitHub-задач с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
GitHubIssueCommentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей комментариев к GitHub-задачам с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
GitHubIssueAttachmentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей вложений к GitHub-задачам с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
GitHubPullRequestCommentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей комментариев к GitHub-запросам на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
GitHubPullRequestDocumentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей GitHub-запросов на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
GitHubPullRequestDocumentAttachmentConfigurationFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей вложений к GitHub-запросам на вытягивание с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями GitHub. Дополнительная информация доступна в разделе Сопоставление полей источника данных. Имена полей GitHub-источника данных должны существовать в вашей пользовательской метаданных GitHub.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Чтобы создать пользовательские поля, сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительная информация доступна в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, возникает исключение.IndexFieldName -> (строка)
AlfrescoConfiguration -> (структура)
Предоставляет конфигурационную информацию для подключения к Alfresco в качестве источника данных.
Примечание
ПоддержкаAlfrescoConfiguration завершилась в мае 2023 года. Рекомендуется мигрировать на шаблон схемы источника данных Alfresco или использовать API TemplateConfiguration.SiteUrl -> (строка)
SiteId -> (строка)
SecretArn -> (строка)
Amazon Resource Name (ARN) секрета Secrets Manager, содержащего пары ключ-значение, необходимые для подключения к вашему источнику данных Alfresco. Секрет должен содержать JSON-структуру со следующими ключами:
- username—Имя пользователя учетной записи Alfresco.
- password—Пароль учетной записи Alfresco.
SslCertificateS3Path -> (структура)
Путь к сертификату SSL, хранящемуся в ведре Amazon S3. Используется для подключения к Alfresco, если требуется безопасное подключение SSL.
Вы можете просто сгенерировать самозаверяющий X509-сертификат на любом компьютере с помощью OpenSSL. Пример использования OpenSSL для создания X509-сертификата см. в разделе Создание и подписание X509-сертификата.
Bucket -> (строка)
Key -> (строка)
CrawlSystemFolders -> (булево)
TRUE для индексирования общих файлов.CrawlComments -> (булево)
TRUE для индексирования комментариев к блогам и другому контенту.EntityFilter -> (список)
Укажите, следует ли индексировать библиотеки документов, вики или блоги. Вы можете указать один или несколько из этих вариантов.
(строка)
DocumentLibraryFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей библиотек документов Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
BlogFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей блогов Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
WikiFieldMappings -> (список)
Список объектов DataSourceToIndexFieldMapping, которые сопоставляют атрибуты или имена полей вики Alfresco с именами полей индекса Amazon Kendra. Для создания пользовательских полей используйте API UpdateIndex перед сопоставлением с полями Alfresco. Дополнительную информацию см. в разделе Сопоставление полей источника данных. Имена полей источника данных Alfresco должны существовать в вашей пользовательской метаданных Alfresco.
(структура)
Сопоставляет атрибуты или имена полей документов, синхронизированных из источника данных, с именами полей индекса Amazon Kendra. Вы можете настроить сопоставления полей для каждого источника данных при вызове API CreateDataSource или UpdateDataSource. Для создания пользовательских полей сначала используйте API UpdateIndex для создания поля индекса, а затем сопоставьте его с полем источника данных. Дополнительную информацию см. в разделе Сопоставление полей источника данных.
DataSourceFieldName -> (строка)
UpdateIndex.DateFieldFormat -> (строка)
DataSourceFieldName, является полем даты, необходимо указать формат даты. Если поле не является полем даты, будет выброшено исключение.IndexFieldName -> (строка)
InclusionPatterns -> (список)
Список шаблонов регулярных выражений для включения определенных файлов в ваш источник данных Alfresco. Файлы, соответствующие шаблонам, включаются в индекс. Файлы, не соответствующие шаблонам, исключаются из индекса. Если файл соответствует и шаблону включения, и шаблону исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
ExclusionPatterns -> (список)
Список шаблонов регулярных выражений для исключения определенных файлов в вашем источнике данных Alfresco. Файлы, соответствующие шаблонам, исключаются из индекса. Файлы, не соответствующие шаблонам, включаются в индекс. Если файл соответствует и шаблону включения, и шаблону исключения, шаблон исключения имеет приоритет, и файл не включается в индекс.
(строка)
VpcConfiguration -> (структура)
Конфигурационная информация для Amazon Virtual Private Cloud для подключения к вашему Alfresco. Дополнительную информацию см. в разделе Настройка VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь возможность выхода в Интернет через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.
(строка)
TemplateConfiguration -> (структура)
Предоставляет шаблон для конфигурационной информации для подключения к вашему источнику данных.
Template -> (документ)
Схема шаблона, используемого для источника данных, где поддерживаются шаблоны.
См. Схемы шаблонов источников данных.
Синтаксис 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 Virtual Private Cloud для подключения к вашему источнику данных. Дополнительную информацию см. в разделе Настройка VPC.
SubnetIds -> (список)
Список идентификаторов подсетей в вашей Amazon VPC. Подсети должны иметь возможность подключения друг к другу в VPC, и они должны иметь возможность выхода в Интернет через устройство NAT.
(строка)
SecurityGroupIds -> (список)
Список идентификаторов групп безопасности в вашей Amazon VPC. Группы безопасности должны разрешать Amazon Kendra подключаться к источнику данных.
(строка)
Сокращенный синтаксис:
SubnetIds=string,string,SecurityGroupIds=string,string
Синтаксис JSON:
{
"SubnetIds": ["string", ...],
"SecurityGroupIds": ["string", ...]
}
--description (строка)
--schedule (строка)
--role-arn (строка)
--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 -> (строка)
StringListValue -> (список)
Список строк. Максимальная длина или количество строк по умолчанию составляет 10.
(строка)
LongValue -> (целое число)
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 -> (строка)
StringListValue -> (список)
Список строк. Максимальная длина или количество строк по умолчанию составляет 10.
(строка)
LongValue -> (целое число)
DateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно, чтобы в формате даты и времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
DocumentContentDeletion -> (булево)
TRUE для удаления содержимого, если выполняется условие, используемое для целевого атрибута.PreExtractionHookConfiguration -> (структура)
Информация о конфигурации для вызова функции Lambda в Lambda для исходных или необработанных документов перед извлечением их метаданных и текста. Вы можете использовать функцию Lambda для применения расширенной логики для создания, изменения или удаления метаданных и содержимого документов. Дополнительную информацию см. в разделе Расширенная обработка данных .
InvocationCondition -> (структура)
Условие, используемое для того, когда должна быть вызвана функция Lambda.
Например, вы можете указать условие, согласно которому, если есть пустые значения даты и времени, Amazon Kendra должен вызвать функцию, которая вставит текущую дату и время.
ConditionDocumentAttributeKey -> (строка)
Идентификатор атрибута документа, используемого для условия.
Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.
В настоящее время Amazon Kendra не поддерживает _document_body в качестве ключа атрибута, используемого для условия.
Operator -> (строка)
Оператор условия.
Например, вы можете использовать ‘Contains’ для частичного соответствия строке.
ConditionOnValue -> (структура)
Значение, используемое оператором.
Например, вы можете указать значение ‘financial’ для строк в поле ‘Source_URI’, которые частично совпадают или содержат это значение.
StringValue -> (строка)
StringListValue -> (список)
Список строк. Максимальная длина или количество строк по умолчанию составляет 10.
(строка)
LongValue -> (целое число)
DateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно, чтобы в формате даты и времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
LambdaArn -> (строка)
S3Bucket -> (строка)
PostExtractionHookConfiguration -> (структура)
Информация о конфигурации для вызова функции Lambda в Lambda для структурированных документов с извлеченными метаданными и текстом. Вы можете использовать функцию Lambda для применения расширенной логики для создания, изменения или удаления метаданных и содержимого документов. Дополнительную информацию см. в разделе Расширенная обработка данных .
InvocationCondition -> (структура)
Условие, используемое для того, когда должна быть вызвана функция Lambda.
Например, вы можете указать условие, согласно которому, если есть пустые значения даты и времени, Amazon Kendra должен вызвать функцию, которая вставит текущую дату и время.
ConditionDocumentAttributeKey -> (строка)
Идентификатор атрибута документа, используемого для условия.
Например, ‘Source_URI’ может быть идентификатором атрибута или поля метаданных, содержащего URI источников, связанных с документами.
В настоящее время Amazon Kendra не поддерживает _document_body в качестве ключа атрибута, используемого для условия.
Operator -> (строка)
Оператор условия.
Например, вы можете использовать ‘Contains’ для частичного соответствия строке.
ConditionOnValue -> (структура)
Значение, используемое оператором.
Например, вы можете указать значение ‘financial’ для строк в поле ‘Source_URI’, которые частично совпадают или содержат это значение.
StringValue -> (строка)
StringListValue -> (список)
Список строк. Максимальная длина или количество строк по умолчанию составляет 10.
(строка)
LongValue -> (целое число)
DateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно, чтобы в формате даты и времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
LambdaArn -> (строка)
S3Bucket -> (строка)
RoleArn -> (строка)
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)
Файл с набором сертификатов CA для проверки 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.
Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Обновление коннектора источника данных Amazon Kendra
Следующий update-data-source обновляет конфигурацию коннектора источника данных Amazon Kendra. Если действие выполняется успешно, служба либо не отправляет выходных данных, либо возвращает HTTP-код состояния 200, либо код возврата AWS CLI 0. Вы можете использовать describe-data-source, чтобы просмотреть конфигурацию и состояние коннектора источника данных.
aws kendra update-data-source \
--id exampledatasource1 \
--index-id exampleindex1 \
--name "new name for example data source 1" \
--description "new description for example data source 1" \
--role-arn arn:aws:iam::my-account-id:role/KendraNewRoleForExampleDataSource \
--configuration '{"TemplateConfiguration": {"Template": file://s3schemanewconfig.json}}' \
--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/KendraNewRoleForCDE"}' \
--language-code "es" \
--schedule "0 0 18 ? * MON,WED,FRI *" \
--vpc-configuration '{"SecurityGroupIds": ["sg-1234567890abcdef0"], "SubnetIds": ["subnet-1c234","subnet-2b134"]}'
Эта команда не генерирует выходных данных.
Дополнительную информацию см. в разделе Начало работы с индексом и коннектором источника данных Amazon Kendra в Руководстве разработчика Amazon Kendra.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.