Spec-Zone.ru › AWS CLI v2

[ aws . chime ]

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

Описание

Обновляет данные пользователя для указанного идентификатора пользователя. В настоящее время для этого действия поддерживаются только обновления LicenseType.

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

Синтаксис

  update-user
--account-id <value>
--user-id <value>
[--license-type <value>]
[--user-type <value>]
[--alexa-for-business-metadata <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]

Параметры

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

Идентификатор учетной записи Amazon Chime.

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

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

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

Тип лицензии пользователя для обновления. Он должен быть поддерживаемым типом лицензии для учетной записи Amazon Chime, к которой принадлежит пользователь.

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

  • Basic
  • Plus
  • Pro
  • ProTrial

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

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

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

  • PrivateUser
  • SharedDevice

--alexa-for-business-metadata (структура)

Метаданные Alexa for Business.

IsAlexaForBusinessEnabled -> (логическое значение)

Включает или отключает Alexa for Business.

AlexaForBusinessRoomArn -> (строка)

ARN ресурса комнаты.

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

IsAlexaForBusinessEnabled=boolean,AlexaForBusinessRoomArn=string

Синтаксис JSON:

{
  "IsAlexaForBusinessEnabled": true|false,
  "AlexaForBusinessRoomArn": "string"
}

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

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры входных данных CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запросы параметров входных данных CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

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

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

В этом примере обновляются указанные данные для указанного пользователя.

Команда:

aws chime update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \
    --license-type "Basic"

Вывод:

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE"
    }
}

Вывод

Пользователь -> (структура)

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

UserId -> (строка)

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

AccountId -> (строка)

Идентификатор учетной записи Amazon Chime.

PrimaryEmail -> (строка)

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

PrimaryProvisionedNumber -> (строка)

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

DisplayName -> (строка)

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

LicenseType -> (строка)

Тип лицензии для пользователя.

UserType -> (строка)

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

UserRegistrationStatus -> (строка)

Статус регистрации пользователя.

UserInvitationStatus -> (строка)

Статус приглашения пользователя.

RegisteredOn -> (метка времени)

Дата и время регистрации пользователя в формате ISO 8601.

InvitedOn -> (метка времени)

Дата и время приглашения пользователя в учетную запись Amazon Chime в формате ISO 8601.

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

Метаданные Alexa for Business.

IsAlexaForBusinessEnabled -> (логическое значение)

Включает или отключает Alexa for Business.

AlexaForBusinessRoomArn -> (строка)

ARN ресурса комнаты.

PersonalPIN -> (строка)

Персональный PIN-код пользователя для проведения собраний.

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

Spec-Zone.ru

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