Skip to content

SessionSummary

Source code in docs_src/capo_athena/types/session_summary.py
class SessionSummary(TypedDict, closed=True):
    session_id: NotRequired["capo_athena.types.session_id.SessionId"]
    """<p>The session ID.</p>"""
    description: NotRequired["capo_athena.types.description_string.DescriptionString"]
    """<p>The session description.</p>"""
    engine_version: NotRequired["capo_athena.types.engine_version.EngineVersion"]
    """<p>The engine version used by the session (for example, <code>PySpark engine version 3</code>).</p>"""
    notebook_version: NotRequired["capo_athena.types.name_string.NameString"]
    """<p>The notebook version.</p>"""
    status: NotRequired["capo_athena.types.session_status.SessionStatus"]
    """<p>Contains information about the session status.</p>"""

description instance-attribute

description: NotRequired[DescriptionString]

The session description.

engine_version instance-attribute

engine_version: NotRequired[EngineVersion]

The engine version used by the session (for example, PySpark engine version 3).

notebook_version instance-attribute

notebook_version: NotRequired[NameString]

The notebook version.

session_id instance-attribute

session_id: NotRequired[SessionId]

The session ID.

status instance-attribute

status: NotRequired[SessionStatus]

Contains information about the session status.