Spec-Zone.ru › AWS CLI v2

[ aws . organizations ]

update-policy

Описание

Обновляет существующую политику новым именем, описанием или содержимым. Если какой-либо параметр не указан, его значение остаётся неизменным. Тип политики изменить нельзя.

Этот оператор может быть вызван только из учетной записи управления организацией или учетной записью участника, являющейся делегированным администратором службы Amazon Web Services.

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

Синтаксис

  update-policy
--policy-id <value>
[--name <value>]
[--description <value>]
[--content <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-id (строка)

Уникальный идентификатор (ID) политики, которую необходимо обновить.

Шаблон регулярного выражения для строки ID политики требует «p-», за которым следуют от 8 до 128 строчных или прописных букв, цифр или символа подчёркивания (_).

--name (строка)

Если указано, новое имя политики.

Шаблон регулярного выражения, используемый для проверки этого параметра, — строка любых символов в диапазоне ASCII.

--description (строка)

Если указано, новое описание политики.

--content (строка)

Если указано, новое содержимое политики. Текст должен быть правильно отформатированным JSON, соответствующим синтаксису типа политики. Дополнительную информацию см. в разделе синтаксис SCP в руководстве пользователя «Организации».

Максимальный размер документа политики зависит от типа политики. Дополнительную информацию см. в разделе Максимальные и минимальные значения в руководстве пользователя «Организации».

--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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичное и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключить вывод AWS CLI для страниц.

--cli-auto-prompt (логическое)

Автоматически запросить входные параметры CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматический запрос входных параметров CLI.

Примеры

Примечание

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

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

Пример 1: Переименование политики

Следующий update-policy пример переименовывает политику и присваивает ей новое описание.

aws organizations update-policy \
    --policy-id p-examplepolicyid111 \
    --name Renamed-Policy \
    --description "This description replaces the original."

Вывод отображает новое имя и описание.

{
    "Policy": {
        "Content": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":{\n\"Effect\":\"Allow\",\n\"Action\":\"ec2:*\",\n\"Resource\":\"*\"\n  }\n}\n",
        "PolicySummary": {
            "Id": "p-examplepolicyid111",
            "AwsManaged": false,
            "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
            "Description": "This description replaces the original.",
            "Name": "Renamed-Policy",
            "Type": "SERVICE_CONTROL_POLICY"
        }
    }
}

Пример 2: Замена текстового содержимого JSON политики

В следующем примере показано, как заменить текстовое содержимое JSON SCP в предыдущем примере новой строкой текста JSON политики, которая разрешает доступ к S3 вместо EC2:

aws organizations update-policy \
    --policy-id p-examplepolicyid111 \
    --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}"

Вывод отображает новое содержимое:

{
    "Policy": {
        "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }",
        "PolicySummary": {
            "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111",
            "AwsManaged": false;
            "Description": "This description replaces the original.",
            "Id": "p-examplepolicyid111",
            "Name": "Renamed-Policy",
            "Type": "SERVICE_CONTROL_POLICY"
        }
    }
}

Вывод

Политика -> (структура)

Структура, содержащая подробности об обновлённой политике, отображающая внесённые изменения.

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

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

Id -> (строка)

Уникальный идентификатор (ID) политики.

Шаблон регулярного выражения для строки ID политики требует «p-», за которым следуют от 8 до 128 строчных или прописных букв, цифр или символа подчёркивания (_).

Arn -> (строка)

Amazon Resource Name (ARN) политики.

Дополнительную информацию об ARN в Организациях см. в разделе Форматы ARN, поддерживаемые Организациями в справочнике «Справочник по авторизации служб Amazon Web Services».

Name -> (строка)

Дружественное имя политики.

Шаблон регулярного выражения, используемый для проверки этого параметра, — строка любых символов в диапазоне ASCII.

Description -> (строка)

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

Type -> (строка)

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

AwsManaged -> (логическое)

Логическое значение, указывающее, является ли указанная политика управляемой Amazon Web Services. Если true, то вы можете присоединить политику к корням, отделам или учетным записям, но не можете её изменить.

Content -> (строка)

Текстовое содержимое политики.

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

Spec-Zone.ru

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