Skip to content

SessionStatus

Source code in docs_src/capo_athena/types/session_status.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class SessionStatus(TypedDict, closed=True):
    start_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time that the session started.</p>"""
    last_modified_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The most recent date and time that the session was modified.</p>"""
    end_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time that the session ended.</p>"""
    idle_since_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time starting at which the session became idle. Can be empty if the session is not currently idle.</p>"""
    state: NotRequired["capo_athena.types.session_state.SessionState"]
    """<p>The state of the session. A description of each state follows.</p> <p> <code>CREATING</code> - The session is being started, including acquiring resources.</p> <p> <code>CREATED</code> - The session has been started.</p> <p> <code>IDLE</code> - The session is able to accept a calculation.</p> <p> <code>BUSY</code> - The session is processing another task and is unable to accept a calculation.</p> <p> <code>TERMINATING</code> - The session is in the process of shutting down.</p> <p> <code>TERMINATED</code> - The session and its resources are no longer running.</p> <p> <code>DEGRADED</code> - The session has no healthy coordinators.</p> <p> <code>FAILED</code> - Due to a failure, the session and its resources are no longer running.</p>"""
    state_change_reason: NotRequired[
        "capo_athena.types.description_string.DescriptionString"
    ]
    """<p>The reason for the session state change (for example, canceled because the session was terminated).</p>"""

end_date_time instance-attribute 

end_date_time: NotRequired[Date]

The date and time that the session ended.

idle_since_date_time instance-attribute 

idle_since_date_time: NotRequired[Date]

The date and time starting at which the session became idle. Can be empty if the session is not currently idle.

last_modified_date_time instance-attribute 

last_modified_date_time: NotRequired[Date]

The most recent date and time that the session was modified.

start_date_time instance-attribute 

start_date_time: NotRequired[Date]

The date and time that the session started.

state instance-attribute 

state: NotRequired[SessionState]

The state of the session. A description of each state follows.

CREATING - The session is being started, including acquiring resources.

CREATED - The session has been started.

IDLE - The session is able to accept a calculation.

BUSY - The session is processing another task and is unable to accept a calculation.

TERMINATING - The session is in the process of shutting down.

TERMINATED - The session and its resources are no longer running.

DEGRADED - The session has no healthy coordinators.

FAILED - Due to a failure, the session and its resources are no longer running.

state_change_reason instance-attribute 

state_change_reason: NotRequired[DescriptionString]

The reason for the session state change (for example, canceled because the session was terminated).