テーブル API - AWS Glue

テーブル API

Table API は、データ型とテーブルに関連付けられたオペレーションについて説明しています。

データ型

テーブル構造

列と行で構成されている関連データのコレクションを表します。

Fields

  • 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 – 数値 (integer)。None 以下。

    このテーブルの保持時間。

  • StorageDescriptor - StorageDescriptor オブジェクト。

    このテーブルの物理ストレージに関する情報を含むストレージ記述子。

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

    テーブルがパーティション分割される列のリスト。パーティションキーとしてプリミティブ型のみがサポートされています。

    Amazon Athena によって使用されるテーブルを作成しており、partitionKeys を指定していない場合は必ず、partitionKeys の値を空のリストに設定する必要があります。例:

    "PartitionKeys": []

  • ViewOriginalText - UTF-8 文字列。409,600 バイト長以下。

    テーブルが表示される場合、表示されるオリジナルテキスト。その他の場合は null

  • ViewExpandedText - UTF-8 文字列。409,600 バイト長以下。

    テーブルが表示される場合、表示される展開されたテキスト。その他の場合は null

  • TableType - UTF-8 文字列。255 バイト長以下。

    このテーブルの種類 (EXTERNAL_TABLEVIRTUAL_VIEW など)。

  • Parameters - キー/値ペアのマップ配列。

    各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。

    各値は UTF-8 文字列で、512,000 バイト長以下です。

    これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。

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

    テーブルを作成した個人または団体。

  • IsRegisteredWithLakeFormation – Boolean.

    テーブルが AWS Lake Formation に登録されているかどうかを示します。

  • TargetTable - TableIdentifier オブジェクト。

    リソースリンク用のターゲットテーブルを記述する TableIdentifier 構造。

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

    テーブルデータベースがあるデータカタログの ID。

TableInput 構造

テーブルの定義に使用される構造。

Fields

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

    テーブル所有者。

  • LastAccessTime – タイムスタンプ.

    テーブルが最後にアクセスされた時刻。

  • LastAnalyzedTime – タイムスタンプ.

    このテーブルの列統計が最後に計算された時刻。

  • Retention – 数値 (integer)。None 以下。

    このテーブルの保持時間。

  • StorageDescriptor - StorageDescriptor オブジェクト。

    このテーブルの物理ストレージに関する情報を含むストレージ記述子。

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

    テーブルがパーティション分割される列のリスト。パーティションキーとしてプリミティブ型のみがサポートされています。

    Amazon Athena によって使用されるテーブルを作成しており、partitionKeys を指定していない場合は必ず、partitionKeys の値を空のリストに設定する必要があります。例:

    "PartitionKeys": []

  • ViewOriginalText - UTF-8 文字列。409,600 バイト長以下。

    テーブルが表示される場合、表示されるオリジナルテキスト。その他の場合は null

  • ViewExpandedText - UTF-8 文字列。409,600 バイト長以下。

    テーブルが表示される場合、表示される展開されたテキスト。その他の場合は null

  • TableType - UTF-8 文字列。255 バイト長以下。

    このテーブルの種類 (EXTERNAL_TABLEVIRTUAL_VIEW など)。

  • Parameters - キー/値ペアのマップ配列。

    各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。

    各値は UTF-8 文字列で、512,000 バイト長以下です。

    これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。

  • TargetTable - TableIdentifier オブジェクト。

    リソースリンク用のターゲットテーブルを記述する TableIdentifier 構造。

列の構造

Table の列。

Fields

  • 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 構造

テーブルデータの物理ストレージについて説明します。

Fields

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

    テーブル内の Columns のリストです。

  • Location - 場所文字列。2,056 バイト長以下。URI address multi-line string pattern に一致。

    テーブルの物理的な場所。デフォルトでは、ウェアハウスの場所、その後にウェアハウス内のデータベースの場所、その後にテーブル名が続く形式になります。

  • InputFormat - 書式設定文字列。128 バイト長以下。Single-line string pattern に一致。

    入力形式: SequenceFileInputFormat (バイナリ)、または TextInputFormat、もしくはカスタム形式。

  • OutputFormat - 書式設定文字列。128 バイト長以下。Single-line string pattern に一致。

    出力形式: SequenceFileOutputFormat (バイナリ)、または IgnoreKeyTextOutputFormat、もしくはカスタム形式。

  • Compressed – Boolean.

    テーブルのデータが圧縮されている場合は True、圧縮されていない場合は False

  • NumberOfBuckets – 数値 (整数)。

    テーブルにディメンション列が含まれている場合、指定する必要があります。

  • SerdeInfo - SerDeInfo オブジェクト。

    シリアライズ/デシリアライズ (SerDe) 情報。

  • BucketColumns - UTF-8 文字列の配列。

    テーブルのリデューサーグループ化列、クラスター列、およびバケット列のリスト。

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

    テーブル内の各バケットのソート順を指定するリスト。

  • Parameters - キー/値ペアのマップ配列。

    各キーはキー文字列。1~255 バイト長。Single-line string pattern に一致。

    各値は UTF-8 文字列で、512,000 バイト長以下です。

    キーと値の形式でのユーザーが指定したプロパティ。

  • SkewedInfo - SkewedInfo オブジェクト。

    列に高い頻度で表示される値 (歪んだ値) に関する情報。

  • StoredAsSubDirectories – Boolean.

    テーブルデータがサブディレクトリに保管されている場合は True、保管されていない場合は False

  • SchemaReference - SchemaReference オブジェクト。

    AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。

    テーブルを作成するとき、スキーマの空の列リストを渡し、代わりにスキーマリファレンスを使用できます。

