DeleteSessions

Supprime la session Amazon DCV spécifiée et la retire du cache du courtier.

Paramètres de demande

SessionId

ID de la session à supprimer.

Type : String

Obligatoire : oui

Owner

Le propriétaire de la session à supprimer.

Type : String

Obligatoire : oui

Force

Supprime une session du cache du courtier en tentant de la supprimer du serveur Amazon DCV. Cela est utile pour supprimer les sessions obsolètes du cache du broker. Par exemple, si un serveur Amazon DCV a été arrêté, mais que les sessions sont toujours enregistrées sur le Broker, utilisez cet indicateur pour purger les sessions du cache du Broker.

N'oubliez pas que si la session est toujours active, elle est à nouveau mise en cache par le courtier.

Valeurs valides : true | false

Type : booléen

Obligatoire : non

Paramètres de réponse

SessionId

L'ID de la session

State

Renvoyé uniquement si les sessions ont été correctement supprimées. Indique l'état actuel de la session. Si la demande aboutit, la session passe à l'DELETINGétat actuel. La suppression de la session peut prendre quelques minutes. Lorsqu'il a été supprimé, l'état passe de DELETING àDELETED.

FailureReason

Renvoyé uniquement si certaines sessions n'ont pas pu être supprimées. Indique pourquoi la session n'a pas pu être supprimée.

exemple

Python

Demande

L'exemple suivant supprime deux sessions : une session dont l'SessionId123identifiant appartient à et une session dont l'SessionIdabcidentifiant appartient à. user1 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')])

Réponse

Voici un exemple de sortie. SessionId123a été correctement supprimé, mais n'SessionIdabca pas pu être supprimé.

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