Exemples d’utilisation de l’AWS CLI avec WorkSpaces - AWS Command Line Interface
Actions

Exemples d’utilisation de l’AWS CLI avec WorkSpaces

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec WorkSpaces.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L’exemple de code suivant montre comment utiliser create-tags.

AWS CLI

Pour ajouter des balises à une instance WorkSpace

L’exemple create-tags suivant ajoute les balises spécifiées à l’instance WorkSpace spécifiée.

aws workspaces create-tags \
    --resource-id ws-dk1xzr417 \
    --tags Key=Department,Value=Finance

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage des ressources WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser create-workspaces.

AWS CLI

Exemple 1 : pour créer une instance WorkSpace AlwaysOn

L’exemple create-workspaces suivant crée une instance WorkSpace AlwaysOn pour l’utilisateur spécifié, en utilisant l’annuaire et l’offre spécifiés.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc

Sortie :

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-kcqms853t",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mateo",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}

Exemple 2 : pour créer une instance WorkSpace AutoStop

L’exemple create-workspaces suivant crée une instance WorkSpace AutoStop pour l’utilisateur spécifié, en utilisant l’annuaire et l’offre spécifiés.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}

Sortie :

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "DirectoryId": "d-926722edaf",
            "UserName": "Mary",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc"
        }
    ]
}

Exemple 3 : pour créer une instance WorkSpace découplée par l’utilisateur

L’exemple create-workspaces suivant crée une instance WorkSpace découplée par l’utilisateur en définissant le nom d’utilisateur sur [UNDEFINED] et en spécifiant un nom d’instance WorkSpace, un ID d’annuaire et un ID d’offre.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}

Sortie :

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-abcd1234",
            "DirectoryId": "d-926722edaf",
            "UserName": "[UNDEFINED]",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc",
            "WorkspaceName": "MaryWorkspace1"
        }
    ]
}

Pour plus d’informations, consultez Lancement d’un bureau virtuel dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser delete-tags.

AWS CLI

Pour supprimer une balise d’une instance WorkSpace

L’exemple delete-tags suivant supprime la balise spécifiée de l’instance WorkSpace spécifiée.

aws workspaces delete-tags \
    --resource-id ws-dk1xzr417 \
    --tag-keys Department

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage des ressources WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser deregister-workspace-directory.

AWS CLI

Pour annuler l’enregistrement d’un annuaire

L’exemple deregister-workspace-directory suivant désenregistre l’annuaire spécifié.

aws workspaces deregister-workspace-directory \
    --directory-id d-926722edaf

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Enregistrement d’un annuaire avec WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

L’exemple de code suivant montre comment utiliser describe-tags.

AWS CLI

Pour décrire les balises d’une instance WorkSpace

L’exemple describe-tags suivant décrit les balises de l’instance WorkSpace spécifiée.

aws workspaces describe-tags \
    --resource-id ws-dk1xzr417

Sortie :

{
    "TagList": [
        {
            "Key": "Department",
            "Value": "Finance"
        }
    ]
}

Pour plus d’informations, consultez Balisage des ressources WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser describe-workspace-bundles.

AWS CLI

Pour répertorier les offres proposées par Amazon

L’exemple describe-workspace-bundles suivant répertorie les noms et les identifiants des offres fournies par Amazon, sous forme de tableau et triés par nom.

aws workspaces describe-workspace-bundles \
    --owner AMAZON \
    --query "Bundles[*].[Name, BundleId]"

Sortie :

[
    [
        "Standard with Amazon Linux 2",
        "wsb-clj85qzj1"
    ],
    [
        "Performance with Windows 10 (Server 2016 based)",
        "wsb-gm4d5tx2v"
    ],
    [
        "PowerPro with Windows 7",
        "wsb-1pzkp0bx4"
    ],
    [
        "Power with Amazon Linux 2",
        "wsb-2bs6k5lgn"
    ],
    [
        "Graphics with Windows 10 (Server 2019 based)",
        "wsb-03gyjnfyy"
    ],
    ...
]

