airflow.providers.amazon.aws.sensors.opensearch_serverless¶

類¶

OpenSearchServerlessCollectionActiveSensor

輪詢 Collection 的狀態直到其達到最終狀態；如果查詢失敗則失敗。

模組內容¶

class airflow.providers.amazon.aws.sensors.opensearch_serverless.OpenSearchServerlessCollectionActiveSensor(*, collection_id=None, collection_name=None, poke_interval=10, max_retries=60, deferrable=conf.getboolean('operators', 'default_deferrable', fallback=False), **kwargs)[source]¶

基類: airflow.providers.amazon.aws.sensors.base_aws.AwsBaseSensor[airflow.providers.amazon.aws.hooks.opensearch_serverless.OpenSearchServerlessHook]

輪詢 Collection 的狀態直到其達到最終狀態；如果查詢失敗則失敗。

另請參見

有關如何使用此感測器的更多資訊，請參閱指南：《等待 Amazon OpenSearch Serverless Collection 變為活躍》

引數:

collection_id (str | None) – Collection ID。在同一請求中不能同時提供名稱和 ID。
collection_name (str | None) – Collection 名稱。在同一請求中不能同時提供名稱和 ID。
deferrable (bool) – 如果為 True，感測器將以可延遲模式執行。此模式需要安裝 aiobotocore 模組。（預設值：False，但可以在配置檔案中設定 default_deferrable 為 True 來覆蓋）
poke_interval (int) – 輪詢週期，單位為秒，用於檢查作業狀態。（預設值：10）
max_retries (int) – 返回當前狀態前的重試次數（預設值：60）
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

INTERMEDIATE_STATES = ('CREATING',)[source]¶

FAILURE_STATES = ('DELETING', 'FAILED')[source]¶

SUCCESS_STATES = ('ACTIVE',)[source]¶

FAILURE_MESSAGE = 'OpenSearch Serverless Collection 感測器失敗'[source]¶

aws_hook_class[source]¶

template_fields: collections.abc.Sequence[str][source]¶

ui_color = '#66c3ff'[source]¶

collection_id = None[source]¶

collection_name = None[source]¶

poke_interval = 10[source]¶

max_retries = 60[source]¶

deferrable = True[source]¶

poke(context, **kwargs)[source]¶

派生此類時覆蓋此方法。

execute(context)[source]¶

建立運算子時派生此類。

執行任務的主要方法。Context 與渲染 jinja 模板時使用的字典相同。

有關更多 Context，請參考 get_template_context。