Spec-Zone.ru › AWS CLI v2

[ aws . iam ]

list-users

Описание

Отображает пользователей IAM, у которых есть указанный префикс пути. Если префикс пути не указан, операция возвращает всех пользователей в учетной записи Amazon Web Services. Если пользователей нет, операция возвращает пустой список.

Примечание

Операции перечисления ресурсов IAM возвращают подмножество доступных атрибутов для ресурса. Данная операция не возвращает следующие атрибуты, даже если они являются атрибутами возвращаемого объекта:

  • PermissionsBoundary
  • Теги

Чтобы просмотреть всю информацию о пользователе, см. GetUser.

Вы можете выполнить постраничный вывод результатов, используя параметры MaxItems и Marker.

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

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

Синтаксис

  list-users
[--path-prefix <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]

Параметры

--path-prefix (строка)

Префикс пути для фильтрации результатов. Например: /division_abc/subdivision_xyz/, что получит все имена пользователей, чьи пути начинаются с /division_abc/subdivision_xyz/.

Этот параметр необязателен. Если он не указан, по умолчанию используется слеш (/), перечисляющий все имена пользователей. Этот параметр допускает (через свой шаблон регулярных выражений) строку символов, состоящую либо из одного слеша (/), либо из строки, которая должна начинаться и заканчиваться слешами. Кроме того, он может содержать любой ASCII-символ от ! (\u0021 ) до символа DEL (\u007F), включая большинство знаков препинания, цифры и заглавные и строчные буквы.

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

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

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

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

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

Токен для указания, с какой точки начать постраничный вывод. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

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

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

Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS Command Line Interface.

--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.

Для перечисления пользователей IAM

Следующая list-users команда перечисляет пользователей IAM в текущей учетной записи.

aws iam list-users

Вывод:

{
    "Users": [
        {
            "UserName": "Adele",
            "Path": "/",
            "CreateDate": "2013-03-07T05:14:48Z",
            "UserId": "AKIAI44QH8DHBEXAMPLE",
            "Arn": "arn:aws:iam::123456789012:user/Adele"
        },
        {
            "UserName": "Bob",
            "Path": "/",
            "CreateDate": "2012-09-21T23:03:13Z",
            "UserId": "AKIAIOSFODNN7EXAMPLE",
            "Arn": "arn:aws:iam::123456789012:user/Bob"
        }
    ]
}

Дополнительную информацию см. в разделе Перечисление пользователей IAM в Руководстве пользователя AWS IAM.

Вывод

Пользователи -> (список)

Список пользователей.

(структура)

Содержит информацию об сущности пользователя IAM.

Этот тип данных используется в качестве элемента ответа в следующих операциях:

  • CreateUser
  • GetUser
  • ListUsers

Путь -> (строка)

Путь к пользователю. Более подробную информацию о путях можно найти в разделе Идентификаторы IAM в Руководстве по IAM .

ARN политики, используемой для установки границ разрешений для пользователя.

Имя пользователя -> (строка)

Дружественное имя, идентифицирующее пользователя.

Идентификатор пользователя -> (строка)

Устойчивая и уникальная строка, идентифицирующая пользователя. Более подробную информацию об идентификаторах можно найти в разделе Идентификаторы IAM в Руководстве по IAM .

Arn -> (строка)

Amazon Resource Name (ARN), идентифицирующий пользователя. Более подробную информацию об ARN и о том, как использовать ARN в политиках, можно найти в разделе Идентификаторы IAM в Руководстве по IAM .

Дата создания -> (метка времени)

Дата и время создания пользователя в формате даты и времени ISO 8601.

Последняя дата использования пароля -> (метка времени)

Дата и время, в формате даты и времени ISO 8601, когда пароль пользователя был последний раз использован для входа на веб-сайт Amazon Web Services. Список веб-сайтов Amazon Web Services, которые записывают время последнего входа пользователя, можно найти в разделе Отчеты о крэдиентах в Руководстве по IAM . Если пароль используется более одного раза в течение пяти минут, в этом поле возвращается только первое использование. Если поле имеет значение null (нет значения), это означает, что пользователь никогда не входил с помощью пароля. Это может быть из-за:

  • У пользователя никогда не было пароля.
  • Пароль существует, но не использовался с момента начала отслеживания этой информации IAM 20 октября 2014 года.

Значение null не означает, что у пользователя никогда не было пароля. Также, если у пользователя в настоящее время нет пароля, но он был в прошлом, то в этом поле содержится дата и время последнего использованного пароля.

Это значение возвращается только в операциях GetUser и ListUsers.

PermissionsBoundary -> (структура)

Более подробную информацию о границах разрешений можно найти в разделе Границы разрешений для идентификаторов IAM в Руководстве по IAM .

PermissionsBoundaryType -> (строка)

Тип использования границ разрешений, указывающий тип ресурса IAM, используемого в качестве границ разрешений для сущности. Этот тип данных может иметь только значение Policy .

PermissionsBoundaryArn -> (строка)

ARN политики, используемой для установки границ разрешений для пользователя или роли.

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

Список тегов, связанных с пользователем. Более подробную информацию о тегах можно найти в разделе Маркирование ресурсов IAM в Руководстве по 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