Spec-Zone.ru › AWS CLI v2

[ aws . workmail ]

update-user

Описание

Обновляет данные пользователя. Для получения последней информации необходимо предварительно выполнить вызов DescribeUser. Набор данных в запросе должен соответствовать ожидаемому при выполнении другого DescribeUser вызова.

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

Синтаксис

  update-user
--organization-id <value>
--user-id <value>
[--role <value>]
[--display-name <value>]
[--first-name <value>]
[--last-name <value>]
[--hidden-from-global-address-list | --no-hidden-from-global-address-list]
[--initials <value>]
[--telephone <value>]
[--street <value>]
[--job-title <value>]
[--city <value>]
[--company <value>]
[--zip-code <value>]
[--department <value>]
[--country <value>]
[--office <value>]
[--identity-provider-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]

Параметры

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

Идентификатор организации, в рамках которой существует пользователь.

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

Идентификатор пользователя, который нужно обновить.

Идентификатор может быть UserId, Username или email. Доступны следующие форматы идентификации:

  • Идентификатор пользователя: 12345678-1234-1234-1234-123456789012 или S-1-1-12-1234567890-123456789-123456789-1234
  • Адрес электронной почты: user@domain.tld
  • Имя пользователя: user

--role (строка)

Обновляет роль пользователя.

Нельзя передавать SYSTEM_USER или RESOURCE.

Возможные значения:

  • USER
  • RESOURCE
  • SYSTEM_USER
  • REMOTE_USER

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

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

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

Обновляет имя пользователя (имя).

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

Обновляет фамилию пользователя.

--hidden-from-global-address-list | --no-hidden-from-global-address-list (логическое значение)

Если включено, пользователь скрыт из глобального адресного списка.

--initials (строка)

Обновляет инициалы пользователя.

--telephone (строка)

Обновляет контактные данные пользователя.

--street (строка)

Обновляет адрес улицы пользователя.

--job-title (строка)

Обновляет должность пользователя.

--city (строка)

Обновляет город пользователя.

--company (строка)

Обновляет компанию пользователя.

--zip-code (строка)

Обновляет почтовый индекс пользователя.

--department (строка)

Обновляет отдел пользователя.

--country (строка)

Обновляет страну пользователя.

--office (строка)

Обновляет офис пользователя.

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

Идентификатор пользователя из IAM Identity Center. Если этот параметр пустой, он будет автоматически обновлён при первом входе пользователя в почтовый ящик, связанный с WorkMail.

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

Вывод

Нет

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

Spec-Zone.ru

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