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

# 使用 的 WorkSpaces 範例 AWS CLI
<a name="cli_workspaces_code_examples"></a>

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

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

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

**Topics**
+ [動作](#actions)

## 動作
<a name="actions"></a>

### `create-tags`
<a name="workspaces_CreateTags_cli_topic"></a>

以下程式碼範例顯示如何使用 `create-tags`。

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

```
aws workspaces create-tags \
    --resource-id ws-dk1xzr417 \
    --tags Key=Department,Value=Finance
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[標記 WorkSpaces 資源](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-tags.html)。

### `create-workspaces`
<a name="workspaces_CreateWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `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 管理指南*》中的[啟動虛擬桌面](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [CreateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-workspaces.html)。

### `delete-tags`
<a name="workspaces_DeleteTags_cli_topic"></a>

以下程式碼範例顯示如何使用 `delete-tags`。

**AWS CLI**  
**從 WorkSpace 刪除標籤**  
下列 `delete-tags` 範例會將指定標籤從指定 WorkSpace 中刪除。  

```
aws workspaces delete-tags \
    --resource-id ws-dk1xzr417 \
    --tag-keys Department
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[標記 WorkSpaces 資源](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/delete-tags.html)。

### `deregister-workspace-directory`
<a name="workspaces_DeregisterWorkspaceDirectory_cli_topic"></a>

以下程式碼範例顯示如何使用 `deregister-workspace-directory`。

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

```
aws workspaces deregister-workspace-directory \
    --directory-id d-926722edaf
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》**中的[向 WorkSpaces 註冊目錄](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DeregisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/deregister-workspace-directory.html)。

### `describe-tags`
<a name="workspaces_DescribeTags_cli_topic"></a>

以下程式碼範例顯示如何使用 `describe-tags`。

**AWS CLI**  
**描述 WorkSpace 的標籤**  
下列 `describe-tags` 範例描述指定 WorkSpace 的標籤。  

```
aws workspaces describe-tags \
    --resource-id ws-dk1xzr417
```
輸出：  

```
{
    "TagList": [
        {
            "Key": "Department",
            "Value": "Finance"
        }
    ]
}
```
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[標記 WorkSpaces 資源](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-tags.html)。

### `describe-workspace-bundles`
<a name="workspaces_DescribeWorkspaceBundles_cli_topic"></a>

以下程式碼範例顯示如何使用 `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 套件和映像](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-bundles.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeWorkspaceBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-bundles.html)。

### `describe-workspace-directories`
<a name="workspaces_DescribeWorkspaceDirectories_cli_topic"></a>

以下程式碼範例顯示如何使用 `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": {
                "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 Personal 的目錄](https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeWorkspaceDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-directories.html)。

### `describe-workspaces-connection-status`
<a name="workspaces_DescribeWorkspacesConnectionStatus_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeWorkspacesConnectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces-connection-status.html)。

### `describe-workspaces`
<a name="workspaces_DescribeWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [DescribeWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces.html)。

### `migrate-workspace`
<a name="workspaces_MigrateWorkspace_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [MigrateWorkspace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/migrate-workspace.html)。

### `modify-workspace-creation-properties`
<a name="workspaces_ModifyWorkspaceCreationProperties_cli_topic"></a>

以下程式碼範例顯示如何使用 `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 的目錄詳細資訊](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ModifyWorkspaceCreationProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-creation-properties.html)。

### `modify-workspace-properties`
<a name="workspaces_ModifyWorkspaceProperties_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ModifyWorkspaceProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-properties.html)。

### `modify-workspace-state`
<a name="workspaces_ModifyWorkspaceState_cli_topic"></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 維護](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [ModifyWorkspaceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-state.html)。

### `reboot-workspaces`
<a name="workspaces_RebootWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `reboot-workspaces`。

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

```
aws workspaces reboot-workspaces \
    --reboot-workspace-requests ws-dk1xzr417
```
輸出：  

```
{
    "FailedRequests": []
}
```
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[重新啟動 WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/reboot-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RebootWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/reboot-workspaces.html)。

### `rebuild-workspaces`
<a name="workspaces_RebuildWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `rebuild-workspaces`。

**AWS CLI**  
**重新建置 WorkSpace**  
下列 `rebuild-workspaces` 範例會重建指定的 WorkSpace。  

```
aws workspaces rebuild-workspaces \
    --rebuild-workspace-requests ws-dk1xzr417
```
輸出：  

```
{
    "FailedRequests": []
}
```
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[重建 WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RebuildWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/rebuild-workspaces.html)。

### `register-workspace-directory`
<a name="workspaces_RegisterWorkspaceDirectory_cli_topic"></a>

以下程式碼範例顯示如何使用 `register-workspace-directory`。

**AWS CLI**  
**註冊目錄**  
下列 `register-workspace-directory` 範例會註冊指定目錄以搭配 Amazon WorkSpaces 使用。  

```
aws workspaces register-workspace-directory \
    --directory-id d-926722edaf
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon [ WorkSpaces 管理指南》中的向 WorkSpaces Personal 註冊現有的 AWS Directory Service 目錄](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html)。 *Amazon WorkSpaces *  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RegisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/register-workspace-directory.html)。

### `restore-workspace`
<a name="workspaces_RestoreWorkspace_cli_topic"></a>

以下程式碼範例顯示如何使用 `restore-workspace`。

**AWS CLI**  
**還原 WorkSpace**  
下列 `restore-workspace` 範例會還原指定的 WorkSpace。  

```
aws workspaces restore-workspace \
    --workspace-id ws-dk1xzr417
```
此命令不會產生輸出。  
如需詳細資訊，請參閱《Amazon WorkSpaces 管理指南》**中的[還原 WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [RestoreWorkspace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/restore-workspace.html)。

### `start-workspaces`
<a name="workspaces_StartWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StartWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/start-workspaces.html)。

### `stop-workspaces`
<a name="workspaces_StopWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `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](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [StopWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/stop-workspaces.html)。

### `terminate-workspaces`
<a name="workspaces_TerminateWorkspaces_cli_topic"></a>

以下程式碼範例顯示如何使用 `terminate-workspaces`。

**AWS CLI**  
**終止 WorkSpace**  
下列 `terminate-workspaces` 範例會終止指定的工作區。  

```
aws workspaces terminate-workspaces \
    --terminate-workspace-requests ws-dk1xzr417
```
輸出：  

```
{
    "FailedRequests": []
}
```
如需詳細資訊，請參閱《*Amazon WorkSpaces 管理指南*》中的[刪除 WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces.html)。  
+  如需 API 詳細資訊，請參閱《AWS CLI 命令參考》**中的 [TerminateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/terminate-workspaces.html)。