GetSessionScreenshots

Obtém capturas de tela de uma ou mais DCV sessões da Amazon.

O tipo de arquivo de imagem e a resolução da captura de tela dependem da configuração do Agente do Gerenciador de Sessões. Para modificar o tipo de arquivo de imagem, configure o parâmetro session-screenshot-format. Para modificar a resolução, configure os parâmetros session-screenshot-max-width e session-screenshot-max-height. Para obter mais informações, consulte o arquivo de configuração do agente no Guia do administrador do Amazon DCV Session Manager.

Parâmetros de solicitação

SessionId

O ID da DCV sessão da Amazon da qual obter a captura de tela.

Tipo: string

Obrigatório: Sim

Parâmetros de resposta

RequestId

O ID exclusivo da solicitação.

SuccessfulList

Informações sobre as capturas de tela bem-sucedidas. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

SessionScreenshot

Informações sobre as capturas de tela. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

SessionId

O ID da DCV sessão da Amazon da qual a captura de tela foi feita.

Images

Informações sobre as imagens. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

Format

O formato da imagem. Os valores possíveis incluem: jpeg e png.

Data

O formato codificado em base64 da imagem da captura de tela.

CreationTime

A data e a hora em que a captura de tela foi tirada.

Primary

Indica se a captura de tela é da tela principal da DCV sessão da Amazon.

UnsuccessfulList

Informações sobre as capturas de tela malsucedidas. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:

GetSesionScreenshotRequestData

A solicitação original que falhou.

SessionId

O ID da DCV sessão da Amazon da qual a captura de tela deveria ser feita.

FailureReason

O motivo da falha.

Exemplo

Python

Solicitação

O exemplo a seguir obtém capturas de tela de duas sessões (sessionId1 e sessionId2). A sessão sessionId2 não existe e resulta em uma falha.

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"])

Resposta

Esta é uma saída de exemplo.

{
    "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."
        }
    ]
}