View a markdown version of this page

WorkSpaces exemples utilisant AWS CLI - AWS Exemples de code SDK
Actions

D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples GitHub .

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

WorkSpaces exemples utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with 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 utilisercreate-tags.

AWS CLI

Pour ajouter des balises à WorkSpace

L'create-tagsexemple suivant ajoute les balises spécifiées aux balises spécifiées WorkSpace.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section WorkSpaces Ressources relatives aux balises dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utilisercreate-workspaces.

AWS CLI

Exemple 1 : pour créer un AlwaysOn WorkSpace

L'create-workspacesexemple suivant crée un AlwaysOn WorkSpace pour l'utilisateur spécifié, en utilisant le répertoire et le bundle 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 un AutoStop WorkSpace

L'create-workspacesexemple suivant crée un AutoStop WorkSpace pour l'utilisateur spécifié, en utilisant le répertoire et le bundle 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 interface découplée par l'utilisateur WorkSpace

L'create-workspacesexemple suivant crée un utilisateur découplé WorkSpace en définissant le nom d'utilisateur sur et en spécifiant un WorkSpace nom[UNDEFINED], un ID de répertoire et un ID de bundle.

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 la section Lancer un bureau virtuel dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserdelete-tags.

AWS CLI

Pour supprimer une étiquette d'un WorkSpace

L'delete-tagsexemple suivant supprime la balise spécifiée de la valeur spécifiée WorkSpace.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section WorkSpaces Ressources relatives aux balises dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserderegister-workspace-directory.

AWS CLI

Pour annuler l’enregistrement d’un annuaire

L’exemple deregister-workspace-directory suivant désenregistre le répertoire spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la section Enregistrer un annuaire WorkSpaces dans le Guide d' WorkSpaces administration Amazon.

L'exemple de code suivant montre comment utiliserdescribe-tags.

AWS CLI

Pour décrire les balises d'un WorkSpace

L'describe-tagsexemple suivant décrit les balises pour les éléments spécifiés WorkSpace.

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

Sortie :

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

Pour plus d'informations, consultez la section WorkSpaces Ressources relatives aux balises dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserdescribe-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 ID des offres fournies par Amazon, sous forme de table 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 WorkSpaces les lots et les images dans le Guide d' WorkSpaces administration Amazon.

L'exemple de code suivant montre comment utiliserdescribe-workspace-directories.

AWS CLI

Pour décrire un répertoire enregistré

L’exemple describe-workspace-directories suivant décrit le répertoire 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 la section Gérer les annuaires pour WorkSpaces Personal dans le Guide WorkSpaces d'administration Amazon.

L'exemple de code suivant montre comment utiliserdescribe-workspaces-connection-status.

AWS CLI

Pour décrire l'état de connexion d'un WorkSpace

L'describe-workspaces-connection-statusexemple suivant décrit l'état de connexion de la connexion spécifiée WorkSpace.

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 la section Administrer votre WorkSpaces dans le Guide WorkSpaces d'administration Amazon.

L'exemple de code suivant montre comment utiliserdescribe-workspaces.

AWS CLI

Pour décrire un WorkSpace

L'describe-workspacesexemple suivant décrit ce qui est spécifié WorkSpace.

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 la section Administrer votre WorkSpaces dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utilisermigrate-workspace.

AWS CLI

Pour migrer un WorkSpace

L'migrate-workspaceexemple suivant fait migrer le bundle spécifié WorkSpace vers le bundle spécifié.

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 la section Migrer un WorkSpace dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utilisermodify-workspace-creation-properties.

AWS CLI

Pour modifier WorkSpace la propriété de création d'un répertoire

L’exemple modify-workspace-creation-properties suivant active la propriété EnableInternetAccess pour le répertoire spécifié. Cela permet l'attribution automatique d'adresses IP publiques aux adresses 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 la section Mettre à jour les informations du répertoire pour vous WorkSpaces dans le Guide WorkSpaces d'administration Amazon.

L'exemple de code suivant montre comment utilisermodify-workspace-properties.

AWS CLI

Pour modifier le mode de fonctionnement d'un WorkSpace

L'modify-workspace-propertiesexemple suivant définit le mode d'exécution du paramètre spécifié WorkSpace surAUTO_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 Modifier un WorkSpace dans le Guide d' WorkSpaces administration Amazon.

L'exemple de code suivant montre comment utilisermodify-workspace-state.

AWS CLI

Pour modifier l'état d'un WorkSpace

L'modify-workspace-stateexemple suivant définit l'état du paramètre spécifié WorkSpace surADMIN_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 la section relative à la WorkSpace maintenance dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserreboot-workspaces.

AWS CLI

Pour redémarrer un WorkSpace

L'reboot-workspacesexemple suivant redémarre le paramètre spécifié WorkSpace.

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

Sortie :

{
    "FailedRequests": []
}

Pour plus d'informations, consultez Redémarrer un WorkSpace dans le Guide d' WorkSpaces administration Amazon.

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

L'exemple de code suivant montre comment utiliserrebuild-workspaces.

AWS CLI

Pour reconstruire un WorkSpace

L'rebuild-workspacesexemple suivant reconstruit la valeur spécifiée WorkSpace.

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

Sortie :

{
    "FailedRequests": []
}

Pour plus d'informations, consultez Reconstruire un WorkSpace dans le Guide d' WorkSpaces administration Amazon.

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

L'exemple de code suivant montre comment utiliserregister-workspace-directory.

AWS CLI

Pour enregistrer un répertoire

L'register-workspace-directoryexemple suivant enregistre le répertoire 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, voir Enregistrer un annuaire du service d' AWS annuaire existant auprès de WorkSpaces Personal dans le Guide d' WorkSpaces administration Amazon.

L'exemple de code suivant montre comment utiliserrestore-workspace.

AWS CLI

Pour restaurer un WorkSpace

L'restore-workspaceexemple suivant restaure la valeur spécifiée WorkSpace.

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

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez Restaurer un WorkSpace dans le Guide d' WorkSpaces administration Amazon.

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

L'exemple de code suivant montre comment utiliserstart-workspaces.

AWS CLI

Pour démarrer un AutoStop WorkSpace

L'start-workspacesexemple suivant démarre la commande spécifiée WorkSpace. Le mode de fonctionnement WorkSpace doit être deAutoStop.

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

Sortie :

{
    "FailedRequests": []
}

Pour plus d'informations, consultez la section Arrêter et démarrer un AutoStop WorkSpace dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserstop-workspaces.

AWS CLI

Pour arrêter un AutoStop WorkSpace

L'stop-workspacesexemple suivant arrête le paramètre spécifié WorkSpace. Le mode de fonctionnement WorkSpace doit être deAutoStop.

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

Sortie :

{
    "FailedRequests": []
}

Pour plus d'informations, consultez la section Arrêter et démarrer un AutoStop WorkSpace dans le Guide WorkSpaces d'administration Amazon.

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

L'exemple de code suivant montre comment utiliserterminate-workspaces.

AWS CLI

Pour mettre fin à un WorkSpace

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

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

Sortie :

{
    "FailedRequests": []
}

Pour plus d'informations, consultez Supprimer un WorkSpace dans le Guide d' WorkSpaces administration Amazon.

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