View a markdown version of this page

实体化视图 API - AWS Glue

实体化视图 API

实体化视图 API 描述了用于启动、停止和监控实体化视图刷新任务运行的 AWS Glue 数据类型和操作。

数据类型

MaterializedViewRefreshTaskRun 结构

显示实体化视图刷新任务运行详细信息的对象。

字段
  • CustomerId – UTF-8 字符串,长度不超过 12 个字节。

    AWS 账户 ID。

  • MaterializedViewRefreshTaskRunId – UTF-8 字符串,与 Custom string pattern #48 匹配。

    实体化视图刷新任务运行的标识符。

  • DatabaseName – UTF-8 字符串。

    表所在的数据库。

  • TableName – UTF-8 字符串。

    实体化视图的名称。

  • CatalogId – 目录 id 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据目录的 ID。如果没有提供,则默认情况下使用 账户 ID。

  • Role – UTF-8 字符串。

    服务为运行实体化视图刷新任务而代入的 IAM 角色。

  • Status – UTF-8 字符串(有效值:STARTING |RUNNING |SUCCEEDED |FAILED |STOPPED )。

    任务运行的状态。

  • CreationTime – 时间戳。

    此任务的创建时间。

  • LastUpdated – 时间戳。

    上次修改此任务的时间点。

  • StartTime – 时间戳。

    任务的开始时间。

  • EndTime – 时间戳。

    任务的结束时间。

  • ErrorMessage – 描述字符串,长度不超过 2048 个字节,与 URI address multi-line string pattern 匹配。

    作业的错误消息。

  • DPUSeconds – 数字(double)。

    所有自动扩展的 Worker 线程的计算 DPU 使用量(以秒为单位)。

  • RefreshType – UTF-8 字符串(有效值:FULL |INCREMENTAL )。

    刷新任务运行的类型。FULL 或 INCREMENTAL。

  • ProcessedBytes – 数字(长整型)。

    刷新任务运行为刷新实体化视图所扫描的字节数。

操作

StartMaterializedViewRefreshTaskRun 操作(Python:start_materialized_view_refresh_task_run)

为指定的实体化视图启动实体化视图刷新任务运行。

请求
  • CatalogId必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据目录的 ID。如果没有提供,则默认情况下使用 账户 ID。

  • DatabaseName必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据库的名称。

  • TableName必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    要为其运行刷新任务的实体化视图的名称。

  • FullRefresh – 布尔值。

    指定这是否是任务运行的完全刷新。

响应
  • MaterializedViewRefreshTaskRunId – UTF-8 字符串,与 Custom string pattern #48 匹配。

    实体化视图刷新任务运行的标识符。

错误
  • AccessDeniedException

  • EntityNotFoundException

  • MaterializedViewRefreshTaskRunningException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • InvalidInputException

StopMaterializedViewRefreshTaskRun 操作(Python:stop_materialized_view_refresh_task_run)

为指定的实体化视图停止实体化视图刷新任务运行。

请求
  • CatalogId必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据目录的 ID。如果没有提供,则默认情况下使用 账户 ID。

  • DatabaseName必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据库的名称。

  • TableName必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    实体化视图的名称。

响应
  • 无响应参数。

错误
  • AccessDeniedException

  • MaterializedViewRefreshTaskNotRunningException

  • MaterializedViewRefreshTaskStoppingException

  • InvalidInputException

  • OperationTimeoutException

GetMaterializedViewRefreshTaskRun 操作(Python:get_materialized_view_refresh_task_run)

在已知任务运行 ID 的情况下,获取任务运行的相关元数据/信息。

请求
  • CatalogId必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据目录的 ID。如果没有提供,则默认情况下使用 账户 ID。

  • MaterializedViewRefreshTaskRunId必填: UTF-8 字符串,与 Custom string pattern #48 匹配。

    特定实体化视图刷新任务运行的标识符。

响应
  • MaterializedViewRefreshTaskRun – 一个 MaterializedViewRefreshTaskRun 对象。

    表示任务运行详细信息的 MaterializedViewRefreshTaskRun 对象。

错误
  • AccessDeniedException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

ListMaterializedViewRefreshTaskRuns 操作(Python:list_materialized_view_refresh_task_runs)

列出特定账户的所有任务运行。

请求
  • CatalogId必填:UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据目录的 ID。如果没有提供,则默认情况下使用 账户 ID。

  • DatabaseName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    表所在的数据库。

  • TableName – UTF-8 字符串,长度不少于 1 个字节或超过 255 个字节,与 Single-line string pattern 匹配。

    实体化视图的名称。

  • MaxResults – 数字(整数),不小于 1 或大于 1000。

    响应的最大大小。

  • NextToken – UTF-8 字符串。

    延续标记 (如果这是延续调用)。

响应
  • MaterializedViewRefreshTaskRunsMaterializedViewRefreshTaskRun 对象的数组。

    ListMaterializedViewRefreshTaskRuns 操作的结果。

  • NextToken – UTF-8 字符串。

    延续令牌(如果尚未返回所有任务运行 ID)。

错误
  • AccessDeniedException

  • InvalidInputException

  • OperationTimeoutException

异常

MaterializedViewRefreshTaskRunningException 结构

当任务已处于运行状态时引发的异常。

字段
  • Message – UTF-8 字符串。

    描述问题的消息。

MaterializedViewRefreshTaskNotRunningException 结构

当停止不处于运行状态的任务时引发的异常。

字段
  • Message – UTF-8 字符串。

    描述问题的消息。

MaterializedViewRefreshTaskStoppingException 结构

当任务已处于正在停止状态时引发的异常。

字段
  • Message – UTF-8 字符串。

    描述问题的消息。