WorkSpaces 使用範例 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

WorkSpaces 使用範例 AWS CLI

下列程式碼範例說明如何使用 AWS Command Line Interface 與來執行動作及實作常見案例 WorkSpaces。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用create-tags

AWS CLI

若要將標籤新增至 WorkSpace

下列create-tags範例會將指定的標籤加入至指定的標籤 WorkSpace。

aws workspaces create-tags \ --resource-id ws-dk1xzr417 \ --tags Key=Department,Value=Finance

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南中的標記 WorkSpaces 資源

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateTags中的。

下列程式碼範例會示範如何使用create-workspaces

AWS CLI

範例 1:若要建立 AlwaysOn WorkSpace

下列create-workspaces範例會使用指定的目錄和套裝軟體, AlwaysOn WorkSpace 為指定的使用者建立一個。

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 WorkSpace

下列create-workspaces範例會使用指定的目錄和套裝軟體, AutoStop WorkSpace 為指定的使用者建立一個。

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:建立使用者解耦 WorkSpace

下列create-workspaces範例會透 WorkSpace 過將使用者名稱設定為[UNDEFINED],並指定 WorkSpace 名稱、目錄 ID 和套裝軟體 ID 來建立使用者解耦。

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 管理指南中的啟動虛擬桌面

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateWorkspaces中的。

下列程式碼範例會示範如何使用delete-tags

AWS CLI

若要從標籤中刪除標籤 WorkSpace

下列delete-tags範例會從指定的刪除指定的標籤 WorkSpace。

aws workspaces delete-tags \ --resource-id ws-dk1xzr417 \ --tag-keys Department

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南中的標記 WorkSpaces 資源

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteTags中的。

下列程式碼範例會示範如何使用deregister-workspace-directory

AWS CLI

若要取消註冊目錄

下列deregister-workspace-directory範例會取消註冊指定的目錄。

aws workspaces deregister-workspace-directory \ --directory-id d-926722edaf

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces中的註冊目錄

下列程式碼範例會示範如何使用describe-tags

AWS CLI

若要描述的標籤 WorkSpace

下列describe-tags範例說明指定的標籤 WorkSpace。

aws workspaces describe-tags \ --resource-id ws-dk1xzr417

輸出:

