[ aws . identitystore ]
list-users
Описание
Выводит список всех пользователей в хранилище идентификаторов. Возвращает постраничный список полных User объектов. Фильтрация по User по атрибуту UserName устарела. Используйте вместо этого действие API GetUserId.
Примечание
Если у вас есть права администратора на учётную запись члена, вы можете использовать этот API из учётной записи члена. Подробнее об учётных записях членов см. в руководстве Пользователь Organizations.См. также: Документацию API AWS
list-users — это постраничная операция. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих запросов: Users
Синтаксис
list-users
--identity-store-id <value>
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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]
Параметры
--identity-store-id (строка)
d-1234567890. В этом примере d- — это фиксированный префикс, а 1234567890 — случайная строка, содержащая цифры и строчные буквы. Это значение генерируется при создании нового хранилища идентификаторов.--filters (список)
Список объектов Filter, используемых в запросах ListUsers и ListGroups.
(структура)
Фильтр запроса, используемый в ListUsers и ListGroups. Этот объект фильтра содержит имя атрибута и значение атрибута для поиска пользователей или групп.
AttributePath -> (строка)
UserName — это допустимый путь к атрибуту для API ListUsers, а DisplayName — для API ListGroups.AttributeValue -> (строка)
Сокращенный синтаксис:
AttributePath=string,AttributeValue=string ...
Синтаксис JSON:
[
{
"AttributePath": "string",
"AttributeValue": "string"
}
...
]
--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.
--max-items (целое число)
Общее количество элементов, которые необходимо вернуть в выводе команды. Если доступно больше элементов, чем указано, в выводе команды будет предоставлен NextToken. Для продолжения постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничный вывод» руководства Пользовательского интерфейса 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
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла с данными аутентификации.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (булево)
Не подписывать запросы. Данные аутентификации не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с пакетом сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться в режиме блокировки без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Вывод
Пользователи -> (список)
Список объектов User в хранилище идентификации.
(структура)
Объект пользователя, содержащий метаданные и атрибуты указанного пользователя.
Имя пользователя -> (строка)
Идентификатор пользователя -> (строка)
Внешние идентификаторы -> (список)
Список объектов ExternalId, содержащих идентификаторы, выданные этому ресурсу внешним поставщиком идентификации.
(структура)
Идентификатор, выданный этому ресурсу внешним поставщиком идентификации.
Выдающий -> (строка)
Идентификатор -> (строка)
Имя -> (структура)
Объект, содержащий имя пользователя.
Отформатированное -> (строка)
Фамилия -> (строка)
Имя -> (строка)
Отчество -> (строка)
Префикс обращения -> (строка)
Суффикс обращения -> (строка)
Имя для отображения -> (строка)
Псевдоним -> (строка)
URL профиля -> (строка)
Электронные адреса -> (список)
Список объектов Email, содержащих электронные адреса, связанные с пользователем.
(структура)
Электронный адрес, связанный с пользователем.
Значение -> (строка)
Тип -> (строка)
Основной -> (логическое значение)
Адреса -> (список)
Список объектов Address, содержащих адреса, связанные с пользователем.
(структура)
Адрес, связанный с указанным пользователем.
Улица -> (строка)
Населённый пункт -> (строка)
Регион -> (строка)
Почтовый индекс -> (строка)
Страна -> (строка)
Отформатированный -> (строка)
Тип -> (строка)
Основной -> (логическое значение)
Номера телефонов -> (список)
Список объектов PhoneNumber, содержащих номера телефонов, связанные с пользователем.
(структура)
Номер телефона, связанный с пользователем.
Значение -> (строка)
Тип -> (строка)
Основной -> (логическое значение)
Тип пользователя -> (строка)
Должность -> (строка)
Предпочитаемый язык -> (строка)
Регион -> (строка)
Временная зона -> (строка)
Идентификатор хранилища идентификации -> (строка)
Маркер следующей страницы -> (строка)
ListUsers и ListGroups. Это значение генерируется службой хранилища идентификации. Возвращается в ответе API, если общее количество результатов превышает размер одной страницы. Этот маркер также возвращается, если он используется в запросе API для поиска следующей страницы.
© Copyright 2025, Amazon Web Services. Created using Sphinx.