Beispiele für WorkSpaces unter Verwendung von AWS CLI - AWS-SDK-Codebeispiele
Aktionen

Weitere AWS-SDK-Beispiele sind im GitHub-Repository Beispiele für AWS Doc SDKs verfügbar.

Beispiele für WorkSpaces unter Verwendung von AWS CLI

Die folgenden Codebeispiele zeigen, wie Sie Aktionen durchführen und gängige Szenarien implementieren, indem Sie AWS Command Line Interface mit WorkSpaces nutzen.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Servicefunktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anweisungen zum Einrichten und Ausführen des Codes im Kodex finden.

Themen

Aktionen

Die folgenden Codebeispiele zeigen, wie create-tags verwendet wird.

AWS CLI

So fügen Sie Tags zu einem WorkSpace hinzu

Im folgenden Beispiel für create-tags wird das angegebene Objekt zum angegebenen WorkSpace hinzugefügt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von WorkSpaces-Ressourcen im Administratorhandbuch für Amazon WorkSpaces.

  • Weitere API-Informationen finden Sie unter CreateTags in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie create-workspaces verwendet wird.

AWS CLI

Beispiel 1: So erstellen Sie einen AlwaysOn-WorkSpace

Im folgenden Beispiel für create-workspaces wird unter Verwendung des angegebenen Verzeichnisses und Pakets ein AlwaysOn-WorkSpace für den angegebenen Benutzer erstellt.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc

Ausgabe:

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

Beispiel 2: So erstellen Sie einen AutoStop-WorkSpace

Im folgenden Beispiel für create-workspaces wird ein AutoStop-WorkSpace für den angegebenen Benutzer unter Verwendung des angegebenen Verzeichnisses und Pakets erstellt.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}

Ausgabe:

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

Beispiel 3: So erstellen Sie einen vom Benutzer entkoppelten WorkSpace

Im folgenden Beispiel für create-workspaces wird ein vom Benutzer entkoppelter WorkSpace erstellt, indem der Benutzername auf [UNDEFINED] festgelegt wird und ein WorkSpace-Name, eine Verzeichnis-ID und eine Bundle-ID angegeben werden.

aws workspaces create-workspaces \
    --workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}

Ausgabe:

{
    "FailedRequests": [],
    "PendingRequests": [
        {
            "WorkspaceId": "ws-abcd1234",
            "DirectoryId": "d-926722edaf",
            "UserName": "[UNDEFINED]",
            "State": "PENDING",
            "BundleId": "wsb-0zsvgp8fc",
            "WorkspaceName": "MaryWorkspace1"
        }
    ]
}

Weitere Informationen finden Sie unter Starten eines virtuellen Desktops im Administrationshandbuch für Amazon WorkSpaces.

  • Weitere API-Informationen finden Sie unter CreateWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie delete-tags verwendet wird.

AWS CLI

So löschen Sie ein Tag aus einem WorkSpace

Im folgenden Beispiel für delete-tags wird das angegebene Tag aus dem spezifizierten WorkSpace gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Markieren von WorkSpaces-Ressourcen im Administratorhandbuch für Amazon WorkSpaces.

  • Weitere API-Informationen finden Sie unter DeleteTags in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie deregister-workspace-directory verwendet wird.

AWS CLI

So melden Sie ein Verzeichnis ab

Im folgenden Beispiel für deregister-workspace-directory wird die Registrierung des angegebenen Verzeichnisses aufgehoben.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Registrieren eines Verzeichnisses mit WorkSpaces im Administratorhandbuch für Amazon WorkSpaces.

Die folgenden Codebeispiele zeigen, wie describe-tags verwendet wird.

AWS CLI

So beschreiben Sie die Tags für einen WorkSpace

Im folgenden Beispiel für describe-tags werden die Tags für den angegebenen WorkSpace beschrieben.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Markieren von WorkSpaces-Ressourcen im Administratorhandbuch für Amazon WorkSpaces.

  • Weitere API-Informationen finden Sie unter DescribeTags in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie describe-workspace-bundles verwendet wird.

AWS CLI

So listen Sie die von Amazon bereitgestellten Bundles auf

Im folgenden Beispiel für describe-workspace-bundles werden die Namen und IDs der von Amazon bereitgestellten Bundles im Tabellenformat aufgelistet und nach Namen sortiert.

aws workspaces describe-workspace-bundles \
    --owner AMAZON \
    --query "Bundles[*].[Name, BundleId]"

Ausgabe:

[
    [
        "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"
    ],
    ...
]

Weitere Informationen finden Sie unter WorkSpaces-Pakete und Abbilder im Administratorhandbuch für Amazon WorkSpaces.

Die folgenden Codebeispiele zeigen, wie describe-workspace-directories verwendet wird.

AWS CLI

So beschreiben Sie ein registriertes Verzeichnis

Im folgenden Beispiel für describe-workspace-directories wird das angegebene registrierte Verzeichnis beschrieben.

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

Ausgabe:

{
    "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"
            }
        }
    ]
}

Weitere Informationen finden Sie unter WorkSpaces Personal-Verzeichnisse verwalten im Administratorhandbuch für Amazon WorkSpaces.

