Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

создать-опыт

Описание

Создаёт опыт Amazon Kendra, такой как приложение поиска. Для получения дополнительной информации о создании опыта приложения поиска, включая использование Python и Java SDK, см. Создание опыта поиска без кода.

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

Синтаксис

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

Параметры

--name (строка)

Имя вашего опыта Amazon Kendra.

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

Идентификатор индекса для вашего опыта Amazon Kendra.

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

Amazon Resource Name (ARN) роли IAM с разрешением на доступ к API Query, API GetQuerySuggestions и другим необходимым API. Роль также должна включать разрешение на доступ к IAM Identity Center, где хранятся данные о ваших пользователях и группах. Для получения дополнительной информации см. Роли доступа IAM для Amazon Kendra.

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

Конфигурационная информация для вашего опыта Amazon Kendra. Это включает ContentSourceConfiguration , который указывает идентификаторы источников данных и/или идентификаторы часто задаваемых вопросов, и UserIdentityConfiguration, который указывает информацию о пользователе или группе для предоставления доступа к вашему опыту Amazon Kendra.

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

Идентификаторы ваших источников данных и часто задаваемых вопросов. Или вы можете указать, что хотите использовать документы, проиндексированные с помощью API BatchPutDocument. Это содержимое, которое вы хотите использовать для своего опыта Amazon Kendra.

DataSourceIds -> (список)

Идентификатор источников данных, которые вы хотите использовать для своего опыта Amazon Kendra.

(строка)

FaqIds -> (список)

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

(строка)

DirectPutContent -> (булево)

TRUE для использования документов, которые вы проиндексировали напрямую с помощью API BatchPutDocument.

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

Имя поля IAM Identity Center, содержащее идентификаторы ваших пользователей, такие как их электронные адреса.

IdentityAttributeName -> (строка)

Имя поля IAM Identity Center, содержащее идентификаторы ваших пользователей, такие как их электронные адреса. Это используется для фильтрации контекста пользователя и для предоставления доступа к вашему опыту Amazon Kendra. Вы должны настроить IAM Identity Center с Amazon Kendra. Вы должны включить своих пользователей и группы в список управления доступом при импорте документов в свой индекс. Для получения дополнительной информации см. Начало работы с источником идентификатора IAM Identity Center.

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

ContentSourceConfiguration={DataSourceIds=[string,string],FaqIds=[string,string],DirectPutContent=boolean},UserIdentityConfiguration={IdentityAttributeName=string}

Синтаксис JSON:

{
  "ContentSourceConfiguration": {
    "DataSourceIds": ["string", ...],
    "FaqIds": ["string", ...],
    "DirectPutContent": true|false
  },
  "UserIdentityConfiguration": {
    "IdentityAttributeName": "string"
  }
}

--description (строка)

Описание вашего опыта Amazon Kendra.

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

Токен, который вы предоставляете для идентификации запроса на создание вашего опыта Amazon Kendra. Несколько вызовов API CreateExperience с одинаковым токеном клиента создают только один опыт Amazon Kendra.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичным данным, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить пейджер CLI для вывода.

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

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

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

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

Вывод

Id -> (строка)

Идентификатор вашего опыта Amazon Kendra.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API