GetSessionScreenshots

Permet d'obtenir des captures d'écran d'une ou de plusieurs DCV sessions Amazon.

Le type de fichier image et la résolution de la capture d'écran dépendent de la configuration de Session Manager Broker. Pour modifier le type de fichier image, configurez le session-screenshot-format paramètre. Pour modifier la résolution, configurez les session-screenshot-max-height paramètres session-screenshot-max-width et. Pour plus d'informations, consultez le fichier de configuration du courtier dans le guide de l'administrateur d'Amazon DCV Session Manager.

Paramètres de demande

SessionId

L'ID de la DCV session Amazon à partir de laquelle vous souhaitez obtenir la capture d'écran.

Type : String

Obligatoire : oui

Paramètres de réponse

RequestId

L'identifiant unique de la demande.

SuccessfulList

Informations sur les captures d'écran réussies. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

SessionScreenshot

Informations sur les captures d'écran. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

SessionId

ID de la DCV session Amazon à partir de laquelle la capture d'écran a été prise.

Images

Informations sur les images. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

Format

Format de l'image. Les valeurs possibles incluent jpeg et png.

Data

Le format codé base64 de l'image de capture d'écran.

CreationTime

Date et heure auxquelles la capture d'écran a été prise.

Primary

Indique si la capture d'écran est celle de l'écran principal de la DCV session Amazon.

UnsuccessfulList

Informations sur les captures d'écran infructueuses. Cette structure de données inclut les paramètres de réponse imbriqués suivants :

GetSesionScreenshotRequestData

La demande initiale qui a échoué.

SessionId

L'ID de la DCV session Amazon à partir de laquelle la capture d'écran devait être prise.

FailureReason

Raison de l'échec.

Exemple

Python

Demande

L'exemple suivant obtient des captures d'écran de deux sessions (sessionId1etsessionId2). La session sessionId2 n'existe pas et entraîne un échec.

from swagger_client.models.describe_servers_request_data import DescribeServersRequestData

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

def get_session_screenshots(session_ids):
    request = [GetSessionScreenshotRequestData(session_id=session_id) for session_id in session_ids]
    print('Get Session Screenshots Request:', request)
    api_instance = get_sessions_api()
    api_response = api_instance.get_session_screenshots(body=request)
    print('Get Session Screenshots Response:', api_response)

def main():
    get_session_screenshots(["sessionId1", "sessionId2"])

Réponse

Voici un exemple de sortie.

{
    "RequestId": "542735ef-f6ab-47d8-90e5-23df31d8d166",
    "SuccessfulList": [
        {
            "SessionScreenshot": {
                "SessionId": "sessionId1",
                "Images": [
                    {
                        "Format": "png",
                        "Data": "iVBORw0KGgoAAAANSUhEUgAAAEXAMPLE",
                        "CreationTime": "2021-03-30T15:47:06.822Z",
                        "Primary": true
                    }
                ]
            }
        }
    ],
    "UnsuccessfulList": [
        {
            "GetSessionScreenshotRequestData": {
                "SessionId": "sessionId2"
            },
            "FailureReason": "Dcv session not found."
        }
    ]
}