describe-data-source

Описание

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

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

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

Синтаксис

  describe-data-source
--id <value>
--index-id <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 (строка)

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

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

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

--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 (булево)

Включить отладочную регистрацию.

--endpoint-url (строка)

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

--no-verify-ssl (булево)

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

--no-paginate (булево)

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

--output (строка)

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

json
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

--no-sign-request (булево)

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

--ca-bundle (строка)

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

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования для использования для двоичных блоков. Формат по умолчанию — 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 (булево)

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

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для получения информации о соединителе Amazon Kendra для источника данных

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

aws kendra describe-data-source \
    --id exampledatasource1 \
    --index-id exampleindex1

Вывод:

{
    "Configuration": {
        "TemplateConfiguration": {
            "Template": {
                "connectionConfiguration": {
                    "repositoryEndpointMetadata": {
                        "BucketName": "amzn-s3-demo-bucket"
                    }
                },
                "repositoryConfigurations": {
                    "document":{
                        "fieldMappings": [
                            {
                                "indexFieldName":"_document_title",
                                "indexFieldType":"STRING",
                                "dataSourceFieldName": "title"
                            },
                            {
                                "indexFieldName":"_last_updated_at",
                                "indexFieldType":"DATE",
                                "dataSourceFieldName": "modified_date"
                            }
                        ]
                    }
                },
                "additionalProperties": {
                    "inclusionPatterns": [
                        "*.txt",
                        "*.doc",
                        "*.docx"
                    ],
                    "exclusionPatterns": [
                        "*.json"
                    ],
                    "inclusionPrefixes": [
                        "PublicExampleDocsFolder"
                    ],
                    "exclusionPrefixes": [
                        "PrivateDocsFolder/private"
                    ],
                    "aclConfigurationFilePath": "ExampleDocsFolder/AclConfig.json",
                    "metadataFilesPrefix": "metadata"
                },
                "syncMode": "FULL_CRAWL",
                "type" : "S3",
                "version": "1.0.0"
            }
        }
    },
    "CreatedAt": 2024-02-25T13:30:10+00:00,
    "CustomDocumentEnrichmentConfiguration": {
        "PostExtractionHookConfiguration": {
            "LambdaArn": "arn:aws:iam::my-account-id:function/my-function-ocr-docs",
            "S3Bucket": "s3://amzn-s3-demo-bucket/scanned-image-text-example-docs/function"
        },
        "RoleArn": "arn:aws:iam:my-account-id:role/KendraRoleForCDE"
    }
    "Description": "Example data source 1 for example index 1 contains the first set of example documents",
    "Id": exampledatasource1,
    "IndexId": exampleindex1,
    "LanguageCode": "en",
    "Name": "example data source 1",
    "RoleArn": "arn:aws:iam::my-account-id:role/KendraRoleForS3TemplateConfigDataSource",
    "Schedule": "0 0 18 ? * TUE,MON,WED,THU,FRI,SAT *",
    "Status": "ACTIVE",
    "Type": "TEMPLATE",
    "UpdatedAt": 1709163615,
    "VpcConfiguration": {
        "SecurityGroupIds": ["sg-1234567890abcdef0"],
        "SubnetIds": ["subnet-1c234","subnet-2b134"]
    }
}

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

Вывод

Id -> (строка)

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

IndexId -> (строка)

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

Name -> (строка)

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

Type -> (строка)

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

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, в каталоге и его подкаталогах.

(строка)

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

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

S3Prefix -> (строка)

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

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

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

KeyPath -> (строка)

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

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

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

SharePointVersion -> (строка)

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

Urls -> (список)

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

(строка)

SecretArn -> (строка)

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

CrawlAttachments -> (булево)

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

UseChangeLog -> (булево)

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

InclusionPatterns -> (список)

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

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

(строка)

ExclusionPatterns -> (список)

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

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

(строка)

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

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

DocumentTitleFieldName -> (строка)

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

DisableLocalGroups -> (булево)

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

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

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

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

Bucket -> (строка)

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

Key -> (строка)

Имя файла.

AuthenticationType -> (строка)

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

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

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

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

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

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

Host -> (строка)

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

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

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

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

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

Credentials -> (строка)

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

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

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

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

DatabaseEngineType -> (строка)

Тип СУБД, которая выполняет базу данных.

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

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

DatabaseHost -> (строка)

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

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

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

DatabaseName -> (строка)

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

TableName -> (строка)

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

SecretArn -> (строка)

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

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

(строка)

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

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

DocumentIdColumnName -> (строка)

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

DocumentDataColumnName -> (строка)

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

DocumentTitleColumnName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

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

ChangeDetectingColumns -> (список)

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

(строка)

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

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

AllowedGroupsColumnName -> (строка)

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

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

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

QueryIdentifiersEnclosingOption -> (строка)

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

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

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

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

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

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

ServerUrl -> (строка)

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

SecretArn -> (строка)

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

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

StandardObjectConfigurations -> (список)

Конфигурация стандартных объектов Salesforce, которые индексирует Amazon Kendra.

(структура)

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

Name -> (строка)

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

DocumentDataFieldName -> (строка)

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

