[ aws . workspaces-web ]
create-user-settings
Описание
Создаёт ресурс настроек пользователя, который может быть связан с веб-порталом. После связывания с веб-порталом настройки пользователя контролируют, как пользователи могут передавать данные между сеансом потоковой передачи и своими локальными устройствами.
См. также: Документацию API AWS
Синтаксис
create-user-settings
[--additional-encryption-context <value>]
[--client-token <value>]
[--cookie-synchronization-configuration <value>]
--copy-allowed <value>
[--customer-managed-key <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>
[--tags <value>]
[--toolbar-configuration <value>]
--upload-allowed <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]
Параметры
--additional-encryption-context (отображение)
Дополнительный контекст шифрования настроек пользователя.
ключ -> (строка)
значение -> (строка)
Сокращённый синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--client-token (строка)
Уникальный, чувствительный к регистру идентификатор, который вы предоставляете, чтобы обеспечить идемпотентность запроса. Идемпотентность гарантирует, что запрос API выполняется только один раз. С идемпотентным запросом, если исходный запрос выполняется успешно, последующие повторения с тем же токеном клиента возвращают результат от исходного успешного запроса.
Если вы не указываете токен клиента, он автоматически генерируется SDK Amazon Web Services.
--cookie-synchronization-configuration (структура)
Настройка, которая определяет, какие файлы cookie должны быть синхронизированы с локального браузера конечного пользователя в удалённый браузер.
allowlist -> (список)
Список спецификаций файлов cookie, которые разрешено синхронизировать с удалённым браузером.
(структура)
Определяет один файл cookie или набор файлов cookie в браузере конечного пользователя.
домен -> (строка)
имя -> (строка)
путь -> (строка)
blocklist -> (список)
Список спецификаций файлов cookie, которые заблокированы от синхронизации с удалённым браузером.
(структура)
Определяет один файл cookie или набор файлов cookie в браузере конечного пользователя.
домен -> (строка)
имя -> (строка)
путь -> (строка)
Сокращённый синтаксис:
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 (строка)
Указывает, может ли пользователь копировать текст из сеанса потоковой передачи на локальное устройство.
Возможные значения:
DisabledEnabled
--customer-managed-key (строка)
--deep-link-allowed (строка)
Указывает, может ли пользователь использовать глубокие ссылки, которые открываются автоматически при подключении к сеансу.
Возможные значения:
DisabledEnabled
--disconnect-timeout-in-minutes (целое число)
--download-allowed (строка)
Указывает, может ли пользователь загружать файлы из сеанса потоковой передачи на локальное устройство.
Возможные значения:
DisabledEnabled
--idle-disconnect-timeout-in-minutes (целое число)
--paste-allowed (строка)
Указывает, может ли пользователь вставлять текст из локального устройства в сеанс потоковой передачи.
Возможные значения:
DisabledEnabled
--print-allowed (строка)
Указывает, может ли пользователь печатать на локальном устройстве.
Возможные значения:
DisabledEnabled
--tags (список)
Теги для добавления к ресурсу настроек пользователя. Тег — это пара «ключ-значение».
(структура)
Тег.
Ключ -> (строка)
Значение -> (строка)
Сокращённый синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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 (строка)
Указывает, может ли пользователь загружать файлы с локального устройства в сеанс потоковой передачи.
Возможные значения:
DisabledEnabled
--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 (булево)
Автоматически запрашивать параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическую запрос параметров ввода командной строки.
Вывод
userSettingsArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.