AWS CLI を使用した WorkSpaces の例 - AWS Command Line Interface
アクション

このドキュメントはバージョン 1 の AWS CLI のみを対象としています。AWS CLI のバージョン 2 に関連するドキュメントについては、バージョン 2 用ユーザーガイドを参照してください。

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]、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 管理ガイド」の「仮想デスクトップの起動」を参照してください。

  • 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 でディレクトリを登録する」を参照してください。

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

次の例は、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 バンドルとイメージ」を参照してください。

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

次の例は、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": {
                "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」を参照してください。

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

次の例は、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 管理ガイド」の「Amazon 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 管理ガイド」の「Amazon 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 管理ガイド」の「WorkSpaces の移行」を参照してください。

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

次の例は、modify-workspace-creation-properties を使用する方法を説明しています。

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 のディレクトリ詳細を更新する」を参照してください。

次の例は、modify-workspace-properties を使用する方法を説明しています。

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 管理ガイド」の「WorkSpaces の変更」を参照してください。

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

次の例は、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 のメンテナンス」を参照してください。

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

次の例は、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

このコマンドでは何も出力されません。

詳細については、「Amazon WorkSpaces 管理ガイド」の「Register an existing AWS Directory Service directory with WorkSpaces Personal」を参照してください。

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

次の例は、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 WorkSpace を開始するには

次の 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 WorkSpace を停止するには

次の 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 の例では、指定されたワークスペースを終了します。

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

出力:

{
    "FailedRequests": []
}

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

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