文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 使用 AWS SDKs 的 WorkSpaces 基本範例
下列程式碼範例示範如何搭配 AWS SDK 使用 Amazon WorkSpaces 的基本功能。
**Contents**
+ [動作](workspaces_code_examples_actions.md)
+ [`CreateTags`](workspaces_example_workspaces_CreateTags_section.md)
+ [`CreateWorkspaces`](workspaces_example_workspaces_CreateWorkspaces_section.md)
+ [`DeleteTags`](workspaces_example_workspaces_DeleteTags_section.md)
+ [`DescribeTags`](workspaces_example_workspaces_DescribeTags_section.md)
+ [`DescribeWorkspaceBundles`](workspaces_example_workspaces_DescribeWorkspaceBundles_section.md)
+ [`DescribeWorkspaceDirectories`](workspaces_example_workspaces_DescribeWorkspaceDirectories_section.md)
+ [`DescribeWorkspaces`](workspaces_example_workspaces_DescribeWorkspaces_section.md)
+ [`DescribeWorkspacesConnectionStatus`](workspaces_example_workspaces_DescribeWorkspacesConnectionStatus_section.md)
+ [`ModifyWorkspaceCreationProperties`](workspaces_example_workspaces_ModifyWorkspaceCreationProperties_section.md)
+ [`ModifyWorkspaceProperties`](workspaces_example_workspaces_ModifyWorkspaceProperties_section.md)
+ [`ModifyWorkspaceState`](workspaces_example_workspaces_ModifyWorkspaceState_section.md)
+ [`RebootWorkspaces`](workspaces_example_workspaces_RebootWorkspaces_section.md)
+ [`RebuildWorkspaces`](workspaces_example_workspaces_RebuildWorkspaces_section.md)
+ [`RegisterWorkspaceDirectory`](workspaces_example_workspaces_RegisterWorkspaceDirectory_section.md)
+ [`StopWorkspaces`](workspaces_example_workspaces_StopWorkspaces_section.md)
+ [`TerminateWorkspaces`](workspaces_example_workspaces_TerminateWorkspaces_section.md)
# 使用 AWS SDKs 的 WorkSpaces 動作
下列程式碼範例示範如何使用 AWS SDKs 執行個別 WorkSpaces 動作。每個範例均包含 GitHub 的連結，您可以在連結中找到設定和執行程式碼的相關說明。
下列範例僅包含最常使用的動作。如需完整清單，請參閱《[Amazon WorkSpaces API 參考](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html)》。
**Topics**
+ [`CreateTags`](workspaces_example_workspaces_CreateTags_section.md)
+ [`CreateWorkspaces`](workspaces_example_workspaces_CreateWorkspaces_section.md)
+ [`DeleteTags`](workspaces_example_workspaces_DeleteTags_section.md)
+ [`DescribeTags`](workspaces_example_workspaces_DescribeTags_section.md)
+ [`DescribeWorkspaceBundles`](workspaces_example_workspaces_DescribeWorkspaceBundles_section.md)
+ [`DescribeWorkspaceDirectories`](workspaces_example_workspaces_DescribeWorkspaceDirectories_section.md)
+ [`DescribeWorkspaces`](workspaces_example_workspaces_DescribeWorkspaces_section.md)
+ [`DescribeWorkspacesConnectionStatus`](workspaces_example_workspaces_DescribeWorkspacesConnectionStatus_section.md)
+ [`ModifyWorkspaceCreationProperties`](workspaces_example_workspaces_ModifyWorkspaceCreationProperties_section.md)
+ [`ModifyWorkspaceProperties`](workspaces_example_workspaces_ModifyWorkspaceProperties_section.md)
+ [`ModifyWorkspaceState`](workspaces_example_workspaces_ModifyWorkspaceState_section.md)
+ [`RebootWorkspaces`](workspaces_example_workspaces_RebootWorkspaces_section.md)
+ [`RebuildWorkspaces`](workspaces_example_workspaces_RebuildWorkspaces_section.md)
+ [`RegisterWorkspaceDirectory`](workspaces_example_workspaces_RegisterWorkspaceDirectory_section.md)
+ [`StopWorkspaces`](workspaces_example_workspaces_StopWorkspaces_section.md)
+ [`TerminateWorkspaces`](workspaces_example_workspaces_TerminateWorkspaces_section.md)
# 搭配使用 `CreateTags` 與 CLI
下列程式碼範例示範如何使用 `CreateTags`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會將新標籤新增至名為 `ws-wsname` 的工作區。標籤的索引鍵為 "Name"，索引鍵值為 `AWS_Workspace`。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**範例 2：此範例會將多個標籤新增至名為 `ws-wsname` 的工作區。一個標籤的索引鍵為 "Name"，且索引鍵值為 `AWS_Workspace`；另一個標籤的標籤索引鍵為 "Stage"，且索引鍵值為 "Test"。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateTags](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會將新標籤新增至名為 `ws-wsname` 的工作區。標籤的索引鍵為 "Name"，索引鍵值為 `AWS_Workspace`。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**範例 2：此範例會將多個標籤新增至名為 `ws-wsname` 的工作區。一個標籤的索引鍵為 "Name"，且索引鍵值為 `AWS_Workspace`；另一個標籤的標籤索引鍵為 "Stage"，且索引鍵值為 "Test"。**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `CreateWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `CreateWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：為提供的搭售組合、目錄和使用者建立 WorkSpace。**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**範例 2：此範例會建立多個 WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：為提供的搭售組合、目錄和使用者建立 WorkSpace。**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**範例 2：此範例會建立多個 WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DeleteTags` 與 CLI
下列程式碼範例示範如何使用 `DeleteTags`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會移除與 Workspace 相關聯的標籤**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《*AWS Tools for PowerShell Cmdlet 參考 (V4)*》中的 [DeleteTags](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會移除與 Workspace 相關聯的標籤**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**輸出：**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeTags` 與 CLI
下列程式碼範例示範如何使用 `DescribeTags`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會擷取給定 Workspace 的標籤**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**輸出：**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeTags](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會擷取給定 Workspace 的標籤**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**輸出：**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeWorkspaceBundles` 與 CLI
下列程式碼範例示範如何使用 `DescribeWorkspaceBundles`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會擷取目前區域中所有 Workspace 搭售組合的詳細資訊**
```
Get-WKSWorkspaceBundle
```
**輸出：**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會擷取目前區域中所有 Workspace 搭售組合的詳細資訊**
```
Get-WKSWorkspaceBundle
```
**輸出：**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeWorkspaceDirectories` 與 CLI
下列程式碼範例示範如何使用 `DescribeWorkspaceDirectories`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會列出已註冊目錄的目錄詳細資訊**
```
Get-WKSWorkspaceDirectory
```
**輸出：**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會列出已註冊目錄的目錄詳細資訊**
```
Get-WKSWorkspaceDirectory
```
**輸出：**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `DescribeWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：擷取管道中所有 WorkSpaces 的詳細資訊。**
```
Get-WKSWorkspace
```
**輸出：**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**範例 2：此命令顯示 `us-west-2` 區域中工作區的 `WorkSpaceProperties` 子屬性值。如需 `WorkSpaceProperties` 子屬性的詳細資訊，請參閱 https://docs.aws.amazon.com/workspaces/latest/api/API\$1WorkspaceProperties.html。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**輸出：**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**範例 3：此命令顯示 `us-west-2` 區域中工作區的 `WorkSpaceProperties` 子屬性 `RootVolumeSizeGib` 的值。GiB 的根磁碟區大小為 80。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**輸出：**
```
80
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：擷取管道中所有 WorkSpaces 的詳細資訊。**
```
Get-WKSWorkspace
```
**輸出：**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**範例 2：此命令顯示 `us-west-2` 區域中工作區的 `WorkSpaceProperties` 子屬性值。如需 `WorkSpaceProperties` 子屬性的詳細資訊，請參閱 https://docs.aws.amazon.com/workspaces/latest/api/API\$1WorkspaceProperties.html。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**輸出：**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**範例 3：此命令顯示 `us-west-2` 區域中工作區的 `WorkSpaceProperties` 子屬性 `RootVolumeSizeGib` 的值。GiB 的根磁碟區大小為 80。**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**輸出：**
```
80
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `DescribeWorkspacesConnectionStatus` 與 CLI
下列程式碼範例示範如何使用 `DescribeWorkspacesConnectionStatus`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會擷取指定之 Workspace 的連線狀態**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會擷取指定之 Workspace 的連線狀態**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ModifyWorkspaceCreationProperties` 與 CLI
下列程式碼範例示範如何使用 `ModifyWorkspaceCreationProperties`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例在建立 Workspace 時，將網際網路存取和維護模式設為預設值**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例在建立 Workspace 時，將網際網路存取和維護模式設為預設值**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ModifyWorkspaceProperties` 與 CLI
下列程式碼範例示範如何使用 `ModifyWorkspaceProperties`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會將指定 Workspace 的 Workspace 執行模式屬性變更為自動停止**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會將指定 Workspace 的 Workspace 執行模式屬性變更為自動停止**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `ModifyWorkspaceState` 與 CLI
下列程式碼範例示範如何使用 `ModifyWorkspaceState`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例將指定的 Workspace 狀態變更為可用**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例將指定的 Workspace 狀態變更為可用**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RebootWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `RebootWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：重新啟動指定的 WorkSpace。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**範例 2：重新啟動多個 WorkSpaces。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**範例 3：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Restart-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 重新啟動。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：重新啟動指定的 WorkSpace。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**範例 2：重新啟動多個 WorkSpaces。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**範例 3：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Restart-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 重新啟動。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RebuildWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `RebuildWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：重建指定的 WorkSpace。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Reset-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 重建。**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：重建指定的 WorkSpace。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Reset-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 重建。**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `RegisterWorkspaceDirectory` 與 CLI
下列程式碼範例示範如何使用 `RegisterWorkspaceDirectory`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：此範例會為 Workspaces Service 註冊指定目錄**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：此範例會為 Workspaces Service 註冊指定目錄**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `StopWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `StopWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：停止多個 WorkSpaces。**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Stop-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 停止。**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**範例 3：此範例示範如何傳遞 StopRequest 物件，定義要停止的 WorkSpaces。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [StopWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：停止多個 WorkSpaces。**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Stop-WKSWorkspace 的 -WorkSpaceId 參數，導致 WorkSpaces 停止。**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**範例 3：此範例示範如何傳遞 StopRequest 物件，定義要停止的 WorkSpaces。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------
# 搭配使用 `TerminateWorkspaces` 與 CLI
下列程式碼範例示範如何使用 `TerminateWorkspaces`。
------
#### [ CLI ]
**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)。
------
#### [ PowerShell ]
**Tools for PowerShell V4**
**範例 1：終止多個 WorkSpaces。使用 -Force 切換變數可阻止 Cmdlet 提示確認。**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Remove-WKSWorkspace 的 -WorkSpaceId 參數，終止所有 WorkSpaces。Cmdlet 會在每個 WorkSpace 終止之前提示。若要隱藏確認提示，請新增 -Force 切換變數。**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**範例 3：此範例示範如何傳遞定義要終止之 WorkSpaces 的 TerminateRequest 物件。除非也指定 -Force 切換變數，否則 Cmdlet 會提示確認。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V4)》**中的 [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。
**Tools for PowerShell V5**
**範例 1：終止多個 WorkSpaces。使用 -Force 切換變數可阻止 Cmdlet 提示確認。**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**範例 2：擷取所有 WorkSpaces 的集合，並將 ID 傳輸至 Remove-WKSWorkspace 的 -WorkSpaceId 參數，終止所有 WorkSpaces。Cmdlet 會在每個 WorkSpace 終止之前提示。若要隱藏確認提示，請新增 -Force 切換變數。**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**範例 3：此範例示範如何傳遞定義要終止之 WorkSpaces 的 TerminateRequest 物件。除非也指定 -Force 切換變數，否則 Cmdlet 會提示確認。**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ 如需 API 詳細資訊，請參閱《AWS Tools for PowerShell Cmdlet 參考 (V5)》**中的 [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。
------