Skip to content

QueryExecutionStatus

Source code in docs_src/capo_athena/types/query_execution_status.py 
14
15
16
17
18
19
20
21
22
23
24
class QueryExecutionStatus(TypedDict, closed=True):
    state: NotRequired["capo_athena.types.query_execution_state.QueryExecutionState"]
    """<p>The state of query execution. <code>QUEUED</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>RUNNING</code> indicates that the query is in execution phase. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution.</p> <note> <p>For queries that experience certain transient errors, the state transitions from <code>RUNNING</code> back to <code>QUEUED</code>. The <code>FAILED</code> state is always terminal with no automatic retry. </p> </note>"""
    state_change_reason: NotRequired["capo_athena.types.string.String"]
    """<p>Further detail about the status of the query.</p>"""
    submission_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time that the query was submitted.</p>"""
    completion_date_time: NotRequired["capo_athena.types.date.Date"]
    """<p>The date and time that the query completed.</p>"""
    athena_error: NotRequired["capo_athena.types.athena_error.AthenaError"]
    """<p>Provides information about an Athena query error.</p>"""

athena_error instance-attribute 

athena_error: NotRequired[AthenaError]

Provides information about an Athena query error.

completion_date_time instance-attribute 

completion_date_time: NotRequired[Date]

The date and time that the query completed.

state instance-attribute 

state: NotRequired[QueryExecutionState]

The state of query execution. QUEUED indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. RUNNING indicates that the query is in execution phase. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

For queries that experience certain transient errors, the state transitions from RUNNING back to QUEUED. The FAILED state is always terminal with no automatic retry.

state_change_reason instance-attribute 

state_change_reason: NotRequired[String]

Further detail about the status of the query.

submission_date_time instance-attribute 

submission_date_time: NotRequired[Date]

The date and time that the query was submitted.