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.
# DescribeSessions
Décrit une ou plusieurs sessions Amazon DCV.
**Topics**
+ [Paramètres de demande](#request)
+ [Paramètres de réponse](#response)
+ [Exemple](#example)
## Paramètres de demande
**`SessionIds`**
Les IDs sessions à décrire.
Type : chaîne
Obligatoire : non
**`NextToken`**
Le jeton à utiliser pour récupérer la page de résultats suivante.
Type : chaîne
Obligatoire : non
**`Filters`**
Filtres supplémentaires à appliquer à la demande. Les filtres pris en charge sont les suivants :
+ tag:key : balises attribuées à la session.
+ Propriétaire : propriétaire de la session.
Type : chaîne
Obligatoire : non
## Paramètres de réponse
**`Id`**
L'identifiant unique de la session.
**`Name`**
Le nom de la session.
**`Owner`**
Le propriétaire de la session.
**`Server`**
Informations sur le serveur sur lequel la session s'exécute. Cette structure de données inclut les paramètres de réponse imbriqués suivants :
**`Ip`**
Adresse IP de l'hôte du serveur Amazon DCV.
**`Hostname`**
Le nom d'hôte de l'hôte du serveur Amazon DCV.
**`Port`**
Port par lequel le serveur Amazon DCV communique avec les clients Amazon DCV.
**`Endpoints`**
Informations sur les points de terminaison du serveur Amazon DCV. Cette structure de données inclut les paramètres de réponse imbriqués suivants :
**`IpAddress`**
Adresse IP du point de terminaison du serveur.
**`Port`**
Port du point de terminaison du serveur.
**`Protocol`**
Protocole utilisé par le point de terminaison du serveur. Les valeurs possibles incluent :
+ `HTTP`— Le point de terminaison utilise le protocole WebSocket (TCP).
+ `QUIC`— Le terminal utilise le protocole QUIC (UDP).
**`WebUrlPath`**
Le chemin de l'URL Web du point de terminaison du serveur. Disponible uniquement pour le protocole HTTP.
**`Tags`**
Les balises attribuées au serveur. Cette structure de données inclut les paramètres de réponse imbriqués suivants :
**`Key`**
Identification de balise.
**`Value`**
Valeur de balise.
**`Type`**
Type de session.
**`State`**
État actuel de la session. Les valeurs possibles sont :
+ `CREATING`- le Broker est en train de créer la session.
+ `READY`- la session est prête à accepter les connexions des clients.
+ `DELETING`- la session est en cours de suppression.
+ `DELETED`- la session a été supprimée.
+ `UNKNOWN`- impossible de déterminer l'état de la session. Le courtier et l'agent peuvent ne pas être en mesure de communiquer.
**`Substate`**
Sous-état actuel de la session. Les valeurs possibles sont :
+ `SESSION_PLACING`- la session attend d'être placée sur un serveur DCV disponible.
+ `PENDING_PREPARATION`- la session est créée mais n'est pas utilisable ; elle est liée à un serveur DCV.
**`CreationTime`**
Date et heure de création de la session.
**`LastDisconnectionTime`**
Date et heure de la dernière déconnexion du client.
**`NumOfConnections`**
Le nombre de connexions client actives.
**`StorageRoot`**
Indique le chemin du dossier utilisé pour le stockage de session. Pour plus d'informations sur le stockage de sessions Amazon DCV, consultez la section [Activation du stockage de session](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) dans le manuel *Amazon DCV Administrator Guide*.
Type : chaîne
Obligatoire : non
## Exemple
------
#### [ Python ]
**Demande**
L'exemple suivant décrit les sessions détenues par `user1` et dotées d'une balise de`os=windows`.
```
from swagger_client.models.describe_sessions_request_data import DescribeSessionsRequestData
from swagger_client.models.key_value_pair import KeyValuePair
def get_sessions_api():
api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
set_request_headers(api_instance.api_client)
return api_instance
def describe_sessions(session_ids=None, next_token=None, tags=None, owner=None):
filters = list()
if tags:
for tag in tags:
filter_key_value_pair = KeyValuePair(key='tag:' + tag['Key'], value=tag['Value'])
filters.append(filter_key_value_pair)
if owner:
filter_key_value_pair = KeyValuePair(key='owner', value=owner)
filters.append(filter_key_value_pair)
request = DescribeSessionsRequestData(session_ids=session_ids, filters=filters, next_token=next_token)
print('Describe Sessions Request:', request)
api_instance = get_sessions_api()
api_response = api_instance.describe_sessions(body=request)
print('Describe Sessions Response', api_response)
def main():
describe_sessions(
owner='user1',
tags=[{'Key': 'os', 'Value': 'windows'}])
```
**Réponse**
Voici un exemple de sortie.
```
{
"Sessions": [
{
"Id": "SessionId1897",
"Name": "a session name",
"Owner": "an owner 1890",
"Server": {
"Ip": "1.1.1.123",
"Hostname": "server hostname",
"Port": "1222",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 9443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "",
"Protocol": "QUIC"
}
],
"Tags": [
{
"Key": "os",
"Value": "windows"
},
{
"Key": "ram",
"Value": "4gb"
}
]
},
"Type": "VIRTUAL",
"State": "READY",
"CreationTime": "2020-10-06T10:15:31.633Z",
"LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
"NumOfConnections": 2,
"StorageRoot" : "/storage/root"
},
{
"Id": "SessionId1895",
"Name": "a session name",
"Owner": "an owner 1890",
"Server": {
"Ip": "1.1.1.123",
"Hostname": "server hostname",
"Port": "1222",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 9443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "",
"Protocol": "QUIC"
}
],
"Tags": [
{
"Key": "os",
"Value": "windows"
},
{
"Key": "ram",
"Value": "4gb"
}
]
},
"Type": "VIRTUAL",
"State": "DELETING",
"CreationTime": "2020-10-06T10:15:31.633Z",
"LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
"NumOfConnections": 2,
"StorageRoot" : "/storage/root"
}
]
}
```
------