Die folgenden Codebeispiele zeigen, wie describe-workspaces-connection-status verwendet wird.

AWS CLI

So beschreiben Sie den Verbindungsstatus eines WorkSpace

Im folgenden Beispiel für describe-workspaces-connection-status wird der Verbindungsstatus des angegebenen WorkSpace beschrieben.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Verwalten von WorkSpaces im Administratorhandbuch für Amazon WorkSpace.

Die folgenden Codebeispiele zeigen, wie describe-workspaces verwendet wird.

AWS CLI

So beschreiben Sie einen WorkSpace

Im folgenden Beispiel für describe-workspaces wird der angegebene WorkSpace beschrieben.

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

Ausgabe:

{
    "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": []
        }
    ]
}

Weitere Informationen finden Sie unter Verwalten von WorkSpaces im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter DescribeWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie migrate-workspace verwendet wird.

AWS CLI

So migrieren Sie einen WorkSpace

Im folgenden Beispiel für migrate-workspace wird der angegebene WorkSpace in das angegebene Bundle migriert.

aws workspaces migrate-workspace \
    --source-workspace-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

Ausgabe:

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

Weitere Informationen finden Sie unter Migrieren eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter MigrateWorkspace in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie modify-workspace-creation-properties verwendet wird.

AWS CLI

So ändern Sie die WorkSpace-Erstellungseigenschaft eines Verzeichnisses

Im folgenden Beispiel für modify-workspace-creation-properties wird die EnableInternetAccess-Eigenschaft für das angegebene Verzeichnis aktiviert. Dies ermöglicht die automatische Zuweisung von öffentlichen IP-Adressen für die WorkSpaces, die für das Verzeichnis erstellt wurden.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktualisieren von Verzeichnisdetails für Ihre WorkSpaces im Administratorhandbuch für Amazon WorkSpaces.

Die folgenden Codebeispiele zeigen, wie modify-workspace-properties verwendet wird.

AWS CLI

So ändern Sie den Funktionsmodus eines WorkSpaces

Im folgenden Beispiel für modify-workspace-properties wird der Ausführungsmodus des angegebenen WorkSpace auf AUTO_STOP festgelegt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Ändern eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

Die folgenden Codebeispiele zeigen, wie modify-workspace-state verwendet wird.

AWS CLI

So ändern Sie den Status eines WorkSpace

Im folgenden Beispiel für modify-workspace-state wird der Status des angegebenen WorkSpace auf ADMIN_MAINTENANCE gesetzt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Warten von WorkSpace im Administratorhandbuch für Amazon WorkSpace.

Die folgenden Codebeispiele zeigen, wie reboot-workspaces verwendet wird.

AWS CLI

So starten Sie einen WorkSpace neu

Im folgenden Beispiel für reboot-workspaces wird der angegebene WorkSpace neu gestartet.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Neustarten eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter RebootWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie rebuild-workspaces verwendet wird.

AWS CLI

So erstellen Sie einen WorkSpace neu

Im folgenden Beispiel für rebuild-workspaces wird der angegebene WorkSpace neu erstellt.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Neuerstellen eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter RebuildWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie register-workspace-directory verwendet wird.

AWS CLI

So registrieren Sie ein Verzeichnis

Im folgenden Beispiel für register-workspace-directory wird das angegebene Verzeichnis zur Verwendung mit Amazon WorkSpaces registriert.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Registrieren eines vorhandenen AWS-Verzeichnisservice-Verzeichnisses bei WorkSpaces Personal im Administratorhandbuch für Amazon WorkSpaces.

Die folgenden Codebeispiele zeigen, wie restore-workspace verwendet wird.

AWS CLI

So stellen Sie einen WorkSpace wieder her

Im folgenden Beispiel für restore-workspace wird der angegebene WorkSpace gelöst.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Wiederherstellen eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter RestoreWorkspace in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie start-workspaces verwendet wird.

AWS CLI

So starten Sie einen AutoStop-WorkSpace

Im folgenden Beispiel für start-workspaces wird der angegebene WorkSpace gestartet. Der WorkSpace muss den Betriebsmodus AutoStop haben.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Stoppen und Starten eines AutoStop-WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter StartWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie stop-workspaces verwendet wird.

AWS CLI

So beenden Sie einen AutoStop-WorkSpace

Im folgenden Beispiel für stop-workspaces wird der angegebene WorkSpace gestoppt. Der WorkSpace muss den Betriebsmodus AutoStop haben.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Stoppen und Starten eines AutoStop-WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter StopWorkspaces in der AWS CLI-Befehlsreferenz.

Die folgenden Codebeispiele zeigen, wie terminate-workspaces verwendet wird.

AWS CLI

So beenden Sie einen WorkSpace

Im folgenden Beispiel für terminate-workspaces wird der angegebene WorkSpace beendet.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Löschen eines WorkSpace im Administratorhandbuch für Amazon WorkSpace.

  • Weitere API-Informationen finden Sie unter TerminateWorkspaces in der AWS CLI-Befehlsreferenz.