Проверка доступа к документу
Описание
Проверяет, имеет ли пользователь разрешения на доступ к указанному документу, и возвращает фактический ACL, прикрепленный к документу. При проверке доступа пользователя к документу учитываются псевдонимы пользователей и группы.
См. также: Документацию API AWS
Синтаксис
check-document-access
--application-id <value>
--index-id <value>
--user-id <value>
--document-id <value>
[--data-source-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]
Параметры
--application-id (строка)
--index-id (строка)
--user-id (строка)
--document-id (строка)
--data-source-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.
Вывод
userGroups -> (список)
Массив групп, к которым принадлежит пользователь для указанного источника данных. Каждая группа имеет имя и тип.
(структура)
Представляет группу, связанную с заданным пользователем в системе управления доступом.
name -> (строка)
type -> (строка)
userAliases -> (список)
Массив псевдонимов, связанных с пользователем. Это включает как глобальные, так и локальные псевдонимы, каждый из которых имеет имя и тип.
(структура)
Представляет связанного пользователя в системе управления доступом.
id -> (строка)
type -> (строка)
hasAccess -> (логическое значение)
documentAcl -> (структура)
Список управления доступом (ACL), связанный с документом. Включает условия разрешения и запрета, определяющие доступ пользователя.
allowlist -> (структура)
Условия разрешения для документа. Пользователи или группы, соответствующие этим условиям, получают доступ к документу.
memberRelation -> (строка)
conditions -> (список)
Массив условий, определяющих правила членства. Каждое условие определяет критерии для включения пользователей или групп в это членство.
(структура)
Представляет условие в ACL документа, определяя правила доступа для пользователей и групп.
memberRelation -> (строка)
users -> (список)
Массив идентификаторов пользователей, к которым относится это условие. Пользователи, указанные здесь, подчиняются правилу доступа, определенному этим условием.
(структура)
Представляет пользователя в ACL документа, используемого для определения разрешений на доступ для отдельных пользователей.
id -> (строка)
type -> (строка)
groups -> (список)
Массив идентификаторов групп, к которым относится это условие. Группы, указанные здесь, подчиняются правилу доступа, определенному этим условием.
(структура)
Представляет группу в ACL документа, используемую для определения разрешений на доступ для нескольких пользователей совместно.
name -> (строка)
type -> (строка)
denyList -> (структура)
Условия запрета для документа. Пользователи или группы, соответствующие этим условиям, получают отказ в доступе к документу, что переопределяет разрешения по списку разрешенных.
memberRelation -> (строка)
conditions -> (список)
Массив условий, определяющих правила членства. Каждое условие определяет критерии для включения пользователей или групп в это членство.
(структура)
Представляет условие в ACL документа, определяя правила доступа для пользователей и групп.
memberRelation -> (строка)
users -> (список)
Массив идентификаторов пользователей, к которым относится это условие. Пользователи, указанные здесь, подчиняются правилу доступа, определенному этим условием.
(структура)
Представляет пользователя в ACL документа, используемого для определения разрешений на доступ для отдельных пользователей.
id -> (строка)
type -> (строка)
groups -> (список)
Массив идентификаторов групп, к которым относится это условие. Группы, указанные здесь, подчиняются правилу доступа, определенному этим условием.
(структура)
Представляет группу в ACL документа, используемую для определения разрешений на доступ для нескольких пользователей совместно.
name -> (строка)
type -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|