Spec-Zone.ru › AWS CLI v2

[ aws . verifiedpermissions ]

put-schema

Описание

Создаёт или обновляет схему политики в указанном хранилище политик. Схема используется для проверки любых политик Cedar и шаблонов политик, отправленных в хранилище политик. Любые изменения схемы проверяют только политики и шаблоны, отправленные после изменения схемы. Существующие политики и шаблоны не перепроверяются по изменённой схеме. Если вы впоследствии обновите политику, она будет проверена по новой схеме в этот момент.

Примечание

Сервис Verified Permissions обладает *асинхронной согласованностью*. Для распространения нового или изменённого элемента через сервис и его отображения в результатах других операций Verified Permissions может потребоваться несколько секунд.

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

Синтаксис

  put-schema
--policy-store-id <value>
--definition <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 (строка)

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

--definition (структура помеченного объединения)

Указывает определение схемы, которое необходимо сохранить. Определение схемы должно быть записано в формате JSON схемы Cedar.

Примечание

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

cedarJson -> (строка)

Строковое представление JSON схемы, поддерживаемой приложениями, использующими это хранилище политик. Чтобы удалить схему, выполните PutSchema с {} для этого параметра. Дополнительную информацию см. в разделе Схема хранилища политик в Руководстве пользователя Amazon Verified Permissions.

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

cedarJson=string

Синтаксис JSON:

{
  "cedarJson": "string"
}

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

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

Сохранение схемы в хранилище политик

Следующий пример put-schema создаёт или заменяет схему в указанном хранилище политик.

Параметр cedarJson во входном файле принимает строковое представление объекта JSON. Он содержит вложенные кавычки (”) внутри самой внешней пары кавычек. Это требует преобразования JSON в строку, предваряя все вложенные кавычки символом обратного слэша ( " ) и объединяя все строки в одну текстовую строку без разрывов строк.

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

aws verifiedpermissions put-schema
–definition file://schema.txt –policy-store-id PSEXAMPLEabcdefg111111

Содержимое schema.txt:

{
    "cedarJson": "{\"MySampleNamespace\": {\"actions\": {\"remoteAccess\": {
            \"appliesTo\": {\"principalTypes\": [\"Employee\"]}}},\"entityTypes\": {
            \"Employee\": {\"shape\": {\"attributes\": {\"jobLevel\": {\"type\":
            \"Long\"},\"name\": {\"type\": \"String\"}},\"type\": \"Record\"}}}}}"
}

Вывод:

{
    "policyStoreId": "PSEXAMPLEabcdefg111111",
    "namespaces": [
        "MySampleNamespace"
    ],
    "createdDate": "2023-06-14T17:47:13.999885+00:00",
    "lastUpdatedDate": "2023-06-14T17:47:13.999885+00:00"
}

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

Вывод

policyStoreId -> (строка)

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

namespaces -> (список)

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

(строка)

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

Дата и время первоначального создания схемы.

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

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

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

Spec-Zone.ru

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