Table API
テーブル API は、データ型とテーブルに関連する操作について説明しています。
データ型
Table 構造
列と行で構成されている関連データのコレクションを表します。
フィールド
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、これはすべて小文字であることが必要です。
-
DatabaseName– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルメタデータが存在するデータベースの名前。Hive との互換性を保つため、名前はすべて小文字にする必要があります。
-
Description– 説明文字列。2,048 バイト長以下。URI address multi-line string pattern に一致。テーブルの説明。
-
Owner– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの所有者。
-
CreateTime– タイムスタンプ。データカタログでテーブル定義が作成された時刻。
-
UpdateTime– タイムスタンプ。テーブルが最後に更新された時刻。
-
LastAccessTime– タイムスタンプ。テーブルが最後にアクセスされた時刻。これは通常 HDFS から取得されるため、信頼性が低い場合があります。
-
LastAnalyzedTime– タイムスタンプ。このテーブルの列統計が最後に計算された時刻。
-
Retention– 数値 (整数)、None 以下。このテーブルの保持時間。
-
StorageDescriptor– StorageDescriptor オブジェクト。このテーブルの物理ストレージに関する情報を含むストレージ記述子。
-
PartitionKeys– Column オブジェクトの配列。テーブルがパーティション分割される列のリスト。パーティションキーとしてプリミティブ型のみがサポートされています。
Amazon Athena によって使用されるテーブルを作成しており、
partitionKeysを指定していない場合は必ず、partitionKeysの値を空のリストに設定する必要があります。例:"PartitionKeys": [] -
ViewOriginalText- UTF-8 文字列。409,600 バイト長以下。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。テーブルが
VIRTUAL_VIEWの場合、base64 でエンコードされた特定の Athena 設定です。 -
ViewExpandedText- UTF-8 文字列。409,600 バイト長以下。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。
-
TableType- UTF-8 文字列。255 バイト長以下。このテーブルのタイプ。AWS Glue では、
EXTERNAL_TABLEタイプでテーブルが作成されます。Athena など、その他のサービスでは、テーブルタイプを追加してテーブルが作成されることがあります。AWS Glue 関連テーブルタイプ:
- EXTERNAL_TABLE
-
Hive 互換属性 - Hive 以外の管理テーブルを示します。
- GOVERNED
-
AWS Lake Formation で使用されます。AWS Glue データカタログは
GOVERNEDを認識します。
-
Parameters– キーバリューペアのマップ配列。各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。
-
CreatedBy– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルを作成した個人または団体。
-
IsRegisteredWithLakeFormation– ブール。テーブルが AWS Lake Formation に登録されているかどうかを示します。
-
TargetTable– TableIdentifier オブジェクト。リソースリンク用のターゲットテーブルを記述する
TableIdentifier構造。 -
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルデータベースがあるデータカタログの ID。
-
VersionId– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルバージョンの ID。
-
FederatedTable– FederatedTable オブジェクト。AWS Glue Data Catalog の外部のエンティティを参照する
FederatedTable構造。 -
ViewDefinition– ViewDefinition オブジェクト。ビューのダイアレクト、クエリなど、ビューを定義するすべての情報を含む構造。
-
IsMultiDialectView– ブール。ビューがさまざまなクエリエンジンの SQL ダイアレクトをサポートし、それらのエンジンで読み取れるようにするかどうかを指定します。
TableInput 構造
テーブルの定義に使用される構造。
フィールド
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive との互換性を保つため、これは保存時には小文字で折りた畳まれます。
-
Description– 説明文字列。2,048 バイト長以下。URI address multi-line string pattern に一致。テーブルの説明。
-
Owner– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの所有者。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。
-
LastAccessTime– タイムスタンプ。テーブルが最後にアクセスされた時刻。
-
LastAnalyzedTime– タイムスタンプ。このテーブルの列統計が最後に計算された時刻。
-
Retention– 数値 (整数)、None 以下。このテーブルの保持時間。
-
StorageDescriptor– StorageDescriptor オブジェクト。このテーブルの物理ストレージに関する情報を含むストレージ記述子。
-
PartitionKeys– Column オブジェクトの配列。テーブルがパーティション分割される列のリスト。パーティションキーとしてプリミティブ型のみがサポートされています。
Amazon Athena によって使用されるテーブルを作成しており、
partitionKeysを指定していない場合は必ず、partitionKeysの値を空のリストに設定する必要があります。例:"PartitionKeys": [] -
ViewOriginalText- UTF-8 文字列。409,600 バイト長以下。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。テーブルが
VIRTUAL_VIEWの場合、base64 でエンコードされた特定の Athena 設定です。 -
ViewExpandedText- UTF-8 文字列。409,600 バイト長以下。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。
-
TableType- UTF-8 文字列。255 バイト長以下。このテーブルのタイプ。AWS Glue では、
EXTERNAL_TABLEタイプでテーブルが作成されます。Athena など、その他のサービスでは、テーブルタイプを追加してテーブルが作成されることがあります。AWS Glue 関連テーブルタイプ:
- EXTERNAL_TABLE
-
Hive 互換属性 - Hive 以外の管理テーブルを示します。
- GOVERNED
-
AWS Lake Formation で使用されます。AWS Glue データカタログは
GOVERNEDを認識します。
-
Parameters– キーバリューペアのマップ配列。各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。
-
TargetTable– TableIdentifier オブジェクト。リソースリンク用のターゲットテーブルを記述する
TableIdentifier構造。 -
ViewDefinition– ViewDefinitionInput オブジェクト。ビューのダイアレクト、クエリなど、ビューを定義するすべての情報を含む構造。
FederatedTable 構造
AWS Glue Data Catalog の外部のエンティティを指すテーブル。
フィールド
-
Identifier– UTF-8 文字列。1 ~ 512 バイト長。Single-line string pattern に一致。フェデレーションテーブルの一意の識別子。
-
DatabaseIdentifier– UTF-8 文字列。1 ~ 512 バイト長。Single-line string pattern に一致。フェデレーションデータベースの一意の識別子。
-
ConnectionName– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。外部メタストアへの接続の名前。
-
ConnectionType– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。フェデレーティッドテーブルへのアクセスに使用される接続タイプで、外部データソースに接続するためのプロトコルまたは方法を指定します。
列の構造
Table 内の列。
フィールド
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。Columnの名前。 -
Type– UTF-8 文字列。131,072 バイト長以下。Single-line string pattern に一致。Columnのデータ型。 -
Comment– コメント文字列。255 バイト長以下。Single-line string pattern に一致。自由形式のテキストコメント。
-
Parameters– キーバリューペアのマップ配列。各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキーバリューペアは、列に関連付けられたプロパティを定義します。
StorageDescriptor 構造
テーブルデータの物理ストレージについて説明します。
フィールド
-
Columns– Column オブジェクトの配列。テーブル内の
Columnsのリストです。 -
Location– 場所文字列。2,056 バイト長以下。URI address multi-line string pattern に一致。テーブルの物理的な場所。デフォルトでは、ウェアハウスの場所、その後にウェアハウス内のデータベースの場所、その後にテーブル名が続く形式になります。
-
AdditionalLocations– UTF-8 文字列の配列。Delta テーブルへのパスを指す場所のリスト。
-
InputFormat– 書式設定文字列。128 バイト長以下。Single-line string pattern に一致。入力形式:
SequenceFileInputFormat(バイナリ)、またはTextInputFormat、もしくはカスタム形式。 -
OutputFormat– 書式設定文字列。128 バイト長以下。Single-line string pattern に一致。出力形式:
SequenceFileOutputFormat(バイナリ)、またはIgnoreKeyTextOutputFormat、もしくはカスタム形式。 -
Compressed– ブール。テーブルのデータが圧縮されている場合は
True、圧縮されていない場合はFalse。 -
NumberOfBuckets– 数値 (整数)。テーブルにディメンション列が含まれている場合、指定する必要があります。
-
SerdeInfo– SerDeInfo オブジェクト。シリアライズ/デシリアライズ (SerDe) 情報。
-
BucketColumns– UTF-8 文字列の配列。テーブルのリデューサーグループ化列、クラスター列、およびバケット列のリスト。
-
SortColumns– 注文 オブジェクトの配列。テーブル内の各バケットのソート順を指定するリスト。
-
Parameters– キーバリューペアのマップ配列。各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
ユーザーが指定したキーバリュー形式のプロパティ。
-
SkewedInfo– SkewedInfo オブジェクト。列に高い頻度で表示される値 (歪んだ値) に関する情報。
-
StoredAsSubDirectories– ブール。テーブルデータがサブディレクトリに保管されている場合は
True、保管されていない場合はFalse。 -
SchemaReference– SchemaReference オブジェクト。AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
テーブルを作成するときにスキーマに空の列リストを渡し、代わりにスキーマリファレンスを使用します。
SchemaReference 構造
AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
フィールド
-
SchemaId– SchemaId オブジェクト。スキーマアイデンティティフィールドを含む構造。こちらか
SchemaVersionIdのいずれかを指定する必要があります。 -
SchemaVersionId– UTF-8 文字列。36 バイト長。Custom string pattern #44 に一致。スキーマのバージョンに割り当てられた一意の ID。こちらか
SchemaIdのいずれかを指定する必要があります。 -
SchemaVersionNumber– 数値 (long)。1~100000。スキーマのバージョン番号。
SerDeInfo 構造
エクストラクターおよびローダーとして機能するシリアライズ/デシリアライズプログラム (SerDe) に関する情報。
フィールド
-
Name– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。SerDe 名。
-
SerializationLibrary– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。通常、SerDe を実装するクラス。例は
org.apache.hadoop.hive.serde2.columnar.ColumnarSerDeです。 -
Parameters– キーバリューペアのマップ配列。各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキーバリューペアは SerDe の初期化パラメータを定義します。
Order 構造
ソートされた列のソート順を指定します。
フィールド
-
Column– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。列の名前。
-
SortOrder– 必須: 数値 (integer)。1 以下。列が昇順 (
== 1) または降順 (==0) でソートされていることを指定します。
SkewedInfo 構造
テーブルで歪んだ値を指定します。「歪んだ値」とは、非常に高い頻度で発生する値です。
フィールド
-
SkewedColumnNames– UTF-8 文字列の配列。歪んだ値を含む列名のリスト。
-
SkewedColumnValues– UTF-8 文字列の配列。頻繁に出現するため、歪んだとみなされる値のリスト。
-
SkewedColumnValueLocationMaps– キーバリューペアのマップ配列。各キーは UTF-8 文字列。
各値は UTF-8 文字列。
歪んだ値が含まれている列へのマッピング。
TableVersion 構造
テーブルのバージョンを指定します。
フィールド
-
Table– Table オブジェクト。該当するテーブル。
-
VersionId– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。このテーブルのバージョンを特定する ID 値。
VersionIdは整数の文字列表現です。各バージョンは 1 ずつ増加します。
TableError 構造
テーブル操作に対するエラーレコード。
フィールド
-
TableName– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、これはすべて小文字であることが必要です。
-
ErrorDetail– ErrorDetail オブジェクト。エラーに関する詳細。
TableVersionError 構造
テーブルバージョン操作に対するエラーレコード。
フィールド
-
TableName– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。該当するテーブルの名前。
-
VersionId– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。該当するバージョンの ID 値。
VersionIDは整数の文字列表現です。各バージョンは 1 ずつ増加します。 -
ErrorDetail– ErrorDetail オブジェクト。エラーに関する詳細。
SortCriterion 構造
ソート基準となるフィールドとソート順を指定します。
フィールド
-
FieldName– 値の文字列の長さ。1~1024 バイト長。ソートするフィールドの名前。
-
Sort– UTF-8 文字列 (有効な値:ASC="ASCENDING"|DESC="DESCENDING")。昇順または降順のソート。
TableIdentifier 構造
リソースリンク用のターゲットテーブルを記述する構造。
フィールド
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルデータベースがあるデータカタログの ID。
-
DatabaseName– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。ターゲットテーブルを含むカタログデータベースの名前。
-
Name– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。ターゲットテーブルの名前。
-
Region– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。ターゲットテーブルのリージョン。
KeySchemaElement 構造
名前とタイプで構成されるパーティションキーペア。
フィールド
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションキーの名前。
-
Type– 必須: UTF-8 文字列。131072 バイト長以下。Single-line string pattern に一致。パーティションキーのタイプ。
PartitionIndex 構造
パーティションインデックスの構造。
フィールド
-
Keys– 必須: UTF-8 文字列の配列。1 個の以上の文字列。パーティションインデックスのキー。
-
IndexName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションインデックスの名前。
PartitionIndexDescriptor 構造
テーブル内のパーティションインデックスの記述子。
フィールド
-
IndexName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションインデックスの名前。
-
Keys– 必須: KeySchemaElement オブジェクトの配列、少なくとも 1 つの構造体。KeySchemaElement構造体としてのパーティションインデックスの 1 つ以上のキーのリスト。 -
IndexStatus– 必須: UTF-8 文字列 (有効な値:CREATING|ACTIVE|DELETING|FAILED)。インデックスパーティションのステータス。
次のようなステータスがあります。
-
CREATING: インデックスは作成中です。インデックスが CREATING 状態の場合、インデックスまたはそのテーブルは削除できません。
-
ACTIVE: インデックスの作成に成功しました。
-
FAILED: インデックスの作成に失敗しました。
-
DELETING: インデックスは、インデックスのリストから削除されます。
-
-
BackfillErrors– BackfillError オブジェクトの配列。既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。
BackfillError 構造
既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。
これらのエラーでは、インデックスの登録が失敗した理由の詳細が表示され、応答として限られた数のパーティションが示されます。これにより、障害が発生したパーティションを修正し、インデックスの登録を再試行できます。発生する可能性のある最も一般的なエラーのセットは、次のように分類されます。
-
EncryptedPartitionError: パーティションが暗号化されています。
-
InvalidPartitionTypeDataError: パーティション値がそのパーティション列のデータ型と一致しません。
-
MissingPartitionValueError: パーティションが暗号化されています。
-
UnsupportedPartitionCharacterError: パーティション値内の文字がサポートされていません。例: U+0000、U+0001、U+0002。
-
InternalError: 他のエラーコードに属さないすべてのエラー。
フィールド
-
Code– UTF-8 文字列 (有効な値:ENCRYPTED_PARTITION_ERROR|INTERNAL_ERROR|INVALID_PARTITION_TYPE_DATA_ERROR|MISSING_PARTITION_VALUE_ERROR|UNSUPPORTED_PARTITION_CHARACTER_ERROR)。既存のテーブルのパーティションインデックスを登録するときに発生したエラーのエラーコード。
-
Partitions– PartitionValueList オブジェクトの配列。応答内の限られた数のパーティションのリスト。
IcebergInput 構造
カタログ内に作成する Apache Iceberg メタデータテーブルを定義する構造。
フィールド
-
MetadataOperation– 必須: UTF-8 文字列 (有効な値:CREATE)。必須のメタデータオペレーション。これは
CREATEにのみ設定できます。 -
Version– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。Iceberg テーブルのテーブルバージョン。デフォルトは 2 です。
-
CreateIcebergTableInput– CreateIcebergTableInput オブジェクト。テーブルプロパティやメタデータ仕様など、AWS Glue Data Catalog で新しい Iceberg テーブルを作成するために必要な設定パラメータ。
OpenTableFormatInput 構造
オープン形式のテーブルを表す構造。
フィールド
-
IcebergInput– IcebergInput オブジェクト。Apache Iceberg メタデータテーブルを定義する
IcebergInput構造を指定します。
ViewDefinition 構造
表現の詳細を含む構造。
フィールド
-
IsProtected– ブール。このフラグを true に設定すると、クエリ計画中にユーザー提供のオペレーションをビューの論理プランにプッシュしないようにエンジンに指示できます。ただし、このフラグを設定しても、エンジンが従うとは限りません。エンジンのドキュメントを参照して、提供される保証を理解してください。
-
Definer- UTF-8 文字列。20 ~ 2,048 バイト長。Single-line string pattern に一致。SQL のビューの定義者。
-
SubObjects- UTF-8 文字列の配列。文字列 10 個以下。テーブル Amazon リソースネーム (ARN) のリスト。
-
Representations– ViewRepresentation オブジェクトの配列。1~1000 個の構造体。表現のリスト。
ViewDefinitionInput 構造
AWS Glue ビューを作成または更新するための詳細を含む構造。
フィールド
-
IsProtected– ブール。このフラグを true に設定すると、クエリ計画中にユーザー提供のオペレーションをビューの論理プランにプッシュしないようにエンジンに指示できます。ただし、このフラグを設定しても、エンジンが従うとは限りません。エンジンのドキュメントを参照して、提供される保証を理解してください。
-
Definer- UTF-8 文字列。20 ~ 2,048 バイト長。Single-line string pattern に一致。SQL のビューの定義者。
-
Representations– ViewRepresentationInput オブジェクトの配列、1~10 個の構造。ビューのダイアレクトとビューを定義するクエリを含む構造のリスト。
-
SubObjects- UTF-8 文字列の配列。文字列 10 個以下。ビューを構成するベーステーブルの ARN のリスト。
ViewRepresentation 構造
ビューのダイアレクトとビューを定義するクエリを含む構造。
フィールド
-
Dialect– UTF-8 文字列 (有効な値:REDSHIFT|ATHENA|SPARK)。クエリエンジンのダイアレクト。
-
DialectVersion– UTF-8 文字列、1~255 バイト長。クエリエンジンのダイアレクトのバージョン。3.0.0 などです。
-
ViewOriginalText- UTF-8 文字列。409,600 バイト長以下。CREATE VIEW DDL実行中に顧客が提供したSELECTクエリ。この SQL は、ビューのクエリ中には使用されません (ViewExpandedTextが代わりに使用されます)。ViewOriginalTextは、ユーザーがビューを作成した元の DDL コマンドを表示したいSHOW CREATE VIEWのような場合に使用されます。 -
ViewExpandedText- UTF-8 文字列。409,600 バイト長以下。ビューの拡張された SQL。この SQL は、ビューでクエリを処理するときにエンジンによって使用されます。エンジンは、ビューの作成中にオペレーションを実行して
ViewOriginalTextをViewExpandedTextに変換する場合があります。例:-
完全修飾識別子:
SELECT * from table1 -> SELECT * from db1.table1
-
-
ValidationConnection– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。ビューの特定の表現の検証に使用される接続の名前。
-
IsStale– ブール。古いとマークされたダイアレクトは無効になり、それぞれのクエリエンジンでクエリを実行する前に更新する必要があります。
ViewRepresentationInput 構造
Lake Formation ビューを更新または作成するための表現の詳細を含む構造。
フィールド
-
Dialect– UTF-8 文字列 (有効な値:REDSHIFT|ATHENA|SPARK)。特定の表現のエンジンタイプを指定するパラメータ。
-
DialectVersion– UTF-8 文字列、1~255 バイト長。特定の表現のエンジンのバージョンを指定するパラメータ。
-
ViewOriginalText- UTF-8 文字列。409,600 バイト長以下。ビューを記述する元の SQL クエリを表す文字列。
-
ValidationConnection– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。ビューの特定の表現の検証に使用される接続の名前。
-
ViewExpandedText- UTF-8 文字列。409,600 バイト長以下。ビューを記述する SQL クエリおよび拡張されたリソースの ARN を表す文字列
UpdateOpenTableFormatInput 構造
AWS Glue Data Catalog でオープンテーブル形式のテーブルを更新するための入力パラメータ。Apache Iceberg などの形式固有の更新操作のラッパーとして機能します。
フィールド
-
UpdateIcebergInput– UpdateIcebergInput オブジェクト。スキーマの変更、パーティションの仕様、テーブルのプロパティなど、適用するテーブルの変更を定義する Apache Iceberg 固有の更新パラメータ。
UpdateIcebergInput 構造
既存の Iceberg テーブルに適用される更新操作を含む、AWS Glue Data Catalog の Apache Iceberg テーブルの更新に固有の入力パラメータ。
フィールド
-
UpdateIcebergTableInput– 必須: UpdateIcebergTableInput オブジェクト。Iceberg テーブルに適用する特定の更新操作。スキーマ、パーティション、プロパティなど、テーブルの新しい状態を定義する更新のリストが含まれます。
CreateIcebergTableInput 構造
テーブルプロパティやメタデータ仕様など、AWS Glue Data Catalog で新しい Iceberg テーブルを作成するために必要な設定パラメータ。
フィールド
-
Location– 必須: 場所文字列。2,056 バイト長以下。URI address multi-line string pattern に一致。Iceberg テーブルデータが保存される S3 ロケーション。
-
Schema– 必須: IcebergSchema オブジェクト。Iceberg テーブルの構造、フィールドタイプ、メタデータを指定するスキーマ定義。
-
PartitionSpec– IcebergPartitionSpec オブジェクト。最適なクエリパフォーマンスのために、Iceberg テーブルデータを整理およびパーティショニングする方法を定義するパーティショニング仕様。
-
WriteOrder– IcebergSortOrder オブジェクト。クエリのパフォーマンスを最適化するために各パーティション内でデータを順序付ける方法を定義する、ソート順序の仕様。
-
Properties– キーバリューペアのマップ配列。各キーは UTF-8 文字列。
各値は UTF-8 文字列。
Iceberg テーブルの追加テーブルプロパティと設定のキーと値のペア。
UpdateIcebergTableInput 構造
AWS Glue Data Catalog の既存の Iceberg テーブルに適用する更新操作が含まれ、テーブルメタデータの新しい状態を定義します。
フィールド
-
Updates– 必須: IcebergTableUpdate オブジェクトの配列。スキーマの変更、パーティション仕様、テーブルプロパティを含む、Iceberg テーブルに加える変更を指定するテーブル更新操作のリスト。
IcebergSortOrder 構造
Iceberg テーブルのソート順序仕様を定義し、クエリのパフォーマンスを最適化するためにパーティション内でデータを順序付ける方法を決定します。
フィールド
-
OrderId– 必須: 数値 (integer)。Iceberg テーブルのメタデータ内のこのソート順序仕様の一意の識別子。
-
Fields– 必須: IcebergSortField オブジェクトの配列。Iceberg テーブルデータの順序基準を定義する、フィールドとそのソート方向のリスト。
IcebergSortField 構造
ソースフィールド、変換、ソート方向、null 値の順序など、Iceberg ソート順序仕様内の単一のフィールドを定義します。
フィールド
-
SourceId– 必須: 数値 (integer)。このソートフィールドの基礎となるテーブルスキーマのソースフィールドの識別子。
-
Transform– 必須: UTF–8 文字列。ID、バケット、切り捨てなど、ソート前にソースフィールドに適用される変換関数。
-
Direction– 必須: UTF-8 文字列 (有効な値:asc="ASC"|desc="DESC")。フィールドのソート方向。昇順または降順のいずれか。
-
NullOrder– 必須: UTF-8 文字列 (有効な値:nulls-first="NULLS_FIRST"|nulls-last="NULLS_LAST")。このフィールドの null 値の順序付け動作。null をソート順で最初または最後に表示するかどうかを指定します。
IcebergPartitionSpec 構造
Iceberg テーブルのパーティショニング仕様を定義し、最適なクエリパフォーマンスのためにテーブルデータを整理およびパーティショニングする方法を決定します。
フィールド
-
Fields– 必須: IcebergPartitionField オブジェクトの配列。ソースフィールドとその変換など、テーブルデータのパーティショニング方法を定義するパーティションフィールドのリスト。
-
SpecId– 数値 (整数)。Iceberg テーブルのメタデータ履歴内にあるこのパーティション仕様の一意の識別子。
IcebergPartitionField 構造
ソースフィールド、変換関数、パーティション名、一意の識別子など、Iceberg パーティション仕様内の単一のパーティションフィールドを定義します。
フィールド
-
SourceId– 必須: 数値 (integer)。このパーティションフィールドの基礎となるテーブルスキーマのソースフィールドの識別子。
-
Transform– 必須: UTF–8 文字列。ID、バケット、切り捨て、年、月、日、時間など、パーティションを作成するためにソースフィールドに適用される変換関数。
-
Name– 必須: UTF-8 文字列。1 ~ 1024 バイト長。Single-line string pattern に一致。パーティショニングされたテーブル構造に表示されるパーティションフィールドの名前。
-
FieldId– 数値 (整数)。Iceberg テーブルのパーティション仕様内でこのパーティションフィールドに割り当てられた一意の識別子。
IcebergSchema 構造
フィールド定義、データ型、スキーマメタデータなど、Iceberg テーブルのスキーマ構造を定義します。
フィールド
-
SchemaId– 数値 (整数)。Iceberg テーブルのスキーマの進化履歴内にあるこのスキーマバージョンの一意の識別子。
-
IdentifierFieldIds– 符号付き 32 ビット整数の配列。テーブル内のレコードを一意に識別するフィールド識別子のリスト。行レベルの操作と重複排除に使用されます。
-
Type– UTF-8 文字列 (有効な値:struct="STRUCT")。スキーマ構造のルートタイプ。通常は Iceberg テーブルスキーマの「構造体」です。
-
Fields– 必須: IcebergStructField オブジェクトの配列。フィールド名、タイプ、メタデータなど、テーブルスキーマを構成するフィールド定義のリスト。
IcebergStructField 構造
識別子、名前、データ型、null 値の許容性、ドキュメントなど、Iceberg テーブルスキーマ内の単一のフィールドを定義します。
フィールド
-
Id– 必須: 数値 (integer)。Iceberg テーブルスキーマ内でこのフィールドに割り当てられた一意の識別子。スキーマの進化とフィールドの追跡に使用されます。
-
Name– 必須: UTF-8 文字列。1 ~ 1024 バイト長。Single-line string pattern に一致。テーブルスキーマおよびクエリ操作に表示されるフィールドの名前。
-
Type– 必須:IcebergDocumentという名前の空の構造。このフィールドのデータ型定義。含まれるデータの構造と形式を指定します。
-
Required– 必須: Boolean。テーブルスキーマでこのフィールドが必要 (null 値を許容しない) かオプション (null 値を許容する) かを示します。
-
Doc– コメント文字列。255 バイト長以下。Single-line string pattern に一致。このフィールドの目的と使用に関する追加のコンテキストを提供する、オプションのドキュメントまたは説明テキスト。
IcebergTableUpdate 構造
スキーマの変更、パーティショニングの変更、ソート順の調整、場所の更新、プロパティの変更など、Iceberg テーブルに適用される更新の完全なセットを定義します。
フィールド
-
Schema– 必須: IcebergSchema オブジェクト。フィールド構造、データ型、またはスキーマメタデータへの変更を指定する、Iceberg テーブルの更新されたスキーマ定義。
-
PartitionSpec– IcebergPartitionSpec オブジェクト。テーブルデータを再編成してパーティショニングする方法を定義する、更新されたパーティショニング仕様。
-
SortOrder– IcebergSortOrder オブジェクト。クエリのパフォーマンスを最適化するためにパーティション内でデータを順序付ける方法を定義する、更新されたソート順序の仕様。
-
Location– 必須: 場所文字列。2,056 バイト長以下。URI address multi-line string pattern に一致。Iceberg テーブルデータが保存される更新された S3 ロケーションを定義します。
-
Properties– キーバリューペアのマップ配列。各キーは UTF-8 文字列。
各値は UTF-8 文字列。
Iceberg テーブルのテーブルプロパティと設定の更新されたキーと値のペア。
操作
BatchDeleteTableVersion アクション (Python: batch_delete_table_version)
GetColumnStatisticsForTable アクション (Python: get_column_statistics_for_table)
UpdateColumnStatisticsForTable アクション (Python: update_column_statistics_for_table)
DeleteColumnStatisticsForTable アクション (Python: delete_column_statistics_for_table)
CreateTable アクション (Python: create_table)
データカタログで新しいテーブル定義を作成します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。Tableを作成するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。 -
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。新しいテーブルを作成するカタログデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
Name– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。AWS Glue Data Catalog に作成される、指定されたデータベース内のテーブルの一意の識別子。
-
TableInput– TableInput オブジェクト。カタログで作成するメタデータテーブルを定義する
TableInputオブジェクト。 -
PartitionIndexes– PartitionIndex オブジェクトの配列。構造 3 個以下。テーブル内に作成されるパーティションインデックスのリストである
PartitionIndex構造。 -
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。トランザクションの ID。
-
OpenTableFormatInput– OpenTableFormatInput オブジェクト。オープン形式のテーブルを作成するときに
OpenTableFormatInput構造を指定します。
レスポンス
応答パラメータはありません。
エラー
AlreadyExistsExceptionInvalidInputExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionExceptionConcurrentModificationExceptionResourceNotReadyExceptionFederationSourceExceptionFederationSourceRetryableException
UpdateTable アクション (Python: update_table)
データカタログのメタデータテーブルを更新します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
Name– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。AWS Glue Data Catalog に作成される、指定されたデータベース内のテーブルの一意の識別子。
-
TableInput– TableInput オブジェクト。カタログのメタデータテーブルを定義するための、更新された
TableInputオブジェクト。 -
SkipArchive– ブール。UpdateTableは、デフォルトでは、更新する前に常にテーブルのアーカイブされたバージョンを作成します。ただし、skipArchiveが true に設定されている場合、UpdateTableではアーカイブされたバージョンは作成されません。 -
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。テーブルの内容を更新するトランザクション ID。
-
VersionId– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの内容を更新するバージョン ID。
-
ViewUpdateAction– UTF-8 文字列 (有効な値:ADD|REPLACE|ADD_OR_REPLACE|DROP)。ビューの更新時に実行されるオペレーション。
-
Force– ブール。一致するストレージ記述子とサブオブジェクト一致要件を無視するように true に設定できるフラグ。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionConcurrentModificationExceptionResourceNumberLimitExceededExceptionGlueEncryptionExceptionResourceNotReadyExceptionFederationSourceExceptionFederationSourceRetryableExceptionAlreadyExistsException
DeleteTable アクション (Python: delete_table)
データカタログからテーブル定義を削除します。
注記
このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
すべての関連リソースをすぐに削除するには、DeleteTableVersion または BatchDeleteTableVersion を使用し、DeletePartition または BatchDeletePartition を使用して、テーブルに属するすべてのリソースを削除してから、DeleteTable を呼び出します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。削除するテーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。テーブルの内容を更新するトランザクション ID。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionConcurrentModificationExceptionResourceNotReadyExceptionFederationSourceExceptionFederationSourceRetryableException
BatchDeleteTable アクション (Python: batch_delete_table)
一度に複数のテーブルを削除します。
注記
このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
すべての関連リソースをすぐに削除するには、DeleteTableVersion または BatchDeleteTableVersion を使用し、DeletePartition または BatchDeletePartition を使用して、テーブルに属するすべてのリソースを削除してから、BatchDeleteTable を呼び出します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。削除するテーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TablesToDelete– 必須: UTF-8 文字列の配列。文字列 100 個以下。削除するテーブルのリスト。
-
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。テーブルの内容を更新するトランザクション ID。
応答
-
Errors– TableError オブジェクトの配列。指定されたテーブルの削除試行中に発生したエラーのリスト。
エラー
InvalidInputExceptionEntityNotFoundExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionExceptionResourceNotReadyException
GetTable アクション (Python:get_table)
指定されたテーブルのデータカタログ内にある Table 定義を取得します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログのデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
Name– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。定義を取得するテーブルの名前です。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。テーブルの内容を更新するトランザクション ID。
-
QueryAsOfTime– タイムスタンプ。テーブルの内容を読み取る時点の時間。設定されていない場合は、最新のトランザクションコミット時間が使用されます。
TransactionIdと一緒に指定することはできません。 -
IncludeStatusDetails– ブール。AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
レスポンス
-
Table– Table オブジェクト。指定したテーブルを定義する
Tableオブジェクト。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionExceptionResourceNotReadyExceptionFederationSourceExceptionFederationSourceRetryableException
GetTables アクション (Python: get_tables)
特定の Database 内の、一部またはすべてのテーブル定義を取得します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルをリスト表示するカタログ内のデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
Expression- UTF-8 文字列。2,048 バイト長以下。Single-line string pattern に一致。正規表現パターン。存在する場合、パターンに名前が一致するテーブルのみが返されます。
-
NextToken– UTF–8 文字列。継続トークン (これが継続呼び出しの場合)。
-
MaxResults– 数値 (integer)。1~100。1 回の応答で返されるテーブルの最大数。
-
TransactionId– UTF-8 文字列。1~255 バイト長。Custom string pattern #43 に一致。テーブルの内容を更新するトランザクション ID。
-
QueryAsOfTime– タイムスタンプ。テーブルの内容を読み取る時点の時間。設定されていない場合は、最新のトランザクションコミット時間が使用されます。
TransactionIdと一緒に指定することはできません。 -
IncludeStatusDetails– ブール。AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
-
AttributesToGet– UTF-8 文字列の配列。GetTables呼び出しによって返されるテーブルフィールドを指定します。このパラメータは空のリストを受け入れません。リクエストにはNAMEを含める必要があります。有効な値の組み合わせは次のとおりです。
-
NAME- データベースにあるすべてのテーブルの名前。 -
NAME、TABLE_TYPE- すべてのテーブルとテーブルタイプの名前。
-
応答
-
TableList– Table オブジェクトの配列。リクエストされた
Tableオブジェクトのリスト。 -
NextToken– UTF-8 文字列。継続トークン (現在のリストセグメントが最後ではない場合に存在)。
エラー
EntityNotFoundExceptionInvalidInputExceptionOperationTimeoutExceptionInternalServiceExceptionGlueEncryptionExceptionFederationSourceExceptionFederationSourceRetryableException
GetTableVersion アクション (Python: get_table_version)
テーブルの指定されたバージョンを取得します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
VersionId– UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。取得するテーブルバージョンの ID 値。
VersionIDは整数の文字列表現です。各バージョンは 1 ずつ増加します。
レスポンス
-
TableVersion– TableVersion オブジェクト。リクエストされたテーブルのバージョン。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException
GetTableVersions アクション (Python: get_table_versions)
指定したテーブルで使用可能なバージョンを指定する文字列のリストを取得します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
NextToken– UTF–8 文字列。継続トークン (これが最初の呼び出しでない場合)。
-
MaxResults– 数値 (integer)。1~100。1 回の応答で返すテーブルバージョンの最大数。
応答
-
TableVersions– TableVersion オブジェクトの配列。指定したテーブルの使用可能なバージョンを指定する文字列のリスト。
-
NextToken– UTF–8 文字列。継続トークン (使用可能なバージョンのリストに最後のバージョンが含まれていない場合)。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException
DeleteTableVersion アクション (Python: delete_table_version)
テーブルの指定されたバージョンを削除します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
VersionId– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。削除するテーブルバージョンの ID。
VersionIDは整数の文字列表現です。各バージョンは 1 ずつ増加します。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutException
BatchDeleteTableVersion アクション (Python: batch_delete_table_version)
テーブルの指定されたバージョンのバッチを削除します。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
-
VersionIds– 必須: UTF-8 文字列の配列。文字列 100 個以下。削除するバージョンの ID リスト。
VersionIdは整数の文字列表現です。各バージョンは 1 ずつ増加します。
応答
-
Errors– TableVersionError オブジェクトの配列。指定されたテーブルバージョンを削除しようとしているときに発生したエラーのリスト。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutException
SearchTables アクション (Python: search_tables)
テーブルメタデータのプロパティと親データベースに基づいて一連のテーブルを検索します。テキストまたはフィルタ条件で検索できます。
Lake Formation に定義されているセキュリティポリシーに基づいて、アクセスできるテーブルのみを取得できます。テーブルが返されるようにするには、少なくともテーブルへの読み取り専用アクセスが必要です。テーブル内の一部の列にアクセスできない場合、テーブルのリストが返されるときに、これらの列は検索されません。列にはアクセスできても、これら列内のデータにアクセスできない場合は、これらの列とこれらの列に関連付けられたメタデータが検索に含まれます。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。一意の識別子 (
account_idで構成)。 -
NextToken– UTF–8 文字列。継続トークン (これが継続呼び出しの場合)。
-
Filters– PropertyPredicate オブジェクトの配列。キーバリューペアのリスト、および検索結果のフィルタリングに使用する比較演算子。述語に一致するすべてのエンティティを返します。
PropertyPredicate構造体のComparatorメンバーは時間フィールドにのみ使用され、他のフィールドタイプでは省略できます。また、Key=Nameなど文字列値を比較する場合、ファジーマッチアルゴリズムが使用されます。Keyフィールド (例えば、Nameフィールドの値) は、特定の句読点文字 (-、:、# など) でトークンに分割されます。次に、各トークンはPropertyPredicateのValueメンバーとエグザクトマッチで比較されます。例えば、Key=NameおよびValue=linkの場合、customer-linkやxx-link-yyという名前のテーブルは返されますが、xxlinkyyの場合は返されません。 -
SearchText– 値の文字列の長さ。1~1024 バイト長。テキスト検索に使用する文字列。
値を引用符で囲んで指定すると、値との完全一致に基づいてフィルタリングされます。
-
SortCriteria– SortCriterion オブジェクトの配列。構造 1 個以下。結果をフィールド名で昇順または降順でソートするための条件のリスト。
-
MaxResults– 1~1000 の数値 (整数)。1 回の応答で返されるテーブルの最大数。
-
ResourceShareType– UTF-8 文字列 (有効な値:FOREIGN|ALL|FEDERATED)。アカウントと共有されているテーブルを検索するように指定できます。指定できる値は、
FOREIGNまたはALLです。-
FOREIGNに設定されている場合、アカウントと共有されているテーブルが検索されます。 -
ALLに設定されている場合、アカウントと共有されているテーブルとローカルアカウントのテーブルが検索されます。
-
-
IncludeStatusDetails– ブール。AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
レスポンス
-
NextToken– UTF-8 文字列。継続トークン (現在のリストセグメントが最後ではない場合に存在)。
-
TableList– Table オブジェクトの配列。リクエストされた
Tableオブジェクトのリスト。SearchTablesレスポンスは、ユーザーがアクセスできるテーブルのみを返します。
エラー
InternalServiceExceptionInvalidInputExceptionOperationTimeoutException
GetPartitionIndexes アクション (Python: get_partition_indexes)
テーブルに関連付けられたパーティションインデックスを取得します。
リクエスト
-
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 文字列。継続トークン (これが継続呼び出しの場合)。
応答
-
PartitionIndexDescriptorList– PartitionIndexDescriptor オブジェクトの配列。インデックス記述子のリスト。
-
NextToken– UTF-8 文字列。継続トークン (現在のリストセグメントが最後ではない場合に存在)。
エラー
InternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionEntityNotFoundExceptionConflictException
CreatePartitionIndex アクション (Python: create_partition_index)
既存のテーブルに指定されたパーティションインデックスを作成します。
リクエスト
-
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 に一致。パーティションインデックスを作成するテーブルの名前を指定します。
-
PartitionIndex– 必須: PartitionIndex オブジェクト。PartitionIndex構造を指定して、既存のテーブルにパーティションインデックスを作成します。
レスポンス
応答パラメータはありません。
エラー
AlreadyExistsExceptionInvalidInputExceptionEntityNotFoundExceptionResourceNumberLimitExceededExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException
DeletePartitionIndex アクション (Python: delete_partition_index)
既存のテーブルから指定されたパーティションインデックスを削除します。
リクエスト
-
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 に一致。パーティションインデックスを削除するテーブルの名前を指定します。
-
IndexName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。削除するパーティションインデックスの名前。
レスポンス
応答パラメータはありません。
エラー
InternalServiceExceptionOperationTimeoutExceptionInvalidInputExceptionEntityNotFoundExceptionConflictExceptionGlueEncryptionException
GetColumnStatisticsForTable アクション (Python: get_column_statistics_for_table)
列のテーブル統計を取得します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は GetTable です。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションが存在するカタログデータベースの名前。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションのテーブルの名前。
-
ColumnNames– 必須: UTF-8 文字列の配列。文字列 100 個以下。列名のリスト。
応答
-
ColumnStatisticsList– ColumnStatistics オブジェクトの配列。ColumnStatistics のリスト。
-
Errors– ColumnError オブジェクトの配列。取得に失敗した ColumnStatistics のリスト。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException
UpdateColumnStatisticsForTable アクション (Python: update_column_statistics_for_table)
列のテーブル統計を作成または更新します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は UpdateTable です。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションが存在するカタログデータベースの名前。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションのテーブルの名前。
-
ColumnStatisticsList– 必須: ColumnStatistics オブジェクトの配列。構造 25 個以下。列の統計のリスト。
応答
-
Errors– ColumnStatisticsError オブジェクトの配列。ColumnStatisticsErrors のリスト。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException
DeleteColumnStatisticsForTable アクション (Python: delete_column_statistics_for_table)
列のテーブル統計を取得します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は DeleteTable です。
リクエスト
-
CatalogId– カタログ ID 文字列。1~255 バイト長。Single-line string pattern に一致。該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
-
DatabaseName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションが存在するカタログデータベースの名前。
-
TableName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。パーティションのテーブルの名前。
-
ColumnName– 必須: UTF-8 文字列。1~255 バイト長。Single-line string pattern に一致。列の名前。
レスポンス
応答パラメータはありません。
エラー
EntityNotFoundExceptionInvalidInputExceptionInternalServiceExceptionOperationTimeoutExceptionGlueEncryptionException