Spec-Zone.ru › AWS CLI v2

[ aws . verifiedpermissions ]

list-policies

Описание

Возвращает постраничный список всех политик, хранящихся в указанном хранилище политик.

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

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

Синтаксис

  list-policies
--policy-store-id <value>
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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-store-id (строка)

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

--filter (структура)

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

principal -> (структура помеченных объединений)

Фильтрует вывод, отображая только политики, которые ссылаются на указанного принципала.

Примечание

Это структура помеченных объединений. Можно задать только один из следующих ключей верхнего уровня: unspecified, identifier.

unspecified -> (булево)

Используется для указания, что принципал или ресурс не заданы. Это может использоваться для поиска политик, которые не связаны с конкретным принципалом или ресурсом.

identifier -> (структура)

Идентификатор сущности. Он может состоять из EntityType и EntityId, принципала или ресурса.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

resource -> (структура помеченных объединений)

Фильтрует вывод, отображая только политики, которые ссылаются на указанный ресурс.

Примечание

Это структура помеченных объединений. Можно задать только один из следующих ключей верхнего уровня: unspecified, identifier.

unspecified -> (булево)

Используется для указания, что принципал или ресурс не заданы. Это может использоваться для поиска политик, которые не связаны с конкретным принципалом или ресурсом.

identifier -> (структура)

Идентификатор сущности. Он может состоять из EntityType и EntityId, принципала или ресурса.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

policyType -> (строка)

Фильтрует вывод, отображая только политики указанного типа.

policyTemplateId -> (строка)

Фильтрует вывод, отображая только политики, связанные с шаблоном, созданные на основе указанного шаблона политики.

Сокращённый синтаксис:

principal={unspecified=boolean,identifier={entityType=string,entityId=string}},resource={unspecified=boolean,identifier={entityType=string,entityId=string}},policyType=string,policyTemplateId=string

Синтаксис JSON:

{
  "principal": {
    "unspecified": true|false,
    "identifier": {
      "entityType": "string",
      "entityId": "string"
    }
  },
  "resource": {
    "unspecified": true|false,
    "identifier": {
      "entityType": "string",
      "entityId": "string"
    }
  },
  "policyType": "STATIC"|"TEMPLATE_LINKED",
  "policyTemplateId": "string"
}

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

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

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

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя по 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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

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

Примеры

Примечание

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

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

Для получения списка доступных политик

Следующий list-policies пример выводит все политики в указанном хранилище политик.

aws verifiedpermissions list-policies \
    --policy-store-id PSEXAMPLEabcdefg111111

Вывод:

{
    "policies": [
        {
            "createdDate": "2023-06-12T20:33:37.382907+00:00",
            "definition": {
                "static": {
                    "description": "Grant everyone of janeFriends UserGroup access to the vacationFolder Album"
                }
            },
            "lastUpdatedDate": "2023-06-12T20:33:37.382907+00:00",
            "policyId": "SPEXAMPLEabcdefg111111",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "policyType": "STATIC",
            "principal": {
                "entityId": "janeFriends",
                "entityType": "UserGroup"
            },
            "resource": {
                "entityId": "vacationFolder",
                "entityType": "Album"
            }
        },
        {
            "createdDate": "2023-06-12T20:39:44.975897+00:00",
            "definition": {
                "static": {
                    "description": "Grant everyone access to the publicFolder Album"
                }
            },
            "lastUpdatedDate": "2023-06-12T20:39:44.975897+00:00",
            "policyId": "SPEXAMPLEabcdefg222222",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "policyType": "STATIC",
            "resource": {
                "entityId": "publicFolder",
                "entityType": "Album"
            }
        },
        {
            "createdDate": "2023-06-12T20:49:51.490211+00:00",
            "definition": {
                "templateLinked": {
                    "policyTemplateId": "PTEXAMPLEabcdefg111111"
                }
            },
            "lastUpdatedDate": "2023-06-12T20:49:51.490211+00:00",
            "policyId": "SPEXAMPLEabcdefg333333",
            "policyStoreId": "PSEXAMPLEabcdefg111111",
            "policyType": "TEMPLATE_LINKED",
            "principal": {
                "entityId": "alice",
                "entityType": "User"
            },
            "resource": {
                "entityId": "VacationPhoto94.jpg",
                "entityType": "Photo"
            }
        }
    ]
}

Дополнительную информацию о политиках см. в разделе Политики Amazon Verified Permissions в Руководстве пользователя Amazon Verified Permissions.

Вывод

nextToken -> (строка)

Если присутствует, это значение указывает, что доступно больше вывода, чем включено в текущем ответе. Используйте это значение в параметре запроса NextToken в последующем вызове операции, чтобы получить следующую часть вывода. Вы должны повторять это до тех пор, пока элемент ответа NextToken не вернётся значением null. Это указывает, что это последняя страница результатов.

policies -> (список)

Перечисляет все политики, доступные в указанном хранилище политик.

(структура)

Содержит информацию о политике.

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

policyStoreId -> (строка)

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

policyId -> (строка)

Идентификатор политики, о которой требуется информация.

policyType -> (строка)

Тип политики. Это одно из следующих значений:

  • STATIC
  • TEMPLATE_LINKED

principal -> (структура)

Принципал, связанный с политикой.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

resource -> (структура)

Ресурс, связанный с политикой.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

actions -> (список)

Действие, разрешённое или запрещённое политикой. Например, {"actions": [{"actionId": "ViewPhoto", "actionType": "PhotoFlash::Action"}, {"entityID": "SharePhoto", "entityType": "PhotoFlash::Action"}]}.

(структура)

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

Этот тип данных используется в качестве параметра запроса для операций IsAuthorized, BatchIsAuthorized и IsAuthorizedWithToken.

Пример: { "actionId": "<action name>", "actionType": "Action" }

actionType -> (строка)

Тип действия.

actionId -> (строка)

Идентификатор действия.

definition -> (структура помеченных союзов)

Определение политики элемента в списке возвращаемых политик.

Примечание

Это структура помеченных союзов. Только один из следующих ключевых элементов верхнего уровня может быть задан: static, templateLinked.

static -> (структура)

Информация о статической политике, которая не была создана с помощью шаблона политики.

description -> (строка)

Описание статической политики.

templateLinked -> (структура)

Информация о политике, связанной с шаблоном, которая была создана путём инстанцирования шаблона политики.

policyTemplateId -> (строка)

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

principal -> (структура)

Принципал, связанный с этой политикой, связанной с шаблоном. Verified Permissions заменяет этот принципал на заполнитель ?principal в шаблоне политики при оценке запроса на авторизацию.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

resource -> (структура)

Ресурс, связанный с этой политикой, связанной с шаблоном. Verified Permissions заменяет этот ресурс на заполнитель ?resource в шаблоне политики при оценке запроса на авторизацию.

entityType -> (строка)

Тип сущности.

Пример: "entityType":"*typeName* "

entityId -> (строка)

Идентификатор сущности.

"entityId":"*identifier* "

createdDate -> (метка времени)

Дата и время создания политики.

lastUpdatedDate -> (метка времени)

Дата и время последнего обновления политики.

effect -> (строка)

Эффект решения, возвращаемого политикой на запрос об авторизации. Например, "effect": "Permit".

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

Spec-Zone.ru

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