Apache Livy · Schema

CreateSessionRequest

Parameters for creating an interactive session

Big DataInteractive ComputingOpen SourceRESTSpark

Properties

Name	Type	Description
kind	string	Session programming language
proxyUser	string	User to impersonate when running the session
jars	array	JARs to include on the classpath
pyFiles	array	Python files to include
files	array	Files to include
driverMemory	string	Driver memory amount
driverCores	integer	Number of driver cores
executorMemory	string	Executor memory amount
executorCores	integer	Number of executor cores
numExecutors	integer	Number of executors
conf	object	Spark configuration key-value pairs

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-livy/refs/heads/main/json-schema/rest-api-create-session-request-schema.json",
  "title": "CreateSessionRequest",
  "description": "Parameters for creating an interactive session",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Session programming language",
      "enum": [
        "spark",
        "pyspark",
        "sparkr",
        "sql"
      ],
      "example": "pyspark"
    },
    "proxyUser": {
      "type": "string",
      "description": "User to impersonate when running the session",
      "example": "alice"
    },
    "jars": {
      "type": "array",
      "description": "JARs to include on the classpath",
      "items": {
        "type": "string"
      }
    },
    "pyFiles": {
      "type": "array",
      "description": "Python files to include",
      "items": {
        "type": "string"
      }
    },
    "files": {
      "type": "array",
      "description": "Files to include",
      "items": {
        "type": "string"
      }
    },
    "driverMemory": {
      "type": "string",
      "description": "Driver memory amount",
      "example": "512m"
    },
    "driverCores": {
      "type": "integer",
      "description": "Number of driver cores",
      "example": 1
    },
    "executorMemory": {
      "type": "string",
      "description": "Executor memory amount",
      "example": "1g"
    },
    "executorCores": {
      "type": "integer",
      "description": "Number of executor cores",
      "example": 1
    },
    "numExecutors": {
      "type": "integer",
      "description": "Number of executors",
      "example": 2
    },
    "conf": {
      "type": "object",
      "description": "Spark configuration key-value pairs"
    }
  }
}