将 TerminateWorkspaces 与 CLI 配合使用 - AWS SDK 代码示例

AWS 文档 SDK 示例 GitHub 存储库中还有更多 AWS SDK 示例。

将 TerminateWorkspaces 与 CLI 配合使用

以下代码示例演示如何使用 TerminateWorkspaces。

CLI
AWS CLI

终止 WorkSpace

以下 terminate-workspaces 示例终止指定的 Workspace。

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

输出：

{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》中的删除 WorkSpace。

PowerShell
Tools for PowerShell V4

示例 1：终止多个工作空间。使用 -Force 开关可阻止 cmdlet 提示进行确认。

Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force

示例 2：检索所有工作空间的集合，然后将 ID 通过管道传输到 Remove-WKSWorkspace 的 -WorkSpaceId 参数，同时终止所有工作空间。cmdlet 将在终止每个工作空间之前发出提示。要禁止确认提示，请添加 -Force 开关。

Get-WKSWorkspaces | Remove-WKSWorkspace

示例 3：此示例演示如何传递 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 Reference (V4)》中的 TerminateWorkspaces。

Tools for PowerShell V5

示例 1：终止多个工作空间。使用 -Force 开关可阻止 cmdlet 提示进行确认。

Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force

示例 2：检索所有工作空间的集合，然后将 ID 通过管道传输到 Remove-WKSWorkspace 的 -WorkSpaceId 参数，同时终止所有工作空间。cmdlet 将在终止每个工作空间之前发出提示。要禁止确认提示，请添加 -Force 开关。

Get-WKSWorkspaces | Remove-WKSWorkspace

示例 3：此示例演示如何传递 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 Reference (V5)》中的 TerminateWorkspaces。