Anforderungsparameter Antwortparameter Beispiel

CreateSessions

Erstellt eine neue Amazon DCV-Sitzung mit den angegebenen Details.

API-Aktionen

Anforderungsparameter
Antwortparameter
Beispiel

Anforderungsparameter

Name

Der Name für die Sitzung.

Typ: Zeichenfolge

Erforderlich: Ja

Owner

Der Name des Sitzungsbesitzers. Dies muss der Name eines vorhandenen Benutzers auf dem Amazon DCV-Zielserver sein.

Typ: Zeichenfolge

Erforderlich: Ja

Type

Der Sitzungstyp Weitere Informationen zu den Sitzungstypen finden Sie unter Einführung in Amazon DCV-Sitzungen im Amazon DCV-Administratorhandbuch.

Gültige Werte: CONSOLE | VIRTUAL

Typ: Zeichenfolge

Erforderlich: Ja

InitFile

Wird mit virtuellen Sitzungen auf Linux Amazon DCV-Servern unterstützt. Es wird bei Konsolensitzungen auf Windows- und Linux-Amazon-DCV-Servern nicht unterstützt. Der Pfad zum benutzerdefinierten Skript auf dem Amazon DCV-Server, das für die Initialisierung der Sitzung ausgeführt werden soll, wenn sie erstellt wird. Der Dateipfad ist relativ zu dem für den agent.init_folder Agent-Konfigurationsparameter angegebenen Init-Verzeichnis. Wenn sich die Datei im angegebenen Init-Verzeichnis befindet, geben Sie nur den Dateinamen an. Wenn sich die Datei nicht im angegebenen Init-Verzeichnis befindet, geben Sie den relativen Pfad an. Weitere Informationen finden Sie unter Agent-Konfigurationsdatei im Amazon DCV Session Manager-Administratorhandbuch.

Typ: Zeichenfolge

Erforderlich: Nein

MaxConcurrents

Die maximale Anzahl gleichzeitiger Amazon DCV-Clients.

Typ: Ganzzahl

Erforderlich: Nein

DcvGlEnabled

Gibt an, ob die virtuelle Sitzung für die Verwendung von hardwarebasiertem OpenGL konfiguriert ist. Wird nur bei virtuellen Sitzungen unterstützt. Dieser Parameter wird von Windows Amazon DCV-Servern nicht unterstützt.

Zulässige Werte: true | false

Typ: Boolesch

Erforderlich: Nein

PermissionsFile

Der Base64-kodierte Inhalt der Berechtigungsdatei. Standardmäßig die Server-Standardwerte, falls kein Wert angegeben ist. Weitere Informationen finden Sie unter Konfiguration der Amazon DCV-Autorisierung im Amazon DCV-Administratorhandbuch.

Typ: Zeichenfolge

Erforderlich: Nein

EnqueueRequest

Gibt an, ob die Anfrage in die Warteschlange gestellt werden soll, wenn sie nicht sofort bearbeitet werden kann.

Typ: Boolesch

Standard: false

Erforderlich: Nein

AutorunFile

Unterstützt mit Konsolensitzungen auf Windows Amazon DCV-Servern und virtuellen Sitzungen auf Linux-Amazon-DCV-Servern. Es wird bei Konsolensitzungen auf Linux-Amazon-DCV-Servern nicht unterstützt.

Der Pfad zu einer Datei auf dem Host-Server, die innerhalb der Sitzung ausgeführt werden soll. Der Dateipfad ist relativ zu dem Autorun-Verzeichnis, das für den agent.autorun_folder Agent-Konfigurationsparameter angegeben wurde. Wenn sich die Datei im angegebenen Autorun-Verzeichnis befindet, geben Sie nur den Dateinamen an. Wenn sich die Datei nicht im angegebenen Autorun-Verzeichnis befindet, geben Sie den relativen Pfad an. Weitere Informationen finden Sie in der Agent-Konfigurationsdatei im Amazon DCV Session Manager-Administratorhandbuch.

