Spec-Zone.ru › AWS CLI v2

[ aws . chime ]

batch-update-user

Описание

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

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

Синтаксис

  batch-update-user
--account-id <value>
--update-user-request-items <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.

--update-user-request-items (список)

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

(структура)

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

UserId -> (строка)

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

LicenseType -> (строка)

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

UserType -> (строка)

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

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

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

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

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

AlexaForBusinessRoomArn -> (строка)

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

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

UserId=string,LicenseType=string,UserType=string,AlexaForBusinessMetadata={IsAlexaForBusinessEnabled=boolean,AlexaForBusinessRoomArn=string} ...

Синтаксис JSON:

[
  {
    "UserId": "string",
    "LicenseType": "Basic"|"Plus"|"Pro"|"ProTrial",
    "UserType": "PrivateUser"|"SharedDevice",
    "AlexaForBusinessMetadata": {
      "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
  • 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-auto-prompt (логическое значение)

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

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

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

Примеры

Примечание

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

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

Для обновления нескольких пользователей в одной команде

Следующий batch-update-user пример обновляет LicenseType для каждого из перечисленных пользователей в указанной учетной записи Amazon Chime.

aws chime batch-update-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE
    --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic"

Вывод:

{
    "UserErrors": []
}

Вывод

UserErrors -> (список)

Если действие BatchUpdateUser завершается ошибкой для одного или нескольких идентификаторов пользователей в запросе, возвращается список идентификаторов пользователей вместе с кодами ошибок и сообщениями об ошибках.

(структура)

Список ошибок, возвращаемых при возникновении ошибок во время действий BatchSuspendUser , BatchUnsuspendUser или BatchUpdateUser. Он включает идентификаторы пользователей, коды ошибок и сообщения об ошибках.

UserId -> (строка)

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

ErrorCode -> (строка)

Код ошибки.

ErrorMessage -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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