DeleteSessions - Amazon DCV-Sitzungsmanager
AnforderungsparameterAntwortparameterBeispiel

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.

DeleteSessions

Löscht die angegebene Amazon DCV-Sitzung und entfernt sie aus dem Cache des Brokers.

Anforderungsparameter

SessionId

Die ID der zu löschenden Sitzung.

Typ: Zeichenfolge

Erforderlich: Ja

Owner

Der Besitzer der zu löschenden Sitzung.

Typ: Zeichenfolge

Erforderlich: Ja

Force

Löscht eine Sitzung aus dem Cache des Brokers und versucht, sie vom Amazon DCV-Server zu löschen. Dies ist nützlich, um veraltete Sitzungen aus dem Cache des Brokers zu entfernen. Wenn beispielsweise ein Amazon DCV-Server gestoppt wurde, die Sitzungen aber immer noch auf dem Broker registriert sind, verwenden Sie dieses Flag, um die Sitzungen aus dem Cache des Brokers zu löschen.

Denken Sie daran, dass die Sitzung, wenn sie noch aktiv ist, vom Broker erneut zwischengespeichert wird.

Zulässige Werte: true | false

Typ: Boolesch

Erforderlich: Nein

Antwortparameter

SessionId

Die ID der Sitzung

State

Wird nur zurückgegeben, wenn die Sitzungen erfolgreich gelöscht wurden. Zeigt den aktuellen Status der Sitzung an. Wenn die Anforderung erfolgreich abgeschlossen wurde, wechselt die Sitzung in den DELETING Status. Es kann einige Minuten dauern, bis die Sitzung gelöscht ist. Nach dem Löschen wechselt der Status von DELETING zuDELETED.

FailureReason

Wird nur zurückgegeben, wenn einige Sitzungen nicht gelöscht werden konnten. Zeigt an, warum die Sitzung nicht gelöscht werden konnte.

Beispiel

Python
Anforderung

Im folgenden Beispiel werden zwei Sitzungen gelöscht — eine Sitzung mit der IDSessionId123, die gehörtuser1, und eine Sitzung mit der ID, SessionIdabc die Eigentümer ist. user99

from swagger_client.models.delete_session_request_data import DeleteSessionRequestData

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 delete_sessions(sessions_to_delete, force=False):
    delete_sessions_request = list()
    for session_id, owner in sessions_to_delete:
        a_request = DeleteSessionRequestData(session_id=session_id, owner=owner, force=force)
        delete_sessions_request.append(a_request)

    print('Delete Sessions Request:', delete_sessions_request)
    api_instance = get_sessions_api()
    api_response = api_instance.delete_sessions(body=delete_sessions_request)
    print('Delete Sessions Response', api_response)

def main():
    delete_sessions([('SessionId123', 'an owner user1'), ('SessionIdabc', 'user99')])
Antwort

Im Folgenden finden Sie ein Beispiel für die Ausgabe. SessionId123wurde erfolgreich gelöscht, SessionIdabc konnte aber nicht gelöscht werden.

{
    "RequestId": "10311636-df90-4cd1-bcf7-474e9675b7cd",
    "SuccessfulList": [
        {
            "SessionId": "SessionId123",
            "State": "DELETING"
        }
    ],
    "UnsuccessfulList": [
        {
            "SessionId": "SessionIdabc",
            "FailureReason": "The requested dcvSession does not exist"
        }
    ]
}