Die Datei wird im Namen des angegebenen Besitzers ausgeführt. Der angegebene Besitzer muss berechtigt sein, die Datei auf dem Server auszuführen. Auf Windows Amazon DCV-Servern wird die Datei ausgeführt, wenn sich der Besitzer bei der Sitzung anmeldet. Auf Linux-Amazon-DCV-Servern wird die Datei ausgeführt, wenn die Sitzung erstellt wird.

Typ: Zeichenfolge

Erforderlich: Nein

AutorunFileArguments

Wird mit virtuellen Sitzungen auf Linux Amazon DCV-Servern unterstützt. Es wird in Konsolensitzungen auf Windows- und Linux-Amazon-DCV-Servern nicht unterstützt. Befehlszeilenargumente, an die AutorunFilebei der Ausführung innerhalb der Sitzung übergeben wurde. Argumente werden in der Reihenfolge übergeben, in der sie im angegebenen Array erscheinen. Die maximal zulässige Anzahl von Argumenten und die maximal zulässige Länge jedes Arguments können konfiguriert werden. Weitere Informationen finden Sie in der Broker-Konfigurationsdatei im Amazon DCV Session Manager-Administratorhandbuch.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

DisableRetryOnFailure

Gibt an, ob die Anfrage zum Erstellen einer Sitzung nicht erneut versucht werden soll, wenn sie auf einem Amazon DCV-Host aus irgendeinem Grund fehlschlägt. Weitere Informationen zum Mechanismus zum Erstellen von Sitzungswiederholungen finden Sie in der Broker-Konfigurationsdatei im Amazon DCV Session Manager-Administratorhandbuch.

Typ: Boolesch

Standard: false

Erforderlich: Nein

Requirements

Die Anforderungen, die der Server erfüllen muss, um die Sitzung durchführen zu können. Die Anforderungen können Server-Tags und and/or Servereigenschaften beinhalten. Sowohl Server-Tags als auch Servereigenschaften werden durch Aufrufen der DescribeServersAPI abgerufen.

Bedingungsausdrücke für Anforderungen:

a! = b wahr, wenn ungleich a ist b
a= b wahr, wenn gleich a ist b
a> b wahr, wenn größer a ist als b
a>= b wahr, wenn a es größer oder gleich ist b
a< b wahr, wenn kleiner a ist als b
a<= b wahr, wenn kleiner oder gleich a ist b
a= b wahr, wenn es die a Zeichenfolge enthält b

Anforderungen boolesche Operatoren:

aund b wahr, wenn a und b wahr sind
aoder b wahr, wenn a oder wahr b sind
nicht a wahr, wenn a es falsch ist

Den Tag-Schlüsseln muss ein Präfix vorangestellt werdentag:, den Servereigenschaften muss ein Präfix vorangestellt werden. server: Die Anforderungsausdrücke unterstützen Klammern. ()

Beispiele für Anforderungen:

tag:color = 'pink' and (server:Host.Os.Family = 'windows' or tag:color := 'red')
"server:Host.Aws.Ec2InstanceType := 't2' and server:Host.CpuInfo.NumberOfCpus >= 2"

Numerische Werte können in exponentieller Notation angegeben werden, zum Beispiel:"server:Host.Memory.TotalBytes > 1024E6".

Die unterstützten Servereigenschaften sind:

Id
Hostname
Version
SessionManagerAgentVersion
Host.Os.BuildNumber
Host.Os.Family
Host.Os.KernelVersion
Host.Os.Name
Host.Os.Version
Host.Memory.TotalBytes
Host.Memory.UsedBytes
Host.Swap.TotalBytes
Host.Swap.UsedBytes
Host.CpuLoadAverage.OneMinute
Host.CpuLoadAverage.FiveMinutes
Host.CpuLoadAverage.FifteenMinutes
Host.Aws.Ec2InstanceId
Host.Aws.Ec2InstanceType
Host.Aws.Region
Host.Aws.Ec2ImageId
Host.CpuInfo.Architecture
Host.CpuInfo.ModelName
Host.CpuInfo.NumberOfCpus
Host.CpuInfo.PhysicalCoresPerCpu
Host.CpuInfo.Vendor

