Skip to content

GetSessionResponse

Source code in docs_src/capo_athena/types/get_session_response.py
class GetSessionResponse(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>"""
    work_group: NotRequired["capo_athena.types.work_group_name.WorkGroupName"]
    """<p>The workgroup to which the session belongs.</p>"""
    engine_version: NotRequired["capo_athena.types.name_string.NameString"]
    """<p>The engine version used by the session (for example, <code>PySpark engine version 3</code>). You can get a list of engine versions by calling <a>ListEngineVersions</a>.</p>"""
    engine_configuration: NotRequired[
        "capo_athena.types.engine_configuration.EngineConfiguration"
    ]
    """<p>Contains engine configuration information like DPU usage.</p>"""
    notebook_version: NotRequired["capo_athena.types.name_string.NameString"]
    """<p>The notebook version.</p>"""
    monitoring_configuration: NotRequired[
        "capo_athena.types.monitoring_configuration.MonitoringConfiguration"
    ]
    session_configuration: NotRequired[
        "capo_athena.types.session_configuration.SessionConfiguration"
    ]
    """<p>Contains the workgroup configuration information used by the session.</p>"""
    status: NotRequired["capo_athena.types.session_status.SessionStatus"]
    """<p>Contains information about the status of the session.</p>"""
    statistics: NotRequired["capo_athena.types.session_statistics.SessionStatistics"]
    """<p>Contains the DPU execution time.</p>"""

description instance-attribute

description: NotRequired[DescriptionString]

The session description.

engine_configuration instance-attribute

engine_configuration: NotRequired[EngineConfiguration]

Contains engine configuration information like DPU usage.

engine_version instance-attribute

engine_version: NotRequired[NameString]

The engine version used by the session (for example, PySpark engine version 3). You can get a list of engine versions by calling ListEngineVersions.

monitoring_configuration instance-attribute

monitoring_configuration: NotRequired[MonitoringConfiguration]

notebook_version instance-attribute

notebook_version: NotRequired[NameString]

The notebook version.

session_configuration instance-attribute

session_configuration: NotRequired[SessionConfiguration]

Contains the workgroup configuration information used by the session.

session_id instance-attribute

session_id: NotRequired[SessionId]

The session ID.

statistics instance-attribute

statistics: NotRequired[SessionStatistics]

Contains the DPU execution time.

status instance-attribute

status: NotRequired[SessionStatus]

Contains information about the status of the session.

work_group instance-attribute

work_group: NotRequired[WorkGroupName]

The workgroup to which the session belongs.