GetSessionScreenshots - Gerenciador de Sessões do Amazon DCV
Parâmetros de solicitaçãoParâmetros de respostaExemplo

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

GetSessionScreenshots

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

Para modificar o formato da imagem, configure o parâmetro session-screenshot-format na configuração do Agente do Gerenciador de Sessões. Consulte o arquivo de configuração do Agente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

Quando os parâmetros MaxWidth ou MaxHeight da solicitação GetSessionScreenshots não forem especificados, os valores session-screenshot-max-width e session-screenshot-max-height definidos no arquivo de configuração do Agente do Gerenciador de Sessões serão usados. Para modificar esses parâmetros, consulte também o arquivo de configuração do Agente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

O valor superior da resolução da captura de tela é limitado à resolução da sessão remota. Se os parâmetros MaxWidth e MaxHeight forem definidos como valores maiores do que a resolução da sessão remota atual, a captura de tela resultante será limitada à resolução real da sessão.

nota

Para modificar esses valores no console de acesso, consulte o arquivo de configuração do Web Client no Guia do administrador do console de acesso do Amazon DCV. Para modificar esses valores com a CLI do Gerenciador de Sessões, consulte get-session-screenshots no Guia da CLI do Amazon DCV.

Parâmetros de solicitação

SessionId

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

Tipo: string

Obrigatório: Sim

MaxWidth

A largura máxima, em pixels, das capturas de tela da sessão. Se não for especificado, os valores da configuração do Agente do Gerenciador de Sessões serão aplicados. Se fornecido, deve ser um número maior que 0.

Tipo: inteiro

Obrigatório: Não

MaxHeight

A altura máxima, em pixels, das capturas de tela da sessão. Se não for especificado, os valores da configuração do Agente do Gerenciador de Sessões serão aplicados. Se fornecido, deve ser um número maior que 0.

Tipo: inteiro

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 sessão do Amazon DCV da qual a captura de tela foi tirada.

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 sessão do Amazon DCV.

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 sessão do Amazon DCV da qual a captura de tela foi tirada.

FailureReason

O motivo da falha.

GetSessionScreenshotRequestData

A solicitação original que falhou.

Exemplo

Python
Solicitação

O exemplo a seguir obtém capturas de tela de duas sessões (sessionId1 e sessionId2) com a largura máxima definida em 800 e a altura máxima definida em 600. A sessão sessionId2 não existe e resulta em uma falha.

from swagger_client.models.describe_servers_request_data import GetSessionScreenshotRequestData

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, max_width=None, max_height=None):
    request = [GetSessionScreenshotRequestData(session_id=session_id, max_width=max_width, max_height=max_height) 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"]), 800, 600)
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."
        }
    ]
}