Spec-Zone.ru › AWS CLI v2

[ aws . identitystore ]

describe-user

Описание

Получает метаданные и атрибуты пользователя из хранилища идентификаторов.

Примечание

Если у вас есть права администратора в учётной записи участника, вы можете использовать этот API из учётной записи участника. Подробнее об учётных записях участников читайте в руководстве Organizations User Guide.

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

Синтаксис

  describe-user
--identity-store-id <value>
--user-id <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]

Параметры

--identity-store-id (строка)

Глобально уникальный идентификатор хранилища идентификаторов, например, d-1234567890. В этом примере d- — это фиксированный префикс, а 1234567890 — случайная строка, содержащая цифры и строчные буквы. Это значение генерируется при создании нового хранилища идентификаторов.

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

Идентификатор пользователя в хранилище идентификаторов.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла с вашими данными.

--region (строка)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

Вывод

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

Уникальная строка, используемая для идентификации пользователя. Предельная длина — 128 символов. Это значение может содержать буквы, символы с диакритическими знаками, символы, цифры и знаки препинания. Это значение задаётся при создании пользователя и хранится как атрибут объекта пользователя в хранилище идентификаторов.

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

Идентификатор пользователя в хранилище идентификаторов.

Внешние идентификаторы -> (список)

Список объектов ExternalId, содержащих идентификаторы, выданные этому ресурсу внешним поставщиком идентификаторов.

(структура)

Идентификатор, выданный этому ресурсу внешним поставщиком идентификаторов.

Издатель -> (строка)

Издатель внешнего идентификатора.

Идентификатор -> (строка)

Идентификатор, выданный этому ресурсу внешним поставщиком идентификаторов.

Имя -> (структура)

Имя пользователя.

Отформатированное имя -> (строка)

Строка, содержащая отформатированную версию имени для отображения.

Фамилия -> (строка)

Фамилия пользователя.

Имя -> (строка)

Имя пользователя.

Отчество -> (строка)

Отчество пользователя.

Должность -> (строка)

Должность пользователя. Например, «Доктор».

Постскриптум -> (строка)

Постскриптум пользователя. Например, «М.Д.»

Отображаемое имя -> (строка)

Отображаемое имя пользователя.

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

Альтернативное описательное имя пользователя.

Ссылка на профиль -> (строка)

Ссылка на профиль пользователя.

Электронные адреса -> (список)

Электронный адрес пользователя.

(структура)

Электронный адрес, связанный с пользователем.

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

Строка, содержащая электронный адрес. Например, «johndoe@amazon.com».

Тип -> (строка)

Строка, представляющая тип адреса. Например, «Работа».

Основной -> (логическое значение)

Логическое значение, указывающее, является ли это основной электронный адрес для связанного ресурса.

Адреса -> (список)

Физический адрес пользователя.

(структура)

Адрес, связанный с указанным пользователем.

Улица -> (строка)

Улица адреса.

Населённый пункт -> (строка)

Населённый пункт адреса.

Регион -> (строка)

Регион адреса.

Почтовый индекс -> (строка)

Почтовый индекс адреса.

Страна -> (строка)

Страна адреса.

Отформатированный адрес -> (строка)

Строка, содержащая отформатированный адрес для отображения.

Тип -> (строка)

Строка, представляющая тип адреса. Например, «Домашний».

Основной -> (логическое значение)

Логическое значение, указывающее, является ли это основной адрес для связанного ресурса.

Номера телефонов -> (список)

Список объектов PhoneNumber, связанных с пользователем.

(структура)

Номер телефона, связанный с пользователем.

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

Строка, содержащая номер телефона. Например, «8675309» или «+1 (800) 123-4567».

Тип -> (строка)

Строка, представляющая тип номера телефона. Например, «Мобильный».

Основной -> (логическое значение)

Логическое значение, указывающее, является ли это основной номер телефона для связанного ресурса.

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

Строка, указывающая тип пользователя.

Должность -> (строка)

Строка, содержащая должность пользователя.

Предпочитаемый язык -> (строка)

Предпочитаемый язык пользователя.

Регион -> (строка)

Строка, содержащая географический регион или местоположение пользователя.

Часовой пояс -> (строка)

Часовой пояс пользователя.

Идентификатор хранилища идентификаторов -> (строка)

Глобально уникальный идентификатор хранилища идентификаторов.

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

Spec-Zone.ru

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