WorkSpaces Beispiele mit AWS CLI - AWS SDK-Codebeispiele
Aktionen

Weitere AWS SDK-Beispiele sind im Repo AWS Doc SDK Examples GitHub verfügbar.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

WorkSpaces Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with Aktionen ausführen und allgemeine Szenarien implementieren WorkSpaces.

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

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

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-tags.

AWS CLI

Um Tags zu einem hinzuzufügen WorkSpace

Im folgenden create-tags Beispiel werden die angegebenen Tags zu den angegebenen hinzugefügt WorkSpace.

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 WorkSpaces Tag-Ressourcen im Amazon WorkSpaces Administration Guide.

  • Einzelheiten zur API finden Sie CreateTagsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-workspaces.

AWS CLI

Beispiel 1: Um ein zu erstellen AlwaysOn WorkSpace

Im folgenden create-workspaces Beispiel wird eine AlwaysOn WorkSpace für den angegebenen Benutzer erstellt, wobei das angegebene Verzeichnis und das angegebene Bundle verwendet werden.

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: Um ein zu erstellen AutoStop WorkSpace

Im folgenden create-workspaces Beispiel wird eine AutoStop WorkSpace für den angegebenen Benutzer erstellt, wobei das angegebene Verzeichnis und das angegebene Bundle verwendet werden.

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: Um ein vom Benutzer entkoppeltes Objekt zu erstellen WorkSpace

Im folgenden create-workspaces Beispiel wird eine benutzerentkoppelte Datei erstellt, WorkSpace indem der Benutzername auf gesetzt und ein WorkSpace Name[UNDEFINED], 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 WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie CreateWorkspacesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-tags.

AWS CLI

Um ein Tag aus einem zu löschen WorkSpace

Im folgenden delete-tags Beispiel wird das angegebene Tag aus dem angegebenen WorkSpace Tag 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 WorkSpaces Tag-Ressourcen im Amazon WorkSpaces Administration Guide.

  • Einzelheiten zur API finden Sie DeleteTagsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungderegister-workspace-directory.

AWS CLI

Um die Registrierung eines Verzeichnisses aufzuheben

Im folgenden deregister-workspace-directory Beispiel 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 bei WorkSpaces im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-tags.

AWS CLI

Um die Tags für ein zu beschreiben WorkSpace

Das folgende describe-tags Beispiel beschreibt die Tags für die angegebenen WorkSpace.

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

Ausgabe:

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

Weitere Informationen finden Sie unter WorkSpaces Tag-Ressourcen im Amazon WorkSpaces Administration Guide.

  • Einzelheiten zur API finden Sie DescribeTagsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-workspace-bundles.

AWS CLI

Um die von Amazon bereitgestellten Bundles aufzulisten

Das folgende describe-workspace-bundles Beispiel listet die Namen und die IDs von Amazon bereitgestellten Bundles im Tabellenformat und sortiert nach Namen auf.

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 Bundles und Images im Amazon WorkSpaces Administration Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-workspace-directories.

AWS CLI

Um ein registriertes Verzeichnis zu beschreiben

Das folgende describe-workspace-directories Beispiel beschreibt das angegebene registrierte Verzeichnis.

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 Verzeichnisse für WorkSpaces Personal verwalten im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-workspaces-connection-status.

AWS CLI

Um den Verbindungsstatus eines zu beschreiben WorkSpace

Das folgende describe-workspaces-connection-status Beispiel beschreibt den Verbindungsstatus des angegebenen WorkSpace.

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 Verwaltung Ihres WorkSpaces im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdescribe-workspaces.

AWS CLI

Um einen zu beschreiben WorkSpace

Das folgende describe-workspaces Beispiel beschreibt den angegebenen WorkSpace.

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 Verwaltung Ihres WorkSpaces im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmigrate-workspace.

AWS CLI

Um ein zu migrieren WorkSpace

Im folgenden migrate-workspace Beispiel wird das angegebene Paket WorkSpace zum angegebenen Paket 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 Migrate a WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie MigrateWorkspacein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungmodify-workspace-creation-properties.

AWS CLI

Um eine WorkSpace Erstellungseigenschaft eines Verzeichnisses zu ändern

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

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 Verzeichnisdetails für Sie aktualisieren WorkSpaces im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmodify-workspace-properties.

AWS CLI

Um den Laufmodus eines zu ändern WorkSpace

Im folgenden modify-workspace-properties Beispiel wird der angegebene Laufmodus WorkSpace auf gesetztAUTO_STOP.

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 Modify a WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungmodify-workspace-state.

AWS CLI

Um den Status eines zu ändern WorkSpace

Im folgenden modify-workspace-state Beispiel wird der angegebene Status WorkSpace auf gesetztADMIN_MAINTENANCE.

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 WorkSpace Wartung im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungreboot-workspaces.

AWS CLI

Um einen neu zu starten WorkSpace

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

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Reboot a WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie RebootWorkspacesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungrebuild-workspaces.

AWS CLI

Um einen neu zu erstellen WorkSpace

Im folgenden rebuild-workspaces Beispiel wird das angegebene WorkSpace neu erstellt.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Rebuild a WorkSpace im Amazon WorkSpaces Administration Guide.

Das folgende Codebeispiel zeigt die Verwendungregister-workspace-directory.

AWS CLI

Um ein Verzeichnis zu registrieren

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

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 Directory Service Service-Verzeichnisses bei WorkSpaces Personal im WorkSpaces Amazon-Administratorhandbuch.

Das folgende Codebeispiel zeigt die Verwendungrestore-workspace.

AWS CLI

Um eine wiederherzustellen WorkSpace

Das folgende restore-workspace Beispiel stellt die angegebene Datei wieder her WorkSpace.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Wiederherstellen a WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie RestoreWorkspacein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungstart-workspaces.

AWS CLI

Um ein zu starten AutoStop WorkSpace

Im folgenden start-workspaces Beispiel wird der angegebene gestartet WorkSpace. Der WorkSpace muss den Betriebsmodus habenAutoStop.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Stopp und Start AutoStop WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie StartWorkspacesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungstop-workspaces.

AWS CLI

Um ein zu stoppen AutoStop WorkSpace

Im folgenden stop-workspaces Beispiel wird der angegebene Vorgang beendet WorkSpace. Der WorkSpace muss den Betriebsmodus habenAutoStop.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Stopp und Start AutoStop WorkSpace im WorkSpaces Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie StopWorkspacesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungterminate-workspaces.

AWS CLI

Um einen zu beenden WorkSpace

Das folgende terminate-workspaces Beispiel beendet den angegebenen Workspace.

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

Ausgabe:

{
    "FailedRequests": []
}

Weitere Informationen finden Sie unter Löschen eines WorkSpace im WorkSpaces Amazon-Administratorhandbuch.