View a markdown version of this page

WorkSpaces esempi di utilizzo AWS CLI - AWS Esempi di codice SDK
Azioni

Sono disponibili altri esempi di AWS SDK nel repository AWS Doc SDK Examples. GitHub

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 di utilizzo 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

L’esempio di codice seguente mostra come utilizzare create-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-id ws-dk1xzr417 \
    --tags Key=Department,Value=Finance

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta WorkSpaces le risorse relative ai tag nella Amazon WorkSpaces Administration Guide.

  • Per i dettagli sulle API, consulta CreateTags AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare create-workspaces.

AWS CLI

Esempio 1: Per 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 \
    --workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc

Output:

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

Esempio 2: Per 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 \
    --workspaces DirectoryId=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: Per creare un utente disaccoppiato WorkSpace

L'create-workspacesesempio seguente crea un utente disaccoppiato impostando il nome utente su e WorkSpace specificando un nome[UNDEFINED], un ID di directory e un ID di WorkSpace bundle.

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 Administration Guide. WorkSpaces

L’esempio di codice seguente mostra come utilizzare delete-tags.

AWS CLI

Per eliminare un tag da un WorkSpace

L'delete-tagsesempio seguente elimina il tag specificato da quello specificato WorkSpace.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta le WorkSpaces risorse relative ai tag nella Amazon WorkSpaces Administration Guide.

  • Per i dettagli sulle API, consulta DeleteTags AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare deregister-workspace-directory.

AWS CLI

Come annullare la registrazione di una directory

L’esempio deregister-workspace-directory seguente annulla la registrazione della directory specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Register a directory with nella Amazon Administration Guide. WorkSpaces WorkSpaces

L’esempio di codice seguente mostra come utilizzare describe-tags.

AWS CLI

Per descrivere i tag di a WorkSpace

L'describe-tagsesempio seguente descrive i tag per il file specificato WorkSpace.

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

Output:

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

Per ulteriori informazioni, consulta WorkSpaces le risorse relative ai tag nella Amazon WorkSpaces Administration Guide.

  • Per i dettagli sulle API, consulta DescribeTags AWS CLI Command Reference.

L’esempio di codice seguente mostra come utilizzare describe-workspace-bundles.

AWS CLI

Come elencare i bundle forniti da Amazon

L’esempio describe-workspace-bundles seguente elenca i nomi e gli ID dei bundle forniti da Amazon, in formato tabella e ordinati per nome.

aws workspaces describe-workspace-bundles \
    --owner AMAZON \
    --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 Administration Guide. WorkSpaces

L’esempio di codice seguente mostra come utilizzare describe-workspace-directories.

AWS CLI

Come descrivere una directory registrata

L’esempio describe-workspace-directories seguente descrive la directory registrata specificata.

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

Output:

{
    "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 Personal nella Amazon Administration Guide. WorkSpaces WorkSpaces

L’esempio di codice seguente mostra come utilizzare describe-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 del dispositivo specificato WorkSpace.

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

Output:

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

Per ulteriori informazioni, consulta Administration your WorkSpaces nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare describe-workspaces.

AWS CLI

Per descrivere un WorkSpace

L'describe-workspacesesempio seguente descrive il valore specificato WorkSpace.

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

Output:

{
    "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.

L’esempio di codice seguente mostra come utilizzare migrate-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-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

Output:

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

Per ulteriori informazioni, consulta Migrate a WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare modify-workspace-creation-properties.

AWS CLI

Per modificare una proprietà di creazione di una directory WorkSpace

L’esempio modify-workspace-creation-properties seguente abilita la proprietà EnableInternetAccess per la directory specificata. Ciò consente l'assegnazione automatica degli indirizzi IP pubblici a quelli WorkSpaces creati per la directory.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Aggiornare i dettagli della tua directory WorkSpaces nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare modify-workspace-properties.

AWS CLI

Per modificare la modalità di esecuzione di un WorkSpace

L'modify-workspace-propertiesesempio seguente imposta la modalità di esecuzione di quella specificata WorkSpace suAUTO_STOP.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Modify a WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare modify-workspace-state.

AWS CLI

Per modificare lo stato di un WorkSpace

L'modify-workspace-stateesempio seguente imposta lo stato del valore specificato WorkSpace suADMIN_MAINTENANCE.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta la WorkSpace manutenzione nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare reboot-workspaces.

AWS CLI

Per riavviare un WorkSpace

L'reboot-workspacesesempio seguente riavvia il file specificato. WorkSpace

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Reboot a WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare rebuild-workspaces.

AWS CLI

Per ricostruire un WorkSpace

L'rebuild-workspacesesempio seguente ricostruisce il valore specificato. WorkSpace

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Rebuild a WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare register-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-id d-926722edaf

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Registrare una AWS directory Directory Service esistente con WorkSpaces Personal nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare restore-workspace.

AWS CLI

Per ripristinare un WorkSpace

L'restore-workspaceesempio seguente ripristina il valore specificato WorkSpace.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Restore a WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare start-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-requests WorkspaceId=ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare stop-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-requests WorkspaceId=ws-dk1xzr417

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Amazon WorkSpaces Administration Guide.

L’esempio di codice seguente mostra come utilizzare terminate-workspaces.

AWS CLI

Per terminare un WorkSpace

L’esempio terminate-workspaces seguente termina lo spazio di lavoro specificato.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Delete a WorkSpace nella Amazon WorkSpaces Administration Guide.