Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

привязать-сущности-к-опыту

Описание

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

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

Синтаксис

  associate-entities-to-experience
--id <value>
--index-id <value>
--entity-list <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.

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

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

--entity-list (список)

Список пользователей или групп в вашем источнике идентификации IAM Identity Center.

(структура)

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

EntityId -> (строка)

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

EntityType -> (строка)

Указывает, настраиваете ли вы User или Group.

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

EntityId=string,EntityType=string ...

Синтаксис JSON:

[
  {
    "EntityId": "string",
    "EntityType": "USER"|"GROUP"
  }
  ...
]

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

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

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

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

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

Вывод

FailedEntityList -> (список)

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

(структура)

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

EntityId -> (строка)

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

ErrorMessage -> (строка)

Причина, по которой пользователь или группа в вашем источнике идентификации IAM Identity Center не смогли должным образом настроить работу с вашим опытом Amazon Kendra.

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

Spec-Zone.ru

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