Typ: Zeichenfolge

Erforderlich: Nein

StorageRoot

Gibt den Pfad zu dem Ordner an, der als Speicher für die Sitzung verwendet wird. Weitere Informationen zum Amazon DCV-Sitzungsspeicher finden Sie unter Enabling Session Storage im Amazon DCV-Administratorhandbuch.

Typ: Zeichenfolge

Erforderlich: Nein

Antwortparameter

Id: Die eindeutige ID der Sitzung.
Name: Der Sitzungsname
Owner: Der Besitzer der Sitzung.
Type: Die Art der Sitzung.
State: Der Status der Sitzung. Wenn die Anfrage erfolgreich abgeschlossen wurde, wechselt die Sitzung in den CREATING Status.
Substate: Der Unterstatus der Sitzung. Wenn die Anforderung erfolgreich abgeschlossen wurde, wechselt der Unterstatus in den SESSION_PLACING Unterstatus.

Beispiel

Python

Anforderung

Im folgenden Beispiel werden drei Sitzungen erstellt.



from swagger_client.models.create_session_request_data import CreateSessionRequestData

def get_sessions_api():
    api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def create_sessions(sessions_to_create):
    create_sessions_request = list()
    for name, owner, session_type, init_file_path, autorun_file, autorun_file_arguments, max_concurrent_clients,\
            dcv_gl_enabled, permissions_file, requirements, storage_root in sessions_to_create:
        a_request = CreateSessionRequestData(
            name=name, owner=owner, type=session_type,
            init_file_path=init_file_path, autorun_file=autorun_file, autorun_file_arguments=autorun_file_arguments, max_concurrent_clients=max_concurrent_clients,
            dcv_gl_enabled=dcv_gl_enabled, permissions_file=permissions_file, requirements=requirements, storage_root=storage_root)
        create_sessions_request.append(a_request)

    api_instance = get_sessions_api()
    print('Create Sessions Request:', create_sessions_request)
    api_response = api_instance.create_sessions(body=create_sessions_request)
    print('Create Sessions Response:', api_response)

def main():
    create_sessions([
    ('session1', 'user1', 'CONSOLE', None, None, None, 1, None, '/dcv/permissions.file', "tag:os = 'windows' and server:Host.Memory.TotalBytes > 1024", "/storage/root"),
    ('session2', 'user1', 'VIRTUAL', None, 'myapp.sh', None, 1, False, None, "tag:os = 'linux'", None),
    ('session3', 'user1', 'VIRTUAL', '/dcv/script.sh', 'myapp.sh', ['argument1', 'argument2'], 1, False, None, "tag:os = 'linux'", None),
])

Antwort

Das Folgende ist die Beispielausgabe.


{
              "RequestId": "e32d0b83-25f7-41e7-8c8b-e89326ecc87f",
    "SuccessfulList": [
    {
            "Id": "78b45deb-1163-46b1-879b-7d8fcbe9d9d6",
            "Name": "session1",
            "Owner": "user1",
            "Type": "CONSOLE",
            "State": "CREATING"
    },
    {
            "Id": " a0c743c4-9ff7-43ce-b13f-0c4d55a268dd",
            "Name": "session2",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    },
    {
            "Id": " 10311636-df90-4cd1-bcf7-474e9675b7cd",
            "Name": "session3",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    }
    ],
    "UnsuccessfulList": [
    ]
}

Warnung JavaScript ist in Ihrem Browser nicht verfügbar oder deaktiviert.

Zur Nutzung der AWS-Dokumentation muss JavaScript aktiviert sein. Weitere Informationen finden auf den Hilfe-Seiten Ihres Browsers.

Dokumentkonventionen

CloseServers

DescribeServers