Skip to content

CalculationStatus

Source code in docs_src/capo_athena/types/calculation_status.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class CalculationStatus(TypedDict, closed=True):
    submission_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time the calculation was submitted for processing.</p>"""
    completion_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time the calculation completed processing.</p>"""
    state: NotRequired[
        "capo_athena.types.calculation_execution_state.CalculationExecutionState"
    ]
    """<p>The state of the calculation execution. A description of each state follows.</p> <p> <code>CREATING</code> - The calculation is in the process of being created.</p> <p> <code>CREATED</code> - The calculation has been created and is ready to run.</p> <p> <code>QUEUED</code> - The calculation has been queued for processing.</p> <p> <code>RUNNING</code> - The calculation is running.</p> <p> <code>CANCELING</code> - A request to cancel the calculation has been received and the system is working to stop it.</p> <p> <code>CANCELED</code> - The calculation is no longer running as the result of a cancel request.</p> <p> <code>COMPLETED</code> - The calculation has completed without error.</p> <p> <code>FAILED</code> - The calculation failed and is no longer running.</p>"""
    state_change_reason: NotRequired[
        "capo_athena.types.description_string.DescriptionString"
    ]
    """<p>The reason for the calculation state change (for example, the calculation was canceled because the session was terminated).</p>"""

completion_date_time instance-attribute 

completion_date_time: NotRequired[Date]

The date and time the calculation completed processing.

state instance-attribute 

state: NotRequired[CalculationExecutionState]

The state of the calculation execution. A description of each state follows.

CREATING - The calculation is in the process of being created.

CREATED - The calculation has been created and is ready to run.

QUEUED - The calculation has been queued for processing.

RUNNING - The calculation is running.

CANCELING - A request to cancel the calculation has been received and the system is working to stop it.

CANCELED - The calculation is no longer running as the result of a cancel request.

COMPLETED - The calculation has completed without error.

FAILED - The calculation failed and is no longer running.

state_change_reason instance-attribute 

state_change_reason: NotRequired[DescriptionString]

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

submission_date_time instance-attribute 

submission_date_time: NotRequired[Date]

The date and time the calculation was submitted for processing.