Pour plus d’informations, consultez Bundles et Images d’instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser describe-workspace-directories.

AWS CLI

Pour décrire un annuaire enregistré

L’exemple describe-workspace-directories suivant décrit l’annuaire enregistré spécifié.

aws workspaces describe-workspace-directories \
    --directory-ids d-926722edaf

Sortie :

{
    "Directories": [
        {
            "DirectoryId": "d-926722edaf",
            "Alias": "d-926722edaf",
            "DirectoryName": "example.com",
            "RegistrationCode": "WSpdx+9RJ8JT",
            "SubnetIds": [
                "subnet-9d19c4c6",
                "subnet-500d5819"
            ],
            "DnsIpAddresses": [
                "172.16.1.140",
                "172.16.0.30"
            ],
            "CustomerUserName": "Administrator",
            "IamRoleId": "arn:aws:iam::123456789012:role/workspaces_DefaultRole",
            "DirectoryType": "SIMPLE_AD",
            "WorkspaceSecurityGroupId": "sg-0d89e927e5645d7c5",
            "State": "REGISTERED",
            "WorkspaceCreationProperties": {
                "EnableInternetAccess": false,
                "UserEnabledAsLocalAdministrator": true,
                "EnableMaintenanceMode": true
            },
            "WorkspaceAccessProperties": {
                "DeviceTypeWindows": "ALLOW",
                "DeviceTypeOsx": "ALLOW",
                "DeviceTypeWeb": "DENY",
                "DeviceTypeIos": "ALLOW",
                "DeviceTypeAndroid": "ALLOW",
                "DeviceTypeChromeOs": "ALLOW",
                "DeviceTypeZeroClient": "ALLOW",
                "DeviceTypeLinux": "DENY"
            },
            "Tenancy": "SHARED",
            "SelfservicePermissions": {
                "RestartWorkspace": "ENABLED",
                "IncreaseVolumeSize": "DISABLED",
                "ChangeComputeType": "DISABLED",
                "SwitchRunningMode": "DISABLED",
                "RebuildWorkspace": "DISABLED"
            }
        }
    ]
}

Pour plus d’informations, consultez Gestion des annuaires pour WorkSpaces Personal dans le Guide de l’administrateur Amazon WorkSpaces.

L’exemple de code suivant montre comment utiliser describe-workspaces-connection-status.

AWS CLI

Pour décrire le statut de connexion d’une instance WorkSpace

L’exemple describe-workspaces-connection-status suivant décrit le statut de connexion de l’instance WorkSpace spécifiée.

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

Sortie :

{
    "WorkspacesConnectionStatus": [
        {
            "WorkspaceId": "ws-dk1xzr417",
            "ConnectionState": "CONNECTED",
            "ConnectionStateCheckTimestamp": 1662526214.744
        }
    ]
}

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

L’exemple de code suivant montre comment utiliser describe-workspaces.

AWS CLI

Pour décrire une instance WorkSpace

L’exemple describe-workspaces suivant décrit l’instance WorkSpace spécifiée.

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 d’instances 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.

L’exemple de code suivant montre comment utiliser migrate-workspace.

AWS CLI

Pour migrer une instance WorkSpace

L’exemple migrate-workspace suivant migre l’instance WorkSpace spécifiée vers l’offre spécifiée.

aws workspaces migrate-workspace \
    --source-workspace-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

Sortie :

{
    "SourceWorkspaceId": "ws-dk1xzr417",
    "TargetWorkspaceId": "ws-x5h1lbkp5"
}

Pour plus d’informations, consultez Migration d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser modify-workspace-creation-properties.

AWS CLI

Pour modifier une propriété de création d’instance WorkSpace d’un annuaire

L’exemple modify-workspace-creation-properties suivant active la propriété EnableInternetAccess pour l’annuaire spécifié. Cela permet l’attribution automatique d’adresses IP publiques pour les instances WorkSpaces créées pour l’annuaire.

aws workspaces modify-workspace-creation-properties \
    --resource-id d-926722edaf \
    --workspace-creation-properties EnableInternetAccess=true

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Mise à jour des informations de l’annuaire pour vos instances WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

