Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# GetSessionScreenshots
<a name="GetSessionScreenshots"></a>

Obtiene capturas de pantalla de una o varias sesiones de Amazon DCV.

Para modificar el formato de la imagen, configure el parámetro `session-screenshot-format` en la configuración del agente de Session Manager. Para obtener más información, consulte [Archivo de configuración del agente](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html) en la *Guía del administrador de Amazon DCV Session Manager*.

Si no se especifican los parámetros `MaxWidth` o `MaxHeight` de la solicitud `GetSessionScreenshots`, se utilizarán los valores `session-screenshot-max-width` y `session-screenshot-max-height` establecidos en el archivo de configuración del agente de Session Manager. Para obtener más información, consulte [Archivo de configuración del agente](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html) en la *Guía del administrador de Amazon DCV Session Manager*.

El valor superior de la resolución de la captura de pantalla se limita a la resolución de la sesión remota. Si los parámetros `MaxWidth` y `MaxHeight` se establecen en valores superiores a la resolución de la sesión remota actual, la captura de pantalla resultante se limitará a la resolución de la sesión real.

**nota**  
Para modificar estos valores desde la consola de acceso, consulte el [archivo de configuración del cliente web](https://docs.aws.amazon.com/dcv/latest/access-console/web-client-config-files.html) en la *Guía del administrador de la consola de acceso de Amazon DCV*. Para modificar estos valores con la CLI de Session Manager, consulte `get-session-screenshots` en la *guía de la CLI de Amazon DCV*.

**Topics**
+ [Parámetros de solicitud](#request)
+ [Parámetros de respuesta](#response)
+ [Ejemplo](#example)

## Parámetros de solicitud
<a name="request"></a>

**`SessionId`**  
ID de la sesión de Amazon DCV de la que se obtiene la captura de pantalla.  
Tipo: cadena  
Obligatorio: sí

**`MaxWidth`**  
El ancho máximo, en píxeles, de las capturas de pantalla de las sesiones. Si no se especifica, se aplicarán los valores de la configuración del agente de Session Manager. Si se proporciona, debe ser un número superior a 0.   
Tipo: entero  
Obligatorio: no

**`MaxHeight`**  
La altura máxima, en píxeles, de las capturas de pantalla de las sesiones. Si no se especifica, se aplicarán los valores de la configuración del agente de Session Manager. Si se proporciona, debe ser un número superior a 0.  
Tipo: entero  
Obligatorio: sí

## Parámetros de respuesta
<a name="response"></a>

**`RequestId`**  
ID único de la solicitud.

**`SuccessfulList`**  
Información sobre las capturas de pantalla correctas. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:    
**`SessionScreenshot`**  
Información sobre las capturas de pantalla. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:    
**`SessionId`**  
ID de la sesión de Amazon DCV desde la que se tomó la captura de pantalla.  
**`Images`**  
Información acerca de las imágenes. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:    
**`Format`**  
Formato de los datos. Los valores posibles son: `jpeg` y `png`.  
**`Data`**  
La imagen de captura de pantalla está codificada en formato base64.  
**`CreationTime`**  
Fecha y hora en que se realizó la captura de pantalla.  
**`Primary`**  
Indica si la captura de pantalla es de la pantalla principal de la sesión de Amazon DCV.

**`UnsuccessfulList`**  
Información sobre las capturas de pantalla incorrectas. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:    
**`GetSesionScreenshotRequestData`**  
Solicitud original que falló.    
**`SessionId`**  
ID de la sesión de Amazon DCV desde la que se tomó la captura de pantalla.  
**`FailureReason`**  
El motivo del error.

**`GetSessionScreenshotRequestData`**  
Solicitud original que falló.

## Ejemplo
<a name="example"></a>

------
#### [ Python ]

**Solicitud**  
En el siguiente ejemplo, se obtienen capturas de pantalla de dos sesiones (`sessionId1` y `sessionId2`) con el ancho máximo establecido en 800 y la altura máxima en 600. El servidor `sessionId2` no existe y se produce un error.

```
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)
```

**Respuesta**  
A continuación se muestra la salida de ejemplo.

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

------