Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples)
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# SDK を使用する WorkSpaces の基本的な例 AWS SDKs
以下のコード例は、 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)
# SDK を使用した WorkSpaces のアクション AWS SDKs
次のコード例は、 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)
# CLI で `CreateTags` を使用する
次のサンプルコードは、`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` という名前のワークスペースに複数のタグを追加します。1 つのタグには「Name」のキーと `AWS_Workspace` のキー値があり、もう 1 つのタグには「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 コマンドレットリファレンス (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` という名前のワークスペースに複数のタグを追加します。1 つのタグには「Name」のキーと `AWS_Workspace` のキー値があり、もう 1 つのタグには「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 コマンドレットリファレンス (V5)*」の「[CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `CreateWorkspaces` を使用する
次のサンプルコードは、`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` の例では、ユーザー名を に設定し`[UNDEFINED]`、WorkSpace 名、ディレクトリ ID、バンドル ID を指定して、ユーザーが分離した WorkSpace を作成します。
```
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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DeleteTags` を使用する
次のサンプルコードは、`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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DescribeTags` を使用する
次のサンプルコードは、`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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DescribeWorkspaceBundles` を使用する
次のサンプルコードは、`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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DescribeWorkspaceDirectories` を使用する
次のサンプルコードは、`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 管理ガイド*」の「[Manage directories for 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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DescribeWorkspaces` を使用する
次のサンプルコードは、`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 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)」の「*Amazon WorkSpaces の管理*」を参照してください。
+ 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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `DescribeWorkspacesConnectionStatus` を使用する
次のサンプルコードは、`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 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)」の「*Amazon WorkSpaces の管理*」を参照してください。
+ 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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ModifyWorkspaceCreationProperties` を使用する
次のサンプルコードは、`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 の作成中にインターネットアクセスとメンテナンスモードをデフォルト値として true に設定します。**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: このサンプルでは、Workspace の作成中にインターネットアクセスとメンテナンスモードをデフォルト値として true に設定します。**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ModifyWorkspaceProperties` を使用する
次のサンプルコードは、`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 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html)」の「*WorkSpaces の変更*」を参照してください。
+ 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 実行モードプロパティを Auto Stop に変更します。**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace の Workspace 実行モードプロパティを Auto Stop に変更します。**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `ModifyWorkspaceState` を使用する
次のサンプルコードは、`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 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html)」の「*WorkSpaces のメンテナンス*」を参照してください。
+ 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 の状態を Available に変更します。**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: このサンプルは、指定された Workspace の状態を Available に変更します。**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RebootWorkspaces` を使用する
次のサンプルコードは、`RebootWorkspaces` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**WorkSpace を再起動するには**
次の `reboot-workspaces` の例では、指定された WorkSpace を再起動します。
```
aws workspaces reboot-workspaces \
--reboot-workspace-requests ws-dk1xzr417
```
出力:
```
{
"FailedRequests": []
}
```
詳細については、「[Amazon WorkSpaces 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/reboot-workspaces.html)」の「*WorkSpaces の再起動*」を参照してください。
+ 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 のコレクションを取得し、Restart-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再起動します。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (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 のコレクションを取得し、Restart-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再起動します。**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RebuildWorkspaces` を使用する
次のサンプルコードは、`RebuildWorkspaces` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**WorkSpace を再構築するには**
次の `rebuild-workspaces` の例では、指定された WorkSpace を再構築します。
```
aws workspaces rebuild-workspaces \
--rebuild-workspace-requests ws-dk1xzr417
```
出力:
```
{
"FailedRequests": []
}
```
詳細については、「[Amazon WorkSpaces 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html)」の「*WorkSpaces の再構築*」を参照してください。
+ 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 のコレクションを取得し、Reset-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再構築します。**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V4)*」の「[RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**Tools for PowerShell V5**
**例 1: 指定された WorkSpace を再構築します。**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**例 2: すべての WorkSpaces のコレクションを取得し、Reset-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を再構築します。**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ API の詳細については、「*AWS Tools for PowerShell コマンドレットリファレンス (V5)*」の「[RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `RegisterWorkspaceDirectory` を使用する
次のサンプルコードは、`RegisterWorkspaceDirectory` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**ディレクトリを登録するには**
次の `register-workspace-directory` の例では、Amazon WorkSpaces で使用する指定されたディレクトリを登録します。
```
aws workspaces register-workspace-directory \
--directory-id d-926722edaf
```
このコマンドでは何も出力されません。
詳細については、「Amazon [ WorkSpaces 管理ガイド」の「既存の AWS Directory Service ディレクトリを WorkSpaces Personal に登録](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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `StopWorkspaces` を使用する
次のサンプルコードは、`StopWorkspaces` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**AutoStop WorkSpace を停止するには**
次の `stop-workspaces` の例では、指定された WorkSpace を停止しています。WorkSpace には `AutoStop` の実行モードが必要です。
```
aws workspaces stop-workspaces \
--stop-workspace-requests WorkspaceId=ws-dk1xzr417
```
出力:
```
{
"FailedRequests": []
}
```
詳細については、「[Amazon WorkSpaces 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace)」の「*AutoStop 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 のコレクションを取得し、Stop-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を停止します。**
```
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 コマンドレットリファレンス (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 のコレクションを取得し、Stop-WKSWorkspace の -WorkSpaceId パラメータに ID をパイプして、WorkSpaces を停止します。**
```
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 コマンドレットリファレンス (V5)*」の[StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------
# CLI で `TerminateWorkspaces` を使用する
次のサンプルコードは、`TerminateWorkspaces` を使用する方法を説明しています。
------
#### [ CLI ]
**AWS CLI**
**WorkSpace を終了するには**
次の `terminate-workspaces` の例では、指定されたワークスペースを終了します。
```
aws workspaces terminate-workspaces \
--terminate-workspace-requests ws-dk1xzr417
```
出力:
```
{
"FailedRequests": []
}
```
詳細については、「[Amazon WorkSpaces 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces.html)」の「*WorkSpaces の削除*」を参照してください。
+ 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 スイッチを使用すると、コマンドレットの確認を求めるプロンプトが表示されなくなります。**
```
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](https://docs.aws.amazon.com/powershell/v4/reference)」を参照してください。
**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](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。
------