CLI で TerminateWorkspaces を使用する

次のサンプルコードは、TerminateWorkspaces を使用する方法を説明しています。

CLI

AWS CLI

WorkSpace を終了するには

次の terminate-workspaces の例では、指定されたワークスペースを終了します。

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

出力:

{
    "FailedRequests": []
}

詳細については、「Amazon WorkSpaces 管理ガイド」の「WorkSpaces の削除」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「TerminateWorkspaces」を参照してください。

PowerShell

Tools for PowerShell V4

例 1: 複数の WorkSpaces を終了します。-Force スイッチを使用すると、コマンドレットの確認を求めるプロンプトが表示されなくなります。

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

例 2: すべての WorkSpaces のコレクションを取得し、Remove-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、すべての WorkSpaces を終了します。コマンドレットは、各 WorkSpace が終了する前にプロンプトを表示します。確認を非表示にするには、-Force スイッチを追加します。

Get-WKSWorkspaces | Remove-WKSWorkspace

例 3: この例では、終了する WorkSpaces を定義する TerminateRequest オブジェクトを渡す方法を示します。-Force スイッチが指定されていない限り、コマンドレットは続行する前に確認を求めます。

$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 コマンドレットリファレンス (V4)」の「TerminateWorkspaces」を参照してください。

Tools for PowerShell V5

例 1: 複数の WorkSpaces を終了します。-Force スイッチを使用すると、コマンドレットの確認を求めるプロンプトが表示されなくなります。

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

例 2: すべての WorkSpaces のコレクションを取得し、Remove-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、すべての WorkSpaces を終了します。コマンドレットは、各 WorkSpace が終了する前にプロンプトを表示します。確認を非表示にするには、-Force スイッチを追加します。

Get-WKSWorkspaces | Remove-WKSWorkspace

例 3: この例では、終了する WorkSpaces を定義する TerminateRequest オブジェクトを渡す方法を示します。-Force スイッチが指定されていない限り、コマンドレットは続行する前に確認を求めます。

$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 コマンドレットリファレンス (V5)」の「TerminateWorkspaces」を参照してください。