airflow.providers.amazon.aws.hooks.quicksight

模块内容

类

QuickSightHook

与 Amazon QuickSight 交互。
class airflow.providers.amazon.aws.hooks.quicksight.QuickSightHook(*args, **kwargs)[源代码]

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

与 Amazon QuickSight 交互。

提供 boto3.client("quicksight") 的简单封装。

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

另请参阅

NON_TERMINAL_STATES[源代码]
FAILED_STATES[源代码]
create_ingestion(data_set_id, ingestion_id, ingestion_type, wait_for_completion=True, check_interval=30, aws_account_id=None)[源代码]

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

另请参阅

参数

  • data_set_id (str) – 摄取中使用的数据集的 ID。

  • ingestion_id (str) – 摄取的 ID。

  • ingestion_type (str) – 摄取类型：“INCREMENTAL_REFRESH”|“FULL_REFRESH”

  • wait_for_completion (bool) – 是否程序应保持运行直到作业完成

  • check_interval (int) – 操作符将检查 QuickSight 摄取状态的时间间隔（以秒为单位）

  • aws_account_id (str | None) – AWS 账户 ID，如果设置为 None，则使用关联的 AWS 账户 ID。

返回

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

返回类型

dict

get_status(aws_account_id, data_set_id, ingestion_id)[源代码]

获取 QuickSight 创建摄取 API 的当前状态。

另请参阅

参数

  • 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)[源代码]

获取有关错误的任何信息。

参数

  • 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)[源代码]

检查 QuickSight 创建摄取 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) – 操作符将检查 QuickSight 摄取状态的时间间隔（以秒为单位）

返回

摄取完成后 describe_ingestion 调用的响应

此条目是否有帮助？