WorkSpaces 使用示例 Amazon CLI

以下代码示例向您展示了如何使用with来执行操作和实现常见场景 WorkSpaces。 Amazon Command Line Interface

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景和跨服务示例的上下文查看操作。

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

操作

以下代码示例演示如何使用 create-tags。

Amazon CLI

向 a 添加标签 WorkSpace

以下create-tags示例将指定的标签添加到指定的 WorkSpace。


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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》中的标签 WorkSpaces 资源。

有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateTags中的。

以下代码示例演示如何使用 create-workspaces。

Amazon 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示例 WorkSpace 通过将用户名设置为并指定 WorkSpace 名称[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 的详细信息，请参阅Amazon CLI 命令参考CreateWorkspaces中的。

以下代码示例演示如何使用 delete-tags。

Amazon CLI

从中删除标签 WorkSpace

以下delete-tags示例从指定标签中删除指定的标签 WorkSpace。


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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》中的标签 WorkSpaces 资源。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteTags中的。

以下代码示例演示如何使用 deregister-workspace-directory。

Amazon CLI

取消注册目录

以下deregister-workspace-directory示例取消注册指定目录。


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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpaces中的向注册目录。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DeregisterWorkspaceDirectory中的。

以下代码示例演示如何使用 describe-tags。

Amazon CLI

描述 a 的标签 WorkSpace

以下describe-tags示例描述了指定的标签 WorkSpace。


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

输出：


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

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》中的标签 WorkSpaces 资源。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeTags中的。

以下代码示例演示如何使用 describe-workspace-bundles。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeWorkspaceBundles中的。

以下代码示例演示如何使用 describe-workspace-directories。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeWorkspaceDirectories中的。

以下代码示例演示如何使用 describe-workspaces-connection-status。

Amazon 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 管理您的。

有关 API 的详细信息，请参阅Amazon CLI 命令参考DescribeWorkspacesConnectionStatus中的。

以下代码示例演示如何使用 describe-workspaces。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考DescribeWorkspaces中的。

以下代码示例演示如何使用 migrate-workspace。

Amazon 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中的 Migrate a。

有关 API 的详细信息，请参阅Amazon CLI 命令参考MigrateWorkspace中的。

以下代码示例演示如何使用 modify-workspace-creation-properties。

Amazon 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中的 “更新您的目录详情”。

有关 API 的详细信息，请参阅Amazon CLI 命令参考ModifyWorkspaceCreationProperties中的。

以下代码示例演示如何使用 modify-workspace-properties。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ModifyWorkspaceProperties中的。

以下代码示例演示如何使用 modify-workspace-state。

Amazon 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 的详细信息，请参阅Amazon CLI 命令参考ModifyWorkspaceState中的。

以下代码示例演示如何使用 reboot-workspaces。

Amazon CLI

要重新启动 WorkSpace

以下reboot-workspaces示例重新启动指定 WorkSpace的。


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

输出：


{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpace中的重启。

有关 API 的详细信息，请参阅Amazon CLI 命令参考RebootWorkspaces中的。

以下代码示例演示如何使用 rebuild-workspaces。

Amazon CLI

要重建 WorkSpace

以下rebuild-workspaces示例将重建指定 WorkSpace的。


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

输出：


{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpace中的重建。

有关 API 的详细信息，请参阅Amazon CLI 命令参考RebuildWorkspaces中的。

以下代码示例演示如何使用 register-workspace-directory。

Amazon CLI

注册目录

以下register-workspace-directory示例注册了要在 Amazon 上使用的指定目录 WorkSpaces。


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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpaces中的向注册目录。

有关 API 的详细信息，请参阅Amazon CLI 命令参考RegisterWorkspaceDirectory中的。

以下代码示例演示如何使用 restore-workspace。

Amazon CLI

要恢复 WorkSpace

以下restore-workspace示例恢复指定 WorkSpace的。


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

此命令不生成任何输出。

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpace中的 “恢复”。

有关 API 的详细信息，请参阅Amazon CLI 命令参考RestoreWorkspace中的。

以下代码示例演示如何使用 start-workspaces。

Amazon CLI

要开始 AutoStop WorkSpace

以下start-workspaces示例从指定开始 WorkSpace。的运行模式 WorkSpace 必须为AutoStop。


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

输出：


{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 AutoStop WorkSpace中的 “停止并启动”。

有关 API 的详细信息，请参阅Amazon CLI 命令参考StartWorkspaces中的。

以下代码示例演示如何使用 stop-workspaces。

Amazon CLI

要停止 AutoStop WorkSpace

以下stop-workspaces示例停止指定的 WorkSpace。的运行模式 WorkSpace 必须为AutoStop。


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

输出：


{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 AutoStop WorkSpace中的 “停止并启动”。

有关 API 的详细信息，请参阅Amazon CLI 命令参考StopWorkspaces中的。

以下代码示例演示如何使用 terminate-workspaces。

Amazon CLI

要终止 WorkSpace

以下terminate-workspaces示例终止指定的工作空间。


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

输出：


{
    "FailedRequests": []
}

有关更多信息，请参阅《Amazon WorkSpaces 管理指南》 WorkSpace中的 “删除”。

有关 API 的详细信息，请参阅Amazon CLI 命令参考TerminateWorkspaces中的。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

亚马逊 WorkMail 消息流

X-Ray