AWS CLI를 사용한 WorkSpaces 예제 - AWS Command Line Interface
작업

AWS CLI를 사용한 WorkSpaces 예제

다음 코드 예제에서는 WorkSpaces에서 AWS Command Line Interface를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여 줍니다.

작업은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 관련 시나리오의 컨텍스트에 따라 표시되며, 개별 서비스 함수를 직접적으로 호출하는 방법을 보여줍니다.

각 예시에는 전체 소스 코드에 대한 링크가 포함되어 있으며, 여기에서 컨텍스트에 맞춰 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있습니다.

주제

작업

다음 코드 예시에서는 create-tags을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace에 태그를 추가하는 방법

다음 create-tags 예제에서는 지정된 태그를 지정된 WorkSpace.에 추가합니다.

aws workspaces create-tags \
    --resource-id ws-dk1xzr417 \
    --tags Key=Department,Value=Finance

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 리소스 태그를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateTags 섹션을 참조하세요.

다음 코드 예시에서는 create-workspaces을 사용하는 방법을 보여 줍니다.

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 관리 안내서의 가상 데스크톱 시작을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 CreateWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 delete-tags을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace에서 태그를 삭제하는 방법

다음 delete-tags 예제에서는 지정된 WorkSpace에서 지정된 태그를 삭제합니다.

aws workspaces delete-tags \
    --resource-id ws-dk1xzr417 \
    --tag-keys Department

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 리소스 태그를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DeleteTags 섹션을 참조하세요.

다음 코드 예시에서는 deregister-workspace-directory을 사용하는 방법을 보여 줍니다.

AWS CLI

디렉터리를 등록 해제하는 방법

다음 deregister-workspace-directory 예제에서는 지정된 디렉터리의 등록을 취소합니다.

aws workspaces deregister-workspace-directory \
    --directory-id d-926722edaf

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces로 디렉터리 등록을 참조하세요.

다음 코드 예시에서는 describe-tags을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace에 대한 태그 설명

다음 describe-tags 예제에서는 지정된 WorkSpace에 대한 태그를 설명합니다.

aws workspaces describe-tags \
    --resource-id ws-dk1xzr417

출력:

{
    "TagList": [
        {
            "Key": "Department",
            "Value": "Finance"
        }
    ]
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 리소스 태그를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeTags 섹션을 참조하세요.

다음 코드 예시에서는 describe-workspace-bundles을 사용하는 방법을 보여 줍니다.

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 번들 및 이미지를 참조하세요.

다음 코드 예시에서는 describe-workspace-directories을 사용하는 방법을 보여 줍니다.

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": {
                "EnableWorkDocs": false,
                "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의 디렉터리 관리를 참조하세요.

다음 코드 예시에서는 describe-workspaces-connection-status을 사용하는 방법을 보여 줍니다.

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로 관리를 참조하세요.

다음 코드 예시에서는 describe-workspaces을 사용하는 방법을 보여 줍니다.

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로 관리를 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 DescribeWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 migrate-workspace을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace를 마이그레이션하는 방법

다음 migrate-workspace 예제에서는 지정된 WorkSpace를 지정된 번들로 마이그레이션합니다.

aws workspaces migrate-workspace \
    --source-workspace-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

출력:

{
    "SourceWorkspaceId": "ws-dk1xzr417",
    "TargetWorkspaceId": "ws-x5h1lbkp5"
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpace 마이그레이션을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 MigrateWorkspace 섹션을 참조하세요.

다음 코드 예시에서는 modify-workspace-creation-properties을 사용하는 방법을 보여 줍니다.

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의 디렉터리 업데이트를 참조하세요.

다음 코드 예시에서는 modify-workspace-properties을 사용하는 방법을 보여 줍니다.

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 수정을 참조하세요.

다음 코드 예시에서는 modify-workspace-state을 사용하는 방법을 보여 줍니다.

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 유지 관리를 참조하세요.

다음 코드 예시에서는 reboot-workspaces을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace를 재부팅하는 방법

다음 reboot-workspaces 예제에서는 지정된 WorkSpace를 재부팅합니다.

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

출력:

{
    "FailedRequests": []
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 리부팅을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 RebootWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 rebuild-workspaces을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace를 재구축하는 방법

다음 rebuild-workspaces 예제에서는 지정된 WorkSpace 를 재구축합니다.

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

출력:

{
    "FailedRequests": []
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 재구축을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 RebuildWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 register-workspace-directory을 사용하는 방법을 보여 줍니다.

AWS CLI

디렉터리를 등록하는 방법

다음 register-workspace-directory 예제에서는 Amazon WorkSpaces에 사용할 지정된 디렉터리를 등록합니다.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf \
    --no-enable-work-docs

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces로 디렉터리 등록을 참조하세요.

다음 코드 예시에서는 restore-workspace을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace를 복원하는 방법

다음 restore-workspace 예제에서는 지정된 WorkSpace를 복원합니다.

aws workspaces restore-workspace \
    --workspace-id ws-dk1xzr417

이 명령은 출력을 생성하지 않습니다.

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpaces 복원을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 RestoreWorkspace 섹션을 참조하세요.

다음 코드 예시에서는 start-workspaces을 사용하는 방법을 보여 줍니다.

AWS CLI

AutoStop WorkSpaces를 시작하는 방법

다음 start-workspaces 예제에서는 지정된 WorkSpace를 시작합니다. WorkSpace의 실행 모드가 AutoStop이어야 합니다.

aws workspaces start-workspaces \
    --start-workspace-requests WorkspaceId=ws-dk1xzr417

출력:

{
    "FailedRequests": []
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 AutoStop WorkSpace 중지 및 시작을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 StartWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 stop-workspaces을 사용하는 방법을 보여 줍니다.

AWS CLI

AutoStop WorkSpaces를 중지하는 방법

다음 stop-workspaces 예제에서는 지정된 WorkSpace를 중지합니다. WorkSpace의 실행 모드가 AutoStop이어야 합니다.

aws workspaces stop-workspaces \
    --stop-workspace-requests WorkspaceId=ws-dk1xzr417

출력:

{
    "FailedRequests": []
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 AutoStop WorkSpace 중지 및 시작을 참조하세요.

  • API 세부 정보는 AWS CLI 명령 참조의 StopWorkspaces 섹션을 참조하세요.

다음 코드 예시에서는 terminate-workspaces을 사용하는 방법을 보여 줍니다.

AWS CLI

WorkSpace 종료

다음 terminate-workspaces 예제에서는 지정된 WorkSpace를 종료합니다.

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

출력:

{
    "FailedRequests": []
}

자세한 내용은 Amazon WorkSpaces 관리 안내서의 WorkSpace 삭제를 참조하세요.