Spec-Zone.ru › AWS CLI v2

[ aws . verifiedpermissions ]

get-policy

Описание

Получает информацию о заданном политике.

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

Синтаксис

  get-policy
--policy-store-id <value>
--policy-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]

Параметры

--policy-store-id (строка)

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

--policy-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
  • text
  • таблица
  • 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.

Для получения подробной информации о политике

Следующий get-policy пример отображает подробную информацию для политики с указанным идентификатором.

aws verifiedpermissions get-policy \
    --policy-id PSEXAMPLEabcdefg111111 \
    --policy-store-id PSEXAMPLEabcdefg111111

Вывод:

{
    "createdDate": "2023-06-12T20:33:37.382907+00:00",
    "definition": {
        "static": {
            "description": "Grant everyone of janeFriends UserGroup access to the vacationFolder Album",
            "statement": "permit(principal in UserGroup::\"janeFriends\", action, resource in Album::\"vacationFolder\" );"
        }
    },
    "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"
    }
}

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

Вывод

policyStoreId -> (строка)

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

policyId -> (строка)

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

policyType -> (строка)

Тип политики.

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

Принципал, указанный в области действия политики. Этот элемент не включён в ответ, когда Principal отсутствует в содержимом политики.

entityType -> (строка)

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

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

entityId -> (строка)

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

"entityId":"*identifier* "

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

Ресурс, указанный в области действия политики. Этот элемент не включён в ответ, когда 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 -> (строка)

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

statement -> (строка)

Содержимое статической политики, написанной на языке политики Cedar.

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