Spec-Zone.ru › AWS CLI v2

[ aws . resourcegroupstaggingapi ]

untag-resources

Описание

Удаляет указанные метки из указанных ресурсов. При указании ключа метки действие удаляет и сам ключ, и связанное с ним значение. Операция выполняется успешно даже если вы пытаетесь удалить метки из ресурса, которые уже были удалены. Обратите внимание на следующее:

  • Чтобы удалить метки из ресурса, вам необходимы необходимые разрешения для сервиса, к которому принадлежит ресурс, а также разрешения на удаление меток. Дополнительную информацию см. в документации для сервиса, ресурс которого вы хотите разметировать.
  • Вы можете маркировать только ресурсы, расположенные в указанном регионе Amazon Web Services для учетной записи Amazon Web Services, выполняющей вызов.
Минимальные разрешения

В дополнение к разрешению tag:UntagResources, необходимому для этой операции, вам также необходимо разрешение на удаление меток, определенное службой, которая создала ресурс. Например, чтобы удалить метки с экземпляра Amazon EC2 с помощью операции UntagResources, у вас должны быть оба следующих разрешения:

  • tag:UntagResource
  • ec2:DeleteTags

См. также: AWS API Documentation

Синтаксис

  untag-resources
--resource-arn-list <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]

Параметры

--resource-arn-list (список)

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

ARN (Amazon Resource Name) уникально идентифицирует ресурс. Дополнительную информацию см. в разделе Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces в Amazon Web Services General Reference .

(строка)

Синтаксис:

"string" "string" ...

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

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

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

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Для удаления тега из ресурса

Следующий untag-resources пример удаляет указанные ключи тегов и любые связанные значения из указанного ресурса.

aws resourcegroupstaggingapi untag-resources \
    --resource-arn-list arn:aws:s3:::amzn-s3-demo-bucket \
    --tag-keys Environment CostCenter

Вывод:

{
    "FailedResourcesMap": {}
}

Дополнительную информацию см. в разделе UntagResources в Справочнике по API тегирования групп ресурсов.

Вывод

FailedResourcesMap -> (карта)

Карта, содержащая пару ключ-значение для каждого неудачного элемента, который не удалось разгруппировать. Ключ — ARN неудачного ресурса. Значение — объект FailureInfo, содержащий код ошибки, код состояния и сообщение об ошибке. Если ошибок нет, FailedResourcesMap пуста.

ключ -> (строка)

значение -> (структура)

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

Ниже приведены распространенные коды ошибок, которые вы можете получить от других служб Amazon Web Services:

  • InternalServiceException – Это может означать, что API Resource Groups Tagging не получил ответ от другой службы Amazon Web Services. Это также может означать, что тип ресурса в запросе не поддерживается API Resource Groups Tagging. В этих случаях безопасно повторить запрос, а затем вызвать GetResources, чтобы проверить изменения.
  • AccessDeniedException – Это может означать, что вам нужны разрешения для вызова операций маркировки в службе Amazon Web Services, которая содержит ресурс. Например, чтобы использовать API Resource Groups Tagging для маркировки ресурса Amazon CloudWatch alarm, вам необходимо разрешение на вызов как ` TagResources https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ и ` TagResource https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ в API CloudWatch.

Дополнительную информацию об ошибках, генерируемых другими службами Amazon Web Services, см. в документации этой службы.

StatusCode -> (целое число)

Код HTTP состояния распространённой ошибки.

ErrorCode -> (строка)

Код распространённой ошибки. Допустимые значения включают InternalServiceException , InvalidParameterException и любой допустимый код ошибки, возвращаемый службой Amazon Web Services, которая предоставляет ресурс, который вы хотите пометить.

ErrorMessage -> (строка)

Сообщение распространённой ошибки.

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

Spec-Zone.ru

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