[ aws . workspaces ]
update-workspaces-pool
Описание
Обновляет указанный пул.
См. также: Документацию API AWS
Синтаксис
update-workspaces-pool
--pool-id <value>
[--description <value>]
[--bundle-id <value>]
[--directory-id <value>]
[--capacity <value>]
[--application-settings <value>]
[--timeout-settings <value>]
[--running-mode <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]
Параметры
--pool-id (строка)
--description (строка)
--bundle-id (строка)
--directory-id (строка)
--capacity (структура)
Желаемая ёмкость пула.
DesiredUserSessions -> (целое число)
Краткая форма:
DesiredUserSessions=integer
Синтаксис JSON:
{
"DesiredUserSessions": integer
}
--application-settings (структура)
Настройки постоянных приложений для пользователей в пуле.
Status -> (строка)
SettingsGroup -> (строка)
Краткая форма:
Status=string,SettingsGroup=string
Синтаксис JSON:
{
"Status": "DISABLED"|"ENABLED",
"SettingsGroup": "string"
}
--timeout-settings (структура)
Указывает настройки таймаута для указанного пула.
DisconnectTimeoutInSeconds -> (целое число)
IdleDisconnectTimeoutInSeconds -> (целое число)
MaxUserDurationInSeconds -> (целое число)
Краткая форма:
DisconnectTimeoutInSeconds=integer,IdleDisconnectTimeoutInSeconds=integer,MaxUserDurationInSeconds=integer
Синтаксис JSON:
{
"DisconnectTimeoutInSeconds": integer,
"IdleDisconnectTimeoutInSeconds": integer,
"MaxUserDurationInSeconds": integer
}
--running-mode (строка)
Желаемый режим работы пула. Режим работы может быть обновлен только при остановленном пуле.
Возможные значения:
AUTO_STOPALWAYS_ON
--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 для вывода.
--cli-auto-prompt (логическое)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое)
Отключить автоматическое запроса параметров ввода CLI.
Вывод
WorkspacesPool -> (структура)
Описание указанного пула.
PoolId -> (строка)
PoolArn -> (строка)
CapacityStatus -> (структура)
Статус ёмкости пула
AvailableUserSessions -> (целое число)
Количество пользовательских сессий, в настоящее время доступных для потоковой передачи из вашего пула.
AvailableUserSessions = ActualUserSessions - ActiveUserSessions
DesiredUserSessions -> (целое число)
ActualUserSessions -> (целое число)
Общее количество пользовательских сессий, доступных для потоковой передачи или в настоящее время потоковой передачи в вашем пуле.
ActualUserSessions = AvailableUserSessions + ActiveUserSessions
ActiveUserSessions -> (целое число)
PoolName -> (строка)
Description -> (строка)
State -> (строка)
CreatedAt -> (метка времени)
BundleId -> (строка)
DirectoryId -> (строка)
Errors -> (список)
Ошибки пула.
(структура)
Описание ошибки пула.
ErrorCode -> (строка)
ErrorMessage -> (строка)
ApplicationSettings -> (структура)
Настройки постоянных приложений для пользователей пула.
Status -> (строка)
SettingsGroup -> (строка)
S3BucketName -> (строка)
TimeoutSettings -> (структура)
Время, в течение которого сессия пула остается активной после отключения пользователей. Если они пытаются подключиться к сессии пула после отключения или прерывания сети в течение этого интервала времени, они подключаются к предыдущей сессии. В противном случае они подключаются к новой сессии с новым экземпляром пула.
DisconnectTimeoutInSeconds -> (целое число)
IdleDisconnectTimeoutInSeconds -> (целое число)
MaxUserDurationInSeconds -> (целое число)
RunningMode -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.