文档 AWS SDK 示例 GitHub 存储库中还有更多 [S AWS DK 示例](https://github.com/awsdocs/aws-doc-sdk-examples)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 将 `DescribeWorkspaces` 与 CLI 配合使用
<a name="workspaces_example_workspaces_DescribeWorkspaces_section"></a>

以下代码示例演示如何使用 `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 管理*[您](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)的。  
+  有关 API 的详细信息，请参阅*AWS CLI 命令参考[DescribeWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces.html)*中的。

------
#### [ PowerShell ]

**适用于 PowerShell V4 的工具**  
**示例 1： WorkSpaces 将您的所有详细信息检索到管道。**  

```
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 \$1 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 参考 (V* 4) [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)中的。

**适用于 PowerShell V5 的工具**  
**示例 1： WorkSpaces 将您的所有详细信息检索到管道。**  

```
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 \$1 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 参考 (V* 5) [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)中的。

------