Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

обновить-опыт

Описание

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

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

Синтаксис

  update-experience
--id <value>
[--name <value>]
--index-id <value>
[--role-arn <value>]
[--configuration <value>]
[--description <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 (строка)

Идентификатор вашего опыта Amazon Kendra, который вы хотите обновить.

--name (строка)

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

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

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

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

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

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

Информация о конфигурации, которую вы хотите обновить для своего опыта 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.

--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 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.

Вывод

Нет

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

Spec-Zone.ru

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