文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。
本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
# 使用的代码示 WorkSpaces 例 AWS SDKs
以下代码示例向您展示了如何将 Amazon WorkSpaces 与 AWS 软件开发套件 (SDK) 配合使用。
*操作*是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。
**更多资源**
+ **[ WorkSpaces 开发者指南](https://docs.aws.amazon.com/workspaces/latest/userguide/workspaces-user-getting-started.html)** —有关的更多信息 WorkSpaces.
+ **[WorkSpaces API 参考](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html)**-有关所有可用 WorkSpaces 操作的详细信息。
+ **[AWS 开发者中心](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** — 您可以按类别或全文搜索筛选的代码示例。
+ **[AWS SDK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)** — 包含首选语言完整代码的 GitHub 存储库。包括有关设置和运行代码的说明。
**Contents**
+ [基本功能](workspaces_code_examples_basics.md)
+ [操作](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)
# 使用的基本示 WorkSpaces 例 AWS SDKs
以下代码示例展示了如何使用 Amazon WorkSpaces 的基础知识 AWS SDKs。
**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)
# WorkSpaces 使用的操作 AWS SDKs
以下代码示例演示了如何使用执行单个 WorkSpaces操作 AWS SDKs。每个示例都包含一个指向的链接 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**
**向 a 添加标签 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 ]
**适用于 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 参考 (V* 4) [CreateTags](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 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 参考 (V* 5) [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 通过将用户名设置为并指定 WorkSpace 名称`[UNDEFINED]`、目录 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 ]
**适用于 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 参考 (V* 4) [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 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 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例移除与工作空间关联的标签**
```
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 参考 (V* 4) [DeleteTags](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例移除与工作空间关联的标签**
```
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 参考 (V* 5) [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `DescribeTags` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeTags`。
------
#### [ CLI ]
**AWS CLI**
**描述 a 的标签 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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例获取给定工作空间的标签**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**输出**：
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeTags](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例获取给定工作空间的标签**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**输出**：
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `DescribeWorkspaceBundles` 与 CLI 配合使用
以下代码示例演示如何使用 `DescribeWorkspaceBundles`。
------
#### [ CLI ]
**AWS CLI**
**列出 Amazon 提供的捆绑包**
以下`describe-workspace-bundles`示例以表格格式列出了亚马逊提供的捆绑包 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 捆绑包和图片](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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例获取当前区域中所有工作空间捆绑包的详细信息**
```
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 参考 (V* 4) [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例获取当前区域中所有工作空间捆绑包的详细信息**
```
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 参考 (V* 5) [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 *[个人目录](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 ]
**适用于 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 参考 (V* 4) [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 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 参考 (V* 5) [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 ]
**适用于 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 \$1 WorkspaceProperties .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 参考 (V* 4) [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 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 \$1 WorkspaceProperties .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 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例获取指定工作空间的连接状态**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例获取指定工作空间的连接状态**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例支持在创建工作空间时将互联网访问和维护模式设置为 true 作为默认值**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例支持在创建工作空间时将互联网访问和维护模式设置为 true 作为默认值**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例将指定工作空间的“工作空间运行模式”属性更改为“自动停止”**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例将指定工作空间的“工作空间运行模式”属性更改为“自动停止”**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `ModifyWorkspaceState` 与 CLI 配合使用
以下代码示例演示如何使用 `ModifyWorkspaceState`。
------
#### [ CLI ]
**AWS CLI**
**修改 a 的状态 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 ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例将指定工作空间的状态更改为“可用”**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例将指定工作空间的状态更改为“可用”**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：重新启动指定 WorkSpace的。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**示例 2：多次 WorkSpaces重启。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**示例 3：检索所有你的集合， WorkSpaces 并将通过管道传递 IDs 给 Restart-的-WorkSpaceId 参数WKSWorkspace，从而 WorkSpaces 使重新启动。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：重新启动指定 WorkSpace的。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**示例 2：多次 WorkSpaces重启。**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**示例 3：检索所有你的集合， WorkSpaces 并将通过管道传递 IDs 给 Restart-的-WorkSpaceId 参数WKSWorkspace，从而 WorkSpaces 使重新启动。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：重建指定 WorkSpace的。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道 IDs 将它们传递给 Reset-的-WorkSpaceId 参数WKSWorkspace，从而重新构建。 WorkSpaces **
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：重建指定 WorkSpace的。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道 IDs 将它们传递给 Reset-的-WorkSpaceId 参数WKSWorkspace，从而重新构建。 WorkSpaces **
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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
```
此命令不生成任何输出。
有关更多信息，请参阅《*亚马逊 WorkSpaces 管理指南》*中的[向 WorkSpaces 个人注册现有 AWS 目录服务目录](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html)。
+ 有关 API 的详细信息，请参阅*AWS CLI 命令参考[RegisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/register-workspace-directory.html)*中的。
------
#### [ PowerShell ]
**适用于 PowerShell V4 的工具**
**示例 1：此示例注册 Workspaces 服务的指定目录**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 4) [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：此示例注册 Workspaces 服务的指定目录**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ 有关 API 的详细信息，请参阅 *AWS Tools for PowerShell Cmdlet 参考 (V* 5) [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 ]
**适用于 PowerShell V4 的工具**
**示例 1：停止多个 WorkSpaces。**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道传递给 Stop-的-WorkSpaceId 参数，WKSWorkspace WorkSpaces 导致停止。 IDs **
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**示例 3：此示例说明如何传递定义 WorkSpaces 要停止的 StopRequest 对象。**
```
$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 参考 (V* 4) [StopWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：停止多个 WorkSpaces。**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道传递给 Stop-的-WorkSpaceId 参数，WKSWorkspace WorkSpaces 导致停止。 IDs **
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**示例 3：此示例说明如何传递定义 WorkSpaces 要停止的 StopRequest 对象。**
```
$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 参考 (V* 5) [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------
# 将 `TerminateWorkspaces` 与 CLI 配合使用
以下代码示例演示如何使用 `TerminateWorkspaces`。
------
#### [ CLI ]
**AWS CLI**
**要终止 WorkSpace**
以下 `terminate-workspaces` 示例终止指定的 Workspace。
```
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 ]
**适用于 PowerShell V4 的工具**
**示例 1：终止多个 WorkSpaces。使用-Force 开关会阻止 cmdlet 提示确认。**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道传递 IDs 到 Remove-的-WorkSpaceId 参数WKSWorkspace，终止所有的。 WorkSpacescmdlet 将在每个 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 参考 (V* 4) [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。
**适用于 PowerShell V5 的工具**
**示例 1：终止多个 WorkSpaces。使用-Force 开关会阻止 cmdlet 提示确认。**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**示例 2：检索所有你的集合， WorkSpaces 然后通过管道传递 IDs 到 Remove-的-WorkSpaceId 参数WKSWorkspace，终止所有的。 WorkSpacescmdlet 将在每个 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 参考 (V* 5) [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)中的。
------