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

    資料表所在的 Data Catalog 的 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 – 數字 (雙位數)。

    所有自動擴展之工作者的計算 DPU 用量 (以秒為單位)。

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

    重新整理任務執行的類型。完整或增量。

  • ProcessedBytes – 數字 (long)。

    重新整理任務執行已掃描以重新整理具體化檢視的位元組數。

作業

StartMaterializedViewRefreshTaskRun 動作 (Python:start_materialized_view_refresh_task_run)

為指定的具體化視觀表啟動具體化視觀表重新整理任務執行。

請求
  • CatalogId必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern

    資料表所在之 Data Catalog 的 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

    資料表所在之 Data Catalog 的 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

    資料表所在的 Data Catalog 的 ID。若沒有提供,則依預設會使用 帳戶 ID。

  • MaterializedViewRefreshTaskRunId必要:UTF-8 字串,需符合Custom string pattern #48

    特定具體化檢視重新整理任務執行的識別符。

回應
  • MaterializedViewRefreshTaskRunMaterializedViewRefreshTaskRun 物件。

    MaterializedViewRefreshTaskRun 物件,代表任務執行的詳細資訊。

錯誤
  • AccessDeniedException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

ListMaterializedViewRefreshTaskRuns 動作 (Python:list_materialized_view_refresh_task_runs)

列出特定帳戶的所有任務執行。

請求
  • CatalogId必要:UTF-8 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,且需符合Single-line string pattern

    資料表所在的 Data Catalog 的 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 字串。

    接續符記,如果這是接續呼叫。

回應
  • MaterializedViewRefreshTaskRuns – 一個 MaterializedViewRefreshTaskRun 物件陣列。

    ListMaterializedViewRefreshTaskRuns 動作的結果。

  • NextToken – UTF-8 字串。

    持續權杖 (如果尚未傳回所有任務執行 ID)。

錯誤
  • AccessDeniedException

  • InvalidInputException

  • OperationTimeoutException

例外狀況

MaterializedViewRefreshTaskRunningException 結構

當任務已處於執行中狀態時擲回例外狀況。

欄位
  • Message – UTF-8 字串。

    說明問題的訊息。

MaterializedViewRefreshTaskNotRunningException 結構

停止未處於執行中狀態的任務時擲回例外狀況。

欄位
  • Message – UTF-8 字串。

    說明問題的訊息。

MaterializedViewRefreshTaskStoppingException 結構

當任務已處於停止狀態時擲回例外狀況。

欄位
  • Message – UTF-8 字串。

    說明問題的訊息。