DocumentTitleFieldName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

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

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

IncludedStates -> (список)

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

(строка)

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

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

DocumentDataFieldName -> (строка)

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

DocumentTitleFieldName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

CustomKnowledgeArticleTypeConfigurations -> (список)

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

(структура)

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

Name -> (строка)

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

DocumentDataFieldName -> (строка)

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

DocumentTitleFieldName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

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

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

DocumentDataFieldName -> (строка)

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

DocumentTitleFieldName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IncludeFilterTypes -> (список)

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

(строка)

CrawlAttachments -> (логическое)

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

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

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

DocumentTitleFieldName -> (строка)

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

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IncludeAttachmentFilePatterns -> (список)

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

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

(строка)

ExcludeAttachmentFilePatterns -> (список)

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

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

(строка)

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

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

TenantDomain -> (строка)

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

SecretArn -> (строка)

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

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

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

OneDriveUserList -> (список)

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

(строка)

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

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

Bucket -> (строка)

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

Key -> (строка)

Имя файла.

InclusionPatterns -> (список)

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

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

(строка)

ExclusionPatterns -> (список)

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

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

DisableLocalGroups -> (булево)

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

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

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

HostUrl -> (string)

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

SecretArn -> (string)

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

ServiceNowBuildVersion -> (string)

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

KnowledgeArticleConfiguration -> (structure)

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

CrawlAttachments -> (boolean)

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

IncludeAttachmentFilePatterns -> (list)

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

(string)

ExcludeAttachmentFilePatterns -> (list)

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

(string)

DocumentDataFieldName -> (string)

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

DocumentTitleFieldName -> (string)

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

FieldMappings -> (list)

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

(structure)

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

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

FilterQuery -> (string)

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

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

ServiceCatalogConfiguration -> (structure)

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

CrawlAttachments -> (boolean)

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

IncludeAttachmentFilePatterns -> (list)

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

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

(string)

ExcludeAttachmentFilePatterns -> (list)

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

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

(string)

DocumentDataFieldName -> (string)

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

DocumentTitleFieldName -> (string)

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

FieldMappings -> (list)

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

(structure)

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

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

AuthenticationType -> (string)

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

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

ConfluenceConfiguration -> (structure)

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

ServerUrl -> (string)

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

SecretArn -> (string)

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

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

Version -> (string)

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

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)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

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

IndexFieldName -> (string)

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

PageConfiguration -> (structure)

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

PageFieldMappings -> (list)

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

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

(structure)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

BlogConfiguration -> (structure)

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

BlogFieldMappings -> (list)

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

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

(structure)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

AttachmentConfiguration -> (structure)

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

CrawlAttachments -> (boolean)

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

AttachmentFieldMappings -> (list)

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

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

(structure)

DataSourceFieldName -> (string)

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

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

DateFieldFormat -> (string)

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 Resource Name (ARN) секрета Secrets Manager. Вы создаёте секрет для хранения ваших учётных данных в Secrets Manager.

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

AuthenticationType -> (строка)

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

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

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

SecretArn -> (строка)

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

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

Имя поля в источнике данных. Вы должны сначала создать поле индекса с помощью API 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). Если при переползании веб-сайта возникает ошибка, это может быть связано с тем, что веб-сайт заблокирован для переползания.

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

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 -> (целое число)

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

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

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

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

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

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

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

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

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

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

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

Требуется минимум один URL-адрес.

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

UrlInclusionPatterns -> (список)

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

(строка)

UrlExclusionPatterns -> (список)

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

(строка)

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

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

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

Учетные данные веб-прокси являются необязательными, и вы можете использовать их для подключения к серверу веб-прокси, требующему аутентификацию по основам. Для хранения учетных данных веб-прокси вы используете секрет в 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 в настоящее время поддерживает аутентификацию по основам для подключения к серверу веб-прокси. Секрет хранит ваши учетные данные.

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

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

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

BasicAuthentication -> (список)

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

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

(структура)

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

Host -> (строка)

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

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

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

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

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

Credentials -> (строка)

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

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

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

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

OrganizationId -> (строка)

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

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

CrawlComments -> (булево)

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

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

UseChangeLog -> (булево)

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

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

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

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

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

Примечание

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

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

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

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

FileSystemId -> (строка)

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

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

FileSystemType -> (строка)

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

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

Список идентификаторов групп безопасности в вашей VPC Amazon. Группы безопасности должны позволять 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 с правами на чтение и подключение к файловой системе Amazon FSx для Windows.

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

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

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

Примечание

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

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

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

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

TeamId -> (строка)

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

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

SecretArn -> (строка)

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

slackToken — токен пользователя или бота, созданный в Slack. Дополнительную информацию о создании токена в Slack см. в разделе Authentication for a Slack data source.

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

SlackEntityList -> (список)

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

(строка)

UseChangeLog -> (булево)

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

CrawlBotMessage -> (булево)

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

ExcludeArchived -> (булево)

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

SinceCrawlDate -> (строка)

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

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

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

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

PrivateChannelFilter -> (список)

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

(строка)

PublicChannelFilter -> (список)

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

(строка)

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

FieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

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

IndexFieldName -> (строка)

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

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

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

EnterpriseId -> (string)

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

SecretArn -> (string)

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

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

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

UseChangeLog -> (boolean)

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

CrawlComments -> (boolean)

TRUE включить индексацию комментариев.

CrawlTasks -> (boolean)

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

CrawlWebLinks -> (boolean)

TRUE включить индексацию веб-ссылок.

FileFieldMappings -> (list)

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

(structure)

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

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

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

IndexFieldName -> (string)

TaskFieldMappings -> (list)

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

(structure)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

CommentFieldMappings -> (list)

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

(structure)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

WebLinkFieldMappings -> (list)

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

(structure)

DataSourceFieldName -> (string)

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

DateFieldFormat -> (string)

IndexFieldName -> (string)

InclusionPatterns -> (list)

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

(string)

ExclusionPatterns -> (list)

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

(string)

VpcConfiguration -> (structure)

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

SubnetIds -> (list)

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

(string)

SecurityGroupIds -> (list)

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

(string)

QuipConfiguration -> (structure)

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

Domain -> (строка)

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

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 -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

MessageFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

AttachmentFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

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

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

JiraAccountUrl -> (строка)

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

SecretArn -> (строка)

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

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

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

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

Project -> (список)

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

(строка)

IssueType -> (список)

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

(строка)

Status -> (список)

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

(строка)

IssueSubEntityFilter -> (список)

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

(строка)

AttachmentFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

CommentFieldMappings -> (список)

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

(структура)

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

IssueFieldMappings -> (список)

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

(структура)

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

ProjectFieldMappings -> (список)

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

(структура)

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

WorkLogFieldMappings -> (список)

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

(структура)

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

(строка)

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

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

Примечание

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

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

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

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

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

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

OrganizationName -> (строка)

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

HostUrl -> (строка)

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

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

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

HostUrl -> (строка)

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

OrganizationName -> (строка)

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

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

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

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

Bucket -> (строка)

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

Key -> (строка)

Имя файла.

Type -> (строка)

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

SecretArn -> (строка)

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

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

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. Дополнительную информацию см. в разделе Настройка VPC.

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

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

(строка)

GitHubRepositoryConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubCommitConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubIssueDocumentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

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

GitHubIssueCommentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubIssueAttachmentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestCommentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestDocumentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

GitHubPullRequestDocumentAttachmentConfigurationFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

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

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

Примечание

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

SiteUrl -> (строка)

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

SiteId -> (строка)

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

SecretArn -> (строка)

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

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

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

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

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

Bucket -> (строка)

Имя S3-хранилища, содержащего файл.

Key -> (строка)

Имя файла.

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

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

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

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

EntityFilter -> (список)

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

(строка)

DocumentLibraryFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

BlogFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

WikiFieldMappings -> (список)

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

(структура)

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

DataSourceFieldName -> (строка)

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

DateFieldFormat -> (строка)

IndexFieldName -> (строка)

InclusionPatterns -> (список)

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

(строка)

ExclusionPatterns -> (список)

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

(строка)

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

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

SubnetIds -> (список)

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

(строка)

SecurityGroupIds -> (список)

(строка)

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

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

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

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

См. Схемы шаблонов источника данных .

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

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

SubnetIds -> (список)

(строка)

SecurityGroupIds -> (список)

(строка)

CreatedAt -> (временная метка)

Временная метка Unix, когда был создан коннектор источника данных.

UpdatedAt -> (временная метка)

Временная метка Unix, когда коннектор источника данных был обновлен в последний раз.

Description -> (строка)

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

Status -> (строка)

Текущий статус коннектора источника данных. Когда статус ACTIVE, источник данных готов к использованию. Когда статус ErrorMessage, поле ErrorMessage содержит причину ошибки источника данных.

Schedule -> (строка)

График обновления индекса Amazon Kendra.

RoleArn -> (строка)

Amazon Resource Name (ARN) роли IAM с разрешениями на доступ к источнику данных и необходимым ресурсам.

ErrorMessage -> (строка)

Если значение поля Status равно FAILED, поле ErrorMessage содержит описание ошибки, вызвавшей сбой источника данных.

LanguageCode -> (строка)

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

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

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

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

InlineConfigurations -> (список)

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

(структура)

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

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

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

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

ConditionDocumentAttributeKey -> (строка)

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

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

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

Operator -> (строка)

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

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

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

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

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

StringValue -> (строка)

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

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 -> (строка)

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

StringListValue -> (список)

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

(строка)

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

Целое число со знаком.

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

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

DocumentContentDeletion -> (булево)

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

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

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

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

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

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

ConditionDocumentAttributeKey -> (строка)

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

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

Operator -> (строка)

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

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

Целое число со знаком.

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

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

LambdaArn -> (строка)

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

S3Bucket -> (строка)

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

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

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

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

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

ConditionDocumentAttributeKey -> (строка)

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

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

Operator -> (строка)

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

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

Целое число со знаком.

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

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

LambdaArn -> (строка)

S3Bucket -> (строка)

RoleArn -> (строка)

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

END_OF_DOCUMENT_MARKER