SchemaReference 構造

AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。

Fields

  • SchemaId - SchemaId オブジェクト。

    スキーマアイデンティティフィールドを含む構造。こちらか SchemaVersionId のいずれかを指定する必要があります。

  • SchemaVersionId – UTF-8 文字列。36 バイト長ちょうど。Custom string pattern #11 に一致。

    スキーマのバージョンに割り当てられた一意の ID。こちらか SchemaId のいずれかを指定する必要があります。

  • SchemaVersionNumber – 数値 (long)。1~100000。

    スキーマのバージョン番号。

SerDeInfo 構造

エクストラクターおよびローダーとして機能するシリアライズ/デシリアライズプログラム (SerDe) に関する情報。

Fields

  • 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 の初期化パラメータを定義します。

順序の構造

ソートされた列のソート順を指定します。

Fields

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

    列の名前。

  • SortOrder必須: 数値 (integer)。1 以下。

    列が昇順 (== 1) または降順 (==0) でソートされていることを指定します。

SkewedInfo 構造

テーブルで歪んだ値を指定します。「歪んだ値」とは、非常に高い頻度で発生する値です。

Fields

  • SkewedColumnNames - UTF-8 文字列の配列。

    歪んだ値を含む列名のリスト。

  • SkewedColumnValues - UTF-8 文字列の配列。

    頻繁に出現するため、歪んだとみなされる値のリスト。

  • SkewedColumnValueLocationMaps - キー/値ペアのマップ配列。

    各キーは UTF-8 文字列です。

    各値は UTF-8 文字列です。

    歪んだ値が含まれている列へのマッピング。

TableVersion 構造

テーブルのバージョンを指定します。

Fields

  • Table - オブジェクト。

    該当するテーブル。

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

    このテーブルのバージョンを特定する ID 値。VersionId は整数の文字列表現です。各バージョンは 1 ずつ増加します。

TableError 構造

テーブルオペレーションのエラーレコード。

Fields

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

    テーブルの名前。Hive 互換性のために、これはすべて小文字であることが必要です。

  • ErrorDetail - ErrorDetail オブジェクト。

    エラーに関する詳細。

TableVersionError 構造

テーブルバージョンオペレーションのエラーレコード。

Fields

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

    該当するテーブルの名前。

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

    該当するバージョンの ID 値。VersionID は整数の文字列表現です。各バージョンは 1 ずつ増加します。

  • ErrorDetail - ErrorDetail オブジェクト。

    エラーに関する詳細。

SortCriterion の構造

ソート基準となるフィールドとソート順を指定します。

Fields

  • FieldName – Value 文字列、1024 バイト長以下。

    ソートするフィールドの名前。

  • Sort - UTF-8 文字列 (有効な値: ASC="ASCENDING" | DESC="DESCENDING")。

    昇順または降順のソート。

TableIdentifier 構造

リソースリンク用のターゲットテーブルを記述する構造。

Fields

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

    ターゲットテーブルの名前。

KeySchemaElement 構造

名前とタイプで構成されるパーティションキーペア。

Fields

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

    パーティションキーの名前。

  • Type必須: UTF-8 文字列。131072 バイト長以下。Single-line string pattern に一致。

    パーティションキーのタイプ。

PartitionIndex 構造

パーティションインデックスの構造体。

Fields

  • Keys必須: UTF-8 文字列の配列。1 個の以上の文字列。

    パーティションインデックスのキー。

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

    パーティションインデックスの名前。

PartitionIndexDescriptor 構造

テーブル内のパーティションインデックスの記述子。

Fields

  • 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: インデックスは、インデックスのリストから削除されます。

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

    既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。

BackfillError 構造

既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。

