Skip to content

GetQueryStateResponse

Source code in docs_src/capo_lakeformation/types/get_query_state_response.py
class GetQueryStateResponse(TypedDict, closed=True):
    error: NotRequired[
        "capo_lakeformation.types.error_message_string.ErrorMessageString"
    ]
    """<p>An error message when the operation fails.</p>"""
    state: "capo_lakeformation.types.query_state_string.QueryStateString"
    """<p>The state of a query previously submitted. The possible states are:</p> <ul> <li> <p>PENDING: the query is pending.</p> </li> <li> <p>WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.</p> </li> <li> <p>FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.</p> </li> <li> <p>ERROR: an error occurred with the query, such as an invalid query ID or a backend error.</p> </li> </ul>"""

error instance-attribute

error: NotRequired[ErrorMessageString]

An error message when the operation fails.

state instance-attribute

The state of a query previously submitted. The possible states are:

  • PENDING: the query is pending.

  • WORKUNITS_AVAILABLE: some work units are ready for retrieval and execution.

  • FINISHED: the query planning finished successfully, and all work units are ready for retrieval and execution.

  • ERROR: an error occurred with the query, such as an invalid query ID or a backend error.