テーブルオプティマイザ API - AWS Glue

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

テーブルオプティマイザ API

テーブルオプティマイザは、 AWS Glue API圧縮を有効にして読み取りパフォーマンスを向上させるための API について説明します。

データ型

TableOptimizer 構造

テーブルに関連付けられたオプティマイザーに関する詳細が含まれます。

フィールド
  • type – UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。現在、有効な値は compaction のみです。

  • configurationTableOptimizerConfiguration オブジェクト。

    テーブルオプティマイザーを作成または更新する際に指定された TableOptimizerConfiguration オブジェクト。

  • lastRunTableOptimizerRun オブジェクト。

    テーブルオプティマイザーの前回の実行を表す TableOptimizerRun オブジェクト。

TableOptimizerConfiguration 構造

テーブルオプティマイザーの設定に関する詳細が含まれます。テーブルオプティマイザーを作成または更新する際に、この設定を渡します。

フィールド
  • roleArn – UTF-8 文字列、1~512 バイト長、 に一致Single-line string pattern

    呼び出し元によって渡されるロール。このロールは、呼び出し元に代わってオプティマイザーに関連付けられたリソースを更新するための許可をサービスに付与します。

  • enabled – ブール。

    テーブル最適化が有効かどうか。

TableOptimizerRun 構造

テーブルオプティマイザーの実行の詳細が含まれます。

フィールド
  • eventType – UTF-8 文字列 (有効な値: starting="STARTING" | completed="COMPLETED" | failed="FAILED" | in_progress="IN_PROGRESS")。

    テーブルオプティマイザーの実行のステータスを表すイベントタイプ。

  • startTimestamp – タイムスタンプ。

    Lake Formation 内で圧縮ジョブが開始された時点のエポックタイムスタンプを表します。

  • endTimestamp – タイムスタンプ。

    圧縮ジョブが終了した時点のエポックタイムスタンプを表します。

  • metricsRunMetrics オブジェクト。

    オプティマイザーの実行のメトリクスを含む RunMetrics オブジェクト。

  • error – UTF-8 文字列。

    オプティマイザーの実行中に発生したエラー。

BatchGetTableOptimizerEntry 構造

BatchGetTableOptimizer オペレーションで取得するテーブルオプティマイザーを表します。

フィールド
  • catalogId – カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • databaseName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルが存在するカタログのデータベースの名前。

  • tableName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルの名前。

  • type – UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。

BatchTableOptimizer 構造

BatchGetTableOptimizer オペレーションによって返されたいずれかのテーブルオプティマイザーの詳細が含まれます。

フィールド
  • catalogId – カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • databaseName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルが存在するカタログのデータベースの名前。

  • tableName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルの名前。

  • tableOptimizerTableOptimizer オブジェクト。

    テーブルオプティマイザーの設定と前回の実行に関する詳細を含む TableOptimizer オブジェクト。

BatchGetTableOptimizerError 構造

BatchGetTableOptimizer オペレーションによって返されたエラーリスト内のいずれかのエラーに関する詳細が含まれます。

フィールド
  • errorErrorDetail オブジェクト。

    エラーに関するコードとメッセージの詳細を含む ErrorDetail オブジェクト。

  • catalogId – カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • databaseName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルが存在するカタログのデータベースの名前。

  • tableName – UTF-8 文字列、少なくとも 1 バイト長。

    テーブルの名前。

  • type – UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。

RunMetrics 構造

オプティマイザーの実行のメトリクス。

フィールド
  • NumberOfBytesCompacted – UTF-8 文字列。

    圧縮ジョブの実行によって削除されたバイト数。

  • NumberOfFilesCompacted – UTF-8 文字列。

    圧縮ジョブの実行によって削除されたファイル数。

  • NumberOfDpus – UTF-8 文字列。

    ジョブが消費したDPU時間数。

  • JobDurationInHour – UTF-8 文字列。

    ジョブの実行時間 (単位: 時間)。

操作

GetTableOptimizer アクション (Python: get_table_optimizer)

指定されたテーブルに関連付けられているすべてのオプティマイザーの設定を返します。

リクエスト
  • CatalogId – 必須: カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • Type必須: UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。

レスポンス
  • CatalogId – カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName – UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName – UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • TableOptimizerTableOptimizer オブジェクト。

    指定されたテーブルに関連付けられたオプティマイザー。

エラー
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

BatchGetTableOptimizer アクション (Python: batch_get_table_optimizer)

指定されたテーブルオプティマイザーの設定を返します。

リクエスト
  • Entries – 必須: BatchGetTableOptimizerEntry オブジェクトの配列。

    取得するテーブルオプティマイザーを指定する BatchGetTableOptimizerEntry オブジェクトのリスト。

応答
  • TableOptimizersBatchTableOptimizer オブジェクトの配列。

    BatchTableOptimizer オブジェクトのリスト。

  • FailuresBatchGetTableOptimizerError オブジェクトの配列。

    オペレーションで発生したエラーのリスト。

エラー
  • InternalServiceException

ListTableOptimizerRuns アクション (Python: list_table_optimizer_runs)

特定のテーブルについての以前のオプティマイザーの実行の履歴をリストします。

リクエスト
  • CatalogId – 必須: カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • Type必須: UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。現在、有効な値は compaction のみです。

  • MaxResults – 数値 (整数)。

    各呼び出しで返すオプティマイザーの実行の最大数。

  • NextToken – UTF-8 文字列。

    継続トークン (これが継続呼び出しの場合)。

応答
  • CatalogId – カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName – UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName – UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • NextToken – UTF-8 文字列。

    返されたオプティマイザーの実行のリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。

  • TableOptimizerRunsTableOptimizerRun オブジェクトの配列。

    テーブルに関連付けられているオプティマイザーの実行のリスト。

エラー
  • EntityNotFoundException

  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

CreateTableOptimizer アクション (Python: create_table_optimizer)

特定の関数のために新しいテーブルオプティマイザーを作成します。現在サポートされているオプティマイザーの種類は compaction のみです。

リクエスト
  • CatalogId – 必須: カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • Type必須: UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。現在、有効な値は compaction のみです。

  • TableOptimizerConfiguration – 必須: TableOptimizerConfiguration オブジェクト。

    テーブルオプティマイザーの設定を表す TableOptimizerConfiguration オブジェクト。

レスポンス
  • 応答パラメータはありません。

エラー
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • InternalServiceException

DeleteTableOptimizer アクション (Python: delete_table_optimizer)

オプティマイザーと、テーブルに関連付けられているすべてのメタデータを削除します。最適化はテーブルに対して実行されなくなります。

リクエスト
  • CatalogId – 必須: カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • Type必須: UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。

レスポンス
  • 応答パラメータはありません。

エラー
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateTableOptimizer アクション (Python: update_table_optimizer)

既存のテーブルオプティマイザーの設定を更新します。

リクエスト
  • CatalogId – 必須: カタログ ID 文字列、1~255 バイト長、Single-line string pattern に一致。

    テーブルのカタログ ID。

  • DatabaseName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルが存在するカタログのデータベースの名前。

  • TableName必須: UTF-8 文字列、1~255 バイト長、 に一致Single-line string pattern

    テーブルの名前。

  • Type必須: UTF-8 文字列 (有効な値: compaction="COMPACTION")。

    テーブルオプティマイザーのタイプ。現在、有効な値は compaction のみです。

  • TableOptimizerConfiguration – 必須: TableOptimizerConfiguration オブジェクト。

    テーブルオプティマイザーの設定を表す TableOptimizerConfiguration オブジェクト。

レスポンス
  • 応答パラメータはありません。

エラー
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException