将 DescribeWorkspaces 与 CLI 配合使用

以下代码示例演示如何使用 DescribeWorkspaces。

CLI

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。

PowerShell

Tools for PowerShell V4

示例 1：将所有工作空间的详细信息检索到管道。

Get-WKSWorkspace

输出：

BundleId                    : wsb-1a2b3c4d
ComputerName                :
DirectoryId                 : d-1a2b3c4d
ErrorCode                   :
ErrorMessage                :
IpAddress                   :
RootVolumeEncryptionEnabled : False
State                       : PENDING
SubnetId                    :
UserName                    : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey         :
WorkspaceId                 : ws-1a2b3c4d
WorkspaceProperties         : Amazon.WorkSpaces.Model.WorkspaceProperties

示例 2：此命令显示 us-west-2 区域中某个工作空间的 WorkSpaceProperties 的各个子属性的值。有关 WorkSpaceProperties 的子属性的更多信息，请参阅 https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties

输出：

        ComputeTypeName                     : STANDARD
        RootVolumeSizeGib                   : 80
        RunningMode                         : AUTO_STOP
        RunningModeAutoStopTimeoutInMinutes : 60
        UserVolumeSizeGib                   : 50

示例 3：此命令显示 us-west-2 区域中某个工作空间的 WorkSpaceProperties 的子属性 RootVolumeSizeGib 的值。根卷大小（以 GiB 为单位）为 80。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib

输出：

        80

• 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V4)》中的 DescribeWorkspaces。

Tools for PowerShell V5

示例 1：将所有工作空间的详细信息检索到管道。

Get-WKSWorkspace

输出：

BundleId                    : wsb-1a2b3c4d
ComputerName                :
DirectoryId                 : d-1a2b3c4d
ErrorCode                   :
ErrorMessage                :
IpAddress                   :
RootVolumeEncryptionEnabled : False
State                       : PENDING
SubnetId                    :
UserName                    : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey         :
WorkspaceId                 : ws-1a2b3c4d
WorkspaceProperties         : Amazon.WorkSpaces.Model.WorkspaceProperties

示例 2：此命令显示 us-west-2 区域中某个工作空间的 WorkSpaceProperties 的各个子属性的值。有关 WorkSpaceProperties 的子属性的更多信息，请参阅 https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties

输出：

        ComputeTypeName                     : STANDARD
        RootVolumeSizeGib                   : 80
        RunningMode                         : AUTO_STOP
        RunningModeAutoStopTimeoutInMinutes : 60
        UserVolumeSizeGib                   : 50

示例 3：此命令显示 us-west-2 区域中某个工作空间的 WorkSpaceProperties 的子属性 RootVolumeSizeGib 的值。根卷大小（以 GiB 为单位）为 80。

(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib

输出：

        80

• 有关 API 详细信息，请参阅《AWS Tools for PowerShell Cmdlet Reference (V5)》中的 DescribeWorkspaces。