Doc AWS SDK Examples GitHub リポジトリには、他にも SDK の例があります。 [AWS](https://github.com/awsdocs/aws-doc-sdk-examples) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # CLI で `DescribeWorkspaces` を使用する 次のサンプルコードは、`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 管理ガイド](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html)」の「*Amazon WorkSpaces の管理*」を参照してください。 + 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 コマンドレットリファレンス (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 コマンドレットリファレンス (V5)*」の「[DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)」を参照してください。 ------