As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# DescribeSessions
Descreve uma ou mais sessões do Amazon DCV.
**Topics**
+ [Parâmetros de solicitação](#request)
+ [Parâmetros de resposta](#response)
+ [Exemplo](#example)
## Parâmetros de solicitação
**`SessionIds`**
A IDs das sessões a serem descritas.
Tipo: string
Obrigatório: não
**`NextToken`**
O token a ser usado para recuperar da próxima página de resultados.
Tipo: string
Obrigatório: não
**`Filters`**
Filtros adicionais a serem aplicados à solicitação. Os filtros compatíveis incluem:
+ tag:key — As tags atribuídas à sessão.
+ owner — O proprietário da sessão.
Tipo: string
Obrigatório: não
## Parâmetros de resposta
**`Id`**
O ID exclusivo da sessão.
**`Name`**
O nome da sessão.
**`Owner`**
O proprietário da sessão.
**`Server`**
Informações sobre o servidor no qual a sessão está sendo executada. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:
**`Ip`**
O endereço IP ou o nome do host do servidor Amazon DCV.
**`Hostname`**
O nome do host do host do servidor Amazon DCV.
**`Port`**
A porta pela qual o servidor Amazon DCV se comunica com os clientes do Amazon DCV.
**`Endpoints`**
Informações sobre os endpoints do servidor Amazon DCV. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:
**`IpAddress`**
O endereço IP do endpoint do servidor.
**`Port`**
A porta do endpoint do servidor.
**`Protocol`**
O protocolo usado pelo endpoint do servidor. Os possíveis valores incluem:
+ `HTTP`— O endpoint usa o protocolo WebSocket (TCP).
+ `QUIC` — O endpoint usa o protocolo QUIC (UDP).
**`WebUrlPath`**
O caminho do URL da web do endpoint do servidor. Disponível somente para o protocolo HTTP.
**`Tags`**
As tags atribuídas ao servidor. Essa estrutura de dados inclui os seguintes parâmetros de resposta aninhada:
**`Key`**
A chave de tags.
**`Value`**
O valor da tag.
**`Type`**
O tipo de sessão.
**`State`**
O estado atual da sessão. Os valores possíveis são:
+ `CREATING` - o Agente está criando a sessão.
+ `READY` - a sessão está pronta para aceitar conexões de clientes.
+ `DELETING` - a sessão está sendo excluída.
+ `DELETED` - a sessão foi excluída.
+ `UNKNOWN` - incapaz de determinar o estado da sessão. O Agente e o Atendente podem não conseguir se comunicar.
**`Substate`**
O subestado atual da sessão. Os valores possíveis são:
+ `SESSION_PLACING` - a sessão está esperando para ser colocada em um servidor DCV disponível.
+ `PENDING_PREPARATION` - a sessão foi criada, mas não pode ser usada; vinculada a um servidor DCV.
**`CreationTime`**
A data e a hora em que a sessão foi criada.
**`LastDisconnectionTime`**
A data e a hora da última desconexão do cliente.
**`NumOfConnections`**
O número de conexões de cliente ativas.
**`StorageRoot`**
Especifica o caminho para a pasta a ser usada para armazenamento de sessão. Para obter mais informações sobre o armazenamento de sessão do Amazon DCV, consulte [Ativar o armazenamento de sessão](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) no *Guia do administrador do Amazon DCV*.
Tipo: string
Obrigatório: não
## Exemplo
------
#### [ Python ]
**Solicitação**
O exemplo a seguir descreve sessões que são de propriedade de `user1` e têm uma tag 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'}])
```
**Resposta**
Esta é uma saída de exemplo.
```
{
"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"
}
]
}
```
------