WorkSpaces を使用した の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

WorkSpaces を使用した の例 AWS CLI

次のコード例は、 AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています WorkSpaces。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、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 の詳細については、「 コマンドリファレンスCreateTags」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスCreateWorkspaces」の「」を参照してください。 AWS CLI

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

AWS CLI

からタグを削除するには WorkSpace

次のdelete-tags例では、指定した から指定したタグを削除します WorkSpace。

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

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

詳細については、「Amazon WorkSpaces 管理ガイド」の WorkSpaces 「リソースのタグ付け」を参照してください。

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

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

AWS CLI

ディレクトリの登録を解除するには

次のderegister-workspace-directory例では、指定されたディレクトリの登録を解除します。

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

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

詳細については、「Amazon WorkSpaces 管理ガイド」の「 でディレクトリ WorkSpacesを登録する」を参照してください。

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

次の例は、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 の詳細については、「 コマンドリファレンスDescribeTags」の「」を参照してください。 AWS CLI

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

AWS CLI

Amazon が提供するバンドルを一覧表示するには

次のdescribe-workspace-bundles例では、Amazon が提供するバンドルの名前と IDs をテーブル形式で、名前でソートします。

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 の詳細については、「 コマンドリファレンスDescribeWorkspaceBundles」の「」を参照してください。 AWS CLI

次の例は、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のディレクトリを管理する」を参照してください。

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

次の例は、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 の詳細については、「 コマンドリファレンスDescribeWorkspaces」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスMigrateWorkspace」の「」を参照してください。 AWS CLI

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

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

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

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

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

AWS CLI

を再起動するには WorkSpace

次のreboot-workspaces例では、指定された を再起動します WorkSpace。

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

出力:

{ "FailedRequests": [] }

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

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

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

AWS CLI

を再構築するには WorkSpace

次のrebuild-workspaces例では、指定された を再構築します WorkSpace。

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

出力:

{ "FailedRequests": [] }

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

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

次の例は、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を登録する」を参照してください。

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

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

AWS CLI

を復元するには WorkSpace

次のrestore-workspace例では、指定された を復元します WorkSpace。

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

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

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

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

次の例は、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 の詳細については、「 コマンドリファレンスStartWorkspaces」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスStopWorkspaces」の「」を参照してください。 AWS CLI

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

AWS CLI

を終了するには WorkSpace

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

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

出力:

{ "FailedRequests": [] }

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

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