[ aws . workspaces ]
create-workspaces
Описание
Создаёт один или несколько Рабочих мест.
Этот оператор асинхронный и возвращает результат до создания Рабочих мест.
Примечание
- Значение режима работы
MANUALподдерживается только Amazon WorkSpaces Core. Обратитесь в свою команду по обслуживанию аккаунтов, чтобы получить разрешение на использование этого значения. Дополнительную информацию см. в Amazon WorkSpaces Core. - Вам не нужно указывать протокол
PCOIPдля Linux-пакетов, так какDCV(ранее WSP) является протоколом по умолчанию для этих пакетов. - Рабочие места с отвязкой от пользователя поддерживаются только Amazon WorkSpaces Core.
- Проверьте режим работы, чтобы убедиться, что вы используете режим, оптимальный для ваших потребностей и бюджета. Дополнительную информацию о переключении режимов работы см. в разделе Можно ли переключаться между почасовой и ежемесячной оплатой?
См. также: Документация API AWS
Синтаксис
create-workspaces
--workspaces <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]
Параметры
--workspaces (список)
Рабочие места, которые нужно создать. Вы можете указать до 25 Рабочих мест.
(структура)
Описание информации, используемой для создания Рабочего места.
DirectoryId -> (строка)
UserName -> (строка)
Имя пользователя для Рабочего места. Это имя пользователя должно существовать в каталоге службы каталогов для Рабочего места.
Регистр имени пользователя не учитывается, но рекомендуется использовать тот же регистр, что и в каталоге службы каталогов, чтобы избежать потенциальных несовместимостей.
Зарезервированное ключевое слово [UNDEFINED] используется при создании Рабочих мест с отвязкой от пользователя.
BundleId -> (строка)
VolumeEncryptionKey -> (строка)
UserVolumeEncryptionEnabled -> (булево)
RootVolumeEncryptionEnabled -> (булево)
WorkspaceProperties -> (структура)
Свойства Рабочего места.
RunningMode -> (строка)
Режим работы. Дополнительную информацию см. в разделе Управление режимом работы Рабочего места.
Примечание
ЗначениеMANUAL поддерживается только Amazon WorkSpaces Core. Обратитесь в свою команду по обслуживанию аккаунтов, чтобы получить разрешение на использование этого значения. Дополнительную информацию см. в Amazon WorkSpaces Core.Проверьте режим работы, чтобы убедиться, что вы используете режим, оптимальный для ваших потребностей и бюджета. Дополнительную информацию о переключении режимов работы см. в разделе Можно ли переключаться между почасовой и ежемесячной оплатой?
RunningModeAutoStopTimeoutInMinutes -> (целое число)
RootVolumeSizeGib -> (целое число)
UserVolumeSizeGib -> (целое число)
ComputeTypeName -> (строка)
Protocols -> (список)
Протокол. Дополнительную информацию см. в разделе Протоколы для Amazon WorkSpaces.
Примечание
- Доступно только для Рабочих мест, созданных с пакетами PCoIP.
- Свойство
Protocolsчувствительно к регистру. Убедитесь, что вы используетеPCOIPилиDCV(ранее WSP). - Недоступно для Рабочих мест Windows 7 и Рабочих мест с использованием пакетов на базе графических процессоров (Graphics, GraphicsPro, Graphics.g4dn и GraphicsPro.g4dn).
(строка)
OperatingSystemName -> (строка)
GlobalAccelerator -> (структура)
Указывает свойства Global Accelerator.
Mode -> (строка)
PreferredProtocol -> (строка)
Tags -> (список)
Теги для Рабочего места.
(структура)
Описание тега.
Key -> (строка)
Value -> (строка)
WorkspaceName -> (строка)
Имя Рабочего места с отвязкой от пользователя.
Примечание
WorkspaceName требуется, если UserName имеет значение [UNDEFINED] для Рабочих мест с отвязкой от пользователя. WorkspaceName не применимо, если для Рабочих мест с привязкой к пользователю указано UserName.Сокращённый синтаксис:
DirectoryId=string,UserName=string,BundleId=string,VolumeEncryptionKey=string,UserVolumeEncryptionEnabled=boolean,RootVolumeEncryptionEnabled=boolean,WorkspaceProperties={RunningMode=string,RunningModeAutoStopTimeoutInMinutes=integer,RootVolumeSizeGib=integer,UserVolumeSizeGib=integer,ComputeTypeName=string,Protocols=[string,string],OperatingSystemName=string,GlobalAccelerator={Mode=string,PreferredProtocol=string}},Tags=[{Key=string,Value=string},{Key=string,Value=string}],WorkspaceName=string ...
Синтаксис JSON:
[
{
"DirectoryId": "string",
"UserName": "string",
"BundleId": "string",
"VolumeEncryptionKey": "string",
"UserVolumeEncryptionEnabled": true|false,
"RootVolumeEncryptionEnabled": true|false,
"WorkspaceProperties": {
"RunningMode": "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
"RunningModeAutoStopTimeoutInMinutes": integer,
"RootVolumeSizeGib": integer,
"UserVolumeSizeGib": integer,
"ComputeTypeName": "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GENERALPURPOSE_4XLARGE"|"GENERALPURPOSE_8XLARGE"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN",
"Protocols": ["PCOIP"|"WSP", ...],
"OperatingSystemName": "AMAZON_LINUX_2"|"UBUNTU_18_04"|"UBUNTU_20_04"|"UBUNTU_22_04"|"UNKNOWN"|"WINDOWS_10"|"WINDOWS_11"|"WINDOWS_7"|"WINDOWS_SERVER_2016"|"WINDOWS_SERVER_2019"|"WINDOWS_SERVER_2022"|"RHEL_8"|"ROCKY_8",
"GlobalAccelerator": {
"Mode": "ENABLED_AUTO"|"DISABLED"|"INHERITED",
"PreferredProtocol": "TCP"|"NONE"|"INHERITED"
}
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
...
],
"WorkspaceName": "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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, 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 в Руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования, подобные Unix. Эти примеры нужно адаптировать к правилам цитирования вашей оболочки. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Пример 1: Создание Рабочего места AlwaysOn
Следующий пример создания Рабочего места AlwaysOn для указанного пользователя, используя указанный каталог и пакет.
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc
Вывод:
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-kcqms853t",
"DirectoryId": "d-926722edaf",
"UserName": "Mateo",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
Пример 2: Создание Рабочего места AutoStop
Следующий пример создания Рабочего места AutoStop для указанного пользователя, используя указанный каталог и пакет.
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}
Вывод:
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-dk1xzr417",
"DirectoryId": "d-926722edaf",
"UserName": "Mary",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
Пример 3: Создание Рабочего места с отвязкой от пользователя
Следующий пример создания Рабочего места с отвязкой от пользователя, установив имя пользователя в [UNDEFINED] и указав имя Рабочего места, идентификатор каталога и идентификатор пакета.
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}
Вывод:
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-abcd1234",
"DirectoryId": "d-926722edaf",
"UserName": "[UNDEFINED]",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc",
"WorkspaceName": "MaryWorkspace1"
}
]
}
Дополнительную информацию см. в разделе Запуск виртуального рабочего стола в Руководстве по администрированию Amazon WorkSpaces.
Вывод
FailedRequests -> (список)
Информация о Рабочих столах, которые не удалось создать.
(структура)
Описание Рабочего стола, который не может быть создан.
WorkspaceRequest -> (структура)
Информация о Рабочем столе.
DirectoryId -> (строка)
UserName -> (строка)
Имя пользователя для Рабочего стола. Это имя пользователя должно существовать в каталоге службы каталогов для Рабочего стола.
Имя пользователя не чувствительно к регистру, но рекомендуется соответствовать регистру в каталоге службы каталогов, чтобы избежать потенциальных несовместимостей.
Зарезервированное ключевое слово, [UNDEFINED], используется при создании Рабочих столов с отвязанными пользователями.
BundleId -> (строка)
VolumeEncryptionKey -> (строка)
UserVolumeEncryptionEnabled -> (булево)
RootVolumeEncryptionEnabled -> (булево)
WorkspaceProperties -> (структура)
Свойства Рабочего стола.
RunningMode -> (строка)
Режим работы. Для получения дополнительной информации см. Управление режимом работы Рабочего стола .
Примечание
ЗначениеMANUAL поддерживается только Amazon WorkSpaces Core. Обратитесь к своей команде по учетной записи, чтобы получить разрешение на использование этого значения. Дополнительную информацию см. в Amazon WorkSpaces Core .Проверьте режим работы, чтобы убедиться, что вы используете режим, оптимальный для ваших потребностей и бюджета. Дополнительную информацию о переключении режимов работы см. в Можно ли переключаться между почасовой и ежемесячной оплатой?
RunningModeAutoStopTimeoutInMinutes -> (целое число)
RootVolumeSizeGib -> (целое число)
UserVolumeSizeGib -> (целое число)
ComputeTypeName -> (строка)
Protocols -> (список)
Протокол. Для получения дополнительной информации см. Протоколы для Amazon WorkSpaces .
Примечание
- Доступно только для Рабочих столов, созданных с пакетами PCoIP.
- Свойство
Protocolsчувствительно к регистру. Убедитесь, что вы используетеPCOIPилиDCV(ранее WSP). - Недоступно для Рабочих столов Windows 7 и Рабочих столов, использующих пакеты на базе графических процессоров (Graphics, GraphicsPro, Graphics.g4dn и GraphicsPro.g4dn).
(строка)
OperatingSystemName -> (строка)
GlobalAccelerator -> (структура)
Указывает свойства Global Accelerator.
Mode -> (строка)
PreferredProtocol -> (строка)
Tags -> (список)
Теги для Рабочего стола.
(структура)
Описание тега.
Key -> (строка)
Value -> (строка)
WorkspaceName -> (строка)
Имя Рабочего стола с отвязанными пользователями.
Примечание
WorkspaceName требуется, если UserName является [UNDEFINED] для Рабочих столов с отвязанными пользователями. WorkspaceName не применимо, если для Рабочих столов с назначенными пользователями указано UserName.ErrorCode -> (строка)
ErrorMessage -> (строка)
PendingRequests -> (список)
Информация о созданных WorkSpaces.
Поскольку эта операция асинхронна, возвращаемый идентификатор не сразу доступен для использования с другими операциями. Например, если вы вызовете DescribeWorkspaces до создания WorkSpace, возвращаемая информация может быть неполной.
(структура)
Описание WorkSpace.
WorkspaceId -> (строка)
DirectoryId -> (строка)
UserName -> (строка)
IpAddress -> (строка)
State -> (строка)
Операционное состояние WorkSpace.
-
PENDING– WorkSpace находится в состоянии ожидания (например, WorkSpace создаётся). -
AVAILABLE– WorkSpace работает и прошла проверки работоспособности. -
IMPAIRED– См. состояниеUNHEALTHY. -
UNHEALTHY– WorkSpace не отвечает на проверки работоспособности. -
REBOOTING– WorkSpace перезагружается. -
STARTING– WorkSpace запускается, и выполняются проверки работоспособности. -
REBUILDING– WorkSpace перестраивается. -
RESTORING– WorkSpace восстанавливается. -
MAINTENANCE– WorkSpace проходит запланированное техническое обслуживание Amazon Web Services. -
ADMIN_MAINTENANCE– WorkSpace проходит техническое обслуживание администратором WorkSpaces. -
TERMINATING– WorkSpace удаляется. -
TERMINATED– WorkSpace удалён. -
SUSPENDED– WorkSpace приостановлен для создания образа. -
UPDATING– WorkSpace обновляется. -
STOPPING– WorkSpace останавливается. -
STOPPED– WorkSpace остановлен. -
ERROR– WorkSpace находится в состоянии ошибки (например, произошла ошибка во время запуска).
Примечание
После завершения работы WorkSpace состояниеTERMINATED возвращается только ненадолго, прежде чем метаданные каталога WorkSpace очищаются, поэтому это состояние возвращается редко. Чтобы подтвердить завершение работы WorkSpace, проверьте ID WorkSpace, используя DescribeWorkSpaces. Если ID WorkSpace не возвращается, значит, WorkSpace успешно завершил работу.BundleId -> (строка)
SubnetId -> (строка)
ErrorMessage -> (строка)
ErrorCode -> (строка)
ComputerName -> (строка)
VolumeEncryptionKey -> (строка)
UserVolumeEncryptionEnabled -> (булево значение)
RootVolumeEncryptionEnabled -> (булево значение)
WorkspaceName -> (строка)
WorkspaceProperties -> (структура)
Свойства WorkSpace.
RunningMode -> (строка)
Режим работы. Для получения дополнительной информации см. Управление режимом работы WorkSpace.
Примечание
ЗначениеMANUAL поддерживается только Amazon WorkSpaces Core. Обратитесь в свою команду по работе с аккаунтом, чтобы получить разрешение на использование этого значения. Для получения дополнительной информации см. Amazon WorkSpaces Core.Проверьте режим работы, чтобы убедиться, что вы используете режим, оптимальный для ваших потребностей и бюджета. Для получения дополнительной информации о переключении режимов работы см. Можно ли переключаться между почасовой и помесячной оплатой?
RunningModeAutoStopTimeoutInMinutes -> (целое число)
RootVolumeSizeGib -> (целое число)
UserVolumeSizeGib -> (целое число)
ComputeTypeName -> (строка)
Protocols -> (список)
Протокол. Для получения дополнительной информации см. Протоколы для Amazon WorkSpaces.
Примечание
- Доступно только для WorkSpaces, созданных с пакетами PCoIP.
- Свойство
Protocolsчувствительно к регистру. Убедитесь, что вы используетеPCOIPилиDCV(ранее WSP). - Недоступно для Windows 7 WorkSpaces и WorkSpaces, использующих пакеты на базе GPU (Graphics, GraphicsPro, Graphics.g4dn и GraphicsPro.g4dn).
(строка)
OperatingSystemName -> (строка)
GlobalAccelerator -> (структура)
Указывает свойства Global Accelerator.
Mode -> (строка)
PreferredProtocol -> (строка)
ModificationStates -> (список)
Состояния изменений WorkSpace.
(структура)
Описание изменения WorkSpace.
Resource -> (строка)
State -> (строка)
RelatedWorkspaces -> (список)
Запасной или основной WorkSpace, связанный с указанным WorkSpace.
(структура)
Описание связанного WorkSpace. Связанный WorkSpace может быть запасным или основным WorkSpace, связанным с указанным WorkSpace.
WorkspaceId -> (строка)
Region -> (строка)
State -> (строка)
Type -> (строка)
DataReplicationSettings -> (структура)
Указывает настройки репликации данных.
DataReplication -> (строка)
RecoverySnapshotTime -> (метка времени)
StandbyWorkspacesProperties -> (список)
Свойства запасного WorkSpace
(структура)
Описание свойств связанных запасных WorkSpaces.
StandbyWorkspaceId -> (строка)
DataReplication -> (строка)
RecoverySnapshotTime -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.