Spec-Zone.ru › AWS CLI v2

[ aws . kms ]

untag-resource

Описание

Удаляет метки из управляемого клиентом ключа. Чтобы удалить метку, укажите ключ метки и ключ KMS.

Примечание

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

При успешном выполнении операция UntagResource не возвращает никаких выходных данных. Кроме того, если указанный ключ метки не найден для ключа KMS, это не вызывает исключение и не возвращает ответ. Чтобы подтвердить выполнение операции, используйте операцию ListResourceTags.

Дополнительную информацию об использовании меток в KMS см. в разделе Метки ключей. Дополнительную общую информацию о метках, включая формат и синтаксис, см. в разделе Метки ресурсов Amazon Web Services в справочнике Amazon Web Services General Reference.

Ключ KMS, который вы используете для этой операции, должен находиться в совместимом состоянии. Подробнее см. Состояния ключей KMS в справочнике разработчика Key Management Service.

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

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

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

  • CreateKey
  • ListResourceTags
  • ReplicateKey
  • TagResource
Эвентуальная согласованность : API KMS следует модели эвентуальной согласованности. Для получения дополнительной информации см. Эвентуальную согласованность KMS.

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

Синтаксис

  untag-resource
--key-id <value>
--tag-keys <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]

Параметры

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

Идентифицирует ключ KMS, из которого удаляются метки.

Укажите идентификатор или ARN ключа KMS.

Например:

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

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

--tag-keys (список)

Один или несколько ключей меток. Укажите только ключи меток, а не значения меток.

(строка)

Синтаксис:

"string" "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 (boolean)

Включить отладочную запись журнала.

--endpoint-url (string)

Переопределить значение URL по умолчанию для команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один запрос для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определённый профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить кли-паджер для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Для удаления тега из ключа KMS

Следующий пример удаляет тег с "Purpose" ключом из управляемого пользователем ключа KMS.

Для указания ключа KMS используйте параметр key-id. В данном примере используется значение идентификатора ключа, но в данной команде можно использовать идентификатор ключа или ARN ключа. Перед выполнением этой команды замените пример идентификатора ключа на действительный идентификатор ключа из вашей учетной записи AWS.

aws kms untag-resource \
    --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \
    --tag-key 'Purpose'

Эта команда не выводит никаких результатов. Для просмотра тегов ключа KMS AWS используйте команду list-resource-tags.

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

Вывод

Нет

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

Spec-Zone.ru

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