Spec-Zone.ru › AWS CLI v2

[ aws . ds-data ]

обновить-пользователя

Описание

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

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

Синтаксис

  update-user
[--client-token <value>]
--directory-id <value>
[--email-address <value>]
[--given-name <value>]
[--other-attributes <value>]
--sam-account-name <value>
[--surname <value>]
[--update-type <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]

Параметры

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

Уникальный и чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса, так что несколько идентичных вызовов имеют тот же эффект, что и один единственный вызов.

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

Если вы отправляете запрос с тем же токеном клиента, но изменяете один из других параметров в течение 8-часового окна идемпотентности, Directory Service Data возвращает ConflictException.

Примечание

Этот параметр необязателен при использовании командной строки или SDK.

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

Идентификатор каталога, связанного с пользователем.

--email-address (строка)

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

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

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

--other-attributes (массив)

Выражение, определяющее одно или несколько имён атрибутов с типом данных и значением каждого атрибута. Ключ — имя атрибута, а значение — список массивов. Список поддерживаемых атрибутов см. в Directory Service Data Attributes.

Примечание

Имена атрибутов нечувствительны к регистру.

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

значение -> (структура тегированного объединения)

Тип данных атрибута. Каждое значение атрибута описывается как пара имя-значение. Имя — имя схемы AD, а значение — само данные. Список поддерживаемых атрибутов см. в Directory Service Data Attributes.

Примечание

Это структура тегированного объединения. Можно установить только один из следующих верхнеуровневых ключей: BOOL, N, S, SS.

BOOL -> (булево)

Указывает, что значение типа атрибута является булевым. Например:

"BOOL": true

N -> (целое число)

Указывает, что значение типа атрибута является числом. Например:

"N": "16"

S -> (строка)

Указывает, что значение типа атрибута является строкой. Например:

"S": "S Group"

SS -> (список)

Указывает, что значение типа атрибута является набором строк. Например:

"SS": ["sample_service_class/host.sample.com:1234/sample_service_name_1", "sample_service_class/host.sample.com:1234/sample_service_name_2"]

(строка)

Сокращённый синтаксис:

KeyName1=BOOL=boolean,N=long,S=string,SS=string,string,KeyName2=BOOL=boolean,N=long,S=string,SS=string,string

Синтаксис JSON:

{"string": {
      "BOOL": true|false,
      "N": long,
      "S": "string",
      "SS": ["string", ...]
    }
  ...}

--sam-account-name (строка)

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

--surname (строка)

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

--update-type (строка)

Тип обновления, который необходимо выполнить. Если значение для атрибута не существует, используйте ADD. В противном случае используйте REPLACE для изменения значения атрибута или REMOVE для очистки значения атрибута.

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

  • ADD
  • REPLACE
  • REMOVE

--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
  • текст
  • таблица
  • 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 в руководстве пользователя AWS CLI.

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

Обновление атрибута пользователя в каталоге

Следующий update-user пример обновляет указанный атрибут для указанного пользователя в указанном каталоге.

aws ds-data update-user \
    --directory-id d-1234567890 \
    --sam-account-name 'john.doe' \
    --update-type 'ADD' \
    --email-address 'example.corp.com'

Эта команда не выводит ничего.

Для получения дополнительной информации см. просмотр и обновление пользователя AWS Managed Microsoft AD в руководстве по администрированию AWS Directory Service.

Вывод

Нет

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

Spec-Zone.ru

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