awswrangler.athena.wait_query¶
- awswrangler.athena.wait_query(query_execution_id: str, boto3_session: Session | None = None, athena_query_wait_polling_delay: float = 1.0) Dict[str, Any] ¶
Wait for the query end.
Note
This function has arguments which can be configured globally through wr.config or environment variables:
athena_query_wait_polling_delay
Check out the Global Configurations Tutorial for details.
- Parameters:
query_execution_id (str) – Athena query execution ID.
boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.
athena_query_wait_polling_delay (float, default: 0.25 seconds) – Interval in seconds for how often the function will check if the Athena query has completed.
- Returns:
Dictionary with the get_query_execution response.
- Return type:
Dict[str, Any]
Examples
>>> import awswrangler as wr >>> res = wr.athena.wait_query(query_execution_id='query-execution-id')