Parámetros de solicitud Parámetros de respuesta Ejemplo

CreateSessions

Crea una nueva sesión de Amazon DCV con los detalles especificados.

acciones de API

Parámetros de solicitud
Parámetros de respuesta
Ejemplo

Parámetros de solicitud

Name

Nombre de la sesión.

Tipo: cadena

Obligatorio: sí

Owner

Nombre del propietario de la sesión. Debe ser el nombre de un usuario existente en el servidor Amazon DCV de destino.

Tipo: cadena

Obligatorio: sí

Type

El tipo de sesión. Para obtener más información sobre los tipos de sesiones, consulte Introducción a las sesiones Amazon DCV en la Guía del administrador de Amazon DCV.

Valores válidos: CONSOLE | VIRTUAL

Tipo: cadena

Obligatorio: sí

InitFile

Se admite con sesiones virtuales en servidores Amazon DCV de Linux. No se admite con sesiones de consola en servidores Amazon DCV de Windows y Linux. Ruta del script personalizado del servidor Amazon DCV que se va a ejecutar para inicializar la sesión cuando se cree. La ruta del archivo es relativa al directorio de inicio especificado para el parámetro de configuración del agente agent.init_folder. Si el archivo se encuentra en el directorio de inicio especificado, especifique únicamente el nombre del archivo. Si el archivo no se encuentra en el directorio de inicio especificado, especifique la ruta relativa. Para obtener más información, consulte Archivo de configuración del agente en la Guía del administrador de Amazon DCV Session Manager.

Tipo: cadena

Obligatorio: no

MaxConcurrents

Número máximo de clientes Amazon DCV simultáneos.

Tipo: entero

Obligatorio: no

DcvGlEnabled

Indica si la sesión virtual está configurada para utilizar OpenGL basado en hardware. Solo se admite con sesiones virtuales. Este parámetro no es compatible con los servidores Amazon DCV de Windows.

Valores válidos: true | false

Tipo: Booleano

Obligatorio: no

PermissionsFile

Contenido codificado en base64 del archivo de permisos. El valor predeterminado son los valores predeterminados del servidor si se omite. Para obtener más información, consulte Configuración de la autorización de Amazon DCV en la Guía del administrador de Amazon DCV.

Tipo: cadena

Obligatorio: no

EnqueueRequest

Indica si se debe poner en cola la solicitud si no se puede tramitar inmediatamente.

Tipo: Booleano

Predeterminado: false

Obligatorio: no

AutorunFile

Compatible con sesiones de consola en servidores Amazon DCV de Windows y sesiones virtuales en servidores Amazon DCV de Linux. No se admite con sesiones de consola en servidores Amazon DCV de Linux.

Ruta de un archivo en el servidor host que se va a ejecutar dentro de la sesión. La ruta del archivo es relativa al directorio especificado para el parámetro de configuración del agente de agent.autorun_folder. Si el archivo se encuentra en el directorio de ejecución automática especificado, especifique únicamente el nombre del archivo. Si el archivo no se encuentra en el directorio de inicio especificado, especifique la ruta relativa. Para obtener más información, consulte Archivo de configuración del agente en la Guía del administrador de Amazon DCV Session Manager.

El archivo se ejecuta en nombre del Propietario especificado. El propietario especificado debe tener permiso para ejecutar el archivo en el servidor. En servidores Amazon DCV de Windows, el archivo se ejecuta cuando el propietario inicia sesión. En servidores Amazon DCV de Linux, el archivo se ejecuta cuando se crea la sesión.

Tipo: cadena

Obligatorio: no

AutorunFileArguments

Se admite con sesiones virtuales en servidores Amazon DCV de Linux. No se admite en sesiones de consola de servidores Amazon DCV de Windows y Linux. Los argumentos de la línea de comandos se pasan a AutorunFile tras su ejecución en la sesión. Los argumentos se pasan en el orden en que aparecen en la matriz dada. Se puede configurar el número máximo permitido de argumentos y la longitud máxima permitida de cada argumento. Para obtener más información, consulte Archivo de configuración del broker en la Guía del administrador de Amazon DCV Session Manager.

Tipo: matriz de cadenas

Obligatorio: no

DisableRetryOnFailure

Indica si no se debe volver a intentar la solicitud de creación de sesión cuando se produce un error en un host Amazon DCV por cualquier motivo. Para obtener más información sobre el mecanismo de reintento de creación de sesión, consulte el archivo de configuración del broker en la Guía del administrador de Amazon DCV Session Manager.

Tipo: Booleano

Predeterminado: false

Obligatorio: no

Requirements

Requisitos que debe cumplir el servidor para colocar la sesión. Los requisitos pueden incluir etiquetas del servidor y/o propiedades del servidor; tanto las etiquetas como las propiedades del servidor se recuperan llamando a la API DescribeServers.

