Utilisation de DescribeWorkspaces avec une CLI

Les exemples de code suivants illustrent comment utiliser DescribeWorkspaces.

CLI

AWS CLI

Pour décrire une instance WorkSpace

L’exemple describe-workspaces suivant décrit le WorkSpace spécifié.

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

Sortie :

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

Pour plus d’informations, consultez Administration de vos WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

• Pour plus de détails sur l’API, consultez DescribeWorkspaces dans la Référence des commandes de l’AWS CLI.

PowerShell

Outils pour PowerShell V4

Exemple 1 : extrait les détails de tous vos WorkSpaces dans le pipeline.

Get-WKSWorkspace

Sortie :

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

Exemple 2 : cette commande affiche les valeurs des propriétés enfant de WorkSpaceProperties pour un espace de travail dans la région us-west-2. Pour plus d’informations sur les propriétés enfant de WorkSpaceProperties, consultez https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Sortie :

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

Exemple 3 : cette commande indique la valeur de la propriété enfant RootVolumeSizeGib de WorkSpaceProperties pour un espace de travail dans la région us-west-2. La taille du volume racine, en GiO, est de 80.

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

Sortie :

        80

• Pour plus de détails sur l’API, consultez DescribeWorkspaces dans la Référence des applets de commande pour les Outils AWS pour PowerShell (V4).

Outils pour PowerShell V5

Exemple 1 : extrait les détails de tous vos WorkSpaces dans le pipeline.

Get-WKSWorkspace

Sortie :

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

Exemple 2 : cette commande affiche les valeurs des propriétés enfant de WorkSpaceProperties pour un espace de travail dans la région us-west-2. Pour plus d’informations sur les propriétés enfant de WorkSpaceProperties, consultez https://docs.aws.amazon.com/workspaces/latest/api/API_WorkspaceProperties.html.

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

Sortie :

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

Exemple 3 : cette commande indique la valeur de la propriété enfant RootVolumeSizeGib de WorkSpaceProperties pour un espace de travail dans la région us-west-2. La taille du volume racine, en GiO, est de 80.

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

Sortie :

        80

• Pour plus de détails sur l’API, consultez DescribeWorkspaces dans la Référence des applets de commande pour les Outils AWS pour PowerShell (V5).