Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Menjelaskan satu atau lebih sesi Amazon DCV.

**Topics**
+ [Permintaan parameter](#request)
+ [Parameter respons](#response)
+ [Contoh](#example)

## Permintaan parameter
<a name="request"></a>

**`SessionIds`**  
 IDs Sesi untuk menggambarkan.   
Tipe: String  
Wajib: Tidak

**`NextToken`**  
Token yang digunakan untuk mengambil halaman hasil berikutnya.  
Tipe: String  
Wajib: Tidak

**`Filters`**  
Filter tambahan untuk diterapkan pada permintaan. Filter yang didukung meliputi:  
+ Tag:kunci—tag yang ditetapkan untuk sesi.
+ Pemilik — pemilik sesi.
Tipe: String  
Wajib: Tidak

## Parameter respons
<a name="response"></a>

**`Id`**  
ID unik sesi.

**`Name`**  
Nama sesi.

**`Owner`**  
Pemilik sesi.

**`Server`**  
Informasi tentang server tempat sesi berjalan. Struktur data ini mencakup parameter respons bersarang berikut:    
**`Ip`**  
Alamat IP dari host server Amazon DCV.  
**`Hostname`**  
Nama host dari host server Amazon DCV.  
**`Port`**  
Port tempat server Amazon DCV berkomunikasi dengan klien Amazon DCV.  
**`Endpoints`**  
Informasi tentang titik akhir server Amazon DCV. Struktur data ini mencakup parameter respons bersarang berikut:    
**`IpAddress`**  
Alamat IP dari titik akhir server.  
**`Port`**  
Port dari endpoint server.  
**`Protocol`**  
Protokol yang digunakan oleh endpoint server. Nilai yang mungkin termasuk:  
+ `HTTP`Endpoint menggunakan protokol WebSocket (TCP).
+ `QUIC`Endpoint menggunakan protokol QUIC (UDP).  
**`WebUrlPath`**  
Jalur URL web dari titik akhir server. Hanya tersedia untuk protokol HTTP.  
**`Tags`**  
Tag yang ditetapkan ke server. Struktur data ini mencakup parameter respons bersarang berikut:    
**`Key`**  
Kunci tanda.  
**`Value`**  
Nilai tanda.

**`Type`**  
Jenis sesi.

**`State`**  
Keadaan sesi saat ini. Kemungkinan nilainya adalah:  
+ `CREATING`- Broker sedang dalam proses membuat sesi.
+ `READY`- sesi siap menerima koneksi klien.
+ `DELETING`- sesi sedang dihapus.
+ `DELETED`- sesi telah dihapus.
+ `UNKNOWN`- tidak dapat menentukan status sesi. Broker dan Agen mungkin tidak dapat berkomunikasi.

**`Substate`**  
Substate sesi saat ini. Kemungkinan nilainya adalah:  
+ `SESSION_PLACING`- sesi menunggu untuk ditempatkan pada Server DCV yang tersedia.
+ `PENDING_PREPARATION`- sesi dibuat tetapi tidak dapat digunakan; ditautkan ke Server DCV.

**`CreationTime`**  
Tanggal dan waktu sesi dibuat.

**`LastDisconnectionTime`**  
Tanggal dan waktu pemutusan klien terakhir.

**`NumOfConnections`**  
Jumlah koneksi klien aktif.

**`StorageRoot`**  
Menentukan path ke folder yang digunakan untuk penyimpanan sesi. Untuk informasi selengkapnya tentang penyimpanan sesi Amazon DCV, lihat [Mengaktifkan Penyimpanan Sesi di Panduan](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) Administrator *Amazon DCV*.  
Tipe: String  
Wajib: Tidak

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

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

**Permintaan**  
Contoh berikut menjelaskan sesi yang dimiliki oleh `user1` dan memiliki tag`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'}])
```

**Respons**  
Berikut ini adalah output sampel.

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

------