{ "TagList": [ { "Key": "Department", "Value": "Finance" } ] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南中的標記 WorkSpaces 資源

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DescribeTags中的。

下列程式碼範例會示範如何使用describe-workspace-bundles

AWS CLI

列出 Amazon 提供的捆綁

下列describe-workspace-bundles範例會以表格格式列出 Amazon 提供之服務包的名稱和 ID,並依名稱排序。

aws workspaces describe-workspace-bundles \ --owner AMAZON \ --query "Bundles[*].[Name, BundleId]"

輸出:

[ [ "Standard with Amazon Linux 2", "wsb-clj85qzj1" ], [ "Performance with Windows 10 (Server 2016 based)", "wsb-gm4d5tx2v" ], [ "PowerPro with Windows 7", "wsb-1pzkp0bx4" ], [ "Power with Amazon Linux 2", "wsb-2bs6k5lgn" ], [ "Graphics with Windows 10 (Server 2019 based)", "wsb-03gyjnfyy" ], ... ]

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南中的WorkSpaces 套裝軟體和映像

下列程式碼範例會示範如何使用describe-workspace-directories

AWS CLI

描述已註冊的目錄

下列describe-workspace-directories範例說明指定的註冊目錄。

aws workspaces describe-workspace-directories \ --directory-ids d-926722edaf

輸出:

{ "Directories": [ { "DirectoryId": "d-926722edaf", "Alias": "d-926722edaf", "DirectoryName": "example.com", "RegistrationCode": "WSpdx+9RJ8JT", "SubnetIds": [ "subnet-9d19c4c6", "subnet-500d5819" ], "DnsIpAddresses": [ "172.16.1.140", "172.16.0.30" ], "CustomerUserName": "Administrator", "IamRoleId": "arn:aws:iam::123456789012:role/workspaces_DefaultRole", "DirectoryType": "SIMPLE_AD", "WorkspaceSecurityGroupId": "sg-0d89e927e5645d7c5", "State": "REGISTERED", "WorkspaceCreationProperties": { "EnableWorkDocs": false, "EnableInternetAccess": false, "UserEnabledAsLocalAdministrator": true, "EnableMaintenanceMode": true }, "WorkspaceAccessProperties": { "DeviceTypeWindows": "ALLOW", "DeviceTypeOsx": "ALLOW", "DeviceTypeWeb": "DENY", "DeviceTypeIos": "ALLOW", "DeviceTypeAndroid": "ALLOW", "DeviceTypeChromeOs": "ALLOW", "DeviceTypeZeroClient": "ALLOW", "DeviceTypeLinux": "DENY" }, "Tenancy": "SHARED", "SelfservicePermissions": { "RestartWorkspace": "ENABLED", "IncreaseVolumeSize": "DISABLED", "ChangeComputeType": "DISABLED", "SwitchRunningMode": "DISABLED", "RebuildWorkspace": "DISABLED" } } ] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces中的管理目錄

下列程式碼範例會示範如何使用describe-workspaces-connection-status

AWS CLI

若要描述的連線狀態 WorkSpace

下列describe-workspaces-connection-status範例說明指定之的連線狀態 WorkSpace。

aws workspaces describe-workspaces-connection-status \ --workspace-ids ws-dk1xzr417

輸出:

{ "WorkspacesConnectionStatus": [ { "WorkspaceId": "ws-dk1xzr417", "ConnectionState": "CONNECTED", "ConnectionStateCheckTimestamp": 1662526214.744 } ] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces中的管理您的

下列程式碼範例會示範如何使用describe-workspaces

AWS CLI

若要描述 WorkSpace

下列describe-workspaces範例說明指定的 WorkSpace。

aws workspaces describe-workspaces \ --workspace-ids ws-dk1xzr417

輸出:

{ "Workspaces": [ { "WorkspaceId": "ws-dk1xzr417", "DirectoryId": "d-926722edaf", "UserName": "Mary", "IpAddress": "172.16.0.175", "State": "STOPPED", "BundleId": "wsb-0zsvgp8fc", "SubnetId": "subnet-500d5819", "ComputerName": "WSAMZN-RBSLTTD9", "WorkspaceProperties": { "RunningMode": "AUTO_STOP", "RunningModeAutoStopTimeoutInMinutes": 60, "RootVolumeSizeGib": 80, "UserVolumeSizeGib": 10, "ComputeTypeName": "VALUE" }, "ModificationStates": [] } ] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces中的管理您的

下列程式碼範例會示範如何使用migrate-workspace

AWS CLI

若要移轉 WorkSpace

下列migrate-workspace範例會將指定的移轉 WorkSpace 至指定的套裝軟體。

aws workspaces migrate-workspace \ --source-workspace-id ws-dk1xzr417 \ --bundle-id wsb-j4dky1gs4

輸出:

{ "SourceWorkspaceId": "ws-dk1xzr417", "TargetWorkspaceId": "ws-x5h1lbkp5" }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的遷移 a

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考MigrateWorkspace中的。

下列程式碼範例會示範如何使用modify-workspace-creation-properties

AWS CLI

若要修改目錄的 WorkSpace 建立屬性

下列modify-workspace-creation-properties範例會啟用指定目錄的EnableInternetAccess屬性。這會啟用針對目錄 WorkSpaces 建立的公用 IP 位址的自動指派。

aws workspaces modify-workspace-creation-properties \ --resource-id d-926722edaf \ --workspace-creation-properties EnableInternetAccess=true

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces的更新目錄詳細資訊。

下列程式碼範例會示範如何使用modify-workspace-properties

AWS CLI

若要修改的執行模式 WorkSpace

下列modify-workspace-properties範例會將指定的執行模式設定 WorkSpace 為AUTO_STOP

aws workspaces modify-workspace-properties \ --workspace-id ws-dk1xzr417 \ --workspace-properties RunningMode=AUTO_STOP

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的修改 a

下列程式碼範例會示範如何使用modify-workspace-state

AWS CLI

若要修改的狀態 WorkSpace

下列modify-workspace-state範例會將指定的狀態設定 WorkSpace 為ADMIN_MAINTENANCE

aws workspaces modify-workspace-state \ --workspace-id ws-dk1xzr417 \ --workspace-state ADMIN_MAINTENANCE

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南中的WorkSpace 維護

下列程式碼範例會示範如何使用reboot-workspaces

AWS CLI

若要重新啟動 WorkSpace

下列reboot-workspaces範例會重新啟動指 WorkSpace定的。

aws workspaces reboot-workspaces \ --reboot-workspace-requests ws-dk1xzr417

輸出:

{ "FailedRequests": [] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的重新啟動 a

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考RebootWorkspaces中的。

下列程式碼範例會示範如何使用rebuild-workspaces

AWS CLI

若要重新建置 WorkSpace

下列rebuild-workspaces範例會重建指定 WorkSpace的。

aws workspaces rebuild-workspaces \ --rebuild-workspace-requests ws-dk1xzr417

輸出:

{ "FailedRequests": [] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的重建 a

下列程式碼範例會示範如何使用register-workspace-directory

AWS CLI

若要註冊目錄

下列register-workspace-directory範例會註冊指定的目錄以與 Amazon 搭配使用 WorkSpaces。

aws workspaces register-workspace-directory \ --directory-id d-926722edaf \ --no-enable-work-docs

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpaces中的註冊目錄

下列程式碼範例會示範如何使用restore-workspace

AWS CLI

若要還原 WorkSpace

下列restore-workspace範例會還原指定的 WorkSpace。

aws workspaces restore-workspace \ --workspace-id ws-dk1xzr417

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的還原 a

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考RestoreWorkspace中的。

下列程式碼範例會示範如何使用start-workspaces

AWS CLI

若要啟動 AutoStop WorkSpace

下列start-workspaces範例會啟動指定的 WorkSpace。必 WorkSpace 須具有的執行模式AutoStop

aws workspaces start-workspaces \ --start-workspace-requests WorkspaceId=ws-dk1xzr417

輸出:

{ "FailedRequests": [] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 AutoStop WorkSpace中的停止並啟動

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考StartWorkspaces中的。

下列程式碼範例會示範如何使用stop-workspaces

AWS CLI

若要停止 AutoStop WorkSpace

下列stop-workspaces範例會停止指定的 WorkSpace。必 WorkSpace 須具有的執行模式AutoStop

aws workspaces stop-workspaces \ --stop-workspace-requests WorkspaceId=ws-dk1xzr417

輸出:

{ "FailedRequests": [] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 AutoStop WorkSpace中的停止並啟動

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考StopWorkspaces中的。

下列程式碼範例會示範如何使用terminate-workspaces

AWS CLI

若要終止 WorkSpace

下列terminate-workspaces範例會終止指定的工作區。

aws workspaces terminate-workspaces \ --terminate-workspace-requests ws-dk1xzr417

輸出:

{ "FailedRequests": [] }

如需詳細資訊,請參閱 Amazon WorkSpaces 管理指南 WorkSpace中的刪除 a