[ aws . resourcegroupstaggingapi ]
Тегирование ресурсов
Описание
Применяет один или несколько тегов к указанным ресурсам. Обратите внимание на следующее:
- Не все ресурсы могут иметь теги. Список сервисов с ресурсами, поддерживающими тегирование с помощью этой операции, см. в разделе Сервисы, поддерживающие API тегирования ресурсов. Если ресурс еще не поддерживает эту операцию, его служба может поддерживать тегирование с помощью собственных операций API. Для получения дополнительной информации ознакомьтесь с документацией по этой службе.
- Каждый ресурс может иметь до 50 тегов. Другие ограничения см. в разделе Наименование и использование тегов в Справочнике Amazon Web Services.
- Вы можете добавлять теги только к ресурсам, расположенным в указанном регионе Amazon Web Services для учетной записи Amazon Web Services.
- Для добавления тегов к ресурсу необходимы необходимые разрешения для службы, к которой принадлежит ресурс, а также разрешения на добавление тегов. Для получения дополнительной информации ознакомьтесь с документацией каждой службы.
Предупреждение
Минимальные разрешения
В дополнение к разрешению tag:TagResources, необходимому для этой операции, вы также должны иметь разрешение на тегирование, определенное службой, создавшей ресурс. Например, чтобы добавить тег к экземпляру Amazon EC2 с помощью операции TagResources, вам необходимо иметь оба следующих разрешения:
tag:TagResourceec2:CreateTags
См. также: Документация по API AWS
Синтаксис
tag-resources
--resource-arn-list <value>
--tags <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 (ARN) и пространства имен служб Amazon Web Services в Справочнике Amazon Web Services.
(строка)
Синтаксис:
"string" "string" ...
--tags (отображение)
Указывает список тегов, которые нужно добавить к указанным ресурсам. Тег состоит из ключа и значения, которые вы определяете.
ключ -> (строка)
значение -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"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 (логическое значение)
Включить отладку.
--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 CLI.
Для добавления тега к ресурсу
В следующем примере tag-resources тегируется указанный ресурс с именем ключа и значением.
aws resourcegroupstaggingapi tag-resources \
--resource-arn-list arn:aws:s3:::MyProductionBucket \
--tags Environment=Production,CostCenter=1234
Вывод:
{
"FailedResourcesMap": {}
}
Дополнительную информацию см. в разделе TagResources в Справочнике API тегирования ресурсов.
Вывод
FailedResourcesMap -> (отображение)
Отображение, содержащее пару ключ-значение для каждого необработанного элемента, который не удалось пометить. Ключом является ARN необработанного ресурса. Значением является объект FailureInfo, содержащий код ошибки, код состояния и сообщение об ошибке. Если ошибок нет, то FailedResourcesMap пусто.
ключ -> (строка)
значение -> (структура)
Информация об ошибках, возвращаемых для каждого необработанного ресурса. Эта информация может включать InternalServiceException и InvalidParameterException ошибки. Она также может включать любой допустимый код ошибки, возвращаемый службой Amazon Web Services, которая размещает ресурс, представленный ключом ARN.
Ниже приведены распространенные коды ошибок, которые вы можете получить от других служб Amazon Web Services:
- InternalServiceException – Это может означать, что API тегирования ресурсов не получил ответ от другой службы Amazon Web Services. Это также может означать, что тип ресурса в запросе не поддерживается API тегирования ресурсов. В этих случаях можно безопасно повторить запрос, а затем вызвать GetResources для проверки изменений.
-
AccessDeniedException – Это может означать, что вам необходимо разрешение на вызов операций тегирования в службе Amazon Web Services, содержащей ресурс. Например, для использования API тегирования ресурсов для тегирования ресурса Amazon CloudWatch alarm, вам необходимо разрешение на вызов как `
TagResourceshttps://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html`__ и `TagResourcehttps://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html`__ в API CloudWatch.
Для получения дополнительной информации об ошибках, генерируемых другими службами Amazon Web Services, см. документацию по этой службе.
StatusCode -> (целое число)
ErrorCode -> (строка)
InternalServiceException , InvalidParameterException и любой допустимый код ошибки, возвращаемый службой Amazon Web Services, которая размещает ресурс, который вы хотите пометить.ErrorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.