Spec-Zone.ru › AWS CLI v2

[ aws . kms ]

revoke-grant

Описание

Удаляет указанный грант. Вы отозываете грант, чтобы прекратить разрешения, предоставляемые этим грантом. Дополнительную информацию см. в разделе «Выведение из эксплуатации и отмена грантов» в * Руководстве разработчика службы управления ключами (KMS) *.

При создании, выводе из эксплуатации или отмене гранта может быть небольшая задержка, обычно менее пяти минут, пока грант не станет доступен во всей KMS. Это состояние известно как эвентуальная согласованность. Подробности см. в разделе «Эвентуальная согласованность» в * Руководстве разработчика службы управления ключами (KMS) *.

Подробную информацию о грантах, включая терминологию грантов, см. в разделе «Гранты в KMS» в * Руководстве разработчика службы управления ключами (KMS) * . Примеры работы с грантами на нескольких языках программирования см. в разделе «Программирование грантов».

Использование в разных учетных записях : Да. Чтобы выполнить эту операцию с ключом KMS в другой учетной записи Amazon Web Services, укажите ARN ключа в значении параметра KeyId.

Требуемые разрешения : kms:RevokeGrant (политика ключа).

Связанные операции:

  • CreateGrant
  • ListGrants
  • ListRetirableGrants
  • RetireGrant
Эвентуальная согласованность : API KMS использует модель эвентуальной согласованности. Дополнительную информацию см. в разделе «Эвентуальная согласованность KMS».

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

Синтаксис

  revoke-grant
--key-id <value>
--grant-id <value>
[--dry-run | --no-dry-run]
[--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]

Параметры

--key-id (строка)

Уникальный идентификатор ключа KMS, связанного с грантом. Чтобы получить идентификатор ключа и ARN ключа KMS, используйте ListKeys или DescribeKey.

Укажите идентификатор или ARN ключа KMS. Чтобы указать ключ KMS в другой учетной записи Amazon Web Services, необходимо использовать ARN ключа.

Например:

  • Идентификатор ключа: 1234abcd-12ab-34cd-56ef-1234567890ab
  • ARN ключа: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Чтобы получить идентификатор ключа и ARN ключа KMS, используйте ListKeys или DescribeKey.

--grant-id (строка)

Идентифицирует грант для отмены. Чтобы получить идентификатор гранта, используйте CreateGrant , ListGrants или ListRetirableGrants .

--dry-run | --no-dry-run (логическое значение)

Проверяет, будет ли ваш запрос успешным. DryRun — необязательный параметр.

Дополнительную информацию о использовании этого параметра см. в разделе «Тестирование вызовов API KMS» в *Руководстве разработчика службы управления ключами*.

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

Для отмены гранта на ключе главного клиента

Следующий revoke-grant пример удаляет грант из ключа KMS. Следующая команда примера указывает параметры grant-id и key-id. Значение параметра key-id может быть идентификатором ключа или ARN ключа KMS.

aws kms revoke-grant \
    --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab

Эта команда не выводит никаких данных. Чтобы убедиться, что грант был отменён, используйте команду list-grants.

Дополнительную информацию см. в разделе «Выведение из эксплуатации и отмена грантов» в *Руководстве разработчика службы управления ключами AWS*.

Вывод

Нет

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

Spec-Zone.ru

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