airflow.providers.amazon.aws.sensors.mwaa

MwaaDagRunSensor

等待 MWAA 环境中的 DAG Run 完成。

模块内容

class airflow.providers.amazon.aws.sensors.mwaa.MwaaDagRunSensor(*, external_env_name, external_dag_id, external_dag_run_id, success_states=None, failure_states=None, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), poke_interval=60, max_retries=720, **kwargs)[source]

Bases: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.mwaa.MwaaHook]

等待 MWAA 环境中的 DAG Run 完成。

如果 DAG Run 失败,则抛出 AirflowException。

另请参阅

有关如何使用此 sensor 的更多信息,请参阅指南:等待 AWS MWAA DAG Run 的状态

参数:
  • external_env_name (str) – 包含您要等待的 DAG Run 的外部 MWAA 环境名称 (templated)

  • external_dag_id (str) – 包含您要等待的 DAG Run 的外部 MWAA 环境中的 DAG ID (templated)

  • external_dag_run_id (str) – 您要等待的外部 MWAA 环境中的 DAG Run ID (templated)

  • success_states (collections.abc.Collection[str] | None) – 使得此任务标记为成功的 DAG Run 状态集合,默认值为 {airflow.utils.state.DagRunState.SUCCESS} (templated)

  • failure_states (collections.abc.Collection[str] | None) – 使得此任务标记为失败并抛出 AirflowException 的 DAG Run 状态集合,默认值为 {airflow.utils.state.DagRunState.FAILED} (templated)

  • deferrable (bool) – 如果为 True,sensor 将在可延迟模式下运行。此模式需要安装 aiobotocore 模块。(默认值:False,但可以在配置文件中通过设置 default_deferrable 为 True 来覆盖)

  • poke_interval (int) – 检查作业状态的轮询周期,单位为秒。(默认值:60)

  • max_retries (int) – 返回当前状态之前重试的次数。(默认值:720)

  • aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果为 None 或空,则使用默认的 boto3 行为。如果以分布式方式运行 Airflow 且 aws_conn_id 为 None 或空,则将使用默认的 boto3 配置(并且必须在每个 worker 节点上维护)。

  • region_name – AWS region_name。如果未指定,则使用默认的 boto3 行为。

  • verify – 是否验证 SSL 证书。参阅:https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html

  • botocore_config – botocore 客户端的配置字典(键值对)。参阅:https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html

aws_hook_class[source]
template_fields: collections.abc.Sequence[str][source]
success_states[source]
failure_states[source]
external_env_name[source]
external_dag_id[source]
external_dag_run_id[source]
deferrable = True[source]
poke_interval = 60[source]
max_retries = 720[source]
poke(context)[source]

派生此类时覆盖。

execute_complete(context, event=None)[source]
execute(context)[source]

创建操作符时派生。

执行任务的主要方法。Context 与渲染 jinja 模板时使用的字典相同。

有关更多上下文,请参阅 get_template_context。

此条目有帮助吗?