を使用したWorkSpaces の例 AWS CLI - AWS SDKコードの例
アクション

Doc AWS SDK ExamplesWord リポジトリには、さらに多くの GitHub の例があります。 AWS SDK

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

を使用したWorkSpaces の例 AWS CLI

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

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

各例には、完全なソースコードへのリンクが含まれています。ここでは、コンテキストでコードを設定および実行する方法の手順を確認できます。

トピック

アクション

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

AWS CLI

a WorkSpace にタグを追加するには

次のcreate-tags例では、指定されたタグを指定された WorkSpace に追加します。

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

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

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

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

次のコード例は、create-workspaces を使用する方法を示しています。

AWS CLI

例 1: AlwaysOn WorkSpaceWord を作成するには

次のcreate-workspaces例では、指定されたディレクトリとバンドルを使用して、指定されたユーザーの AlwaysOn WorkSpace Word を作成します。

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 WorkSpaceWord を作成するには

次のcreate-workspaces例では、指定されたディレクトリとバンドルを使用して、指定されたユーザーの AutoStop WorkSpace Word を作成します。

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]、a 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

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

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

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

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

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

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

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

AWS CLI

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

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

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

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

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

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

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

AWS CLI

a WorkSpace のタグを記述するには

次のdescribe-tags例では、指定された WorkSpace のタグについて説明します。

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

出力:

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

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

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

次の例は、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"
    ],
    ...
]

詳細については、AmazonWorkSpaces 管理ガイドの「Word バンドルとイメージ」を参照してください。 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": {
                "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 管理ガイドの「Word のディレクトリの管理」を参照してください。 WorkSpaces

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

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

AWS CLI

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

次のコード例は、describe-workspaces を使用する方法を示しています。

AWS CLI

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

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

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

AWS CLI

a WorkSpace を移行するには

次のmigrate-workspace例では、指定された WorkSpace を指定されたバンドルに移行します。

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

出力:

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

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

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

次のコード例は、modify-workspace-creation-properties を使用する方法を示しています。

AWS CLI

ディレクトリの a 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 管理ガイド」の「YourWord のディレクトリの詳細を更新する」を参照してください。 WorkSpaces

次のコード例は、modify-workspace-properties を使用する方法を示しています。

AWS CLI

a WorkSpace の実行モードを変更するには

次のmodify-workspace-properties例では、指定された WorkSpace の実行モードを に設定しますAUTO_STOP。

aws workspaces modify-workspace-properties \
    --workspace-id ws-dk1xzr417 \
    --workspace-properties RunningMode=AUTO_STOP

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

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

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

次のコード例は、modify-workspace-state を使用する方法を示しています。

AWS CLI

a WorkSpace の状態を変更するには

次のmodify-workspace-state例では、指定された WorkSpace の状態を に設定しますADMIN_MAINTENANCE。

aws workspaces modify-workspace-state \
    --workspace-id ws-dk1xzr417 \
    --workspace-state ADMIN_MAINTENANCE

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

詳細については、Amazon WorkSpaces 管理ガイドのWorkSpace メンテナンス」を参照してください。

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

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

AWS CLI

WorkSpace を再起動するには

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

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

出力:

{
    "FailedRequests": []
}

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

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

次のコード例は、rebuild-workspaces を使用する方法を示しています。

AWS CLI

a WorkSpace を再構築するには

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

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

出力:

{
    "FailedRequests": []
}

詳細については、Amazon WorkSpace 管理ガイドの「aWord の再構築」を参照してください。 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 管理ガイドの「Word でディレクトリを登録する」を参照してください。 WorkSpaces

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

次のコード例は、restore-workspace を使用する方法を示しています。

AWS CLI

a WorkSpace を復元するには

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

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

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

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

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

次のコード例は、start-workspaces を使用する方法を示しています。

AWS CLI

AutoStop WorkSpaceWord を起動するには

次のstart-workspaces例では、指定された WorkSpace を起動します。 WorkSpace には の実行モードが必要ですAutoStop。

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

出力:

{
    "FailedRequests": []
}

詳細については、AmazonWorkSpace 管理ガイドの AutoStop を停止して起動する」を参照してください。 WorkSpaces

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

次のコード例は、stop-workspaces を使用する方法を示しています。

AWS CLI

AutoStop WorkSpaceWord を停止するには

次のstop-workspaces例では、指定された WorkSpace を停止します。 WorkSpace には の実行モードが必要ですAutoStop。

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

出力:

{
    "FailedRequests": []
}

詳細については、AmazonWorkSpace 管理ガイドの AutoStop を停止して起動する」を参照してください。 WorkSpaces

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

次のコード例は、terminate-workspaces を使用する方法を示しています。

AWS CLI

a WorkSpace を終了するには

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

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

出力:

{
    "FailedRequests": []
}

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

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