airflow.providers.amazon.aws.utils.waiter¶
Module Contents¶
Functions¶
|
Call get_state_callable until it reaches the desired_state or the failure_states. |
|
Attributes¶
- airflow.providers.amazon.aws.utils.waiter.waiter(get_state_callable, get_state_args, parse_response, desired_state, failure_states, object_type, action, countdown=25 * 60, check_interval_seconds=60)[source]¶
Call get_state_callable until it reaches the desired_state or the failure_states.
- PLEASE NOTE: While not yet deprecated, we are moving away from this method
and encourage using the custom boto waiters as explained in https://github.com/apache/airflow/tree/main/airflow/providers/amazon/aws/waiters
- Parameters
get_state_callable (Callable) – A callable to run until it returns True
get_state_args (dict) – Arguments to pass to get_state_callable
parse_response (list) – Dictionary keys to extract state from response of get_state_callable
desired_state (set) – Wait until the getter returns this value
failure_states (set) – A set of states which indicate failure and should throw an exception if any are reached before the desired_state
object_type (str) – Used for the reporting string. What are you waiting for? (application, job, etc)
action (str) – Used for the reporting string. What action are you waiting for? (created, deleted, etc)
countdown (int | float | None) – Number of seconds the waiter should wait for the desired state before timing out. Defaults to 25 * 60 seconds. None = infinite.
check_interval_seconds (int) – Number of seconds waiter should wait before attempting to retry get_state_callable. Defaults to 60 seconds.