Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# DescribeSessions
Describe una o varias sesiones de Amazon DCV.
**Topics**
+ [Parámetros de solicitud](#request)
+ [Parámetros de respuesta](#response)
+ [Ejemplo](#example)
## Parámetros de solicitud
**`SessionIds`**
La IDs de las sesiones a describir.
Tipo: cadena
Requerido: no
**`NextToken`**
Token que se utilizará para recuperar la siguiente página de resultados.
Tipo: cadena
Requerido: no
**`Filters`**
Filtros adicionales para aplicar a la solicitud. Los filtros compatibles son:
+ tag:key: etiquetas asignadas a la sesión.
+ owner: propietario de la sesión.
Tipo: cadena
Requerido: no
## Parámetros de respuesta
**`Id`**
ID exclusivo de la sesión.
**`Name`**
Nombre de la sesión.
**`Owner`**
Nombre del propietario de la sesión.
**`Server`**
Información sobre el servidor en el que se ejecuta la sesión. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:
**`Ip`**
Dirección IP del host del servidor Amazon DCV.
**`Hostname`**
Nombre del host del servidor Amazon DCV.
**`Port`**
Puerto a través del cual el servidor Amazon DCV se comunica con clientes Amazon DCV.
**`Endpoints`**
Información sobre los puntos de conexión del servidor Amazon DCV. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:
**`IpAddress`**
Dirección IP del punto de conexión del servidor.
**`Port`**
Puerto del punto de conexión del servidor.
**`Protocol`**
Protocolo utilizado por el punto de conexión del servidor. Los valores posibles son:
+ `HTTP`— El punto final utiliza el protocolo WebSocket (TCP).
+ `QUIC`: el punto de conexión utiliza el protocolo QUIC (UDP).
**`WebUrlPath`**
La ruta URL web del punto de conexión del servidor. Disponible solo para el protocolo HTTP.
**`Tags`**
Etiquetas asignadas al servicio. Esta estructura de datos incluye los siguientes parámetros de respuesta anidados:
**`Key`**
La clave de la etiqueta.
**`Value`**
El valor de la etiqueta.
**`Type`**
Tipo de sesión.
**`State`**
Estado actual de la sesión. Los valores posibles son los que se indican a continuación.
+ `CREATING`: el broker está creando la sesión.
+ `READY`: la sesión está lista para aceptar conexiones de clientes.
+ `DELETING`: se está eliminando la sesión.
+ `DELETED`: se ha eliminado la sesión.
+ `UNKNOWN`: no se puede determinar el estado de la sesión. Es posible que el agente y el broker no puedan comunicarse.
**`Substate`**
Subestado actual de la sesión. Los valores posibles son los que se indican a continuación.
+ `SESSION_PLACING`: la sesión está esperando a ser colocada en un servidor DCV disponible.
+ `PENDING_PREPARATION`: la sesión se ha creado pero no se puede utilizar; está vinculada a un servidor DCV.
**`CreationTime`**
Fecha y hora en que se creó la sesión.
**`LastDisconnectionTime`**
Fecha y hora de la última desconexión del cliente.
**`NumOfConnections`**
Número de conexiones de cliente activas.
**`StorageRoot`**
Especifica la ruta a la carpeta usada para el almacenamiento de sesión. Para obtener más información sobre el almacenamiento de sesiones de Amazon DCV, consulte [Habilitación de almacenamiento de sesión](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html) en la *Guía del administrador de Amazon DCV*.
Tipo: cadena
Requerido: no
## Ejemplo
------
#### [ Python ]
**Solicitud**
El siguiente ejemplo describe las sesiones que son propiedad de `user1` y tienen una etiqueta 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'}])
```
**Respuesta**
A continuación se muestra la salida de ejemplo.
```
{
"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"
}
]
}
```
------