Удалить сопоставление принципала

Описание

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

Например, после удаления группы «Летние стажеры» все стажеры, которые входили в эту группу, больше не видят документы только для стажеров в своих результатах поиска.

Если вы хотите удалить или заменить пользователей или подгруппы в группе, вам необходимо использовать операцию PutPrincipalMapping. Например, если пользователь в группе «Инженерия» покидает инженерную команду, и его заменяет другой пользователь, при вызове операции PutPrincipalMapping вы предоставляете обновлённый список пользователей или подгрупп, которые входят в группу «Инженерия». Вы можете обновить свой внутренний список пользователей или подгрупп и передать его при вызове PutPrincipalMapping.

DeletePrincipalMapping в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).

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

Синтаксис

  delete-principal-mapping
--index-id <value>
[--data-source-id <value>]
--group-id <value>
[--ordering-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]

Параметры

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

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

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

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

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

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

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

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

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

Порядковый ID может быть Unix-временем последнего обновления списка членов группы. Затем вы предоставляете этот список при вызове операции PutPrincipalMapping. Это гарантирует, что ваше действие DELETE для обновлённой группы с последним списком членов не будет перезаписано более ранними действиями DELETE для той же группы, которые ещё не обработаны.

По умолчанию порядковый ID — это текущее Unix-время в миллисекундах, когда действие было получено 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
text
таблица
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.

Вывод

Нет