Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-user-tags

Описание

Выводит список тегов, прикреплённых к указанному пользователю IAM. Возвращаемый список тегов отсортирован по ключу тега. Дополнительную информацию о тегах см. в руководстве по IAM «Тегирование ресурсов IAM».

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

list-user-tags — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на запрос со постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Tags

Синтаксис

  list-user-tags
--user-name <value>
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--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]

Параметры

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

Имя пользователя IAM, теги которого вы хотите просмотреть.

Этот параметр позволяет (через шаблон регулярных выражений) использовать строку, состоящую из символов верхнего и нижнего регистра, латинских букв и цифр без пробелов. Вы также можете использовать следующие символы: _+=,.@-

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в руководстве пользователя AWS CLI «Постраничный вывод».

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного в JSON, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер, указывающий, с какой точки начать постраничный вывод. Это NextToken из ранее обрезаемого ответа.

Примеры использования см. в руководстве пользователя AWS CLI «Постраничный вывод».

--page-size (целое число)

Размер каждой страницы для вызова в AWS-сервисе. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньшее количество элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в руководстве пользователя AWS CLI «Постраничный вывод».

--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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

Для вывода списка тегов, прикрепленных к пользователю

Следующая list-user-tags команда получает список тегов, связанных с указанным пользователем IAM.

aws iam list-user-tags \
    --user-name alice

Вывод:

{
    "Tags": [
        {
            "Key": "Department",
            "Value": "Accounting"
        },
        {
            "Key": "DeptID",
            "Value": "12345"
        }
    ],
    "IsTruncated": false
}

Дополнительную информацию см. в разделе «Тегирование ресурсов IAM» руководства пользователя AWS IAM.

Вывод

Теги -> (список)

Список тегов, в настоящее время прикрепленных к пользователю. Каждый тег состоит из имени ключа и связанного значения. Если к указанному ресурсу не прикреплены теги, ответ содержит пустой список.

(структура)

Структура, представляющая метаданные, предоставленные пользователем, которые могут быть связаны с ресурсом IAM. Дополнительную информацию о тегах см. в руководстве по IAM «Тегирование ресурсов IAM».

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

Имя ключа, которое можно использовать для поиска или получения связанного значения. Например, Department или Cost Center — распространенные варианты.

Значение -> (строка)

Значение, связанное с этим тегом. Например, теги с именем ключа Department могут иметь значения, такие как Human Resources, Accounting и Support. Теги с именем ключа Cost Center могут иметь значения, представляющие число, связанное с различными центрами затрат в вашей компании. Как правило, многие ресурсы имеют теги с одинаковым именем ключа, но с различными значениями.

Примечание

Amazon Web Services всегда интерпретирует тег Value как одну строку. Если вам нужно хранить массив, вы можете хранить значения, разделённые запятыми, в строке. Однако интерпретировать значение необходимо в своём коде.

IsTruncated -> (логическое значение)

Флаг, указывающий, есть ли ещё элементы для возврата. Если результаты были обрезаны, вы можете выполнить последующий запрос постраничного вывода, используя параметр запроса Marker, чтобы получить больше элементов. Обратите внимание, что IAM может вернуть меньше, чем MaxItems результатов, даже если доступно больше результатов. Рекомендуется проверять IsTruncated после каждого вызова, чтобы гарантировать получение всех результатов.

Маркер -> (строка)

Если IsTruncated равно true, этот элемент присутствует и содержит значение для использования в параметре Marker в последующем запросе постраничного вывода.

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

Spec-Zone.ru

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