Utilizar DescribeWorkspaces con una CLI

Los siguientes ejemplos de código muestran cómo utilizar DescribeWorkspaces.

CLI

AWS CLI

Para describir un WorkSpace

En el siguiente ejemplo de describe-workspaces, se describe el WorkSpace especificado.

aws workspaces describe-workspaces \
    --workspace-ids ws-dk1xzr417

Salida:

{
    "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": []
        }
    ]
}

Para obtener más información, consulte Administer your WorkSpaces en la Guía de administración de Amazon WorkSpaces.

• Para obtener información sobre la API, consulte DescribeWorkspaces en la Referencia de comandos de la AWS CLI.

PowerShell

Herramientas para PowerShell V4

Ejemplo 1: Recupera los detalles de todas sus instancias de WorkSpaces en la canalización.

Get-WKSWorkspace

Salida:

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

Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de WorkSpaceProperties para un espacio de trabajo de la región us-west-2. Para obtener más información sobre las propiedades secundarias de WorkSpaceProperties, consulte https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Salida:

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

Ejemplo 3: Este comando muestra el valor de la propiedad secundaria RootVolumeSizeGib de WorkSpaceProperties para un espacio de trabajo en la región us-west-2. El tamaño del volumen de la raíz, en GiB, es 80.

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

Salida:

        80

• Para obtener información sobre la API, consulte DescribeWorkspaces en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V4).

Herramientas para PowerShell V5

Ejemplo 1: Recupera los detalles de todas sus instancias de WorkSpaces en la canalización.

Get-WKSWorkspace

Salida:

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

Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de WorkSpaceProperties para un espacio de trabajo de la región us-west-2. Para obtener más información sobre las propiedades secundarias de WorkSpaceProperties, consulte https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Salida:

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

Ejemplo 3: Este comando muestra el valor de la propiedad secundaria RootVolumeSizeGib de WorkSpaceProperties para un espacio de trabajo en la región us-west-2. El tamaño del volumen de la raíz, en GiB, es 80.

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

Salida:

        80

• Para obtener información sobre la API, consulte DescribeWorkspaces en la Referencia de cmdlets de Herramientas de AWS para PowerShell (V5).