Esempi di WorkSpaces con la AWS CLI - AWS Command Line Interface
Operazioni

Esempi di WorkSpaces con la AWS CLI

Gli esempi di codice seguenti mostrano come eseguire azioni e implementare scenari comuni utilizzando AWS Command Line Interface con WorkSpaces.

Le operazioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le operazioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.

Ogni esempio include un link al codice sorgente completo, dove è possibile trovare le istruzioni su come configurare ed eseguire il codice nel contesto.

Argomenti

Operazioni

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

AWS CLI

Come aggiungere tag a uno spazio di lavoro

Nell’esempio seguente create-tags aggiunge i tag specificati allo spazio di lavoro specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sulle API, consulta CreateTags nel Riferimento ai comandi AWS CLI.

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

AWS CLI

Esempio 1: per creare uno spazio di lavoro AlwaysOn

Nell’esempio seguente create-workspaces crea uno spazio di lavoro AlwaysOn per l’utente specificato utilizzando la directory e il bundle 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 uno spazio di lavoro AutoStop

Nell’esempio seguente create-workspaces crea uno spazio di lavoro AutoStop per l’utente specificato utilizzando la directory e il bundle 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 uno spazio di lavoro disaccoppiato dall’utente

Nell’esempio seguente create-workspaces crea uno spazio di lavoro disaccoppiato dall’utente impostando il nome utente su [UNDEFINED] e specificando un nome, un ID di directory e un ID bundle per lo spazio di lavoro.

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 Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta CreateWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Come eliminare un tag da uno spazio di lavoro

Nell’esempio seguente delete-tags elimina il tag specificato dallo spazio di lavoro specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta DeleteTags in AWS CLI Command Reference.

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

AWS CLI

Annullamento della registrazione di una directory

L’esempio seguente deregister-workspace-directory 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 Registrazione di una directory con WorkSpaces nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Come descrivere i tag per uno spazio di lavoro

Nell’esempio seguente describe-tags descrive i tag per lo spazio di lavoro specificato.

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

Output:

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

Per ulteriori informazioni, consulta Tag WorkSpaces resources nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta DescribeTags in AWS CLI Command Reference.

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

AWS CLI

Come elencare i bundle forniti da Amazon

Nell’esempio seguente describe-workspace-bundles 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 WorkSpaces bundles and images nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Come descrivere una directory registrata

Nell’esempio seguente describe-workspace-directories 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 WorkSpaces Personal nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Come descrivere lo stato della connessione di uno spazio di lavoro

Nell’esempio seguente describe-workspaces-connection-status descrive lo stato di connessione dello spazio di lavoro specificato.

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

Output:

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

Per ulteriori informazioni, consulta Administer your WorkSpaces nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Come descrivere uno spazio di lavoro

Nell’esempio seguente describe-workspaces descrive lo spazio di lavoro specificato.

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 Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta DescribeWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Migrazione di un’istanza WorkSpace

Nell’esempio seguente migrate-workspace migra i WorkSpace specificati nel bundle 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 Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta MigrateWorkspace in AWS CLI Command Reference.

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

AWS CLI

Come modificare una proprietà di creazione dello spazio di lavoro di una directory

Nell’esempio seguente modify-workspace-creation-properties abilita la proprietà EnableInternetAccess per la directory specificata. Ciò consente l’assegnazione automatica di indirizzi IP pubblici per gli spazi di lavoro 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 Update directory details for your WorkSpaces nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Modifica della modalità di esecuzione di un’istanza WorkSpace

Nell’esempio seguente modify-workspace-properties imposta la modalità di esecuzione dello spazio di lavoro specificato su AUTO_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 Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Come modificare lo stato di uno spazio di lavoro

Nell’esempio seguente modify-workspace-state imposta lo stato dello spazio di lavoro specificato su ADMIN_MAINTENANCE.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta WorkSpace maintenance nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta ModifyWorkspaceState in AWS CLI Command Reference.

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

AWS CLI

Riavvio di un’istanza WorkSpace

Nell’esempio seguente reboot-workspaces riavvia lo spazio di lavoro specificato.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Reboot a WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta RebootWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Ricostruzione di un’istanza WorkSpace

Nell’esempio seguente rebuild-workspaces ricompila lo spazio di lavoro specificato.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Rebuild a WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta RebuildWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Registrazione di una directory

Nell’esempio seguente register-workspace-directory registra la directory specificata da utilizzare con Amazon WorkSpaces.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Register an existing AWS Directory Service directory with WorkSpaces Personal nella Guida di amministrazione di Amazon WorkSpaces.

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

AWS CLI

Ripristino di un’istanza WorkSpace

Nell’esempio seguente restore-workspace ripristina lo spazio di lavoro specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta Restore a WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta RestoreWorkspace in AWS CLI Command Reference.

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

AWS CLI

Avvio di un’istanza WorkSpace AutoStop

Nell’esempio seguente start-workspaces avvia lo spazio di lavoro specificato. La modalità di esecuzione dello spazio di lavoro deve essere AutoStop.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta StartWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Arresto di un’istanza WorkSpace AutoStop

Nell’esempio seguente stop-workspaces arresta lo spazio di lavoro specificato. La modalità di esecuzione dello spazio di lavoro deve essere AutoStop.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Stop and start an AutoStop WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta StopWorkspaces in AWS CLI Command Reference.

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

AWS CLI

Come terminare uno spazio di lavoro

Nell’esempio seguente terminate-workspaces termina l’area di lavoro specificata.

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

Output:

{
    "FailedRequests": []
}

Per ulteriori informazioni, consulta Delete a WorkSpace nella Guida di amministrazione di Amazon WorkSpaces.

  • Per informazioni dettagliate sull’API, consulta TerminateWorkspaces in AWS CLI Command Reference.