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 – 説明文字列。2,048 バイト長以下。URI address multi-line string pattern に一致。

    ジョブのエラーメッセージ。

  • DPUSeconds – 数値 (double)。

    すべての自動スケーリングされたワーカーについて計算された DPU 使用量 (秒)。

  • RefreshType – UTF-8 文字列 (有効な値: FULL | INCREMENTAL)。

    更新タスク実行のタイプ。FULL または INCREMENTAL。

  • ProcessedBytes – 数値 (long)。

    更新タスクの実行がマテリアライズドビューを更新するためにスキャンしたバイト数。

操作

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 に一致。

    特定のマテリアライズドビューの、更新タスク実行の識別子。

応答
  • MaterializedViewRefreshTaskRunMaterializedViewRefreshTaskRun オブジェクト。

    タスク実行の詳細を示す 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 文字列。

    問題を説明するメッセージ。