обновить-настройки-контроля-доступа
Описание
Обновляет настройки контроля доступа к вашим документам в индексе. Включает в себя информацию о доступе пользователей и групп к вашим документам. Это полезно для фильтрации результатов поиска по контексту пользователя, где результаты поиска фильтруются на основе доступа пользователя или его группы к документам.
Вы можете обновить настройки контроля доступа, созданные вами, без повторного индексирования всех ваших документов. Например, ваш индекс содержит конфиденциальные документы компании, к которым должен иметь доступ только определённый персонал или пользователи. Вы создали настройки контроля доступа «разрешить» для одного пользователя, который недавно присоединился к команде «совершенно секретно», перейдя из команды с доступом «запретить» к конфиденциальным документам. Однако пользователь внезапно возвращается в свою предыдущую команду и больше не должен иметь доступа к совершенно секретным документам. Вы можете обновить настройки контроля доступа, чтобы перенастроить контроль доступа к вашим документам по мере изменения обстоятельств.
Вы вызываете API BatchPutDocument для применения обновлённых настроек контроля доступа, с включенным AccessControlConfigurationId в объекте документа. Если вы используете ведро S3 в качестве источника данных, вы синхронизируете свой источник данных для применения AccessControlConfigurationId в файле .metadata.json. Amazon Kendra в настоящее время поддерживает настройки контроля доступа только для источников данных S3 и документов, индексированных с использованием API BatchPutDocument.
Предупреждение
Вы не можете настроить контроль доступа, используяCreateAccessControlConfiguration для индекса Amazon Kendra Gen AI Enterprise Edition. Amazon Kendra вернёт ошибку ValidationException для индекса Gen_AI_ENTERPRISE_EDITION.См. также: Документация API AWS
Синтаксис
update-access-control-configuration
--index-id <value>
--id <value>
[--name <value>]
[--description <value>]
[--access-control-list <value>]
[--hierarchical-access-control-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]
Параметры
--index-id (строка)
--id (строка)
--name (строка)
--description (строка)
--access-control-list (список)
Информация, которую вы хотите обновить для субъектов (пользователей и/или групп) и к каким документам они должны иметь доступ. Это полезно для фильтрации результатов поиска по контексту пользователя, где результаты поиска фильтруются на основе доступа пользователя или его группы к документам.
(структура)
Предоставляет информацию о пользователях и группах для фильтрации по контексту пользователя.
Имя -> (строка)
Тип -> (строка)
Доступ -> (строка)
DataSourceId -> (строка)
Краткая запись:
Name=string,Type=string,Access=string,DataSourceId=string ...
Синтаксис JSON:
[
{
"Name": "string",
"Type": "USER"|"GROUP",
"Access": "ALLOW"|"DENY",
"DataSourceId": "string"
}
...
]
--hierarchical-access-control-list (список)
Обновленный список списков субъектов, которые определяют иерархию, к каким документам пользователи должны иметь доступ.
(структура)
Информация для определения иерархии, к каким документам пользователи должны иметь доступ.
PrincipalList -> (список)
Список списков субъектов, которые определяют иерархию, к каким документам пользователи должны иметь доступ. Каждый иерархический список указывает, имеет ли пользователь или группа разрешение или запрет на доступ к каждому документу.
(структура)
Предоставляет информацию о пользователях и группах для фильтрации по контексту пользователя.
Имя -> (строка)
Тип -> (строка)
Доступ -> (строка)
DataSourceId -> (строка)
Краткая запись:
PrincipalList=[{Name=string,Type=string,Access=string,DataSourceId=string},{Name=string,Type=string,Access=string,DataSourceId=string}] ...
Синтаксис JSON:
[
{
"PrincipalList": [
{
"Name": "string",
"Type": "USER"|"GROUP",
"Access": "ALLOW"|"DENY",
"DataSourceId": "string"
}
...
]
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята дословно. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если предоставлено значение null или 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.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросов параметров ввода CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.