Glue / Client / create_session

create_session#

Glue.Client.create_session(**kwargs)#

Creates a new session.

Request Syntax

response = client.create_session(
    Id='string',
    Description='string',
    Role='string',
    Command={
        'Name': 'string',
        'PythonVersion': 'string'
    },
    Timeout=123,
    IdleTimeout=123,
    DefaultArguments={
        'string': 'string'
    },
    Connections={
        'Connections': [
            'string',
        ]
    },
    MaxCapacity=123.0,
    NumberOfWorkers=123,
    WorkerType='Standard'|'G.1X'|'G.2X'|'G.025X'|'G.4X'|'G.8X'|'Z.2X',
    SecurityConfiguration='string',
    GlueVersion='string',
    Tags={
        'string': 'string'
    },
    RequestOrigin='string'
)

Parameters:

Id (string) –
[REQUIRED]

The ID of the session request.
Description (string) – The description of the session.
Role (string) –
[REQUIRED]

The IAM Role ARN
Command (dict) –
[REQUIRED]

The SessionCommand that runs the job.
- Name (string) –
  
  Specifies the name of the SessionCommand. Can be ‘glueetl’ or ‘gluestreaming’.
- PythonVersion (string) –
  
  Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
Timeout (integer) – The number of minutes before session times out. Default for Spark ETL jobs is 48 hours (2880 minutes), the maximum session lifetime for this job type. Consult the documentation for other job types.
IdleTimeout (integer) – The number of minutes when idle before session times out. Default for Spark ETL jobs is value of Timeout. Consult the documentation for other job types.
DefaultArguments (dict) –
A map array of key-value pairs. Max is 75 pairs.
- (string) –
  - (string) –
Connections (dict) –
The number of connections to use for the session.
- Connections (list) –
  
  A list of connections used by the job.
  - (string) –
MaxCapacity (float) – The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
NumberOfWorkers (integer) – The number of workers of a defined WorkerType to use for the session.
WorkerType (string) –
The type of predefined worker that is allocated to use for the session. Accepts a value of Standard, G.1X, G.2X, or G.025X.
- For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
- For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
- For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
- For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
SecurityConfiguration (string) – The name of the SecurityConfiguration structure to be used with the session
GlueVersion (string) – The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.
Tags (dict) –
The map of key value pairs (tags) belonging to the session.
- (string) –
  - (string) –
RequestOrigin (string) – The origin of the request.

Return type:

dict

Returns:

Response Syntax

{
    'Session': {
        'Id': 'string',
        'CreatedOn': datetime(2015, 1, 1),
        'Status': 'PROVISIONING'|'READY'|'FAILED'|'TIMEOUT'|'STOPPING'|'STOPPED',
        'ErrorMessage': 'string',
        'Description': 'string',
        'Role': 'string',
        'Command': {
            'Name': 'string',
            'PythonVersion': 'string'
        },
        'DefaultArguments': {
            'string': 'string'
        },
        'Connections': {
            'Connections': [
                'string',
            ]
        },
        'Progress': 123.0,
        'MaxCapacity': 123.0,
        'SecurityConfiguration': 'string',
        'GlueVersion': 'string'
    }
}

Response Structure

(dict) –
- Session (dict) –
  
  Returns the session object in the response.
  - Id (string) –
    
    The ID of the session.
  - CreatedOn (datetime) –
    
    The time and date when the session was created.
  - Status (string) –
    
    The session status.
  - ErrorMessage (string) –
    
    The error message displayed during the session.
  - Description (string) –
    
    The description of the session.
  - Role (string) –
    
    The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.
  - Command (dict) –
    
    The command object.See SessionCommand.
    - Name (string) –
      
      Specifies the name of the SessionCommand. Can be ‘glueetl’ or ‘gluestreaming’.
    - PythonVersion (string) –
      
      Specifies the Python version. The Python version indicates the version supported for jobs of type Spark.
  - DefaultArguments (dict) –
    
    A map array of key-value pairs. Max is 75 pairs.
    - (string) –
      - (string) –
  - Connections (dict) –
    
    The number of connections used for the session.
    - Connections (list) –
      
      A list of connections used by the job.
      - (string) –
  - Progress (float) –
    
    The code execution progress of the session.
  - MaxCapacity (float) –
    
    The number of Glue data processing units (DPUs) that can be allocated when the job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB memory.
  - SecurityConfiguration (string) –
    
    The name of the SecurityConfiguration structure to be used with the session.
  - GlueVersion (string) –
    
    The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

Exceptions

Glue.Client.exceptions.AccessDeniedException
Glue.Client.exceptions.IdempotentParameterMismatchException
Glue.Client.exceptions.InternalServiceException
Glue.Client.exceptions.OperationTimeoutException
Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.ValidationException
Glue.Client.exceptions.AlreadyExistsException
Glue.Client.exceptions.ResourceNumberLimitExceededException