[ aws . workspaces ]
create-workspaces-pool
Описание
Создаёт пул WorkSpaces.
См. также: Документацию API AWS
Синтаксис
create-workspaces-pool
--pool-name <value>
--description <value>
--bundle-id <value>
--directory-id <value>
--capacity <value>
[--tags <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-name (строка)
--description (строка)
--bundle-id (строка)
--directory-id (строка)
--capacity (структура)
Ёмкость пула пользователей.
DesiredUserSessions -> (целое число)
Краткая форма:
DesiredUserSessions=integer
Синтаксис JSON:
{
"DesiredUserSessions": integer
}
--tags (список)
Теги для пула.
(структура)
Описание тега.
Key -> (строка)
Value -> (строка)
Краткая форма:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.