Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-entities-for-policy

Описание

Выводит список всех пользователей, групп и ролей IAM, к которым прикреплён указанный управляемый политикой.

Вы можете использовать необязательный параметр EntityFilter для ограничения результатов определённым типом сущности (пользователи, группы или роли). Например, чтобы вывести только роли, прикреплённые к указанной политике, установите EntityFilter на Role.

Вы можете выполнить постраничный вывод результатов, используя параметры MaxItems и Marker.

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

list-entities-for-policy является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запросов: PolicyGroups, PolicyUsers, PolicyRoles

Синтаксис

  list-entities-for-policy
--policy-arn <value>
[--entity-filter <value>]
[--path-prefix <value>]
[--policy-usage-filter <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--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]

Параметры

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

Amazon Resource Name (ARN) политики IAM, для которой вы хотите получить версии.

Дополнительную информацию об ARN см. в разделе Amazon Resource Names (ARNs) в Общие сведения об Amazon Web Services.

--entity-filter (строка)

Тип сущности для фильтрации результатов.

Например, когда EntityFilter равно Role, возвращаются только роли, прикреплённые к указанной политике. Этот параметр является необязательным. Если он не указан, возвращаются все прикреплённые сущности (пользователи, группы и роли). Аргумент для этого параметра должен соответствовать одному из допустимых значений, перечисленных ниже.

Возможные значения:

  • User
  • Role
  • Group
  • LocalManagedPolicy
  • AWSManagedPolicy

--path-prefix (строка)

Префикс пути для фильтрации результатов. Этот параметр является необязательным. Если он не указан, по умолчанию используется слеш (/), что отображает все сущности.

Этот параметр допускает (через шаблон регулярных выражений) строку символов, состоящую либо из одного слэша (/), либо из строки, которая должна начинаться и заканчиваться слэшами. Кроме того, он может содержать любые ASCII-символы от ! (\u0021) до символа DEL (\u007F), включая большинство знаков препинания, цифр и букв верхнего и нижнего регистра.

--policy-usage-filter (строка)

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

Чтобы вывести только политики разрешений, установите PolicyUsageFilter на PermissionsPolicy. Чтобы вывести только политики, используемые для установки границ разрешений, установите значение на PermissionsBoundary.

Этот параметр является необязательным. Если он не указан, возвращаются все политики.

Возможные значения:

  • PermissionsPolicy
  • PermissionsBoundary

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше заданного значения, в выводе команды предоставляется NextToken. Чтобы продолжить постраничный вывод, укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения, полученные из JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет взята буквально. Этот параметр не может быть указан вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее усечённого ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

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

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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.

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. Подробнее об этом см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы вывести список всех пользователей, групп и ролей, к которым прикреплена указанная управляемая политика

В этом примере возвращается список групп, ролей и пользователей IAM, к которым прикреплена политика arn:aws:iam::123456789012:policy/TestPolicy.

aws iam list-entities-for-policy \
    --policy-arn arn:aws:iam::123456789012:policy/TestPolicy

Вывод:

{
    "PolicyGroups": [
        {
            "GroupName": "Admins",
            "GroupId": "AGPACKCEVSQ6C2EXAMPLE"
        }
    ],
    "PolicyUsers": [
        {
            "UserName": "Alice",
            "UserId": "AIDACKCEVSQ6C2EXAMPLE"
        }
    ],
    "PolicyRoles": [
        {
            "RoleName": "DevRole",
            "RoleId": "AROADBQP57FF2AEXAMPLE"
        }
    ],
    "IsTruncated": false
}

Дополнительную информацию см. в разделе Политики и разрешения в IAM в Руководстве пользователя AWS IAM.

Вывод

PolicyGroups -> (список)

Список групп IAM, к которым прикреплен политику.

(структура)

Содержит информацию о группе, к которой прикреплена управляемая политика.

Этот тип данных используется в качестве элемента ответа в операции ListEntitiesForPolicy.

Дополнительную информацию об управляемых политиках см. в разделе Управляемые политики и встроенные политики в Руководстве по IAM.

GroupName -> (строка)

Имя (наглядное имя, а не ARN) группы.

GroupId -> (строка)

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

PolicyUsers -> (список)

Список пользователей IAM, к которым прикреплена политика.

(структура)

Содержит информацию о пользователе, к которому прикреплена управляемая политика.

Этот тип данных используется в качестве элемента ответа в операции ListEntitiesForPolicy.

Дополнительную информацию об управляемых политиках см. в разделе Управляемые политики и встроенные политики в Руководстве по IAM.

UserName -> (строка)

Имя (наглядное имя, а не ARN) пользователя.

UserId -> (строка)

Уникальная и устойчивая строка, идентифицирующая пользователя. Дополнительную информацию об идентификаторах см. в разделе Идентификаторы IAM в Руководстве по IAM.

PolicyRoles -> (список)

Список ролей IAM, к которым прикреплена политика.

(структура)

Содержит информацию о роли, к которой прикреплена управляемая политика.

Этот тип данных используется в качестве элемента ответа в операции ListEntitiesForPolicy.

Дополнительную информацию об управляемых политиках см. в разделе Управляемые политики и встроенные политики в Руководстве по IAM.

RoleName -> (строка)

Имя (наглядное имя, а не ARN) роли.

RoleId -> (строка)

Уникальная и устойчивая строка, идентифицирующая роль. Дополнительную информацию об идентификаторах см. в разделе Идентификаторы IAM в Руководстве по IAM.

IsTruncated -> (булево)

Флаг, указывающий, имеются ли дополнительные элементы для возврата. Если результаты были усечены, вы можете выполнить последующий запрос для постраничной навигации с использованием параметра Marker для получения дополнительных элементов. Обратите внимание, что IAM может возвращать меньше, чем MaxItems результатов, даже если больше результатов доступны. Рекомендуется проверять IsTruncated после каждого вызова, чтобы убедиться, что вы получаете все свои результаты.

Marker -> (строка)

Когда значение IsTruncated равно true, этот элемент присутствует и содержит значение, используемое для параметра Marker в последующем запросе для постраничной навигации.

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

Spec-Zone.ru

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