airflow.providers.amazon.aws.sensors.comprehend
¶
模块内容¶
类¶
Amazon Comprehend 的通用传感器行为。 |
|
轮询 pii 实体检测作业的状态,直到其达到完成状态;如果作业失败则失败。 |
|
轮询文档分类器的状态,直到其达到完成状态;如果作业失败则失败。 |
- class airflow.providers.amazon.aws.sensors.comprehend.ComprehendBaseSensor(deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[源代码]¶
基类:
airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor
[airflow.providers.amazon.aws.hooks.comprehend.ComprehendHook
]Amazon Comprehend 的通用传感器行为。
- 子类必须实现以下方法
get_state()
- 子类必须设置以下字段
INTERMEDIATE_STATES
FAILURE_STATES
SUCCESS_STATES
FAILURE_MESSAGE
- 参数
deferrable (bool) – 如果为 True,则传感器将以可延期模式运行。此模式需要安装 aiobotocore 模块。(默认值:False,但可以通过在配置文件中将 default_deferrable 设置为 True 来覆盖)
- class airflow.providers.amazon.aws.sensors.comprehend.ComprehendStartPiiEntitiesDetectionJobCompletedSensor(*, job_id, max_retries=75, poke_interval=120, **kwargs)[源代码]¶
-
轮询 pii 实体检测作业的状态,直到其达到完成状态;如果作业失败则失败。
另请参阅
有关如何使用此传感器的更多信息,请查看指南:等待 Amazon Comprehend Start PII 实体检测作业
- 参数
job_id (str) – Comprehend pii 实体检测作业的 id。
deferrable – 如果为 True,则传感器将以可延期模式运行。此模式需要安装 aiobotocore 模块。(默认值:False,但可以通过在配置文件中将 default_deferrable 设置为 True 来覆盖)
poke_interval (int) – 轮询周期(以秒为单位),用于检查作业的状态。(默认值:120)
max_retries (int) – 返回当前状态之前的重试次数。(默认值:75)
aws_conn_id – 用于 AWS 凭证的 Airflow 连接。如果此值为
None
或为空,则使用默认的 boto3 行为。如果在分布式环境中运行 Airflow 并且 aws_conn_id 为 None 或为空,则将使用默认的 boto3 配置(并且必须在每个工作节点上维护)。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
- template_fields: collections.abc.Sequence[str][源代码]¶
- class airflow.providers.amazon.aws.sensors.comprehend.ComprehendCreateDocumentClassifierCompletedSensor(*, document_classifier_arn, fail_on_warnings=False, max_retries=75, poke_interval=120, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), aws_conn_id='aws_default', **kwargs)[源代码]¶
基类:
airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor
[airflow.providers.amazon.aws.hooks.comprehend.ComprehendHook
]轮询文档分类器的状态,直到其达到完成状态;如果作业失败则失败。
另请参阅
有关如何使用此传感器的更多信息,请查看该指南: 等待 Amazon Comprehend 文档分类器
- 参数
document_classifier_arn (str) – Comprehend 文档分类器的 arn。
fail_on_warnings (bool) – 如果设置为 True,当状态为 TRAINED_WITH_WARNING 时,文档分类器训练作业将抛出错误。(默认为 False)
deferrable (bool) – 如果为 True,则传感器将以可延期模式运行。此模式需要安装 aiobotocore 模块。(默认值:False,但可以通过在配置文件中将 default_deferrable 设置为 True 来覆盖)
poke_interval (int) – 轮询周期(以秒为单位),用于检查作业的状态。(默认值:120)
max_retries (int) – 返回当前状态之前的重试次数。(默认值:75)
aws_conn_id (str | None) – 用于 AWS 凭证的 Airflow 连接。如果此项为
None
或为空,则使用默认的 boto3 行为。如果以分布式方式运行 Airflow 且 aws_conn_id 为 None 或为空,则将使用默认的 boto3 配置(并且必须在每个工作节点上维护)。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
- template_fields: collections.abc.Sequence[str][源代码]¶