Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

получить-конфигурацию-контроля-доступа

Описание

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

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

Синтаксис

  describe-access-control-configuration
--index-id <value>
--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 (строка)

Идентификатор индекса для конфигурации контроля доступа.

--id (строка)

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

--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 для вывода.

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

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

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

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

Вывод

Имя -> (строка)

Название конфигурации контроля доступа.

Описание -> (строка)

Описание конфигурации контроля доступа.

Сообщение об ошибке -> (строка)

Сообщение об ошибке с деталями, если есть проблемы с обработкой конфигурации контроля доступа.

Список_контроля_доступа -> (список)

Информация о принципах (пользователях и/или группах) и к каким документам они должны иметь доступ. Это полезно для фильтрации контекста пользователя, где результаты поиска фильтруются на основе доступа пользователя или его группы к документам.

(структура)

Предоставляет информацию о пользователе и группе для фильтрации контекста пользователя.

Имя -> (строка)

Имя пользователя или группы.

Тип -> (строка)

Тип принципала.

Доступ -> (строка)

Разрешить или запретить доступ к документам принципалу.

Идентификатор_источника_данных -> (строка)

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

Иерархический_список_контроля_доступа -> (список)

Список списков принципалов, определяющих иерархию, для доступа к документам пользователей.

(структура)

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

Список_принципалов -> (список)

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

(структура)

Предоставляет информацию о пользователе и группе для фильтрации контекста пользователя.

Имя -> (строка)

Имя пользователя или группы.

Тип -> (строка)

Тип принципала.

Доступ -> (строка)

Разрешить или запретить доступ к документам принципалу.

Идентификатор_источника_данных -> (строка)

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

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

Spec-Zone.ru

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