D'autres exemples de AWS SDK sont disponibles dans le référentiel AWS Doc SDK Examples
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 du 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 façon de configurer et d'exécuter le code en contexte.
Rubriques
Actions
L'exemple de code suivant montre comment utilisercreate-tags.
- AWS CLI
-
Pour ajouter des balises à un WorkSpace
L'
create-tagsexemple suivant ajoute les balises spécifiées aux balises spécifiées WorkSpace.aws workspaces create-tags \ --resource-idws-dk1xzr417\ --tagsKey=Department,Value=FinanceCette commande ne produit aucun résultat.
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, reportez-vous 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 \ --workspacesDirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fcSortie :
{ "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 \ --workspacesDirectoryId=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 un système découplé par l'utilisateur WorkSpace
L'
create-workspacesexemple suivant crée un découplage utilisateur 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 d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous CreateWorkspaces
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdelete-tags.
- AWS CLI
-
Pour supprimer un tag d'un WorkSpace
L'
delete-tagsexemple suivant supprime la balise spécifiée de la balise spécifiée WorkSpace.aws workspaces delete-tags \ --resource-idws-dk1xzr417\ --tag-keysDepartmentCette commande ne produit aucun résultat.
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, reportez-vous DeleteTags
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserderegister-workspace-directory.
- AWS CLI
-
Pour désenregistrer un annuaire
L'
deregister-workspace-directoryexemple suivant annule l'enregistrement du répertoire spécifié.aws workspaces deregister-workspace-directory \ --directory-idd-926722edafCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Enregistrer un annuaire WorkSpaces dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous DeregisterWorkspaceDirectory
à la section Référence des AWS CLI commandes.
-
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 le paramètre spécifié WorkSpace.aws workspaces describe-tags \ --resource-idws-dk1xzr417Sortie :
{ "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, reportez-vous 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 groupées proposées par Amazon
L'
describe-workspace-bundlesexemple suivant répertorie les noms et IDs les offres groupées fournis par Amazon, sous forme de tableau et triés par nom.aws workspaces describe-workspace-bundles \ --ownerAMAZON\ --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 offres groupées et les images dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceBundles
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserdescribe-workspace-directories.
- AWS CLI
-
Pour décrire un annuaire enregistré
L'
describe-workspace-directoriesexemple suivant décrit le répertoire enregistré spécifié.aws workspaces describe-workspace-directories \ --directory-idsd-926722edafSortie :
{ "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 les WorkSpaces particuliers dans le guide WorkSpaces d'administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspaceDirectories
à la section Référence des AWS CLI commandes.
-
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 du paramètre spécifié WorkSpace.aws workspaces describe-workspaces-connection-status \ --workspace-idsws-dk1xzr417Sortie :
{ "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.
-
Pour plus de détails sur l'API, reportez-vous DescribeWorkspacesConnectionStatus
à la section Référence des AWS CLI commandes.
-
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-idsws-dk1xzr417Sortie :
{ "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, reportez-vous 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-idws-dk1xzr417\ --bundle-idwsb-j4dky1gs4Sortie :
{ "SourceWorkspaceId": "ws-dk1xzr417", "TargetWorkspaceId": "ws-x5h1lbkp5" }Pour plus d'informations, consultez Migrate a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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 une propriété de WorkSpace création d'un répertoire
L'
modify-workspace-creation-propertiesexemple suivant active laEnableInternetAccesspropriété pour le répertoire spécifié. Cela permet l'attribution automatique d'adresses IP publiques pour les adresses IP WorkSpaces créées pour l'annuaire.aws workspaces modify-workspace-creation-properties \ --resource-idd-926722edaf\ --workspace-creation-propertiesEnableInternetAccess=trueCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Mettre à jour les informations de votre répertoire WorkSpaces dans le guide WorkSpaces d'administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspaceCreationProperties
à la section Référence des AWS CLI commandes.
-
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-idws-dk1xzr417\ --workspace-propertiesRunningMode=AUTO_STOPCette commande ne produit aucun résultat.
Pour plus d'informations, consultez Modifier un WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous ModifyWorkspaceProperties
à la section Référence des AWS CLI commandes.
-
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 de la valeur spécifiée WorkSpace surADMIN_MAINTENANCE.aws workspaces modify-workspace-state \ --workspace-idws-dk1xzr417\ --workspace-stateADMIN_MAINTENANCECette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section WorkSpace maintenance dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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 fichier spécifié WorkSpace.aws workspaces reboot-workspaces \ --reboot-workspace-requestsws-dk1xzr417Sortie :
{ "FailedRequests": [] }Pour plus d'informations, consultez Reboot a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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 le fichier spécifié WorkSpace.aws workspaces rebuild-workspaces \ --rebuild-workspace-requestsws-dk1xzr417Sortie :
{ "FailedRequests": [] }Pour plus d'informations, consultez Rebuild a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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 annuaire
L'
register-workspace-directoryexemple suivant enregistre le répertoire spécifié pour une utilisation avec Amazon WorkSpaces.aws workspaces register-workspace-directory \ --directory-idd-926722edafCette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section Enregistrer un AWS annuaire Directory Service existant auprès de WorkSpaces Personal dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous RegisterWorkspaceDirectory
à la section Référence des AWS CLI commandes.
-
L'exemple de code suivant montre comment utiliserrestore-workspace.
- AWS CLI
-
Pour restaurer un WorkSpace
L'
restore-workspaceexemple suivant restaure le paramètre spécifié WorkSpace.aws workspaces restore-workspace \ --workspace-idws-dk1xzr417Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez Restore a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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 le fichier spécifié WorkSpace. Le mode de fonctionnement WorkSpace doit être deAutoStop.aws workspaces start-workspaces \ --start-workspace-requestsWorkspaceId=ws-dk1xzr417Sortie :
{ "FailedRequests": [] }Pour plus d'informations, consultez la section Stop and start an AutoStop WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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-requestsWorkspaceId=ws-dk1xzr417Sortie :
{ "FailedRequests": [] }Pour plus d'informations, consultez la section Stop and start an AutoStop WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous 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'
terminate-workspacesexemple suivant met fin à l'espace de travail spécifié.aws workspaces terminate-workspaces \ --terminate-workspace-requestsws-dk1xzr417Sortie :
{ "FailedRequests": [] }Pour plus d'informations, consultez Supprimer un WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour plus de détails sur l'API, reportez-vous TerminateWorkspaces
à la section Référence des AWS CLI commandes.
-