airflow.providers.amazon.aws.hooks.quicksight¶

类¶

QuickSightHook

与 Amazon QuickSight 交互。

模块内容¶

class airflow.providers.amazon.aws.hooks.quicksight.QuickSightHook(*args, **kwargs)[source]¶

基类: airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

与 Amazon QuickSight 交互。

提供围绕 boto3.client("quicksight") 的精简包装。

可以指定其他参数（例如 aws_conn_id），这些参数将向下传递给底层的 AwsBaseHook。

另请参阅

airflow.providers.amazon.aws.hooks.base_aws.AwsBaseHook

NON_TERMINAL_STATES[source]¶

FAILED_STATES[source]¶

create_ingestion(data_set_id, ingestion_id, ingestion_type, wait_for_completion=True, check_interval=30, aws_account_id=None)[source]¶

为数据集创建并启动新的 SPICE 数据摄取；刷新 SPICE 数据集。

另请参阅

QuickSight.Client.create_ingestion()

参数:

data_set_id (str) – 用于数据摄取的数据集的 ID。
ingestion_id (str) – 数据摄取的 ID。
ingestion_type (str) – 数据摄取类型：“INCREMENTAL_REFRESH”|“FULL_REFRESH”
wait_for_completion (bool) – 程序是否应持续运行直到作业完成
check_interval (int) – Operator 检查 QuickSight 数据摄取状态的时间间隔（秒）
aws_account_id (str | None) – AWS 账户 ID，如果设置为 None 则使用关联的 AWS 账户 ID。

返回:

返回关于已创建的数据摄取的描述性信息，包括 Ingestion ARN、HTTP 状态、数据摄取 ID 和数据摄取状态。

返回类型:

dict

get_status(aws_account_id, data_set_id, ingestion_id)[source]¶

获取 QuickSight Create Ingestion API 的当前状态。

另请参阅

QuickSight.Client.describe_ingestion()

参数:

aws_account_id (str | None) – AWS 账户 ID，如果设置为 None 则使用关联的 AWS 账户 ID。
data_set_id (str) – QuickSight 数据集 ID
ingestion_id (str) – QuickSight 数据摄取 ID

返回:

一个 QuickSight 数据摄取状态

返回类型:

str

get_error_info(aws_account_id, data_set_id, ingestion_id)[source]¶

获取有关错误的详细信息（如果有）。

参数:

aws_account_id (str | None) – AWS 账户 ID，如果设置为 None 则使用关联的 AWS 账户 ID。
data_set_id (str) – QuickSight 数据集 ID
ingestion_id (str) – QuickSight 数据摄取 ID

返回:

包含错误类型（键 ‘Type’）和消息（键 ‘Message’）的错误信息字典（如果可用）。否则，返回 None。

返回类型:

dict | None

wait_for_state(aws_account_id, data_set_id, ingestion_id, target_state, check_interval)[source]¶

检查 QuickSight Create Ingestion API 的状态。

参数:

aws_account_id (str | None) – AWS 账户 ID，如果设置为 None 则使用关联的 AWS 账户 ID。
data_set_id (str) – QuickSight 数据集 ID
ingestion_id (str) – QuickSight 数据摄取 ID
target_state (set) – 描述 QuickSight 作业的目标状态
check_interval (int) – Operator 检查 QuickSight 数据摄取状态的时间间隔（秒）

返回:

数据摄取完成后 describe_ingestion 调用的响应