使用的 WorkSpaces 範例 AWS CLI

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 WorkSpaces 來執行動作和實作常見案例。

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

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

主題

動作

動作

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

AWS CLI

將標籤新增至 WorkSpace

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


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》中的標記 WorkSpaces 資源。 Amazon 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 資源。 Amazon 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 註冊目錄。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeregisterWorkspaceDirectory。

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

AWS CLI

描述 WorkSpace 的標籤

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


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

輸出：


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

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

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

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

AWS CLI

列出 Amazon 提供的套件

下列describe-workspace-bundles範例以資料表格式列出 Amazon 提供的套件名稱和 IDs，並依名稱排序。


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 套件和映像。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeWorkspaceBundles。

下列程式碼範例示範如何使用 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 目錄。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeWorkspaceDirectories。

下列程式碼範例示範如何使用 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。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeWorkspacesConnectionStatus。

下列程式碼範例示範如何使用 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。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeWorkspaces。

下列程式碼範例示範如何使用 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。 Amazon WorkSpaces

如需 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 的目錄詳細資訊。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyWorkspaceCreationProperties。

下列程式碼範例示範如何使用 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。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱《 AWS CLI 命令參考》中的 ModifyWorkspaceProperties。

下列程式碼範例示範如何使用 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 WorkSpace s管理指南》中的 WorkSpace 維護。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ModifyWorkspaceState。

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

AWS CLI

重新啟動 WorkSpace

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


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

輸出：


{
    "FailedRequests": []
}

如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》中的重新啟動 WorkSpace。 Amazon WorkSpaces

如需 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。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RebuildWorkspaces。

下列程式碼範例示範如何使用 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 註冊目錄。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RegisterWorkspaceDirectory。

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

AWS CLI

還原 WorkSpace

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


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》中的還原 WorkSpace。 Amazon WorkSpaces

如需 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。 Amazon WorkSpaces

如需 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。 Amazon WorkSpaces

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

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

AWS CLI

終止 WorkSpace

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


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

輸出：


{
    "FailedRequests": []
}

如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》中的刪除 WorkSpace。 Amazon WorkSpaces

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的TerminateWorkspaces。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

Amazon WorkMail Message Flow

X-Ray

使用 的 WorkSpaces 範例 AWS CLI

主題

動作

使用的 WorkSpaces 範例 AWS CLI