Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Beschreibt eine oder mehrere Amazon DCV-Sitzungen.

**Topics**
+ [Anforderungsparameter](#request)
+ [Antwortparameter](#response)
+ [Beispiel](#example)

## Anforderungsparameter
<a name="request"></a>

**`SessionIds`**  
Die IDs zu beschreibende Sitzung.   
Typ: Zeichenfolge  
Erforderlich: Nein

**`NextToken`**  
Das Token, das zum Abrufen der nächsten Ergebnisseite verwendet werden soll.  
Typ: Zeichenfolge  
Erforderlich: Nein

**`Filters`**  
Zusätzliche Filter, die auf die Anfrage angewendet werden sollen. Zu den unterstützten Filtern gehören:  
+ tag:key — Die der Sitzung zugewiesenen Tags.
+ Besitzer — Der Besitzer der Sitzung.
Typ: Zeichenfolge  
Erforderlich: Nein

## Antwortparameter
<a name="response"></a>

**`Id`**  
Die eindeutige ID der Sitzung.

**`Name`**  
Der Name der Sitzung.

**`Owner`**  
Der Besitzer der Sitzung.

**`Server`**  
Informationen über den Server, auf dem die Sitzung läuft. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`Ip`**  
Die IP-Adresse des Amazon DCV-Serverhosts.  
**`Hostname`**  
Der Hostname des Amazon DCV-Serverhosts.  
**`Port`**  
Der Port, über den der Amazon DCV-Server mit Amazon DCV-Clients kommuniziert.  
**`Endpoints`**  
Informationen zu den Amazon DCV-Serverendpunkten. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`IpAddress`**  
Die IP-Adresse des Serverendpunkts.  
**`Port`**  
Der Port des Serverendpunkts.  
**`Protocol`**  
Das vom Serverendpunkt verwendete Protokoll. Mögliche Werte sind:  
+ `HTTP`— Der Endpunkt verwendet das WebSocket (TCP-) Protokoll.
+ `QUIC`— Der Endpunkt verwendet das QUIC-Protokoll (UDP).  
**`WebUrlPath`**  
Der Web-URL-Pfad des Serverendpunkts. Nur für das HTTP-Protokoll verfügbar.  
**`Tags`**  
Die dem Server zugewiesenen Tags. Diese Datenstruktur umfasst die folgenden verschachtelten Antwortparameter:    
**`Key`**  
Der Tag-Schlüssel.  
**`Value`**  
Der Tag-Wert.

**`Type`**  
Die Art der Sitzung.

**`State`**  
Der aktuelle Status der Sitzung. Die möglichen Werte sind:  
+ `CREATING`- Der Broker ist dabei, die Sitzung zu erstellen.
+ `READY`- Die Sitzung ist bereit, Client-Verbindungen anzunehmen.
+ `DELETING`- Die Sitzung wird gelöscht.
+ `DELETED`- Die Sitzung wurde gelöscht.
+ `UNKNOWN`- Der Status der Sitzung konnte nicht ermittelt werden. Der Broker und der Agent können möglicherweise nicht kommunizieren.

**`Substate`**  
Der aktuelle Unterstatus der Sitzung. Die möglichen Werte sind:  
+ `SESSION_PLACING`- Die Sitzung wartet darauf, auf einem verfügbaren DCV-Server platziert zu werden.
+ `PENDING_PREPARATION`- Die Sitzung wurde erstellt, kann aber nicht verwendet werden. Sie ist mit einem DCV-Server verknüpft.

**`CreationTime`**  
Datum und Uhrzeit der Erstellung der Sitzung.

**`LastDisconnectionTime`**  
Datum und Uhrzeit der letzten Verbindungsunterbrechung des Clients.

**`NumOfConnections`**  
Die Anzahl der aktiven Client-Verbindungen.

**`StorageRoot`**  
Gibt den Pfad zu dem Ordner an, der als Speicher für die Sitzung verwendet wird. Weitere Informationen zum Amazon DCV-Sitzungsspeicher finden Sie unter [Enabling Session Storage](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) im *Amazon DCV-Administratorhandbuch*.  
Typ: Zeichenfolge  
Erforderlich: Nein

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

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

**Anforderung**  
Das folgende Beispiel beschreibt Sitzungen, die Eigentum von sind `user1` und das Tag von haben. `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'}])
```

**Antwort**  
Im Folgenden finden Sie ein Beispiel für die Ausgabe.

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

------