これらのエラーでは、インデックスの登録が失敗した理由の詳細が表示され、応答として限られた数のパーティションが示されます。これにより、障害が発生したパーティションを修正し、インデックスの登録を再試行できます。発生する可能性のある最も一般的なエラーのセットは、次のように分類されます。

  • EncryptedPartitionError: パーティションが暗号化されています。

  • InvalidPartitionTypeDataError: パーティション値がそのパーティション列のデータ型と一致しません。

  • MissingPartitionValueError: パーティションが暗号化されています。

  • UnsupportedPartitionCharacterError: パーティション値内の文字がサポートされていません。例: U+0000、U+0001、U+0002。

  • InternalError: 他のエラーコードに属さないすべてのエラー。

Fields

  • Code - UTF-8 文字列 (有効な値: ENCRYPTED_PARTITION_ERROR | INTERNAL_ERROR | INVALID_PARTITION_TYPE_DATA_ERROR | MISSING_PARTITION_VALUE_ERROR | UNSUPPORTED_PARTITION_CHARACTER_ERROR)。

    既存のテーブルのパーティションインデックスを登録するときに発生したエラーのエラーコード。

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

    応答内の限られた数のパーティションのリスト。

Operations

CreateTable アクション (Python: create_table)

データカタログで新しいテーブル定義を作成します。

Request

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

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

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

    新しいテーブルを作成するカタログデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。

  • TableInput必須: TableInput オブジェクト。

    カタログで作成するメタデータテーブルを定義する TableInput オブジェクト。

  • PartitionIndexesPartitionIndex オブジェクトの配列。構造 3 個以下。

    テーブル内に作成されるパーティションインデックスのリストである PartitionIndex 構造体。

Response

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

Errors

  • AlreadyExistsException

  • InvalidInputException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

UpdateTable アクション (Python: update_table)

データカタログのメタデータテーブルを更新します。

Request

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

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

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

    テーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。

  • TableInput必須: TableInput オブジェクト。

    カタログのメタデータテーブルを定義する更新された TableInput オブジェクト。

  • SkipArchive – Boolean.

    UpdateTable は、デフォルトでは、更新する前に常にテーブルのアーカイブされたバージョンを作成します。ただし、skipArchive が true に設定されている場合、UpdateTable ではアーカイブされたバージョンは作成されません。

Response

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

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

DeleteTable アクション (Python: delete_table)

データカタログからテーブル定義を削除します。

注記

このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。

すべての関連リソースをすぐに削除するには、DeleteTable または DeleteTableVersion を使用し、BatchDeleteTableVersion または DeletePartition を使用して、テーブルに属するすべてのリソースを削除してから、BatchDeletePartition を呼び出します。

Request

  • 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 互換性のために、この名前はすべて小文字であることが必要です。

Response

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

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

BatchDeleteTable アクション (Python: batch_delete_table)

一度に複数のテーブルを削除します。

注記

このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。

すべての関連リソースをすぐに削除するには、BatchDeleteTable または DeleteTableVersion を使用し、BatchDeleteTableVersion または DeletePartition を使用して、テーブルに属するすべてのリソースを削除してから、BatchDeletePartition を呼び出します。

Request

  • 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 個以下。

    削除するテーブルのリスト。

Response

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

    指定されたテーブルの削除試行中に発生したエラーのリスト。

Errors

  • InvalidInputException

  • EntityNotFoundException

  • InternalServiceException

  • OperationTimeoutException

GetTable アクション (Python:get_table)

指定されたテーブルのデータカタログでの Table 定義を取得します。

Request

  • 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 互換性のために、この名前はすべて小文字であることが必要です。

Response

  • Table - オブジェクト。

    指定したテーブルを定義する Table オブジェクト。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

GetTables アクション (Python: get_tables)

特定の Database 内の、一部またはすべてのテーブル定義を取得します。

Request

  • 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 回の応答で返されるテーブルの最大数。

Response

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

    リクエストされた Table オブジェクトのリスト。

  • NextToken - UTF-8 文字列。

    継続トークン (現在のリストセグメントが最後のセグメントでない場合のみ)。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • GlueEncryptionException

GetTableVersion アクション (Python: get_table_version)

テーブルの指定されたバージョンを取得します。

Request

  • 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 ずつ増加します。

Response

  • TableVersion - TableVersion オブジェクト。

    リクエストされたテーブルバージョン。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

GetTableVersions アクション (Python: get_table_versions)

指定したテーブルの使用可能なバージョンを指定する文字列のリストを取得します。

Request

  • 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 回の応答で返すテーブルバージョンの最大数。

Response

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

    指定したテーブルの使用可能なバージョンを指定する文字列のリスト。

  • NextToken - UTF-8 文字列。

    使用可能なバージョンのリストに最後のバージョンが含まれていない場合は、継続トークン。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

DeleteTableVersion アクション (Python: delete_table_version)

テーブルの指定されたバージョンを削除します。

Request

  • 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 ずつ増加します。

Response

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

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

BatchDeleteTableVersion アクション (Python: batch_delete_table_version)

