Skip to content

Session

Source code in docs_src/capo_glue/types/session.py
class Session(TypedDict, closed=True):
    id: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The ID of the session.</p>"""
    created_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The time and date when the session was created.</p>"""
    status: NotRequired["capo_glue.types.session_status.SessionStatus"]
    """<p>The session status. </p>"""
    error_message: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>The error message displayed during the session.</p>"""
    description: NotRequired["capo_glue.types.description_string.DescriptionString"]
    """<p>The description of the session.</p>"""
    role: NotRequired["capo_glue.types.orchestration_role_arn.OrchestrationRoleArn"]
    """<p>The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.</p>"""
    command: NotRequired["capo_glue.types.session_command.SessionCommand"]
    """<p>The command object.See SessionCommand.</p>"""
    default_arguments: NotRequired[
        "capo_glue.types.orchestration_arguments_map.OrchestrationArgumentsMap"
    ]
    """<p>A map array of key-value pairs. Max is 75 pairs. </p>"""
    connections: NotRequired["capo_glue.types.connections_list.ConnectionsList"]
    """<p>The number of connections used for the session.</p>"""
    progress: "capo_glue.types.double_value.DoubleValue"
    """<p>The code execution progress of the session.</p>"""
    max_capacity: NotRequired["capo_glue.types.nullable_double.NullableDouble"]
    """<p>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. </p>"""
    security_configuration: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the SecurityConfiguration structure to be used with the session.</p>"""
    glue_version: NotRequired["capo_glue.types.glue_version_string.GlueVersionString"]
    """<p>The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.</p>"""
    number_of_workers: NotRequired["capo_glue.types.nullable_integer.NullableInteger"]
    """<p>The number of workers of a defined <code>WorkerType</code> to use for the session.</p>"""
    worker_type: NotRequired["capo_glue.types.worker_type.WorkerType"]
    """<p>The type of predefined worker that is allocated when a session runs. Accepts a value of <code>G.1X</code>, <code>G.2X</code>, <code>G.4X</code>, or <code>G.8X</code> for Spark sessions. Accepts the value <code>Z.2X</code> for Ray sessions.</p>"""
    completed_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time that this session is completed.</p>"""
    execution_time: NotRequired["capo_glue.types.nullable_double.NullableDouble"]
    """<p>The total time the session ran for.</p>"""
    dpu_seconds: NotRequired["capo_glue.types.nullable_double.NullableDouble"]
    """<p>The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).</p>"""
    idle_timeout: NotRequired["capo_glue.types.idle_timeout.IdleTimeout"]
    """<p>The number of minutes when idle before the session times out.</p>"""
    profile_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of an Glue usage profile associated with the session.</p>"""
    session_type: NotRequired["capo_glue.types.session_type.SessionType"]
    """<p>The type of the session.</p>"""

command instance-attribute

command: NotRequired[SessionCommand]

The command object.See SessionCommand.

completed_on instance-attribute

completed_on: NotRequired[TimestampValue]

The date and time that this session is completed.

connections instance-attribute

connections: NotRequired[ConnectionsList]

The number of connections used for the session.

created_on instance-attribute

created_on: NotRequired[TimestampValue]

The time and date when the session was created.

default_arguments instance-attribute

default_arguments: NotRequired[OrchestrationArgumentsMap]

A map array of key-value pairs. Max is 75 pairs.

description instance-attribute

description: NotRequired[DescriptionString]

The description of the session.

dpu_seconds instance-attribute

dpu_seconds: NotRequired[NullableDouble]

The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).

error_message instance-attribute

error_message: NotRequired[DescriptionString]

The error message displayed during the session.

execution_time instance-attribute

execution_time: NotRequired[NullableDouble]

The total time the session ran for.

glue_version instance-attribute

glue_version: NotRequired[GlueVersionString]

The Glue version determines the versions of Apache Spark and Python that Glue supports. The GlueVersion must be greater than 2.0.

id instance-attribute

id: NotRequired[NameString]

The ID of the session.

idle_timeout instance-attribute

idle_timeout: NotRequired[IdleTimeout]

The number of minutes when idle before the session times out.

max_capacity instance-attribute

max_capacity: NotRequired[NullableDouble]

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.

number_of_workers instance-attribute

number_of_workers: NotRequired[NullableInteger]

The number of workers of a defined WorkerType to use for the session.

profile_name instance-attribute

profile_name: NotRequired[NameString]

The name of an Glue usage profile associated with the session.

progress instance-attribute

progress: DoubleValue

The code execution progress of the session.

role instance-attribute

role: NotRequired[OrchestrationRoleArn]

The name or Amazon Resource Name (ARN) of the IAM role associated with the Session.

security_configuration instance-attribute

security_configuration: NotRequired[NameString]

The name of the SecurityConfiguration structure to be used with the session.

session_type instance-attribute

session_type: NotRequired[SessionType]

The type of the session.

status instance-attribute

status: NotRequired[SessionStatus]

The session status.

worker_type instance-attribute

worker_type: NotRequired[WorkerType]

The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.