Questa documentazione è valida AWS CLI solo per la versione 1. Per la documentazione relativa alla versione 2 di AWS CLI, consulta la Guida per l'utente della versione 2.
Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
WorkSpaces esempi utilizzando AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface with WorkSpaces.
Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come utilizzarecreate-tags.
- AWS CLI
-
Per aggiungere tag a un WorkSpace
L'
create-tagsesempio seguente aggiunge i tag specificati a quelli specificati WorkSpace.aws workspaces create-tags \ --resource-idws-dk1xzr417\ --tagsKey=Department,Value=FinanceQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta CreateTags AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-workspaces.
- AWS CLI
-
Esempio 1: creare un AlwaysOn WorkSpace
L'
create-workspacesesempio seguente crea un file AlwaysOn WorkSpace per l'utente specificato, utilizzando la directory e il pacchetto specificati.aws workspaces create-workspaces \ --workspacesDirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fcOutput:
{ "FailedRequests": [], "PendingRequests": [ { "WorkspaceId": "ws-kcqms853t", "DirectoryId": "d-926722edaf", "UserName": "Mateo", "State": "PENDING", "BundleId": "wsb-0zsvgp8fc" } ] }Esempio 2: creare un AutoStop WorkSpace
L'
create-workspacesesempio seguente crea un file AutoStop WorkSpace per l'utente specificato, utilizzando la directory e il pacchetto specificati.aws workspaces create-workspaces \ --workspacesDirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}Output:
{ "FailedRequests": [], "PendingRequests": [ { "WorkspaceId": "ws-dk1xzr417", "DirectoryId": "d-926722edaf", "UserName": "Mary", "State": "PENDING", "BundleId": "wsb-0zsvgp8fc" } ] }Esempio 3: creare un file disaccoppiato dall'utente WorkSpace
L'
create-workspacesesempio seguente crea un utente disaccoppiato WorkSpace impostando il nome utente su e specificando un nome[UNDEFINED], un ID di directory e un ID di WorkSpace pacchetto.aws workspaces create-workspaces \ --workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}Output:
{ "FailedRequests": [], "PendingRequests": [ { "WorkspaceId": "ws-abcd1234", "DirectoryId": "d-926722edaf", "UserName": "[UNDEFINED]", "State": "PENDING", "BundleId": "wsb-0zsvgp8fc", "WorkspaceName": "MaryWorkspace1" } ] }Per ulteriori informazioni, consulta Launch a virtual desktop nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta CreateWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-tags.
- AWS CLI
-
Per eliminare un tag da un WorkSpace
L'
delete-tagsesempio seguente elimina il tag specificato dal tag specificato WorkSpace.aws workspaces delete-tags \ --resource-idws-dk1xzr417\ --tag-keysDepartmentQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DeleteTags AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarederegister-workspace-directory.
- AWS CLI
-
Come annullare la registrazione di una directory
L’esempio
deregister-workspace-directoryseguente annulla la registrazione della directory specificata.aws workspaces deregister-workspace-directory \ --directory-idd-926722edafQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Registrare una directory con WorkSpaces nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DeregisterWorkspaceDirectory AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-tags.
- AWS CLI
-
Per descrivere i tag per un WorkSpace
L'
describe-tagsesempio seguente descrive i tag per il valore specificato WorkSpace.aws workspaces describe-tags \ --resource-idws-dk1xzr417Output:
{ "TagList": [ { "Key": "Department", "Value": "Finance" } ] }Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DescribeTags AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-workspace-bundles.
- AWS CLI
-
Come elencare i bundle forniti da Amazon
L'
describe-workspace-bundlesesempio seguente elenca i nomi e IDs i pacchetti forniti da Amazon, in formato tabella e ordinati per nome.aws workspaces describe-workspace-bundles \ --ownerAMAZON\ --query"Bundles[*].[Name, BundleId]"Output:
[ [ "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" ], ... ]Per ulteriori informazioni, consulta i WorkSpaces pacchetti e le immagini nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DescribeWorkspaceBundles AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-workspace-directories.
- AWS CLI
-
Come descrivere una directory registrata
L’esempio
describe-workspace-directoriesseguente descrive la directory registrata specificata.aws workspaces describe-workspace-directories \ --directory-idsd-926722edafOutput:
{ "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" } } ] }Per ulteriori informazioni, consulta Manage directories for WorkSpaces Personal nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DescribeWorkspaceDirectories AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-workspaces-connection-status.
- AWS CLI
-
Per descrivere lo stato della connessione di un WorkSpace
L'
describe-workspaces-connection-statusesempio seguente descrive lo stato della connessione dell'oggetto specificato WorkSpace.aws workspaces describe-workspaces-connection-status \ --workspace-idsws-dk1xzr417Output:
{ "WorkspacesConnectionStatus": [ { "WorkspaceId": "ws-dk1xzr417", "ConnectionState": "CONNECTED", "ConnectionStateCheckTimestamp": 1662526214.744 } ] }Per ulteriori informazioni, consulta Administer your WorkSpaces nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DescribeWorkspacesConnectionStatus AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-workspaces.
- AWS CLI
-
Per descrivere un WorkSpace
L'
describe-workspacesesempio seguente descrive quanto specificato WorkSpace.aws workspaces describe-workspaces \ --workspace-idsws-dk1xzr417Output:
{ "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": [] } ] }Per ulteriori informazioni, consulta Administer your WorkSpaces nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta DescribeWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremigrate-workspace.
- AWS CLI
-
Per migrare un WorkSpace
L'
migrate-workspaceesempio seguente migra il pacchetto specificato nel WorkSpace pacchetto specificato.aws workspaces migrate-workspace \ --source-workspace-idws-dk1xzr417\ --bundle-idwsb-j4dky1gs4Output:
{ "SourceWorkspaceId": "ws-dk1xzr417", "TargetWorkspaceId": "ws-x5h1lbkp5" }Per ulteriori informazioni, consulta Migrate a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta MigrateWorkspace AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremodify-workspace-creation-properties.
- AWS CLI
-
Per modificare una proprietà di WorkSpace creazione di una directory
L’esempio
modify-workspace-creation-propertiesseguente abilita la proprietàEnableInternetAccessper la directory specificata. Ciò consente l'assegnazione automatica degli indirizzi IP pubblici per la directory WorkSpaces creata.aws workspaces modify-workspace-creation-properties \ --resource-idd-926722edaf\ --workspace-creation-propertiesEnableInternetAccess=trueQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta la sezione Update directory details for your WorkSpaces nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta ModifyWorkspaceCreationProperties AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremodify-workspace-properties.
- AWS CLI
-
Per modificare la modalità di esecuzione di un WorkSpace
L'
modify-workspace-propertiesesempio seguente imposta la modalità di esecuzione del file specificato WorkSpace suAUTO_STOP.aws workspaces modify-workspace-properties \ --workspace-idws-dk1xzr417\ --workspace-propertiesRunningMode=AUTO_STOPQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Modify a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta ModifyWorkspaceProperties AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaremodify-workspace-state.
- AWS CLI
-
Per modificare lo stato di un WorkSpace
L'
modify-workspace-stateesempio seguente imposta lo stato del specificato WorkSpace suADMIN_MAINTENANCE.aws workspaces modify-workspace-state \ --workspace-idws-dk1xzr417\ --workspace-stateADMIN_MAINTENANCEQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta la sezione WorkSpace manutenzione nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta ModifyWorkspaceState AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarereboot-workspaces.
- AWS CLI
-
Per riavviare un WorkSpace
L'
reboot-workspacesesempio seguente riavvia il file specificato. WorkSpaceaws workspaces reboot-workspaces \ --reboot-workspace-requestsws-dk1xzr417Output:
{ "FailedRequests": [] }Per ulteriori informazioni, consulta Reboot a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta RebootWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarerebuild-workspaces.
- AWS CLI
-
Per ricostruire un WorkSpace
L'
rebuild-workspacesesempio seguente ricostruisce quanto specificato. WorkSpaceaws workspaces rebuild-workspaces \ --rebuild-workspace-requestsws-dk1xzr417Output:
{ "FailedRequests": [] }Per ulteriori informazioni, consulta Rebuild a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta RebuildWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareregister-workspace-directory.
- AWS CLI
-
Come registrare una directory
L'
register-workspace-directoryesempio seguente registra la directory specificata per l'utilizzo con Amazon WorkSpaces.aws workspaces register-workspace-directory \ --directory-idd-926722edafQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Registrare una AWS directory esistente di Directory Service con WorkSpaces Personal nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta RegisterWorkspaceDirectory AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarerestore-workspace.
- AWS CLI
-
Per ripristinare un WorkSpace
L'
restore-workspaceesempio seguente ripristina il valore specificato WorkSpace.aws workspaces restore-workspace \ --workspace-idws-dk1xzr417Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Restore a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta RestoreWorkspace AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestart-workspaces.
- AWS CLI
-
Per avviare un AutoStop WorkSpace
L'
start-workspacesesempio seguente avvia il valore specificato WorkSpace. WorkSpace Deve avere una modalità di esecuzione diAutoStop.aws workspaces start-workspaces \ --start-workspace-requestsWorkspaceId=ws-dk1xzr417Output:
{ "FailedRequests": [] }Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta StartWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestop-workspaces.
- AWS CLI
-
Per fermare un AutoStop WorkSpace
L'
stop-workspacesesempio seguente interrompe il valore specificato WorkSpace. WorkSpace Deve avere una modalità di esecuzione diAutoStop.aws workspaces stop-workspaces \ --stop-workspace-requestsWorkspaceId=ws-dk1xzr417Output:
{ "FailedRequests": [] }Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta StopWorkspaces AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareterminate-workspaces.
- AWS CLI
-
Per terminare un WorkSpace
L’esempio
terminate-workspacesseguente termina lo spazio di lavoro specificato.aws workspaces terminate-workspaces \ --terminate-workspace-requestsws-dk1xzr417Output:
{ "FailedRequests": [] }Per ulteriori informazioni, consulta Delete a WorkSpace nella Amazon WorkSpaces Administration Guide.
-
Per i dettagli sull'API, consulta TerminateWorkspaces AWS CLI
Command Reference.
-