Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# GetSessionScreenshots
Permet d'obtenir des captures d'écran d'une ou de plusieurs sessions Amazon DCV.
Pour modifier le format de l'image, configurez le `session-screenshot-format` paramètre dans la configuration du Session Manager Broker. Consultez le [fichier de configuration du courtier](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html) dans le *guide de l'administrateur d'Amazon DCV Session Manager*.
Lorsque les `MaxHeight` paramètres `MaxWidth` ou de la `GetSessionScreenshots` demande ne sont pas spécifiés, les `session-screenshot-max-height` valeurs `session-screenshot-max-width` et définies dans le fichier de configuration de Session Manager Broker sont utilisées. Pour modifier ces paramètres, consultez également le [fichier de configuration du courtier](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html) dans le *guide de l'administrateur d'Amazon DCV Session Manager*.
La valeur supérieure de la résolution de capture d'écran est limitée à la résolution de la session à distance. Si les `MaxHeight` paramètres `MaxWidth` et sont définis sur des valeurs supérieures à la résolution de session à distance actuelle, la capture d'écran obtenue sera limitée à la résolution de session réelle.
**Note**
Pour modifier ces valeurs depuis la console d'accès, consultez le [fichier de configuration du client Web](https://docs.aws.amazon.com/dcv/latest/access-console/web-client-config-files.html) dans le *guide de l'administrateur de la console d'accès Amazon DCV*. Pour modifier ces valeurs avec la CLI du gestionnaire de session, consultez `get-session-screenshots` le *guide de la CLI Amazon DCV*.
**Topics**
+ [Paramètres de demande](#request)
+ [Paramètres de réponse](#response)
+ [Exemple](#example)
## Paramètres de demande
**`SessionId`**
ID de la session Amazon DCV à partir de laquelle vous souhaitez obtenir la capture d'écran.
Type : Chaîne
Obligatoire : oui
**`MaxWidth`**
Largeur maximale, en pixels, des captures d'écran de session. Si elles ne sont pas spécifiées, les valeurs de la configuration de Session Manager Broker s'appliqueront. S'il est fourni, il doit s'agir d'un nombre supérieur à 0.
Type : Integer
Obligatoire : non
**`MaxHeight`**
Hauteur maximale, en pixels, des captures d'écran de session. Si elles ne sont pas spécifiées, les valeurs de la configuration de Session Manager Broker s'appliqueront. S'il est fourni, il doit s'agir d'un nombre supérieur à 0.
Type : Integer
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 session Amazon DCV à 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 représente l'écran principal de la session Amazon DCV.
**`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`**
ID de la session Amazon DCV à partir de laquelle la capture d'écran devait être prise.
**`FailureReason`**
Raison de l'échec.
**`GetSessionScreenshotRequestData`**
La demande initiale qui a échoué.
## Exemple
------
#### [ Python ]
**Demande**
L'exemple suivant montre des captures d'écran de deux sessions (`sessionId1`et`sessionId2`) avec une largeur maximale définie à 800 et une hauteur maximale définie à 600. La session `sessionId2` n'existe pas et entraîne un échec.
```
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)
```
**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."
}
]
}
```
------