Expresiones de condiciones de requisitos:

a != b true si a es distinto de b
a = b true si a es distinto de b
a > b true si a es mayor que b
a >= b true si a es igual o mayor que b
a < b true si a es menor que b
a <= b true si a es igual o menor que b
a = b true si a contiene la cadena b

Operadores booleanos de requisitos:

a y b true si a y b son true
a o b true si a o b son true
not a true si a es false

Las claves de las etiquetas deben ir precedidas por tag: y las propiedades del servidor deben ir precedidas por server:. Las expresiones de requisitos admiten paréntesis ().

Ejemplos de requisitos:

tag:color = 'pink' and (server:Host.Os.Family = 'windows' or tag:color := 'red')
"server:Host.Aws.Ec2InstanceType := 't2' and server:Host.CpuInfo.NumberOfCpus >= 2"

Los valores numéricos se pueden especificar mediante la notación exponencial, por ejemplo: "server:Host.Memory.TotalBytes > 1024E6".

Las propiedades admitidas del servidor son:

Id
Hostname
Version
SessionManagerAgentVersion
Host.Os.BuildNumber
Host.Os.Family
Host.Os.KernelVersion
Host.Os.Name
Host.Os.Version
Host.Memory.TotalBytes
Host.Memory.UsedBytes
Host.Swap.TotalBytes
Host.Swap.UsedBytes
Host.CpuLoadAverage.OneMinute
Host.CpuLoadAverage.FiveMinutes
Host.CpuLoadAverage.FifteenMinutes
Host.Aws.Ec2InstanceId
Host.Aws.Ec2InstanceType
Host.Aws.Region
Host.Aws.Ec2ImageId
Host.CpuInfo.Architecture
Host.CpuInfo.ModelName
Host.CpuInfo.NumberOfCpus
Host.CpuInfo.PhysicalCoresPerCpu
Host.CpuInfo.Vendor

Tipo: cadena

Obligatorio: no

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 en la Guía del administrador de Amazon DCV.

Tipo: cadena

Obligatorio: no

Parámetros de respuesta

Id: ID exclusivo de la sesión.
Name: El nombre de la sesión.
Owner: Propietario de la sesión.
Type: Tipo de sesión.
State: Estado de la sesión. Si la solicitud se completa correctamente, la sesión pasa al estado CREATING.
Substate: Subestado de la sesión. Si la solicitud se completa correctamente, el subestado pasa al subestado SESSION_PLACING.

Ejemplo

Python

Solicitud

El siguiente ejemplo crea tres sesiones.



from swagger_client.models.create_session_request_data import CreateSessionRequestData

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 create_sessions(sessions_to_create):
    create_sessions_request = list()
    for name, owner, session_type, init_file_path, autorun_file, autorun_file_arguments, max_concurrent_clients,\
            dcv_gl_enabled, permissions_file, requirements, storage_root in sessions_to_create:
        a_request = CreateSessionRequestData(
            name=name, owner=owner, type=session_type,
            init_file_path=init_file_path, autorun_file=autorun_file, autorun_file_arguments=autorun_file_arguments, max_concurrent_clients=max_concurrent_clients,
            dcv_gl_enabled=dcv_gl_enabled, permissions_file=permissions_file, requirements=requirements, storage_root=storage_root)
        create_sessions_request.append(a_request)

    api_instance = get_sessions_api()
    print('Create Sessions Request:', create_sessions_request)
    api_response = api_instance.create_sessions(body=create_sessions_request)
    print('Create Sessions Response:', api_response)

def main():
    create_sessions([
    ('session1', 'user1', 'CONSOLE', None, None, None, 1, None, '/dcv/permissions.file', "tag:os = 'windows' and server:Host.Memory.TotalBytes > 1024", "/storage/root"),
    ('session2', 'user1', 'VIRTUAL', None, 'myapp.sh', None, 1, False, None, "tag:os = 'linux'", None),
    ('session3', 'user1', 'VIRTUAL', '/dcv/script.sh', 'myapp.sh', ['argument1', 'argument2'], 1, False, None, "tag:os = 'linux'", None),
])

Respuesta

A continuación se muestra la salida de ejemplo.


{
              "RequestId": "e32d0b83-25f7-41e7-8c8b-e89326ecc87f",
    "SuccessfulList": [
    {
            "Id": "78b45deb-1163-46b1-879b-7d8fcbe9d9d6",
            "Name": "session1",
            "Owner": "user1",
            "Type": "CONSOLE",
            "State": "CREATING"
    },
    {
            "Id": " a0c743c4-9ff7-43ce-b13f-0c4d55a268dd",
            "Name": "session2",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    },
    {
            "Id": " 10311636-df90-4cd1-bcf7-474e9675b7cd",
            "Name": "session3",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    }
    ],
    "UnsuccessfulList": [
    ]
}

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

CloseServers

DescribeServers