D'autres AWS SDK exemples sont disponibles dans le GitHub dépôt 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 montrent comment appeler des fonctions de service individuelles, vous pouvez les visualiser dans leur 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-tags
exemple suivant ajoute les balises spécifiées aux balises spécifiées WorkSpace.aws workspaces create-tags \ --resource-id
ws-dk1xzr417
\ --tagsKey=Department,Value=Finance
Cette 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 API plus de détails, voir 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-workspaces
exemple 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-workspaces
exemple 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 un système découplé par l'utilisateur WorkSpace
L'
create-workspaces
exemple 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 API plus de détails, voir 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-tags
exemple suivant supprime la balise spécifiée de la balise spécifiée WorkSpace.aws workspaces delete-tags \ --resource-id
ws-dk1xzr417
\ --tag-keysDepartment
Cette 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 API plus de détails, voir 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-directory
exemple suivant annule l'enregistrement du répertoire spécifié.aws workspaces deregister-workspace-directory \ --directory-id
d-926722edaf
Cette 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 API plus de détails, voir 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-tags
exemple suivant décrit les balises pour le paramètre spécifié 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 API plus de détails, voir 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-bundles
exemple 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 \ --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 offres groupées et les images dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-directories
exemple 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": { "EnableWorkDocs": false, "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 WorkSpaces dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-status
exemple suivant décrit l'état de connexion du paramètre spécifié 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.
-
Pour API plus de détails, voir 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-workspaces
exemple 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 API plus de détails, voir 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-workspace
exemple suivant fait migrer le bundle spécifié WorkSpace vers le bundle spécifié.aws workspaces migrate-workspace \ --source-workspace-id
ws-dk1xzr417
\ --bundle-idwsb-j4dky1gs4
Sortie :
{ "SourceWorkspaceId": "ws-dk1xzr417", "TargetWorkspaceId": "ws-x5h1lbkp5" }
Pour plus d'informations, consultez Migrate a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-properties
exemple suivant active laEnableInternetAccess
proprié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-id
d-926722edaf
\ --workspace-creation-propertiesEnableInternetAccess=true
Cette 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 API plus de détails, voir 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-properties
exemple 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-propertiesRunningMode=AUTO_STOP
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez Modifier un WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-state
exemple suivant définit l'état de la valeur spécifiée WorkSpace surADMIN_MAINTENANCE
.aws workspaces modify-workspace-state \ --workspace-id
ws-dk1xzr417
\ --workspace-stateADMIN_MAINTENANCE
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez la section WorkSpace maintenance dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-workspaces
exemple suivant redémarre le fichier spécifié WorkSpace.aws workspaces reboot-workspaces \ --reboot-workspace-requests
ws-dk1xzr417
Sortie :
{ "FailedRequests": [] }
Pour plus d'informations, consultez Reboot a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-workspaces
exemple suivant reconstruit le fichier spécifié WorkSpace.aws workspaces rebuild-workspaces \ --rebuild-workspace-requests
ws-dk1xzr417
Sortie :
{ "FailedRequests": [] }
Pour plus d'informations, consultez Rebuild a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-directory
exemple suivant enregistre le répertoire spécifié pour une utilisation avec Amazon WorkSpaces.aws workspaces register-workspace-directory \ --directory-id
d-926722edaf
\ --no-enable-work-docsCette 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 API plus de détails, voir 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-workspace
exemple suivant restaure le paramètre spécifié WorkSpace.aws workspaces restore-workspace \ --workspace-id
ws-dk1xzr417
Cette commande ne produit aucun résultat.
Pour plus d'informations, consultez Restore a WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-workspaces
exemple suivant démarre le fichier spécifié 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 Stop and start an AutoStop WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-workspaces
exemple 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 Stop and start an AutoStop WorkSpace dans le guide d' WorkSpaces administration Amazon.
-
Pour API plus de détails, voir 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-workspaces
exemple suivant met fin à l'espace de travail spécifié.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 API plus de détails, voir TerminateWorkspaces
la section Référence des AWS CLI commandes.
-