列統計 API

列統計 API は、テーブル内の列の統計を返す AWS Glue API の説明を記述します。

データ型

• ColumnStatisticsTaskRun の構造

• ColumnStatisticsTaskRunningException の構造

• ColumnStatisticsTaskNotRunningException の構造

• ColumnStatisticsTaskStoppingException の構造

ColumnStatisticsTaskRun の構造

列統計実行の詳細を示すオブジェクト。

フィールド

• CustomerId - UTF-8 文字列。12 バイト長以下。

  AWS アカウント ID。

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

  特定の列統計タスク実行の識別子。

• DatabaseName – UTF-8 文字列。

  テーブルが存在するデータベース。

• TableName – UTF-8 文字列。

  列統計が生成されるテーブルの名前。

• ColumnNameList – UTF-8 文字列の配列。

  列名のリスト。何も指定されない場合は、テーブルのすべての列名がデフォルトで使用されます。

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

  テーブルが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。

• Role – UTF-8 文字列。

  統計を生成するためにサービスが引き受ける IAM ロール。

• SampleSize – 数値 (double)。100 以下。

  統計の生成に使用される行の割合。何も指定されない場合は、テーブル全体が統計の生成に使用されます。

• SecurityConfiguration - UTF-8 文字列。128 バイト長以下。

  列統計タスク実行の CloudWatch ログを暗号化するために使用されるセキュリティ設定の名前。

• NumberOfWorkers - 数値 (整数)。1 以上。

  列統計の生成に使用されるワーカーの数。ジョブは、最大 25 個のインスタンスを自動スケールするように事前設定されています。

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

  統計の生成に使用されるワーカーのタイプ。デフォルト: g.1x。

• Status – UTF-8 文字列 (有効な値: STARTING | RUNNING | SUCCEEDED | FAILED | STOPPED)。

  タスク実行のステータス。

• CreationTime – タイムスタンプ。

  このタスクが作成された時刻。

• LastUpdated – タイムスタンプ。

  このタスクが変更された前回の時点。

• StartTime – タイムスタンプ。

  タスクの開始時刻。

• EndTime – タイムスタンプ。

  タスクの終了時刻。

• ErrorMessage – 説明文字列、2048 バイト長以下、URI address multi-line string pattern に一致。

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

• DPUSeconds – 数値 (double)。None 以下。

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

ColumnStatisticsTaskRunningException の構造

列統計生成ジョブの実行中に別のジョブの開始を試行するとスローされる例外。

フィールド

• Message – UTF-8 文字列。

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

ColumnStatisticsTaskNotRunningException の構造

実行中のタスクがないときにタスク実行の停止を試行するとスローされる例外。

フィールド

• Message – UTF-8 文字列。

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

ColumnStatisticsTaskStoppingException の構造

タスク実行の停止を試行するとスローされる例外。

フィールド

• Message – UTF-8 文字列。

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

操作

• StartColumnStatisticsTaskRun アクション (Python: start_column_statistics_task_run)

• GetColumnStatisticsTaskRun アクション (Python: get_column_statistics_task_run)

• GetColumnStatisticsTaskRuns アクション (Python: get_column_statistics_task_runs)

• ListColumnStatisticsTaskRuns アクション (Python: list_column_statistics_task_runs)

• StopColumnStatisticsTaskRun アクション (Python: stop_column_statistics_task_run)

StartColumnStatisticsTaskRun アクション (Python: start_column_statistics_task_run)

指定されたテーブルと列のために列統計タスク実行を開始します。

リクエスト

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

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

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

  統計を生成するテーブルの名前。

• ColumnNameList – UTF-8 文字列の配列。

  統計を生成する列名のリスト。何も指定されない場合は、テーブルのすべての列名がデフォルトで使用されます。

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

  統計を生成するためにサービスが引き受ける IAM ロール。

• SampleSize – 数値 (double)。100 以下。

  統計の生成に使用される行の割合。何も指定されない場合は、テーブル全体が統計の生成に使用されます。

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

  テーブルが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。

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

  列統計タスク実行の CloudWatch ログを暗号化するために使用されるセキュリティ設定の名前。

レスポンス

• ColumnStatisticsTaskRunId – UTF-8 文字列、1～255 バイト長、「Single-line string pattern」に一致。

  列統計タスク実行の識別子。

エラー

• AccessDeniedException

• EntityNotFoundException

• ColumnStatisticsTaskRunningException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• InvalidInputException

GetColumnStatisticsTaskRun アクション (Python: get_column_statistics_task_run)

タスク実行 ID を指定して、タスク実行に関連付けられたメタデータ/情報を取得します。

リクエスト

• ColumnStatisticsTaskRunId – 必須: UTF-8 文字列、1～255 バイト長、「Single-line string pattern」に一致。

  特定の列統計タスク実行の識別子。

レスポンス

• ColumnStatisticsTaskRun – ColumnStatisticsTaskRun オブジェクト。

  列統計実行の詳細を表す ColumnStatisticsTaskRun オブジェクト。

エラー

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

GetColumnStatisticsTaskRuns アクション (Python: get_column_statistics_task_runs)

指定されたテーブルに関連付けられたすべての実行に関する情報を取得します。

リクエスト

• DatabaseName – 必須: UTF-8 文字列。

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

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

  テーブルの名前。

• MaxResults – 1～1000 の数値 (整数)。

  応答の最大サイズ。

• NextToken – UTF-8 文字列。

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

応答

• ColumnStatisticsTaskRuns – ColumnStatisticsTaskRun オブジェクトの配列。

  列統計タスク実行のリスト。

• NextToken – UTF-8 文字列。

  継続トークン (すべてのタスク実行がまだ返されていない場合)。

エラー

• OperationTimeoutException

ListColumnStatisticsTaskRuns アクション (Python: list_column_statistics_task_runs)

特定のアカウントについてのすべてのタスク実行をリストします。

リクエスト

• MaxResults – 1～1000 の数値 (整数)。

  応答の最大サイズ。

• NextToken – UTF-8 文字列。

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

応答

• ColumnStatisticsTaskRunIds - UTF-8 文字列の配列、文字列 100 個以下。

  列統計タスク実行 ID のリスト。

• NextToken – UTF-8 文字列。

  継続トークン (すべてのタスク実行 ID がまだ返されていない場合)。

エラー

• OperationTimeoutException

StopColumnStatisticsTaskRun アクション (Python: stop_column_statistics_task_run)

指定されたテーブルについてのタスク実行を停止します。

リクエスト

• DatabaseName – 必須: UTF-8 文字列。

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

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

  テーブルの名前。

レスポンス

• 応答パラメータはありません。

エラー

• EntityNotFoundException

• ColumnStatisticsTaskNotRunningException

• ColumnStatisticsTaskStoppingException

• OperationTimeoutException