Usar DescribeWorkspaces com uma CLI - Exemplos de código do AWS SDK

Há mais exemplos do AWS SDK disponíveis no repositório do GitHub Documento de Exemplos do AWS SDK.

Usar DescribeWorkspaces com uma CLI

Os exemplos de código a seguir mostram como usar o DescribeWorkspaces.

CLI
AWS CLI

Para descrever um WorkSpace

O exemplo describe-workspaces a seguir descreve o WorkSpace especificado.

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

Saída:

{
    "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 obter mais informações, consulte Administrar seus WorkSpaces no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte DescribeWorkspaces na Referência de comandos da AWS CLI.

PowerShell
Ferramentas para PowerShell V4

Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.

Get-WKSWorkspace

Saída:

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

Exemplo 2: esse comando mostra os valores das propriedades secundárias de WorkSpaceProperties para um espaço de trabalho na região us-west-2. Consulte mais informações sobre as propriedades secundárias de WorkSpaceProperties em https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Saída:

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

Exemplo 3: esse comando mostra o valor da propriedade secundária RootVolumeSizeGib de WorkSpaceProperties para um espaço de trabalho na região us-west-2. O tamanho do volume raiz, em GiB, é 80.

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

Saída:

        80

  • Consulte detalhes da API em DescribeWorkspaces na Referência de cmdlet do Ferramentas da AWS para PowerShell (V4).

Ferramentas para PowerShell V5

Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.

Get-WKSWorkspace

Saída:

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

Exemplo 2: esse comando mostra os valores das propriedades secundárias de WorkSpaceProperties para um espaço de trabalho na região us-west-2. Consulte mais informações sobre as propriedades secundárias de WorkSpaceProperties em https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Saída:

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

Exemplo 3: esse comando mostra o valor da propriedade secundária RootVolumeSizeGib de WorkSpaceProperties para um espaço de trabalho na região us-west-2. O tamanho do volume raiz, em GiB, é 80.

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

Saída:

        80

  • Consulte detalhes da API em DescribeWorkspaces na Referência de cmdlet do Ferramentas da AWS para PowerShell (V5).