Spec-Zone.ru › AWS CLI v2

[ aws . kms ]

удалить-псевдоним

Описание

Удаляет указанный псевдоним.

Примечание

Добавление, удаление или обновление псевдонима может разрешить или запретить доступ к ключу KMS. Подробнее см. ABAC для KMS в руководстве разработчика службы управления ключами.

Поскольку псевдоним не является свойством ключа KMS, вы можете удалять и изменять псевдонимы ключа KMS без изменения самого ключа KMS. Также псевдонимы не отображаются в ответе операции DescribeKey. Чтобы получить псевдонимы всех ключей KMS, используйте операцию ListAliases.

Каждый ключ KMS может иметь несколько псевдонимов. Чтобы изменить псевдоним ключа KMS, используйте DeleteAlias для удаления текущего псевдонима и CreateAlias для создания нового псевдонима. Чтобы связать существующий псевдоним с другим ключом KMS, используйте UpdateAlias.

Использование в разных учетных записях : Нет. Вы не можете выполнить эту операцию с псевдонимом в другой учетной записи Amazon Web Services.

Требуемые разрешения

  • kms:DeleteAlias на псевдониме (политика IAM).
  • kms:DeleteAlias на ключе KMS (политика ключа).

Подробнее см. Управление доступом к псевдонимам в руководстве разработчика службы управления ключами.

Связанные операции:
  • CreateAlias
  • ListAliases
  • UpdateAlias
Постепенная согласованность : API KMS использует модель постепенной согласованности. Для получения дополнительной информации см. Постепенную согласованность KMS.

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

Синтаксис

  delete-alias
--alias-name <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]

Параметры

--alias-name (строка)

Псевдоним, который нужно удалить. Имя псевдонима должно начинаться с alias/, за которым следует имя псевдонима, например, alias/ExampleAlias.

--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
  • текст
  • таблица
  • 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 для вывода.

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

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

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

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

Примеры

Примечание

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

Если не указано иное, все примеры используют правила цитирования в стиле Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. Дополнительную информацию см. в руководстве по использованию кавычек со строками.

Для удаления псевдонима AWS KMS

Следующий пример удаляет псевдоним alias/example-alias. Имя псевдонима должно начинаться с alias/.

aws kms delete-alias \
    --alias-name alias/example-alias

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

Дополнительную информацию см. в руководстве разработчика AWS Key Management Service.

Вывод

Нет

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

Spec-Zone.ru

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