Spec-Zone.ru › AWS CLI v2

[ aws . workspaces-web ]

обновить-настройки-пользователя

Описание

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

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

Синтаксис

  update-user-settings
[--client-token <value>]
[--cookie-synchronization-configuration <value>]
[--copy-allowed <value>]
[--deep-link-allowed <value>]
[--disconnect-timeout-in-minutes <value>]
[--download-allowed <value>]
[--idle-disconnect-timeout-in-minutes <value>]
[--paste-allowed <value>]
[--print-allowed <value>]
[--toolbar-configuration <value>]
[--upload-allowed <value>]
--user-settings-arn <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 (строка)

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

Если вы не укажете токен клиента, он будет автоматически сгенерирован Amazon Web Services SDK.

--cookie-synchronization-configuration (структура)

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

Если списки разрешенных и запрещенных куки пусты, настройка становится пустой.

allowlist -> (список)

Список спецификаций куки, которые разрешено синхронизировать с удаленным браузером.

(структура)

Указывает один куки или набор куки в браузере конечного пользователя.

domain -> (строка)

Домен куки.

name -> (строка)

Имя куки.

path -> (строка)

Путь куки.

blocklist -> (список)

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

(структура)

Указывает один куки или набор куки в браузере конечного пользователя.

domain -> (строка)

Домен куки.

name -> (строка)

Имя куки.

path -> (строка)

Путь куки.

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

allowlist=[{domain=string,name=string,path=string},{domain=string,name=string,path=string}],blocklist=[{domain=string,name=string,path=string},{domain=string,name=string,path=string}]

Синтаксис JSON:

{
  "allowlist": [
    {
      "domain": "string",
      "name": "string",
      "path": "string"
    }
    ...
  ],
  "blocklist": [
    {
      "domain": "string",
      "name": "string",
      "path": "string"
    }
    ...
  ]
}

--copy-allowed (строка)

Указывает, может ли пользователь копировать текст из сеанса потоковой передачи в локальное устройство.

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

  • Disabled
  • Enabled

--deep-link-allowed (строка)

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

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

  • Disabled
  • Enabled

--disconnect-timeout-in-minutes (целое число)

Время активности сеанса потоковой передачи после отключения пользователя.

--download-allowed (строка)

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

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

  • Disabled
  • Enabled

--idle-disconnect-timeout-in-minutes (целое число)

Время бездействия пользователя (неактивности) перед отключением от сеанса потоковой передачи и началом интервала таймаута отключения.

--paste-allowed (строка)

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

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

  • Disabled
  • Enabled

--print-allowed (строка)

Указывает, может ли пользователь печатать на локальном устройстве.

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

  • Disabled
  • Enabled

--toolbar-configuration (структура)

Настройка панели инструментов. Это позволяет администраторам выбрать тип панели инструментов и режим отображения, установить максимальное разрешение экрана для сеансов и выбрать, какие элементы будут видны конечным пользователям во время их сеансов. Если администраторы не изменят эти настройки, конечные пользователи сохранят контроль над своими предпочтениями по панели инструментов.

hiddenToolbarItems -> (список)

Список элементов панели инструментов, которые нужно скрыть.

(строка)

maxDisplayResolution -> (строка)

Максимальное разрешение экрана, разрешенное для сеанса.

toolbarType -> (строка)

Тип панели инструментов, отображаемой во время сеанса.

visualMode -> (строка)

Режим отображения панели инструментов.

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

hiddenToolbarItems=string,string,maxDisplayResolution=string,toolbarType=string,visualMode=string

Синтаксис JSON:

{
  "hiddenToolbarItems": ["Windows"|"DualMonitor"|"FullScreen"|"Webcam"|"Microphone", ...],
  "maxDisplayResolution": "size4096X2160"|"size3840X2160"|"size3440X1440"|"size2560X1440"|"size1920X1080"|"size1280X720"|"size1024X768"|"size800X600",
  "toolbarType": "Floating"|"Docked",
  "visualMode": "Dark"|"Light"
}

--upload-allowed (строка)

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

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

  • Disabled
  • Enabled

--user-settings-arn (строка)

ARN настроек пользователя.

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

Вывод

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

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

additionalEncryptionContext -> (карта)

Дополнительный контекст шифрования для настроек пользователя.

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

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

associatedPortalArns -> (список)

Список ARN веб-порталов, с которыми связаны эти настройки пользователя.

(строка)

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

Конфигурация, определяющая, какие cookie должны быть синхронизированы с локального браузера пользователя в удалённый браузер.

allowlist -> (список)

Список спецификаций cookie, разрешённых для синхронизации с удалённым браузером.

(структура)

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

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

Домен cookie.

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

Имя cookie.

путь -> (строка)

Путь cookie.

blocklist -> (список)

Список спецификаций cookie, запрещённых для синхронизации с удалённым браузером.

(структура)

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

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

Домен cookie.

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

Имя cookie.

путь -> (строка)

Путь cookie.

copyAllowed -> (строка)

Указывает, может ли пользователь копировать текст из сеанса потоковой передачи на локальное устройство.

customerManagedKey -> (строка)

Используемый управляемый клиентом ключ для шифрования конфиденциальной информации в настройках пользователя.

deepLinkAllowed -> (строка)

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

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

Время, в течение которого сеанс потоковой передачи остаётся активным после отключения пользователя.

downloadAllowed -> (строка)

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

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

Время, в течение которого пользователи могут быть бездействующими (неактивными), прежде чем они будут отключены от сеанса потоковой передачи, и начнется интервал таймаута отключения.

pasteAllowed -> (строка)

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

printAllowed -> (строка)

Указывает, может ли пользователь печатать на локальном устройстве.

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

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

hiddenToolbarItems -> (список)

Список элементов панели инструментов, которые следует скрыть.

(строка)

maxDisplayResolution -> (строка)

Максимальное разрешение экрана, разрешённое для сеанса.

toolbarType -> (строка)

Тип панели инструментов, отображаемый во время сеанса.

visualMode -> (строка)

Визуальный режим панели инструментов.

uploadAllowed -> (строка)

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

userSettingsArn -> (строка)

ARN настроек пользователя.

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

Spec-Zone.ru

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