Doc AWS SDK 예제 GitHub 리포지토리에서 더 많은 SDK 예제를 사용할 수 있습니다. [AWS](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)
# 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`이라는 워크스페이스에 여러 태그를 추가합니다. 한 태그는 키가 '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)를 참조하세요.
------
# 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]`로 설정하고 워크스페이스 이름, 디렉터리 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: 이 예제에서는 여러 WorkSpace를 생성합니다.**
```
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: 이 예제에서는 여러 WorkSpace를 생성합니다.**
```
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)를 참조하세요.
------
# 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 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)를 참조하세요.
------
# 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 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)를 참조하세요.
------
# 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 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)을 참조하세요.
------
# 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 관리 안내서*의 [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 ]
**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)를 참조하세요.
------
# 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 관리 안내서의 [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: 파이프라인에 대한 모든 WorkSpace의 세부 정보를 검색합니다.**
```
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: 파이프라인에 대한 모든 WorkSpace의 세부 정보를 검색합니다.**
```
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)를 참조하세요.
------
# 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 관리 안내서의 [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)를 참조하세요.
------
# CLI로 `ModifyWorkspaceCreationProperties` 사용
다음 코드 예시는 `ModifyWorkspaceCreationProperties`의 사용 방법을 보여 줍니다.
------
#### [ CLI ]
**AWS CLI**
**디렉터리의 WorkSpace 생성 속성 수정**
다음 `modify-workspace-creation-properties` 예제에서는 지정된 디렉터리에 대한 `EnableInternetAccess` 속성을 활성화합니다. 이렇게 하면 디렉터리에 대해 생성된 워크스페이스에 퍼블릭 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 Cmdlet 참조(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 Cmdlet 참조(V5)*의 [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)를 참조하세요.
------
# CLI로 `ModifyWorkspaceProperties` 사용
다음 코드 예시는 `ModifyWorkspaceProperties`의 사용 방법을 보여 줍니다.
------
#### [ CLI ]
**AWS CLI**
**WorkSpaces 실행 모드를 수정하는 방법**
다음 `modify-workspace-properties` 예제에서는 지정된 WorkSpace의 실행 모드를 `AUTO_STOP`로 설정합니다.
```
aws workspaces modify-workspace-properties \
--workspace-id ws-dk1xzr417 \
--workspace-properties RunningMode=AUTO_STOP
```
이 명령은 출력을 생성하지 않습니다.
자세한 내용은 **Amazon WorkSpaces 관리 안내서의 [WorkSpaces 수정](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)를 참조하세요.
------
# 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 관리 안내서의 [WorkSpaces 유지 관리](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)를 참조하세요.
------
# CLI로 `RebootWorkspaces` 사용
다음 코드 예시는 `RebootWorkspaces`의 사용 방법을 보여 줍니다.
------
#### [ CLI ]
**AWS CLI**
**WorkSpace를 재부팅하는 방법**
다음 `reboot-workspaces` 예제에서는 지정된 WorkSpace를 재부팅합니다.
```
aws workspaces reboot-workspaces \
--reboot-workspace-requests ws-dk1xzr417
```
출력:
```
{
"FailedRequests": []
}
```
자세한 내용은 **Amazon WorkSpaces 관리 안내서의 [WorkSpaces 리부팅](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: 여러 WorkSpace를 재부팅합니다.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**예제 3: 모든 WorkSpace 컬렉션을 검색하고 Restart-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 재시작합니다.**
```
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: 여러 WorkSpace를 재부팅합니다.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**예제 3: 모든 WorkSpace 컬렉션을 검색하고 Restart-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 재시작합니다.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ API 세부 정보는 *AWS Tools for PowerShell Cmdlet 참조(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 관리 안내서의 [WorkSpaces 재구축](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: 모든 WorkSpace 컬렉션을 검색하고 Reset-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 재구축합니다.**
```
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: 모든 WorkSpace 컬렉션을 검색하고 Reset-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 재구축합니다.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ API 세부 정보는 *AWS Tools for PowerShell Cmdlet 참조(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 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)를 참조하세요.
------
# CLI로 `StopWorkspaces` 사용
다음 코드 예시는 `StopWorkspaces`의 사용 방법을 보여 줍니다.
------
#### [ CLI ]
**AWS CLI**
**AutoStop WorkSpaces를 중지하는 방법**
다음 `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: 여러 WorkSpace를 중지합니다.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**예제 2: 모든 WorkSpace 컬렉션을 검색하고 Stop-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 중지합니다.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**예제 3: 이 예제에서는 중지할 WorkSpace를 정의하는 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 참조(V4)*의 [StopWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)를 참조하세요.
**Tools for PowerShell V5**
**예제 1: 여러 WorkSpace를 중지합니다.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**예제 2: 모든 WorkSpace 컬렉션을 검색하고 Stop-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 WorkSpace를 중지합니다.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**예제 3: 이 예제에서는 중지할 WorkSpace를 정의하는 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 참조(V5)*의 [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)를 참조하세요.
------
# CLI로 `TerminateWorkspaces` 사용
다음 코드 예시는 `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 ]
**Tools for PowerShell V4**
**예제 1: 여러 WorkSpace를 종료합니다. -Force 스위치를 사용하면 cmdlet이 확인 프롬프트를 표시하지 않습니다.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**예제 2: 모든 WorkSpace 컬렉션을 검색하고 Remove-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 모든 WorkSpace를 종료합니다. 각 WorkSpace가 종료되기 전에 cmdlet이 프롬프트를 표시합니다. 확인 프롬프트를 차단하려면 -Force 스위치를 추가합니다.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**예제 3: 이 예제에서는 종료할 WorkSpace를 정의하는 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: 여러 WorkSpace를 종료합니다. -Force 스위치를 사용하면 cmdlet이 확인 프롬프트를 표시하지 않습니다.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**예제 2: 모든 WorkSpace 컬렉션을 검색하고 Remove-WKSWorkspace의 -WorkSpaceId 파라미터에 ID를 파이프하여 모든 WorkSpace를 종료합니다. 각 WorkSpace가 종료되기 전에 cmdlet이 프롬프트를 표시합니다. 확인 프롬프트를 차단하려면 -Force 스위치를 추가합니다.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**예제 3: 이 예제에서는 종료할 WorkSpace를 정의하는 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)를 참조하세요.
------