

文件 AWS 開發套件範例 GitHub 儲存庫中有更多可用的 [AWS SDK 範例](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 ]

**Tools for 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\$1WorkspaceProperties.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 參考 (V4)》**中的 [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)。

**Tools for 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\$1WorkspaceProperties.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 參考 (V5)》**中的 [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)。

------