L’exemple de code suivant montre comment utiliser modify-workspace-properties.

AWS CLI

Pour modifier le mode d’exécution d’une instance WorkSpace

L’exemple modify-workspace-properties suivant définit le mode d’exécution de l’instance WorkSpace spécifiée sur AUTO_STOP.

aws workspaces modify-workspace-properties \
    --workspace-id ws-dk1xzr417 \
    --workspace-properties RunningMode=AUTO_STOP

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Modification d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

L’exemple de code suivant montre comment utiliser modify-workspace-state.

AWS CLI

Pour modifier l’état d’une instance WorkSpace

L’exemple modify-workspace-state suivant définit l’état de l’instance WorkSpace spécifiée sur ADMIN_MAINTENANCE.

aws workspaces modify-workspace-state \
    --workspace-id ws-dk1xzr417 \
    --workspace-state ADMIN_MAINTENANCE

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Maintenance des instances WorkSpaces dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser reboot-workspaces.

AWS CLI

Pour redémarrer une instance WorkSpace

L’exemple reboot-workspaces suivant redémarre l’instance WorkSpace spécifiée.

aws workspaces reboot-workspaces \
    --reboot-workspace-requests ws-dk1xzr417

Sortie :

{
    "FailedRequests": []
}

Pour plus d’informations, consultez Redémarrage d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser rebuild-workspaces.

AWS CLI

Pour reconstruire une instance WorkSpace

L’exemple rebuild-workspaces suivant reconstruit l’instance WorkSpace spécifiée.

aws workspaces rebuild-workspaces \
    --rebuild-workspace-requests ws-dk1xzr417

Sortie :

{
    "FailedRequests": []
}

Pour plus d’informations, consultez Reconstruction d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser register-workspace-directory.

AWS CLI

Pour enregistrer un annuaire

L’exemple register-workspace-directory suivant enregistre l’annuaire spécifié pour l’utiliser avec Amazon WorkSpaces.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Enregistrement d’un annuaire AWS Directory Service existant avec WorkSpaces Personal dans le Guide de l’administrateur Amazon WorkSpaces.

L’exemple de code suivant montre comment utiliser restore-workspace.

AWS CLI

Pour restaurer une instance WorkSpace

L’exemple restore-workspace suivant restaure l’instance WorkSpace spécifiée.

aws workspaces restore-workspace \
    --workspace-id ws-dk1xzr417

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Restauration d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser start-workspaces.

AWS CLI

Pour démarrer une instance WorkSpace AutoStop

L’exemple start-workspaces suivant démarre l’instance WorkSpace spécifiée. L’instance WorkSpace doit avoir un mode d’exécution AutoStop.

aws workspaces start-workspaces \
    --start-workspace-requests WorkspaceId=ws-dk1xzr417

Sortie :

{
    "FailedRequests": []
}

Pour plus d’informations, consultez Arrêt et démarrage d’une instance WorkSpace AutoStop dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser stop-workspaces.

AWS CLI

Pour arrêter une instance WorkSpace AutoStop

L’exemple stop-workspaces suivant arrête l’instance WorkSpace spécifiée. L’instance WorkSpace doit avoir un mode d’exécution AutoStop.

aws workspaces stop-workspaces \
    --stop-workspace-requests WorkspaceId=ws-dk1xzr417

Sortie :

{
    "FailedRequests": []
}

Pour plus d’informations, consultez Arrêt et démarrage d’une instance WorkSpace AutoStop dans le Guide de l’administrateur Amazon WorkSpaces.

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

L’exemple de code suivant montre comment utiliser terminate-workspaces.

AWS CLI

Pour supprimer une instance WorkSpace

L’exemple terminate-workspaces suivant supprime l’instance WorkSpace spécifiée.

aws workspaces terminate-workspaces \
    --terminate-workspace-requests ws-dk1xzr417

Sortie :

{
    "FailedRequests": []
}

Pour plus d’informations, consultez Suppression d’une instance WorkSpace dans le Guide de l’administrateur Amazon WorkSpaces.

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