テーブルの指定されたバージョンのバッチを削除します。

Request

  • 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 ずつ増加します。

Response

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

    指定されたテーブルバージョンを削除しようとしているときに発生したエラーのリスト。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

SearchTables アクション (Python: search_tables)

テーブルメタデータのプロパティと親データベースに基づいて一連のテーブルを検索します。テキストまたはフィルタ条件で検索できます。

Lake Formation に定義されているセキュリティポリシーに基づいて、アクセスできるテーブルのみを取得できます。テーブルが返されるようにするには、少なくともテーブルへの読み取り専用アクセスが必要です。テーブル内の一部の列にアクセスできない場合、テーブルのリストが返されるときに、これらの列は検索されません。列にはアクセスできても、これら列内のデータにアクセスできない場合は、これらの列とこれらの列に関連付けられたメタデータが検索に含まれます。

Request

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

    一意の識別子 (account_id で構成)。

  • NextToken - UTF-8 文字列。

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

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

    キーと値のペアのリスト、および検索結果のフィルタリングに使用する比較演算子。述語に一致するすべてのエンティティを返します。

    PropertyPredicate 構造体の Comparator メンバーは時間フィールドにのみ使用され、他のフィールドタイプでは省略できます。また、Key=Name など文字列値を比較する場合、ファジーマッチアルゴリズムが使用されます。Key フィールド (例えば、Name フィールドの値) は、特定の句読点文字 (-、:、# など) でトークンに分割されます。次に、各トークンは PropertyPredicateValue メンバーとエグザクトマッチで比較されます。例えば、Key=Name および Value=link の場合、customer-linkxx-link-yy という名前のテーブルは返されますが、xxlinkyy の場合は返されません。

  • SearchText – Value 文字列、1024 バイト長以下。

    テキスト検索に使用する文字列。

    値を引用符で囲んで指定すると、値との完全一致に基づいてフィルタリングされます。

  • SortCriteriaSortCriterion オブジェクトの配列。構造 1 個以下。

    結果をフィールド名で昇順または降順でソートするための条件のリスト。

  • MaxResults - 数値 (整数)。1 ~ 1000。

    1 回の応答で返されるテーブルの最大数。

  • ResourceShareType - UTF-8 文字列 (有効な値: FOREIGN | ALL)。

    アカウントと共有されているテーブルを検索するように指定できます。指定できる値は、FOREIGN または ALL です。

    • FOREIGN に設定されている場合、アカウントと共有されているテーブルが検索されます。

    • ALL に設定されている場合、アカウントと共有されているテーブルとローカルアカウントのテーブルが検索されます。

Response

  • NextToken - UTF-8 文字列。

    継続トークン (現在のリストセグメントが最後のセグメントでない場合のみ)。

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

    リクエストされた Table オブジェクトのリスト。SearchTables レスポンスは、ユーザーがアクセスできるテーブルのみを返します。

Errors

  • InternalServiceException

  • InvalidInputException

  • OperationTimeoutException

GetPartitionIndexes アクション (Python: get_partition_indexes)

テーブルに関連付けられたパーティションインデックスを取得します。

Request

  • 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 文字列。

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

Response

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

    インデックス記述子のリスト。

  • NextToken - UTF-8 文字列。

    継続トークン (現在のリストセグメントが最後のセグメントでない場合のみ)。

Errors

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • EntityNotFoundException

  • ConflictException

CreatePartitionIndex アクション (Python: create_partition_index)

既存のテーブルに指定されたパーティションインデックスを作成します。

Request

  • 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 構造体を指定して、既存のテーブルにパーティションインデックスを作成します。

Response

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

Errors

  • AlreadyExistsException

  • InvalidInputException

  • EntityNotFoundException

  • ResourceNumberLimitExceededException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

DeletePartitionIndex アクション (Python: delete_partition_index)

既存のテーブルから指定されたパーティションインデックスを削除します。

Request

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

    削除するパーティションインデックスの名前。

Response

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

Errors

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException

  • EntityNotFoundException

  • ConflictException

  • GlueEncryptionException

GetColumnStatisticsForTable アクション (Python: get_column_statistics_for_table)

列のテーブル統計を取得します。

このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は GetTable です。

Request

  • 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 個以下。

    列名のリスト。

Response

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

    取得に失敗した ColumnStatistics のリスト。

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

    取得に失敗した ColumnStatistics のリスト。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

UpdateColumnStatisticsForTable アクション (Python: update_column_statistics_for_table)

列のテーブル統計を作成または更新します。

このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は UpdateTable です。

Request

  • 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 個以下。

    列の統計のリスト。

Response

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

DeleteColumnStatisticsForTable アクション (Python: delete_column_statistics_for_table)

列のテーブル統計を取得します。

このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は DeleteTable です。

Request

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

    列の名前。

Response

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

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException