Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

put-principal-mapping

Описание

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

Вы также можете сопоставлять подгруппы с группами. Например, группа «Команды по интеллектуальной собственности компании» включает подгруппы «Исследования» и «Инжиниринг». Эти подгруппы содержат собственный список пользователей или людей, работающих в этих командах. Только пользователи, работающие в отделах исследований и инжиниринга, и, следовательно, являющиеся членами группы интеллектуальной собственности, могут видеть конфиденциальные документы компании в результатах поиска.

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

Если в данный момент обрабатывается более пяти PUT действий для группы, генерируется исключение проверки.

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

Синтаксис

  put-principal-mapping
--index-id <value>
[--data-source-id <value>]
--group-id <value>
--group-members <value>
[--ordering-id <value>]
[--role-arn <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]

Параметры

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

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

--data-source-id (строка)

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

Это полезно, если группа связана с несколькими источниками данных, но вы хотите, чтобы группа получала доступ только к документам определенного источника данных. Например, группы «Исследования», «Инжиниринг» и «Продажи и маркетинг» связаны с документами компании, хранящимися в источниках данных Confluence и Salesforce. Однако команде «Продажи и маркетинг» нужен доступ только к документам, связанным с клиентами, хранящимся в Salesforce.

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

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

--group-members (структура)

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

Например, группа «Компания А» включает пользователя «Директор» и подгруппы «Исследования», «Инжиниринг» и «Продажи и маркетинг».

Если у вас более 1000 пользователей и/или подгрупп для одной группы, вам необходимо предоставить путь к файлу S3, в котором перечислены ваши пользователи и подгруппы для данной группы. Ваши подгруппы могут содержать более 1000 пользователей, но список подгрупп, относящихся к группе (и/или пользователям), не должен превышать 1000.

MemberGroups -> (список)

Список пользователей, относящихся к группе. Он также может включать подгруппы. Например, подгруппы «Исследования», «Инжиниринг» и «Продажи и маркетинг» относятся к группе «Компания А».

(структура)

Подгруппы, относящиеся к группе.

GroupId -> (строка)

Идентификатор подгруппы, которую вы хотите сопоставить с группой.

DataSourceId -> (строка)

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

MemberUsers -> (список)

Список пользователей, относящихся к группе. Например, список стажеров относится к группе «Стажеры».

(структура)

Пользователи, относящиеся к группе.

UserId -> (строка)

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

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

Если у вас более 1000 пользователей и/или подгрупп для одной группы, вам необходимо предоставить путь к файлу S3, в котором перечислены ваши пользователи и подгруппы для данной группы. Ваши подгруппы могут содержать более 1000 пользователей, но список подгрупп, относящихся к группе (и/или пользователям), не должен превышать 1000.

Вы можете загрузить этот пример файла S3, который использует правильный формат для перечисления участников группы. Обратите внимание, что dataSourceId является необязательным. Значение type для группы всегда равно GROUP, а для пользователя — всегда равно USER.

Bucket -> (строка)

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

Key -> (строка)

Имя файла.

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

MemberGroups=[{GroupId=string,DataSourceId=string},{GroupId=string,DataSourceId=string}],MemberUsers=[{UserId=string},{UserId=string}],S3PathforGroupMembers={Bucket=string,Key=string}

Синтаксис JSON:

{
  "MemberGroups": [
    {
      "GroupId": "string",
      "DataSourceId": "string"
    }
    ...
  ],
  "MemberUsers": [
    {
      "UserId": "string"
    }
    ...
  ],
  "S3PathforGroupMembers": {
    "Bucket": "string",
    "Key": "string"
  }
}

--ordering-id (длинное целое число)

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

Идентификатор упорядочивания может быть временем Unix последнего обновления списка участников группы. Затем вы предоставляете этот список при вызове PutPrincipalMapping. Это гарантирует, что ваше PUT действие для обновленной группы с последним списком участников не будет перезаписано более ранними PUT действиями для той же группы, которые еще не обработаны.

По умолчанию идентификатор упорядочивания — это текущее время Unix в миллисекундах, когда действие было получено Amazon Kendra.

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

Amazon Resource Name (ARN) роли IAM, имеющей доступ к файлу S3, содержащему список пользователей, относящихся к группе.

Для получения дополнительной информации см. Роли IAM для 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