Skip to content

StartCalculationExecutionResponse

Source code in docs_src/capo_athena/types/start_calculation_execution_response.py
class StartCalculationExecutionResponse(TypedDict, closed=True):
    calculation_execution_id: NotRequired[
        "capo_athena.types.calculation_execution_id.CalculationExecutionId"
    ]
    """<p>The calculation execution UUID.</p>"""
    state: NotRequired[
        "capo_athena.types.calculation_execution_state.CalculationExecutionState"
    ]
    """<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>"""

calculation_execution_id instance-attribute

calculation_execution_id: NotRequired[CalculationExecutionId]

The calculation execution UUID.

state instance-attribute

state: NotRequired[CalculationExecutionState]

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.