# カタログオブジェクト API
カタログオブジェクト API は、AWS Glue でのカタログの操作に関連するデータ型と API について説明します。
**Topics**
+ [カタログ API](aws-glue-api-catalog-catalogs.md)
+ [データベース API](aws-glue-api-catalog-databases.md)
+ [テーブル API](aws-glue-api-catalog-tables.md)
+ [パーティション API](aws-glue-api-catalog-partitions.md)
+ [接続 API](aws-glue-api-catalog-connections.md)
+ [ユーザー定義関数 API](aws-glue-api-catalog-functions.md)
+ [Athena カタログを AWS Glue にインポートする](aws-glue-api-catalog-migration.md)
# カタログ API
「カタログ API」 では、カタログを作成、削除、検索、更新、一覧表示するための API について説明します。
## データタイプ
+ [カタログの構造](#aws-glue-api-catalog-catalogs-Catalog)
+ [CatalogInput 構造](#aws-glue-api-catalog-catalogs-CatalogInput)
+ [TargetRedshiftCatalog 構造](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
+ [CatalogProperties 構造](#aws-glue-api-catalog-catalogs-CatalogProperties)
+ [CatalogPropertiesOutput 構造](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
+ [DataLakeAccessProperties 構造](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
+ [IcebergOptimizationProperties 構造](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
+ [DataLakeAccessPropertiesOutput 構造](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
+ [IcebergOptimizationPropertiesOutput 構造](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
+ [FederatedCatalog 構造](#aws-glue-api-catalog-catalogs-FederatedCatalog)
## カタログの構造
カタログオブジェクトは、AWS Glue データカタログ内またはフェデレーティッドソース内のデータベースの論理グループを表します。Redshift フェデレーティッドカタログ、もしくは別のアカウントまたはリージョンにある Redshift データベースへのリソースリンクを含むカタログの作成が可能になりました。
**フィールド**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログの ID。デフォルトのカタログへのアクセスを許可するときは、このフィールドは指定しません。
+ `Name` – *必須:* UTF-8 文字列。1～64 バイト長。[Custom string pattern #25](aws-glue-api-common.md#regex_25) に一致。
カタログの名前。アカウント ID と同じにすることはできません。
+ `ResourceArn` – UTF–8 文字列。
カタログリソースに割り当てられた Amazon リソースネーム (ARN)。
+ `Description` – 説明文字列。2048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
説明文字列。2,048 バイト以下。URI アドレスの複数行の文字列パターンに一致。カタログの説明。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
カタログのパラメータとプロパティを定義する、キーと値のペアのマップ配列。
+ `CreateTime` – タイムスタンプ。
カタログが作成された時刻。
+ `UpdateTime` – タイムスタンプ。
カタログが最後に更新された時刻。
+ `TargetRedshiftCatalog` – [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog) オブジェクト。
データベースリソースのリンク用のターゲットカタログを記述する `TargetRedshiftCatalog` オブジェクト。
+ `FederatedCatalog` – [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog) オブジェクト。
AWS Glue データカタログの外部のエンティティを指す `FederatedCatalog` オブジェクト。
+ `CatalogProperties` – [CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput) オブジェクト。
データレイクアクセスのプロパティとその他のカスタムプロパティを指定する `CatalogProperties` オブジェクト。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
`PrincipalPermissions` オブジェクトの配列。プリンシパル用のデフォルトのアクセス権限セットをテーブルに作成します。AWS Lake Formation で使用します。AWS Glue オペレーションの通常の過程では使用されません。
+ `CreateDatabaseDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
`PrincipalPermissions` オブジェクトの配列。プリンシパル用のデフォルトのアクセス権限セットをデータベースに作成します。AWS Lake Formation で使用します。AWS Glue オペレーションの通常の過程では使用されません。
+ `AllowFullTableExternalDataAccess` – UTF-8 文字列 (有効な値: `True` \$1 `False`)。
Lake Formation に登録されている Amazon S3 の場所にあるデータへのアクセスをサードパーティーエンジンに許可します。
## CatalogInput 構造
カタログプロパティを記述する構造。
**フィールド**
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
説明文字列。2,048 バイト以下。URI アドレスの複数行の文字列パターンに一致。カタログの説明。
+ `FederatedCatalog` – [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog) オブジェクト。
`FederatedCatalog` オブジェクト。AWS Glue データカタログの外部のエンティティ (Redshift データベースなど) を参照する `FederatedCatalog` 構造。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
カタログのパラメータとプロパティを定義する、キーと値のペアのマップ配列。
+ `TargetRedshiftCatalog` – [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog) オブジェクト。
リソースのリンク用のターゲットカタログを記述する `TargetRedshiftCatalog` オブジェクト。
+ `CatalogProperties` – [CatalogProperties](#aws-glue-api-catalog-catalogs-CatalogProperties) オブジェクト。
データレイクアクセスのプロパティとその他のカスタムプロパティを指定する `CatalogProperties` オブジェクト。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
`PrincipalPermissions` オブジェクトの配列。プリンシパル用のデフォルトのアクセス権限セットをテーブルに作成します。AWS Lake Formation で使用します。通常は空のリストとして明示的に設定する必要があります。
+ `CreateDatabaseDefaultPermissions` – [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
`PrincipalPermissions` オブジェクトの配列。プリンシパル用のデフォルトのアクセス権限セットをデータベースに作成します。AWS Lake Formation で使用します。通常は空のリストとして明示的に設定する必要があります。
+ `AllowFullTableExternalDataAccess` – UTF-8 文字列 (有効な値: `True` \$1 `False`)。
Lake Formation に登録されている Amazon S3 の場所にあるデータへのアクセスをサードパーティーエンジンに許可します。
## TargetRedshiftCatalog 構造
リソースのリンク用のターゲットテーブルを記述する構造。
**フィールド**
+ `CatalogArn` – *必須:* UTF–8 文字列。
カタログリソースの Amazon リソースネーム (ARN)。
## CatalogProperties 構造
データレイクアクセスのプロパティとその他のカスタムプロパティを指定する構造。
**フィールド**
+ `DataLakeAccessProperties` – [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties) オブジェクト。
AWS Glue データカタログ内のカタログリソースに対してデータレイクアクセスを設定するプロパティを指定する `DataLakeAccessProperties` オブジェクト。
+ `IcebergOptimizationProperties` – [IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties) オブジェクト。
カタログの Iceberg テーブル最適化プロパティを指定する構造。これには、このカタログの Iceberg テーブルに適用できる圧縮、保持、孤立ファイル削除オペレーションの設定が含まれます。
+ `CustomProperties` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
カタログの追加のキーと値のプロパティ。列統計の最適化など。
## CatalogPropertiesOutput 構造
カタログリソースの設定プロパティを含むプロパティ属性。
**フィールド**
+ `DataLakeAccessProperties` – [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput) オブジェクト。
AWS Glue データカタログ内のカタログリソースに対してデータレイクアクセスを設定する入力プロパティを持つ `DataLakeAccessProperties` オブジェクト。
+ `IcebergOptimizationProperties` – [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput) オブジェクト。
圧縮、保持、孤立ファイル削除オペレーションの設定など、カタログの Iceberg テーブル最適化設定を指定する `IcebergOptimizationPropertiesOutput` オブジェクト。
+ `CustomProperties` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
カタログの追加のキーと値のプロパティ。列統計の最適化など。
## DataLakeAccessProperties 構造
AWS Glue データカタログ内のカタログリソースに対してデータレイクアクセスを設定する入力プロパティ。
**フィールド**
+ `DataLakeAccess` – ブール。
Amazon Athena、Amazon EMR、AWS Glue ETL など、Redshift 以外のエンジンからデータカタログ内の Amazon Redshift データベースにアクセスする、Apache Spark アプリケーションのデータレイクアクセスをオンまたはオフにします。
+ `DataTransferRole`– UTF-8 文字列。[Custom string pattern #53](aws-glue-api-common.md#regex_53) に一致。
クエリ中にステージングバケットとの間でデータを転送するために AWS Glue が引き受けるロール。
+ `KmsKey` – UTF–8 文字列。
カタログと併せて作成されるステージングバケットに使用される暗号化キー。
+ `CatalogType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ネイティブのカタログリソースに対してフェデレーションカタログタイプを指定します。現在サポートされているタイプは `aws:redshift` です。
## IcebergOptimizationProperties 構造
圧縮、保持、孤立ファイル削除オペレーションの設定など、カタログの Iceberg テーブル最適化プロパティを指定する構造。
**フィールド**
+ `RoleArn` – UTF-8 文字列。[Custom string pattern #53](aws-glue-api-common.md#regex_53) に一致。
Iceberg テーブル最適化オペレーションを実行するために引き受けられる IAM ロールの Amazon リソースネーム (ARN)。
+ `Compaction` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg テーブル圧縮オペレーションの設定パラメータを指定するキーと値のペアのマップ。データファイルのレイアウトを最適化してクエリのパフォーマンスを向上させます。
+ `Retention` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg テーブル保持オペレーションの設定パラメータを指定するキーと値のペアのマップ。テーブルスナップショットのライフサイクルを管理し、ストレージコストを制御します。
+ `OrphanFileDeletion` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg 孤立ファイル削除オペレーションの設定パラメータを指定するキーと値のペアのマップ。テーブルメタデータによって参照されなくなったファイルを識別して削除します。
## DataLakeAccessPropertiesOutput 構造
AWS Glue データカタログ内のカタログリソースに対するデータレイクアクセス設定の出力プロパティ。
**フィールド**
+ `DataLakeAccess` – ブール。
データカタログ内の Amazon Redshift データベースにアクセスする Apache Spark アプリケーションのデータレイクアクセスをオンまたはオフにします。
+ `DataTransferRole`– UTF-8 文字列。[Custom string pattern #53](aws-glue-api-common.md#regex_53) に一致。
クエリ中にステージングバケットとの間でデータを転送するために AWS Glue が引き受けるロール。
+ `KmsKey` – UTF–8 文字列。
カタログと併せて作成されるステージングバケットに使用される暗号化キー。
+ `ManagedWorkgroupName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログリソース用に作成された Redshift Serverless マネージドコンピューティングの名前。
+ `ManagedWorkgroupStatus` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
Redshift Serverless マネージドコンピューティングのステータス。
+ `RedshiftDatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
マネージドコンピューティングのデフォルトの Redshift データベースリソースの名前。
+ `StatusMessage` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
マネージドワークグループのステータスに関する詳細情報を提供するメッセージ。
+ `CatalogType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ネイティブのカタログリソースに対してフェデレーションカタログタイプを指定します。現在サポートされているタイプは `aws:redshift` です。
## IcebergOptimizationPropertiesOutput 構造
AWS Glue データカタログ内のカタログリソースの Iceberg テーブル最適化設定の出力プロパティを含む構造。
**フィールド**
+ `RoleArn` – UTF-8 文字列。[Custom string pattern #53](aws-glue-api-common.md#regex_53) に一致。
Iceberg テーブル最適化オペレーションの実行に使用される IAM ロールの Amazon リソースネーム (ARN)。
+ `Compaction` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg テーブル圧縮オペレーションの設定パラメータを指定するキーと値のペアのマップ。データファイルのレイアウトを最適化してクエリのパフォーマンスを向上させます。
+ `Retention` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg テーブル保持オペレーションの設定パラメータを指定するキーと値のペアのマップ。テーブルスナップショットのライフサイクルを管理し、ストレージコストを制御します。
+ `OrphanFileDeletion` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
Iceberg 孤立ファイル削除オペレーションの設定パラメータを指定するキーと値のペアのマップ。テーブルメタデータによって参照されなくなったファイルを識別して削除します。
+ `LastUpdatedTime` – タイムスタンプ。
Iceberg 最適化プロパティが最後に更新されたタイムスタンプ。
## FederatedCatalog 構造
AWS Glue データカタログの外部のエンティティを指すカタログ。
**フィールド**
+ `Identifier` - UTF-8 文字列。1 ～ 512 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーションカタログの一意の識別子。
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
外部データソース (Redshift フェデレーティッドカタログなど) への接続の名前。
+ `ConnectionType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーティッドカタログへのアクセスに使用される接続のタイプで、外部データソースへの接続のプロトコルまたは方法を指定します。
## 操作
+ [CreateCatalog アクション (Python: create\$1catalog)](#aws-glue-api-catalog-catalogs-CreateCatalog)
+ [UpdateCatalog アクション (Python: update\$1catalog)](#aws-glue-api-catalog-catalogs-UpdateCatalog)
+ [DeleteCatalog アクション (Python: delete\$1catalog)](#aws-glue-api-catalog-catalogs-DeleteCatalog)
+ [GetCatalog アクション (Python: get\$1catalog)](#aws-glue-api-catalog-catalogs-GetCatalog)
+ [GetCatalogs アクション (Python: get\$1catalogs)](#aws-glue-api-catalog-catalogs-GetCatalogs)
## CreateCatalog アクション (Python: create\$1catalog)
AWS Glue データカタログに新しいカタログを作成します。
**リクエスト**
+ `Name` – *必須:* UTF-8 文字列。1～64 バイト長。[Custom string pattern #25](aws-glue-api-common.md#regex_25) に一致。
作成するカタログの名前。
+ `CatalogInput` – *必須:* [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput) オブジェクト。
カタログのメタデータを定義する `CatalogInput` オブジェクト。
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
キーバリューペアのマップ配列。50 ペア以下。各キーは UTF-8 文字列で、1～128 バイト長です。各値は UTF-8 文字列で、256 バイト長以下です。カタログに割り当てるタグ。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
## UpdateCatalog アクション (Python: update\$1catalog)
AWS Glue データカタログ内の既存のカタログのプロパティを更新します。
**リクエスト**
+ `CatalogId` – *必須:* カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログの ID。
+ `CatalogInput` – *必須:* [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput) オブジェクト。
既存のカタログの新しいプロパティを指定する `CatalogInput` オブジェクト。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## DeleteCatalog アクション (Python: delete\$1catalog)
指定されたカタログを AWS Glue データカタログから削除します。
このオペレーションが完了すると、削除されたカタログ内のデータベース、テーブル (それらのテーブルに属する可能性のあるすべてのテーブルのバージョンとパーティションも含む)、ユーザー定義の関数にアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
関連するすべてのリソースを直ちに削除するには、`DeleteCatalog` を呼び出す前に、`DeleteTableVersion` (または `BatchDeleteTableVersion`)、`DeletePartition` (または `BatchDeletePartition`)、`DeleteTable` (または `BatchDeleteTable`)、`DeleteUserDefinedFunction`、`DeleteDatabase` を使用して、カタログに属するすべてのリソースを削除します。
**リクエスト**
+ `CatalogId` – *必須:* カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログの ID。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## GetCatalog アクション (Python: get\$1catalog)
取得するカタログの名前。すべて小文字にします。
**リクエスト**
+ `CatalogId` – *必須:* カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログが属する親カタログの ID。設定されていない場合は、デフォルトで AWS のアカウント番号が使用されます。
**応答**
+ `Catalog` – [カタログ](#aws-glue-api-catalog-catalogs-Catalog) オブジェクト。
`Catalog` オブジェクト。AWS Glue データカタログ内の指定されたカタログの定義。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetCatalogs アクション (Python: get\$1catalogs)
AWS Glue データカタログのカタログで定義されているすべてのカタログを取得します。Redshift フェデレーティッドカタログのユースケースの場合、このオペレーションは、Redshift 名前空間カタログ内の Redshift データベースにマッピングされたカタログのリストを返します。
**リクエスト**
+ `ParentCatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログが属する親カタログの ID。設定されていない場合は、デフォルトで AWS のアカウント番号が使用されます。
+ `NextToken` – UTF-8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 1～1000 の数値 (整数)。
1 回の応答で返されるカタログの最大数。
+ `Recursive` – ブール。
カタログ階層内のすべてのカタログを `ParentCatalogId` から一覧表示するかどうか。デフォルトは `false` です。`true` の場合、`ParentCatalogID` 階層内のすべてのカタログオブジェクトがレスポンス内に一覧表示されます。
+ `IncludeRoot` – ブール。
アカウントとリージョンのデフォルトカタログをレスポンス内に一覧表示するかどうか。デフォルトは `false` です。`true` と `ParentCatalogId = NULL | AWS Account ID` の場合、すべてのカタログとデフォルトカタログがレスポンス内に一覧表示されます。
`ParentCatalogId` が null に等しくなく、この属性が `false` または `true`として渡されると、`InvalidInputException` がスローされます。
**応答**
+ `CatalogList` – *必須:* [カタログ](#aws-glue-api-catalog-catalogs-Catalog) オブジェクトの配列。
`Catalog` オブジェクトの配列。指定された親カタログの `Catalog` オブジェクトのリスト。
+ `NextToken` – UTF-8 文字列。
返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。
**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# データベース API
Database API では、データベースのデータ型について説明し、これにはデータベースを作成、削除、検索、更新、および一覧表示するための API が含まれます。
## データ型
+ [データベース構造](#aws-glue-api-catalog-databases-Database)
+ [DatabaseInput 構造](#aws-glue-api-catalog-databases-DatabaseInput)
+ [PrincipalPermissions 構造](#aws-glue-api-catalog-databases-PrincipalPermissions)
+ [DataLakePrincipal 構造](#aws-glue-api-catalog-databases-DataLakePrincipal)
+ [DatabaseIdentifier 構造](#aws-glue-api-catalog-databases-DatabaseIdentifier)
+ [FederatedDatabase 構造](#aws-glue-api-catalog-databases-FederatedDatabase)
## データベース構造
`Database` オブジェクトは、Hive メタストアまたは RDBMS に存在する可能性のあるテーブルの論理グループを表します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
データベースの名前。Hive との互換性を保つため、これは保存時には小文字で折りた畳まれます。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
データベースの説明。
+ `LocationUri` – Uniform resource identifier (uri)。1～1024 バイト長。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
データベースの場所 (たとえば HDFS パスなど)。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアはデータベースのパラメータとプロパティを定義します。
+ `CreateTime` – タイムスタンプ。
メタデータデータベースがカタログに作成された時刻。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
プリンシパル用のデフォルトのアクセス権限セットをテーブルに作成します。AWS Lake Formation で使用されます。AWS Glue オペレーションの通常の過程では使用されません。
+ `TargetDatabase` – [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier) オブジェクト。
リソースリンク用のターゲットデータベースを記述する `DatabaseIdentifier` 構造。
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
データベースが存在するデータカタログの ID。
+ `FederatedDatabase` – [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase) オブジェクト。
AWS Glue Data Catalog の外部のエンティティを参照する `FederatedDatabase` 構造。
## DatabaseInput 構造
データベースの作成または更新に使用される構造体。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
データベースの名前。Hive との互換性を保つため、これは保存時には小文字で折りた畳まれます。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
データベースの説明。
+ `LocationUri` – Uniform resource identifier (uri)。1～1024 バイト長。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
データベースの場所 (たとえば HDFS パスなど)。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアはデータベースのパラメータとプロパティを定義します。
これらのキー/値ペアはデータベースのパラメータとプロパティを定義します。
+ `CreateTableDefaultPermissions` – [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions) オブジェクトの配列。
プリンシパル用のデフォルトのアクセス権限セットをテーブルに作成します。AWS Lake Formation で使用されます。AWS Glue オペレーションの通常の過程では使用されません。
+ `TargetDatabase` – [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier) オブジェクト。
リソースリンク用のターゲットデータベースを記述する `DatabaseIdentifier` 構造。
+ `FederatedDatabase` – [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase) オブジェクト。
AWS Glue Data Catalog の外部のエンティティを参照する `FederatedDatabase` 構造。
## PrincipalPermissions 構造
プリンシパルに付与される許可です。
**フィールド**
+ `Principal` – [DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal) オブジェクト。
許可を付与されたプリンシパル。
+ `Permissions` – UTF-8 文字列の配列。
プリンシパルに付与される許可。
## DataLakePrincipal 構造
AWS Lake Formation プリンシパルです｡
**フィールド**
+ `DataLakePrincipalIdentifier` – UTF-8 文字列、1～255 バイト長。
AWS Lake Formation プリンシパルの識別子。
## DatabaseIdentifier 構造
リソースリンク用のターゲットデータベースを記述する 構造。
**フィールド**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
データベースが存在するデータカタログの ID。
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログデータベースの名前。
+ `Region` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ターゲットデータベースのリージョン。
## FederatedDatabase 構造
AWS Glue Data Catalog の外部のエンティティを指すデータベース。
**フィールド**
+ `Identifier` – UTF-8 文字列。1 ～ 512 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーションデータベースの一意の識別子。
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
外部メタストアへの接続の名前。
+ `ConnectionType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
JDBC、ODBC、またはその他のサポートされている接続プロトコルなど、フェデレーティッドデータベースへのアクセスに使用される接続のタイプ。
## 操作
+ [CreateDatabase アクション (Python: create\$1database)](#aws-glue-api-catalog-databases-CreateDatabase)
+ [UpdateDatabase アクション (Python: update\$1database)](#aws-glue-api-catalog-databases-UpdateDatabase)
+ [DeleteDatabase アクション (Python: delete\$1database)](#aws-glue-api-catalog-databases-DeleteDatabase)
+ [GetDatabase アクション (Python: get\$1database)](#aws-glue-api-catalog-databases-GetDatabase)
+ [GetDatabases アクション (Python: get\$1databases)](#aws-glue-api-catalog-databases-GetDatabases)
## CreateDatabase アクション (Python: create\$1database)
データカタログに新しいデータベースを作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
データベースを作成するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseInput` – *必須:* [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput) オブジェクト。
データベースのメタデータ。
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
データベースに割り当てるタグ。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## UpdateDatabase アクション (Python: update\$1database)
データカタログの既存のデータベース定義を更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
メタデータのデータベースが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
カタログで更新するデータベースの名前。Hive 互換性のために、これは小文字で表記されます。
+ `DatabaseInput` – *必須:* [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput) オブジェクト。
カタログ内のメタデータデータベースの新しい定義を指定する `DatabaseInput` オブジェクト。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## DeleteDatabase アクション (Python: delete\$1database)
指定されたデータベースをデータカタログから削除します。
**注記**
このオペレーションが完了すると、削除されたデータベース内のテーブル (それらのテーブルに属する可能性のあるすべてのテーブルのバージョンとパーティションも含む) とユーザー定義関数にはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
関連するすべてのリソースを確実にすぐに削除するには、`DeleteDatabase` を呼び出す前に、`DeleteTableVersion`/`BatchDeleteTableVersion`、`DeletePartition`/`BatchDeletePartition`、`DeleteUserDefinedFunction`、`DeleteTable`/`BatchDeleteTable` を使用して、データベースに属するすべてのリソースを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
データベースが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するデータベースの名前。Hive との互換性を保つため、名前はすべて小文字にする必要があります。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetDatabase アクション (Python: get\$1database)
指定されたデータベースの定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
データベースが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
取得するデータベースの名前。Hive 互換性のために、これはすべて小文字にする必要があります。
**レスポンス**
+ `Database` – [データベース](#aws-glue-api-catalog-databases-Database) オブジェクト。
データカタログ内の指定されたデータベースの定義。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetDatabases アクション (Python: get\$1databases)
指定されたデータカタログで定義されているすべてのデータベースを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
`Databases` を取得するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `NextToken` – UTF-8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 数値 (integer)。1～100。
1 回の応答で返すデータベースの最大数。
+ `ResourceShareType` – UTF-8 文字列 (有効な値: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`)。
アカウントと共有しているデータベースを一覧表示するように指定できます。指定できる値は、`FEDERATED`、`FOREIGN` または `ALL` です。
+ `FEDERATED` に設定した場合は、アカウントと共有されているフェデレーションデータベース (外部エンティティを参照) が一覧表示されます。
+ `FOREIGN` に設定した場合は、アカウントと共有されているデータベースが一覧表示されます。
+ `ALL` に設定した場合は、アカウントと共有されているデータベースと、ローカルアカウントのデータベースが一覧表示されます。
+ `AttributesToGet` – UTF-8 文字列の配列。
`GetDatabases` 呼び出しによって返されるデータベースフィールドを指定します。このパラメータは空のリストを受け入れません。リクエストには `NAME` を含める必要があります。
**レスポンス**
+ `DatabaseList` – *必須:* [データベース](#aws-glue-api-catalog-databases-Database) オブジェクトの配列。
指定されたカタログの `Database` オブジェクトのリスト。
+ `NextToken` – UTF-8 文字列。
返されたトークンのリストをページ分割するための継続トークン。リストの現在のセグメントが最後のセグメントではない場合に返されます。
**エラー**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# テーブル API
テーブル API は、データ型とテーブルに関連する操作について説明しています。
## データタイプ
+ [Table 構造](#aws-glue-api-catalog-tables-Table)
+ [TableInput 構造](#aws-glue-api-catalog-tables-TableInput)
+ [FederatedTable 構造](#aws-glue-api-catalog-tables-FederatedTable)
+ [列の構造](#aws-glue-api-catalog-tables-Column)
+ [StorageDescriptor 構造](#aws-glue-api-catalog-tables-StorageDescriptor)
+ [SchemaReference 構造](#aws-glue-api-catalog-tables-SchemaReference)
+ [SerDeInfo 構造](#aws-glue-api-catalog-tables-SerDeInfo)
+ [Order 構造](#aws-glue-api-catalog-tables-Order)
+ [SkewedInfo 構造](#aws-glue-api-catalog-tables-SkewedInfo)
+ [TableVersion 構造](#aws-glue-api-catalog-tables-TableVersion)
+ [TableError 構造](#aws-glue-api-catalog-tables-TableError)
+ [TableVersionError 構造](#aws-glue-api-catalog-tables-TableVersionError)
+ [SortCriterion 構造](#aws-glue-api-catalog-tables-SortCriterion)
+ [TableIdentifier 構造](#aws-glue-api-catalog-tables-TableIdentifier)
+ [KeySchemaElement 構造](#aws-glue-api-catalog-tables-KeySchemaElement)
+ [PartitionIndex 構造](#aws-glue-api-catalog-tables-PartitionIndex)
+ [PartitionIndexDescriptor 構造](#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
+ [BackfillError 構造](#aws-glue-api-catalog-tables-BackfillError)
+ [IcebergInput 構造](#aws-glue-api-catalog-tables-IcebergInput)
+ [OpenTableFormatInput 構造](#aws-glue-api-catalog-tables-OpenTableFormatInput)
+ [ViewDefinition 構造](#aws-glue-api-catalog-tables-ViewDefinition)
+ [ViewDefinitionInput 構造](#aws-glue-api-catalog-tables-ViewDefinitionInput)
+ [ViewRepresentation 構造](#aws-glue-api-catalog-tables-ViewRepresentation)
+ [ViewRepresentationInput 構造](#aws-glue-api-catalog-tables-ViewRepresentationInput)
+ [UpdateOpenTableFormatInput 構造](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
+ [UpdateIcebergInput 構造](#aws-glue-api-catalog-tables-UpdateIcebergInput)
+ [CreateIcebergTableInput 構造](#aws-glue-api-catalog-tables-CreateIcebergTableInput)
+ [UpdateIcebergTableInput 構造](#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
+ [IcebergSortOrder 構造](#aws-glue-api-catalog-tables-IcebergSortOrder)
+ [IcebergSortField 構造](#aws-glue-api-catalog-tables-IcebergSortField)
+ [IcebergPartitionSpec 構造](#aws-glue-api-catalog-tables-IcebergPartitionSpec)
+ [IcebergPartitionField 構造](#aws-glue-api-catalog-tables-IcebergPartitionField)
+ [IcebergSchema 構造](#aws-glue-api-catalog-tables-IcebergSchema)
+ [IcebergStructField 構造](#aws-glue-api-catalog-tables-IcebergStructField)
+ [IcebergTableUpdate 構造](#aws-glue-api-catalog-tables-IcebergTableUpdate)
+ [AuditContext 構造](#aws-glue-api-catalog-tables-AuditContext)
## Table 構造
列と行で構成されている関連データのコレクションを表します。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブル名。Hive 互換性のために、これはすべて小文字であることが必要です。
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルメタデータが存在するデータベースの名前。Hive との互換性を保つため、名前はすべて小文字にする必要があります。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
テーブルの説明。
+ `Owner` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの所有者。
+ `CreateTime` – タイムスタンプ。
データカタログでテーブル定義が作成された時刻。
+ `UpdateTime` – タイムスタンプ。
テーブルが最後に更新された時刻。
+ `LastAccessTime` – タイムスタンプ。
テーブルが最後にアクセスされた時刻。これは通常 HDFS から取得されるため、信頼性が低い場合があります。
+ `LastAnalyzedTime` – タイムスタンプ。
このテーブルの列統計が最後に計算された時刻。
+ `Retention` – 数値 (整数)、None 以下。
このテーブルの保持時間。
+ `StorageDescriptor` – [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor) オブジェクト。
このテーブルの物理ストレージに関する情報を含むストレージ記述子。
+ `PartitionKeys` – [Column](#aws-glue-api-catalog-tables-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\$1TABLE
Hive 互換属性 - Hive 以外の管理テーブルを示します。
GOVERNED
AWS Lake Formation で使用されます。AWS Glue データカタログは `GOVERNED` を認識します。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。
+ `CreatedBy` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルを作成した個人または団体。
+ `IsRegisteredWithLakeFormation` – ブール。
テーブルが AWS Lake Formation に登録されているかどうかを示します。
+ `TargetTable` – [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier) オブジェクト。
リソースリンク用のターゲットテーブルを記述する `TableIdentifier` 構造。
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルデータベースがあるデータカタログの ID。
+ `VersionId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルバージョンの ID。
+ `FederatedTable` – [FederatedTable](#aws-glue-api-catalog-tables-FederatedTable) オブジェクト。
AWS Glue Data Catalog の外部のエンティティを参照する `FederatedTable` 構造。
+ `ViewDefinition` – [ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition) オブジェクト。
ビューのダイアレクト、クエリなど、ビューを定義するすべての情報を含む構造。
+ `IsMultiDialectView` – ブール。
ビューがさまざまなクエリエンジンの SQL ダイアレクトをサポートし、それらのエンジンで読み取れるようにするかどうかを指定します。
## TableInput 構造
テーブルの定義に使用される構造。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブル名。Hive との互換性を保つため、これは保存時には小文字で折りた畳まれます。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
テーブルの説明。
+ `Owner` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの所有者。Apache Hive との互換性のために含まれています。AWS Glue オペレーションの通常の過程では使用されません。
+ `LastAccessTime` – タイムスタンプ。
テーブルが最後にアクセスされた時刻。
+ `LastAnalyzedTime` – タイムスタンプ。
このテーブルの列統計が最後に計算された時刻。
+ `Retention` – 数値 (整数)、None 以下。
このテーブルの保持時間。
+ `StorageDescriptor` – [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor) オブジェクト。
このテーブルの物理ストレージに関する情報を含むストレージ記述子。
+ `PartitionKeys` – [Column](#aws-glue-api-catalog-tables-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\$1TABLE
Hive 互換属性 - Hive 以外の管理テーブルを示します。
GOVERNED
AWS Lake Formation で使用されます。AWS Glue データカタログは `GOVERNED` を認識します。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアは、テーブルに関連付けられたプロパティを定義します。
+ `TargetTable` – [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier) オブジェクト。
リソースリンク用のターゲットテーブルを記述する `TableIdentifier` 構造。
+ `ViewDefinition` – [ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput) オブジェクト。
ビューのダイアレクト、クエリなど、ビューを定義するすべての情報を含む構造。
## FederatedTable 構造
AWS Glue Data Catalog の外部のエンティティを指すテーブル。
**フィールド**
+ `Identifier` – UTF-8 文字列。1 ～ 512 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーションテーブルの一意の識別子。
+ `DatabaseIdentifier` – UTF-8 文字列。1 ～ 512 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーションデータベースの一意の識別子。
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
外部メタストアへの接続の名前。
+ `ConnectionType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
フェデレーティッドテーブルへのアクセスに使用される接続タイプで、外部データソースに接続するためのプロトコルまたは方法を指定します。
## 列の構造
`Table` 内の列。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
`Column` の名前。
+ `Type` – UTF-8 文字列。131,072 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
`Column` のデータ型。
+ `Comment` – コメント文字列。255 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
自由形式のテキストコメント。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキーバリューペアは、列に関連付けられたプロパティを定義します。
## StorageDescriptor 構造
テーブルデータの物理ストレージについて説明します。
**フィールド**
+ `Columns` – [Column](#aws-glue-api-catalog-tables-Column) オブジェクトの配列。
テーブル内の `Columns` のリストです。
+ `Location` – 場所文字列。2,056 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
テーブルの物理的な場所。デフォルトでは、ウェアハウスの場所、その後にウェアハウス内のデータベースの場所、その後にテーブル名が続く形式になります。
+ `AdditionalLocations` – UTF-8 文字列の配列。
Delta テーブルへのパスを指す場所のリスト。
+ `InputFormat` – 書式設定文字列。128 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
入力形式: `SequenceFileInputFormat` (バイナリ)、または `TextInputFormat`、もしくはカスタム形式。
+ `OutputFormat` – 書式設定文字列。128 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
出力形式: `SequenceFileOutputFormat` (バイナリ)、または `IgnoreKeyTextOutputFormat`、もしくはカスタム形式。
+ `Compressed` – ブール。
テーブルのデータが圧縮されている場合は `True`、圧縮されていない場合は `False`。
+ `NumberOfBuckets` – 数値 (整数)。
テーブルにディメンション列が含まれている場合、指定する必要があります。
+ `SerdeInfo` – [SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo) オブジェクト。
シリアライズ/デシリアライズ (SerDe) 情報。
+ `BucketColumns` – UTF-8 文字列の配列。
テーブルのリデューサーグループ化列、クラスター列、およびバケット列のリスト。
+ `SortColumns` – [注文](#aws-glue-api-catalog-tables-Order) オブジェクトの配列。
テーブル内の各バケットのソート順を指定するリスト。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
ユーザーが指定したキーバリュー形式のプロパティ。
+ `SkewedInfo` – [SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo) オブジェクト。
列に高い頻度で表示される値 (歪んだ値) に関する情報。
+ `StoredAsSubDirectories` – ブール。
テーブルデータがサブディレクトリに保管されている場合は `True`、保管されていない場合は `False`。
+ `SchemaReference` – [SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference) オブジェクト。
AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
テーブルを作成するときにスキーマに空の列リストを渡し、代わりにスキーマリファレンスを使用します。
## SchemaReference 構造
AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
**フィールド**
+ `SchemaId` – [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId) オブジェクト。
スキーマアイデンティティフィールドを含む構造。こちらか `SchemaVersionId` のいずれかを指定する必要があります。
+ `SchemaVersionId` – UTF-8 文字列。36 バイト長。[Custom string pattern #45](aws-glue-api-common.md#regex_45) に一致。
スキーマのバージョンに割り当てられた一意の ID。こちらか `SchemaId` のいずれかを指定する必要があります。
+ `SchemaVersionNumber` – 数値 (long)。1～100000。
スキーマのバージョン番号。
## SerDeInfo 構造
エクストラクターおよびローダーとして機能するシリアライズ/デシリアライズプログラム (SerDe) に関する情報。
**フィールド**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
SerDe 名。
+ `SerializationLibrary` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
通常、SerDe を実装するクラス。例は `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe` です。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキーバリューペアは SerDe の初期化パラメータを定義します。
## Order 構造
ソートされた列のソート順を指定します。
**フィールド**
+ `Column` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
列の名前。
+ `SortOrder` – *必須:* 数値 (integer)。1 以下。
列が昇順 (`== 1`) または降順 (`==0`) でソートされていることを指定します。
## SkewedInfo 構造
テーブルで歪んだ値を指定します。「歪んだ値」とは、非常に高い頻度で発生する値です。
**フィールド**
+ `SkewedColumnNames` – UTF-8 文字列の配列。
歪んだ値を含む列名のリスト。
+ `SkewedColumnValues` – UTF-8 文字列の配列。
頻繁に出現するため、歪んだとみなされる値のリスト。
+ `SkewedColumnValueLocationMaps` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列。
各値は UTF-8 文字列。
歪んだ値が含まれている列へのマッピング。
## TableVersion 構造
テーブルのバージョンを指定します。
**フィールド**
+ `Table` – [Table](#aws-glue-api-catalog-tables-Table) オブジェクト。
該当するテーブル。
+ `VersionId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
このテーブルのバージョンを特定する ID 値。`VersionId` は整数の文字列表現です。各バージョンは 1 ずつ増加します。
## TableError 構造
テーブル操作に対するエラーレコード。
**フィールド**
+ `TableName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの名前。Hive 互換性のために、これはすべて小文字であることが必要です。
+ `ErrorDetail` – [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) オブジェクト。
エラーに関する詳細。
## TableVersionError 構造
テーブルバージョン操作に対するエラーレコード。
**フィールド**
+ `TableName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当するテーブルの名前。
+ `VersionId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当するバージョンの ID 値。`VersionID` は整数の文字列表現です。各バージョンは 1 ずつ増加します。
+ `ErrorDetail` – [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) オブジェクト。
エラーに関する詳細。
## SortCriterion 構造
ソート基準となるフィールドとソート順を指定します。
**フィールド**
+ `FieldName` – 値の文字列の長さ。1～1024 バイト長。
ソートするフィールドの名前。
+ `Sort` – UTF-8 文字列 (有効な値: `ASC="ASCENDING"` \$1 `DESC="DESCENDING"`)。
昇順または降順のソート。
## TableIdentifier 構造
リソースリンク用のターゲットテーブルを記述する構造。
**フィールド**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルデータベースがあるデータカタログの ID。
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ターゲットテーブルを含むカタログデータベースの名前。
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ターゲットテーブルの名前。
+ `Region` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ターゲットテーブルのリージョン。
## KeySchemaElement 構造
名前とタイプで構成されるパーティションキーペア。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションキーの名前。
+ `Type` – *必須:* UTF-8 文字列。131072 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションキーのタイプ。
## PartitionIndex 構造
パーティションインデックスの構造。
**フィールド**
+ `Keys` – *必須:* UTF-8 文字列の配列。1 個の以上の文字列。
パーティションインデックスのキー。
+ `IndexName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスの名前。
## PartitionIndexDescriptor 構造
テーブル内のパーティションインデックスの記述子。
**フィールド**
+ `IndexName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスの名前。
+ `Keys` – *必須:* [KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement) オブジェクトの配列、少なくとも 1 つの構造体。
`KeySchemaElement` 構造体としてのパーティションインデックスの 1 つ以上のキーのリスト。
+ `IndexStatus` – *必須:* UTF-8 文字列 (有効な値: `CREATING` \$1 `ACTIVE` \$1 `DELETING` \$1 `FAILED`)。
インデックスパーティションのステータス。
次のようなステータスがあります。
+ CREATING: インデックスは作成中です。インデックスが CREATING 状態の場合、インデックスまたはそのテーブルは削除できません。
+ ACTIVE: インデックスの作成に成功しました。
+ FAILED: インデックスの作成に失敗しました。
+ DELETING: インデックスは、インデックスのリストから削除されます。
+ `BackfillErrors` – [BackfillError](#aws-glue-api-catalog-tables-BackfillError) オブジェクトの配列。
既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。
## BackfillError 構造
既存のテーブルのパーティションインデックスを登録するときに発生する可能性があるエラーのリスト。
これらのエラーでは、インデックスの登録が失敗した理由の詳細が表示され、応答として限られた数のパーティションが示されます。これにより、障害が発生したパーティションを修正し、インデックスの登録を再試行できます。発生する可能性のある最も一般的なエラーのセットは、次のように分類されます。
+ EncryptedPartitionError: パーティションが暗号化されています。
+ InvalidPartitionTypeDataError: パーティション値がそのパーティション列のデータ型と一致しません。
+ MissingPartitionValueError: パーティションが暗号化されています。
+ UnsupportedPartitionCharacterError: パーティション値内の文字がサポートされていません。例: U\$10000、U\$10001、U\$10002。
+ InternalError: 他のエラーコードに属さないすべてのエラー。
**フィールド**
+ `Code` – UTF-8 文字列 (有効な値: `ENCRYPTED_PARTITION_ERROR` \$1 `INTERNAL_ERROR` \$1 `INVALID_PARTITION_TYPE_DATA_ERROR` \$1 `MISSING_PARTITION_VALUE_ERROR` \$1 `UNSUPPORTED_PARTITION_CHARACTER_ERROR`)。
既存のテーブルのパーティションインデックスを登録するときに発生したエラーのエラーコード。
+ `Partitions` – [PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList) オブジェクトの配列。
応答内の限られた数のパーティションのリスト。
## IcebergInput 構造
カタログ内に作成する Apache Iceberg メタデータテーブルを定義する構造。
**フィールド**
+ `MetadataOperation` – *必須:* UTF-8 文字列 (有効な値: `CREATE`)。
必須のメタデータオペレーション。これは `CREATE` にのみ設定できます。
+ `Version` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
Iceberg テーブルのテーブルバージョン。デフォルトは 2 です。
+ `CreateIcebergTableInput` – [CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput) オブジェクト。
テーブルプロパティやメタデータ仕様など、AWS Glue Data Catalog で新しい Iceberg テーブルを作成するために必要な設定パラメータ。
## OpenTableFormatInput 構造
オープン形式のテーブルを表す構造。
**フィールド**
+ `IcebergInput` – [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput) オブジェクト。
Apache Iceberg メタデータテーブルを定義する `IcebergInput` 構造を指定します。
## ViewDefinition 構造
表現の詳細を含む構造。
**フィールド**
+ `IsProtected` – ブール。
このフラグを true に設定すると、クエリ計画中にユーザー提供のオペレーションをビューの論理プランにプッシュしないようにエンジンに指示できます。ただし、このフラグを設定しても、エンジンが従うとは限りません。エンジンのドキュメントを参照して、提供される保証を理解してください。
+ `Definer` – UTF-8 文字列。20 ～ 2,048 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
SQL のビューの定義者。
+ `SubObjects` – UTF-8 文字列の配列。文字列 10 個以下。
テーブル Amazon リソースネーム (ARN) のリスト。
+ `Representations` – [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation) オブジェクトの配列。1～1000 個の構造体。
表現のリスト。
## ViewDefinitionInput 構造
AWS Glue ビューを作成または更新するための詳細を含む構造。
**フィールド**
+ `IsProtected` – ブール。
このフラグを true に設定すると、クエリ計画中にユーザー提供のオペレーションをビューの論理プランにプッシュしないようにエンジンに指示できます。ただし、このフラグを設定しても、エンジンが従うとは限りません。エンジンのドキュメントを参照して、提供される保証を理解してください。
+ `Definer` – UTF-8 文字列。20 ～ 2,048 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
SQL のビューの定義者。
+ `Representations` – [ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput) オブジェクトの配列、1～10 個の構造。
ビューのダイアレクトとビューを定義するクエリを含む構造のリスト。
+ `SubObjects` – UTF-8 文字列の配列。文字列 10 個以下。
ビューを構成するベーステーブルの ARN のリスト。
## ViewRepresentation 構造
ビューのダイアレクトとビューを定義するクエリを含む構造。
**フィールド**
+ `Dialect` – UTF-8 文字列 (有効な値: `REDSHIFT` \$1 `ATHENA` \$1 `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](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ビューの特定の表現の検証に使用される接続の名前。
+ `IsStale` – ブール。
古いとマークされたダイアレクトは無効になり、それぞれのクエリエンジンでクエリを実行する前に更新する必要があります。
## ViewRepresentationInput 構造
Lake Formation ビューを更新または作成するための表現の詳細を含む構造。
**フィールド**
+ `Dialect` – UTF-8 文字列 (有効な値: `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`)。
特定の表現のエンジンタイプを指定するパラメータ。
+ `DialectVersion` – UTF-8 文字列、1～255 バイト長。
特定の表現のエンジンのバージョンを指定するパラメータ。
+ `ViewOriginalText` – UTF-8 文字列。409,600 バイト長以下。
ビューを記述する元の SQL クエリを表す文字列。
+ `ValidationConnection` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
ビューの特定の表現の検証に使用される接続の名前。
+ `ViewExpandedText` – UTF-8 文字列。409,600 バイト長以下。
ビューを記述する SQL クエリおよび拡張されたリソースの ARN を表す文字列
## UpdateOpenTableFormatInput 構造
AWS Glue Data Catalog でオープンテーブル形式のテーブルを更新するための入力パラメータ。Apache Iceberg などの形式固有の更新操作のラッパーとして機能します。
**フィールド**
+ `UpdateIcebergInput` – [UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput) オブジェクト。
スキーマの変更、パーティションの仕様、テーブルのプロパティなど、適用するテーブルの変更を定義する Apache Iceberg 固有の更新パラメータ。
## UpdateIcebergInput 構造
既存の Iceberg テーブルに適用される更新操作を含む、AWS Glue Data Catalog の Apache Iceberg テーブルの更新に固有の入力パラメータ。
**フィールド**
+ `UpdateIcebergTableInput` – *必須:* [UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput) オブジェクト。
Iceberg テーブルに適用する特定の更新操作。スキーマ、パーティション、プロパティなど、テーブルの新しい状態を定義する更新のリストが含まれます。
## CreateIcebergTableInput 構造
テーブルプロパティやメタデータ仕様など、AWS Glue Data Catalog で新しい Iceberg テーブルを作成するために必要な設定パラメータ。
**フィールド**
+ `Location` – *必須:* 場所文字列。2,056 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
Iceberg テーブルデータが保存される S3 ロケーション。
+ `Schema` – *必須:* [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema) オブジェクト。
Iceberg テーブルの構造、フィールドタイプ、メタデータを指定するスキーマ定義。
+ `PartitionSpec` – [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec) オブジェクト。
最適なクエリパフォーマンスのために、Iceberg テーブルデータを整理およびパーティショニングする方法を定義するパーティショニング仕様。
+ `WriteOrder` – [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder) オブジェクト。
クエリのパフォーマンスを最適化するために各パーティション内でデータを順序付ける方法を定義する、ソート順序の仕様。
+ `Properties` –
Iceberg テーブルの追加テーブルプロパティと設定のキーと値のペア。
## UpdateIcebergTableInput 構造
AWS Glue Data Catalog の既存の Iceberg テーブルに適用する更新操作が含まれ、テーブルメタデータの新しい状態を定義します。
**フィールド**
+ `Updates` – *必須:* [IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate) オブジェクトの配列。
スキーマの変更、パーティション仕様、テーブルプロパティを含む、Iceberg テーブルに加える変更を指定するテーブル更新操作のリスト。
## IcebergSortOrder 構造
Iceberg テーブルのソート順序仕様を定義し、クエリのパフォーマンスを最適化するためにパーティション内でデータを順序付ける方法を決定します。
**フィールド**
+ `OrderId` – *必須:* 数値 (整数)。
Iceberg テーブルのメタデータ内のこのソート順序仕様の一意の識別子。
+ `Fields` – *必須:* [IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField) オブジェクトの配列。
Iceberg テーブルデータの順序基準を定義する、フィールドとそのソート方向のリスト。
## IcebergSortField 構造
ソースフィールド、変換、ソート方向、null 値の順序など、Iceberg ソート順序仕様内の単一のフィールドを定義します。
**フィールド**
+ `SourceId` – *必須:* 数値 (整数)。
このソートフィールドの基礎となるテーブルスキーマのソースフィールドの識別子。
+ `Transform` – *必須:* UTF–8 文字列。
ID、バケット、切り捨てなど、ソート前にソースフィールドに適用される変換関数。
+ `Direction` – *必須:* UTF-8 文字列 (有効な値: `asc="ASC"` \$1 `desc="DESC"`)。
フィールドのソート方向。昇順または降順のいずれか。
+ `NullOrder` – *必須:* UTF-8 文字列 (有効な値: `nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`)。
このフィールドの null 値の順序付け動作。null をソート順で最初または最後に表示するかどうかを指定します。
## IcebergPartitionSpec 構造
Iceberg テーブルのパーティショニング仕様を定義し、最適なクエリパフォーマンスのためにテーブルデータを整理およびパーティショニングする方法を決定します。
**フィールド**
+ `Fields` – *必須:* [IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField) オブジェクトの配列。
ソースフィールドとその変換など、テーブルデータのパーティショニング方法を定義するパーティションフィールドのリスト。
+ `SpecId` – 数値 (整数)。
Iceberg テーブルのメタデータ履歴内にあるこのパーティション仕様の一意の識別子。
## IcebergPartitionField 構造
ソースフィールド、変換関数、パーティション名、一意の識別子など、Iceberg パーティション仕様内の単一のパーティションフィールドを定義します。
**フィールド**
+ `SourceId` – *必須:* 数値 (整数)。
このパーティションフィールドの基礎となるテーブルスキーマのソースフィールドの識別子。
+ `Transform` – *必須:* UTF–8 文字列。
ID、バケット、切り捨て、年、月、日、時間など、パーティションを作成するためにソースフィールドに適用される変換関数。
+ `Name` – *必須:* UTF-8 文字列。1 ～ 1024 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティショニングされたテーブル構造に表示されるパーティションフィールドの名前。
+ `FieldId` – 数値 (整数)。
Iceberg テーブルのパーティション仕様内でこのパーティションフィールドに割り当てられた一意の識別子。
## IcebergSchema 構造
フィールド定義、データ型、スキーマメタデータなど、Iceberg テーブルのスキーマ構造を定義します。
**フィールド**
+ `SchemaId` – 数値 (整数)。
Iceberg テーブルのスキーマの進化履歴内にあるこのスキーマバージョンの一意の識別子。
+ `IdentifierFieldIds` – 符号付き 32 ビット整数の配列。
テーブル内のレコードを一意に識別するフィールド識別子のリスト。行レベルの操作と重複排除に使用されます。
+ `Type` – UTF-8 文字列 (有効な値: `struct="STRUCT"`)。
スキーマ構造のルートタイプ。通常は Iceberg テーブルスキーマの「構造体」です。
+ `Fields` – *必須:* [IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField) オブジェクトの配列。
フィールド名、タイプ、メタデータなど、テーブルスキーマを構成するフィールド定義のリスト。
## IcebergStructField 構造
識別子、名前、データ型、null 値の許容性、ドキュメントなど、Iceberg テーブルスキーマ内の単一のフィールドを定義します。
**フィールド**
+ `Id` – *必須:* 数値 (整数)。
Iceberg テーブルスキーマ内でこのフィールドに割り当てられた一意の識別子。スキーマの進化とフィールドの追跡に使用されます。
+ `Name` – *必須:* UTF-8 文字列。1 ～ 1024 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルスキーマおよびクエリ操作に表示されるフィールドの名前。
+ `Type` – *必須:* `IcebergDocument` という名前の空の構造。
このフィールドのデータ型定義。含まれるデータの構造と形式を指定します。
+ `Required` – *必須:* ブール。
テーブルスキーマでこのフィールドが必要 (null 値を許容しない) かオプション (null 値を許容する) かを示します。
+ `Doc` – コメント文字列。255 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
このフィールドの目的と使用に関する追加のコンテキストを提供する、オプションのドキュメントまたは説明テキスト。
## IcebergTableUpdate 構造
スキーマの変更、パーティショニングの変更、ソート順の調整、場所の更新、プロパティの変更など、Iceberg テーブルに適用される更新の完全なセットを定義します。
**フィールド**
+ `Schema` – *必須:* [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema) オブジェクト。
フィールド構造、データ型、またはスキーマメタデータへの変更を指定する、Iceberg テーブルの更新されたスキーマ定義。
+ `PartitionSpec` – [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec) オブジェクト。
テーブルデータを再編成してパーティショニングする方法を定義する、更新されたパーティショニング仕様。
+ `SortOrder` – [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder) オブジェクト。
クエリのパフォーマンスを最適化するためにパーティション内でデータを順序付ける方法を定義する、更新されたソート順序の仕様。
+ `Location` – *必須:* 場所文字列。2,056 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
Iceberg テーブルデータが保存される更新された S3 ロケーションを定義します。
+ `Properties` –
Iceberg テーブルのテーブルプロパティと設定の更新されたキーと値のペア。
## AuditContext 構造
Lake Formation 監査コンテキストを含む構造。
**フィールド**
+ `AdditionalAuditContext` – UTF-8 文字列、2048 バイト長以下。
追加の監査コンテキスト情報を含む文字列。
+ `RequestedColumns` – UTF-8 文字列の配列。
監査のためにリクエストされた列。
+ `AllColumnsRequested` – ブール。
すべての列は監査をリクエストします。
## 操作
+ [CreateTable アクション (Python: create\$1table)](#aws-glue-api-catalog-tables-CreateTable)
+ [UpdateTable アクション (Python: update\$1table)](#aws-glue-api-catalog-tables-UpdateTable)
+ [DeleteTable アクション (Python: delete\$1table)](#aws-glue-api-catalog-tables-DeleteTable)
+ [BatchDeleteTable アクション (Python: batch\$1delete\$1table)](#aws-glue-api-catalog-tables-BatchDeleteTable)
+ [GetTable アクション (Python:get\$1table)](#aws-glue-api-catalog-tables-GetTable)
+ [GetTables アクション (Python: get\$1tables)](#aws-glue-api-catalog-tables-GetTables)
+ [GetTableVersion アクション (Python: get\$1table\$1version)](#aws-glue-api-catalog-tables-GetTableVersion)
+ [GetTableVersions アクション (Python: get\$1table\$1versions)](#aws-glue-api-catalog-tables-GetTableVersions)
+ [DeleteTableVersion アクション (Python: delete\$1table\$1version)](#aws-glue-api-catalog-tables-DeleteTableVersion)
+ [BatchDeleteTableVersion アクション (Python: batch\$1delete\$1table\$1version)](#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
+ [SearchTables アクション (Python: search\$1tables)](#aws-glue-api-catalog-tables-SearchTables)
+ [GetPartitionIndexes アクション (Python: get\$1partition\$1indexes)](#aws-glue-api-catalog-tables-GetPartitionIndexes)
+ [CreatePartitionIndex アクション (Python: create\$1partition\$1index)](#aws-glue-api-catalog-tables-CreatePartitionIndex)
+ [DeletePartitionIndex アクション (Python: delete\$1partition\$1index)](#aws-glue-api-catalog-tables-DeletePartitionIndex)
+ [GetColumnStatisticsForTable アクション (Python: get\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
+ [UpdateColumnStatisticsForTable アクション (Python: update\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
+ [DeleteColumnStatisticsForTable アクション (Python: delete\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)
## CreateTable アクション (Python: create\$1table)
データカタログで新しいテーブル定義を作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
`Table` を作成するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
新しいテーブルを作成するカタログデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
AWS Glue Data Catalog に作成される、指定されたデータベース内のテーブルの一意の識別子。
+ `TableInput` – [TableInput](#aws-glue-api-catalog-tables-TableInput) オブジェクト。
カタログで作成するメタデータテーブルを定義する `TableInput` オブジェクト。
+ `PartitionIndexes` – [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex) オブジェクトの配列。構造 3 個以下。
テーブル内に作成されるパーティションインデックスのリストである `PartitionIndex` 構造。
+ `TransactionId` – UTF-8 文字列、1～255 バイト長、[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
トランザクションの ID。
+ `OpenTableFormatInput` – [OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput) オブジェクト。
オープン形式のテーブルを作成するときに `OpenTableFormatInput` 構造を指定します。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## UpdateTable アクション (Python: update\$1table)
データカタログのメタデータテーブルを更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
AWS Glue Data Catalog に作成される、指定されたデータベース内のテーブルの一意の識別子。
+ `TableInput` – [TableInput](#aws-glue-api-catalog-tables-TableInput) オブジェクト。
カタログのメタデータテーブルを定義するための、更新された `TableInput` オブジェクト。
+ `SkipArchive` – ブール。
`UpdateTable` は、デフォルトでは、更新する前に常にテーブルのアーカイブされたバージョンを作成します。ただし、`skipArchive` が true に設定されている場合、`UpdateTable` ではアーカイブされたバージョンは作成されません。
+ `TransactionId` – UTF-8 文字列。1～255 バイト長。[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
+ `VersionId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの内容を更新するバージョン ID。
+ `ViewUpdateAction` – UTF-8 文字列 (有効な値: `ADD` \$1 `REPLACE` \$1 `ADD_OR_REPLACE` \$1 `DROP`)。
ビューの更新時に実行されるオペレーション。
+ `Force` – ブール。
一致するストレージ記述子とサブオブジェクト一致要件を無視するように true に設定できるフラグ。
+ `UpdateOpenTableFormatInput` – [UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput) オブジェクト。
AWS Glue Data Catalog でオープンテーブル形式のテーブルを更新するための入力パラメータ。Apache Iceberg などの形式固有の更新操作のラッパーとして機能します。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## DeleteTable アクション (Python: delete\$1table)
データカタログからテーブル定義を削除します。
**注記**
このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
すべての関連リソースをすぐに削除するには、`DeleteTable` または `DeleteTableVersion` を使用し、`BatchDeleteTableVersion` または `DeletePartition` を使用して、テーブルに属するすべてのリソースを削除してから、`BatchDeletePartition` を呼び出します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するテーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TransactionId` – UTF-8 文字列。1～255 バイト長。[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchDeleteTable アクション (Python: batch\$1delete\$1table)
一度に複数のテーブルを削除します。
**注記**
このオペレーションが完了すると、削除されたテーブルに属するテーブルのバージョンとパーティションにはアクセスできなくなります。AWS Glue では、このサービスの裁量により、これらの「孤立した」リソースを適時に非同期的に削除します。
すべての関連リソースをすぐに削除するには、`BatchDeleteTable` または `DeleteTableVersion` を使用し、`BatchDeleteTableVersion` または `DeletePartition` を使用して、テーブルに属するすべてのリソースを削除してから、`BatchDeletePartition` を呼び出します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するテーブルが存在するカタログデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TablesToDelete` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
削除するテーブルのリスト。
+ `TransactionId` – UTF-8 文字列。1～255 バイト長。[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
**応答**
+ `Errors` – [TableError](#aws-glue-api-catalog-tables-TableError) オブジェクトの配列。
指定されたテーブルの削除試行中に発生したエラーのリスト。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
## GetTable アクション (Python:get\$1table)
指定されたテーブルのデータカタログ内にある `Table` 定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログのデータベースの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
定義を取得するテーブルの名前です。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TransactionId` – UTF-8 文字列、1～255 バイト長、[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
+ `QueryAsOfTime` – タイムスタンプ。
テーブルの内容を読み取る時点の時間。設定されていない場合は、最新のトランザクションコミット時間が使用されます。`TransactionId` と一緒に指定することはできません。
+ `AuditContext` – [AuditContext](#aws-glue-api-catalog-tables-AuditContext) オブジェクト。
Lake Formation [監査コンテキスト](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html) を含む構造。
+ `IncludeStatusDetails` – ブール。
AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
**応答**
+ `Table` – [Table](#aws-glue-api-catalog-tables-Table) オブジェクト。
指定したテーブルを定義する `Table` オブジェクト。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetTables アクション (Python: get\$1tables)
特定の `Database` 内の、一部またはすべてのテーブル定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルをリスト表示するカタログ内のデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `Expression` – UTF-8 文字列。2,048 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
正規表現パターン。存在する場合、パターンに名前が一致するテーブルのみが返されます。
+ `NextToken` – UTF–8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 数値 (integer)。1～100。
1 回の応答で返されるテーブルの最大数。
+ `TransactionId` – UTF-8 文字列、1～255 バイト長、[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
+ `QueryAsOfTime` – タイムスタンプ。
テーブルの内容を読み取る時点の時間。設定されていない場合は、最新のトランザクションコミット時間が使用されます。`TransactionId` と一緒に指定することはできません。
+ `AuditContext` – [AuditContext](#aws-glue-api-catalog-tables-AuditContext) オブジェクト。
Lake Formation [監査コンテキスト](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html) を含む構造。
+ `IncludeStatusDetails` – ブール。
AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
+ `AttributesToGet` – UTF-8 文字列の配列。
`GetTables` 呼び出しによって返されるテーブルフィールドを指定します。このパラメータは空のリストを受け入れません。リクエストには `NAME` を含める必要があります。
有効な値の組み合わせは次のとおりです。
+ `NAME` - データベースにあるすべてのテーブルの名前。
+ `NAME`、`TABLE_TYPE` - すべてのテーブルとテーブルタイプの名前。
**応答**
+ `TableList` – [Table](#aws-glue-api-catalog-tables-Table) オブジェクトの配列。
リクエストされた `Table` オブジェクトのリスト。
+ `NextToken` – UTF-8 文字列。
継続トークン (現在のリストセグメントが最後ではない場合に存在)。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetTableVersion アクション (Python: get\$1table\$1version)
テーブルの指定されたバージョンを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `VersionId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
取得するテーブルバージョンの ID 値。`VersionID` は整数の文字列表現です。各バージョンは 1 ずつ増加します。
**応答**
+ `TableVersion` – [TableVersion](#aws-glue-api-catalog-tables-TableVersion) オブジェクト。
リクエストされたテーブルのバージョン。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## GetTableVersions アクション (Python: get\$1table\$1versions)
指定したテーブルで使用可能なバージョンを指定する文字列のリストを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `NextToken` – UTF–8 文字列。
継続トークン (これが最初の呼び出しでない場合)。
+ `MaxResults` – 数値 (integer)。1～100。
1 回の応答で返すテーブルバージョンの最大数。
**応答**
+ `TableVersions` – [TableVersion](#aws-glue-api-catalog-tables-TableVersion) オブジェクトの配列。
指定したテーブルの使用可能なバージョンを指定する文字列のリスト。
+ `NextToken` – UTF–8 文字列。
継続トークン (使用可能なバージョンのリストに最後のバージョンが含まれていない場合)。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteTableVersion アクション (Python: delete\$1table\$1version)
テーブルの指定されたバージョンを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `VersionId` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するテーブルバージョンの ID。`VersionID` は整数の文字列表現です。各バージョンは 1 ずつ増加します。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchDeleteTableVersion アクション (Python: batch\$1delete\$1table\$1version)
テーブルの指定されたバージョンのバッチを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログのデータベース。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルの名前。Hive 互換性のために、この名前はすべて小文字であることが必要です。
+ `VersionIds` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
削除するバージョンの ID リスト。`VersionId` は整数の文字列表現です。各バージョンは 1 ずつ増加します。
**応答**
+ `Errors` – [TableVersionError](#aws-glue-api-catalog-tables-TableVersionError) オブジェクトの配列。
指定されたテーブルバージョンを削除しようとしているときに発生したエラーのリスト。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## SearchTables アクション (Python: search\$1tables)
テーブルメタデータのプロパティと親データベースに基づいて一連のテーブルを検索します。テキストまたはフィルタ条件で検索できます。
Lake Formation に定義されているセキュリティポリシーに基づいて、アクセスできるテーブルのみを取得できます。テーブルが返されるようにするには、少なくともテーブルへの読み取り専用アクセスが必要です。テーブル内の一部の列にアクセスできない場合、テーブルのリストが返されるときに、これらの列は検索されません。列にはアクセスできても、これら列内のデータにアクセスできない場合は、これらの列とこれらの列に関連付けられたメタデータが検索に含まれます。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
一意の識別子 (`account_id` で構成)。
+ `NextToken` – UTF–8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `Filters` – [PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate) オブジェクトの配列。
キーバリューペアのリスト、および検索結果のフィルタリングに使用する比較演算子。述語に一致するすべてのエンティティを返します。
`PropertyPredicate` 構造体の `Comparator` メンバーは時間フィールドにのみ使用され、他のフィールドタイプでは省略できます。また、`Key=Name` など文字列値を比較する場合、ファジーマッチアルゴリズムが使用されます。`Key` フィールド (例えば、`Name` フィールドの値) は、特定の句読点文字 (-、:、\$1 など) でトークンに分割されます。次に、各トークンは `PropertyPredicate` の `Value` メンバーとエグザクトマッチで比較されます。例えば、`Key=Name` および `Value=link` の場合、`customer-link` や `xx-link-yy` という名前のテーブルは返されますが、`xxlinkyy` の場合は返されません。
+ `SearchText` – 値の文字列の長さ。1～1024 バイト長。
テキスト検索に使用する文字列。
値を引用符で囲んで指定すると、値との完全一致に基づいてフィルタリングされます。
+ `SortCriteria` – [SortCriterion](#aws-glue-api-catalog-tables-SortCriterion) オブジェクトの配列。構造 1 個以下。
結果をフィールド名で昇順または降順でソートするための条件のリスト。
+ `MaxResults` – 1～1000 の数値 (整数)。
1 回の応答で返されるテーブルの最大数。
+ `ResourceShareType` – UTF-8 文字列 (有効な値: `FOREIGN` \$1 `ALL` \$1 `FEDERATED`)。
アカウントと共有されているテーブルを検索するように指定できます。指定できる値は、`FOREIGN` または `ALL` です。
+ `FOREIGN` に設定されている場合、アカウントと共有されているテーブルが検索されます。
+ `ALL` に設定されている場合、アカウントと共有されているテーブルとローカルアカウントのテーブルが検索されます。
+ `IncludeStatusDetails` – ブール。
AWS Glue データカタログビューを作成または更新するリクエストに関連するステータス詳細を含めるかどうかを指定します。
**応答**
+ `NextToken` – UTF-8 文字列。
継続トークン (現在のリストセグメントが最後ではない場合に存在)。
+ `TableList` – [Table](#aws-glue-api-catalog-tables-Table) オブジェクトの配列。
リクエストされた `Table` オブジェクトのリスト。`SearchTables` 応答は、ユーザーがアクセスできるテーブルのみを返します。
**エラー**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`
## GetPartitionIndexes アクション (Python: get\$1partition\$1indexes)
テーブルに関連付けられたパーティションインデックスを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログの ID。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを取得するデータベースの名前を指定します。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを取得するテーブルの名前を指定します。
+ `NextToken` – UTF–8 文字列。
継続トークン (これが継続呼び出しの場合)。
**応答**
+ `PartitionIndexDescriptorList` – [PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor) オブジェクトの配列。
インデックス記述子のリスト。
+ `NextToken` – UTF-8 文字列。
継続トークン (現在のリストセグメントが最後ではない場合に存在)。
**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
## CreatePartitionIndex アクション (Python: create\$1partition\$1index)
既存のテーブルに指定されたパーティションインデックスを作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログの ID。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを作成するデータベースの名前を指定します。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを作成するテーブルの名前を指定します。
+ `PartitionIndex` – *必須:* [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex) オブジェクト。
`PartitionIndex` 構造を指定して、既存のテーブルにパーティションインデックスを作成します。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeletePartitionIndex アクション (Python: delete\$1partition\$1index)
既存のテーブルから指定されたパーティションインデックスを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
テーブルが存在するカタログの ID。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを削除するデータベースの名前を指定します。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションインデックスを削除するテーブルの名前を指定します。
+ `IndexName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するパーティションインデックスの名前。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `GlueEncryptionException`
## GetColumnStatisticsForTable アクション (Python: get\$1column\$1statistics\$1for\$1table)
列のテーブル統計を取得します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `GetTable` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `ColumnNames` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
列名のリスト。
**応答**
+ `ColumnStatisticsList` – [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) オブジェクトの配列。
ColumnStatistics のリスト。
+ `Errors` – [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError) オブジェクトの配列。
取得に失敗した ColumnStatistics のリスト。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdateColumnStatisticsForTable アクション (Python: update\$1column\$1statistics\$1for\$1table)
列のテーブル統計を作成または更新します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `UpdateTable` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `ColumnStatisticsList` – *必須:* [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) オブジェクトの配列。構造 25 個以下。
列の統計のリスト。
**応答**
+ `Errors` – [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError) オブジェクトの配列。
ColumnStatisticsErrors のリスト。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteColumnStatisticsForTable アクション (Python: delete\$1column\$1statistics\$1for\$1table)
列のテーブル統計を取得します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `DeleteTable` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `ColumnName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
列の名前。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# パーティション API
Partition API では、パーティションを使用するためのデータ型とオペレーションについて説明します。
## データタイプ
+ [パーティションの構造](#aws-glue-api-catalog-partitions-Partition)
+ [PartitionInput の構造](#aws-glue-api-catalog-partitions-PartitionInput)
+ [PartitionSpecWithSharedStorageDescriptor 構造](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
+ [PartitionListComposingSpec 構造](#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
+ [PartitionSpecProxy 構造](#aws-glue-api-catalog-partitions-PartitionSpecProxy)
+ [PartitionValueList 構造](#aws-glue-api-catalog-partitions-PartitionValueList)
+ [セグメント構造](#aws-glue-api-catalog-partitions-Segment)
+ [PartitionError 構造](#aws-glue-api-catalog-partitions-PartitionError)
+ [BatchUpdatePartitionFailureEntry 構造](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
+ [BatchUpdatePartitionRequestEntry 構造](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
+ [StorageDescriptor 構造](#aws-glue-api-catalog-partitions-StorageDescriptor)
+ [SchemaReference 構造](#aws-glue-api-catalog-partitions-SchemaReference)
+ [SerDeInfo 構造](#aws-glue-api-catalog-partitions-SerDeInfo)
+ [SkewedInfo 構造](#aws-glue-api-catalog-partitions-SkewedInfo)
## パーティションの構造
テーブルデータのスライスを表します。
**フィールド**
+ `Values` – UTF-8 文字列の配列。
パーティションの値。
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションを作成するカタログデータベースの名前。
+ `TableName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションを作成するデータベーステーブルの名前。
+ `CreationTime` – タイムスタンプ。
パーティションが作成された時刻。
+ `LastAccessTime` – タイムスタンプ。
パーティションが最後にアクセスされた時刻。
+ `StorageDescriptor` – [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) オブジェクト。
パーティションが格納されている物理的な場所に関する情報を提供します。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアはパーティションパラメータを定義します。
+ `LastAnalyzedTime` – タイムスタンプ。
このパーティションの列統計が最後に計算された時刻。
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションがある Data Catalog の ID。
## PartitionInput の構造
パーティションの作成と更新に使用される構造。
**フィールド**
+ `Values` – UTF-8 文字列の配列。
パーティションの値。SDK ではこのパラメータは必要ありませんが、有効な入力としてこのパラメータを指定する必要があります。
新しいパーティションのキーの値は、文字列オブジェクトの配列として渡す必要があります。この配列は、Amazon S3 プレフィックスに表示されるパーティションキーと同じ順序で順序付けする必要があります。そうしないと、AWS Glue では、間違ったキーに値が追加されます。
+ `LastAccessTime` – タイムスタンプ。
パーティションが最後にアクセスされた時刻。
+ `StorageDescriptor` – [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) オブジェクト。
パーティションが格納されている物理的な場所に関する情報を提供します。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキー/値ペアはパーティションパラメータを定義します。
+ `LastAnalyzedTime` – タイムスタンプ。
このパーティションの列統計が最後に計算された時刻。
## PartitionSpecWithSharedStorageDescriptor 構造
物理的な場所を共有するパーティションのパーティション仕様。
**フィールド**
+ `StorageDescriptor` – [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor) オブジェクト。
共有物理ストレージ情報。
+ `Partitions` – [パーティション](#aws-glue-api-catalog-partitions-Partition) オブジェクトの配列。
この物理的な場所を共有するパーティションのリスト。
## PartitionListComposingSpec 構造
関連するパーティションを一覧表示します。
**フィールド**
+ `Partitions` – [パーティション](#aws-glue-api-catalog-partitions-Partition) オブジェクトの配列。
構成仕様のパーティションのリスト。
## PartitionSpecProxy 構造
指定されたパーティションへのルートパスを提供します。
**フィールド**
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベース。
+ `TableName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションを含むテーブルの名前。
+ `RootPath` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションをアドレス指定するためのプロキシのルートパス。
+ `PartitionSpecWithSharedSD` – [PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor) オブジェクト。
同じ物理ストレージの場所を共有するパーティションの仕様。
+ `PartitionListComposingSpec` – [PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec) オブジェクト。
パーティションのリストを指定します。
## PartitionValueList 構造
パーティションを定義する値のリストが含まれています。
**フィールド**
+ `Values` – *必須:* UTF-8 文字列の配列。
値のリスト。
## セグメント構造
テーブルのパーティションの重複しないリージョンを定義し、複数のリクエストを並行して実行できるようにします。
**フィールド**
+ `SegmentNumber` – *必須:* 数値 (整数)。None 以下。
セグメントのゼロベースのインデックス番号。たとえば、セグメントの合計数が 4 の場合、 `SegmentNumber` 値の範囲は 0～3 です。
+ `TotalSegments` – *必須:* 数値 (整数)。1 ～ 10。
セグメントの合計数。
## PartitionError 構造
パーティションのエラーに関する情報が含まれます。
**フィールド**
+ `PartitionValues` – UTF-8 文字列の配列。
パーティションを定義する値。
+ `ErrorDetail` – [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) オブジェクト。
パーティションエラーの詳細。
## BatchUpdatePartitionFailureEntry 構造
バッチ更新パーティションエラーに関する情報が含まれます。
**フィールド**
+ `PartitionValueList` - UTF-8 文字列の配列、文字列 100 個以下。
パーティションを定義する値のリスト。
+ `ErrorDetail` – [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) オブジェクト。
バッチ更新パーティションエラーの詳細。
## BatchUpdatePartitionRequestEntry 構造
パーティションの更新に使用される値と構造体を含む構造体。
**フィールド**
+ `PartitionValueList` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
パーティションを定義する値のリスト。
+ `PartitionInput` – *必須:* [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) オブジェクト。
パーティションの更新に使用される構造体。
## StorageDescriptor 構造
テーブルデータの物理ストレージについて説明します。
**フィールド**
+ `Columns` – [Column](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column) オブジェクトの配列。
テーブル内の `Columns` のリストです。
+ `Location` – 場所文字列。2,056 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
テーブルの物理的な場所。デフォルトでは、ウェアハウスの場所、その後にウェアハウス内のデータベースの場所、その後にテーブル名が続く形式になります。
+ `AdditionalLocations` – UTF-8 文字列の配列。
Delta テーブルへのパスを指す場所のリスト。
+ `InputFormat` – 書式設定文字列。128 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
入力形式: `SequenceFileInputFormat` (バイナリ)、または `TextInputFormat`、もしくはカスタム形式。
+ `OutputFormat` – 書式設定文字列。128 バイト長以下。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
出力形式: `SequenceFileOutputFormat` (バイナリ)、または `IgnoreKeyTextOutputFormat`、もしくはカスタム形式。
+ `Compressed` – ブール。
テーブルのデータが圧縮されている場合は `True`、圧縮されていない場合は `False`。
+ `NumberOfBuckets` – 数値 (整数)。
テーブルにディメンション列が含まれている場合、指定する必要があります。
+ `SerdeInfo` – [SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo) オブジェクト。
シリアライズ/デシリアライズ (SerDe) 情報。
+ `BucketColumns` – UTF-8 文字列の配列。
テーブルのリデューサーグループ化列、クラスター列、およびバケット列のリスト。
+ `SortColumns` – [注文](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order) オブジェクトの配列。
テーブル内の各バケットのソート順を指定するリスト。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
ユーザーが指定したキーバリュー形式のプロパティ。
+ `SkewedInfo` – [SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo) オブジェクト。
列に高い頻度で表示される値 (歪んだ値) に関する情報。
+ `StoredAsSubDirectories` – ブール。
テーブルデータがサブディレクトリに保管されている場合は `True`、保管されていない場合は `False`。
+ `SchemaReference` – [SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference) オブジェクト。
AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
テーブルを作成するときにスキーマに空の列リストを渡し、代わりにスキーマリファレンスを使用します。
## SchemaReference 構造
AWS Glue スキーマレジストリに保存されているスキーマを参照するオブジェクト。
**フィールド**
+ `SchemaId` – [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId) オブジェクト。
スキーマアイデンティティフィールドを含む構造。こちらか `SchemaVersionId` のいずれかを指定する必要があります。
+ `SchemaVersionId` – UTF-8 文字列。36 バイト長。[Custom string pattern #45](aws-glue-api-common.md#regex_45) に一致。
スキーマのバージョンに割り当てられた一意の ID。こちらか `SchemaId` のいずれかを指定する必要があります。
+ `SchemaVersionNumber` – 数値 (long)。1～100000。
スキーマのバージョン番号。
## SerDeInfo 構造
エクストラクターおよびローダーとして機能するシリアライズ/デシリアライズプログラム (SerDe) に関する情報。
**フィールド**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
SerDe 名。
+ `SerializationLibrary` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
通常、SerDe を実装するクラス。例は `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe` です。
+ `Parameters` – キーバリューペアのマップ配列。
各キーはキー文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
各値は UTF-8 文字列で、512,000 バイト長以下です。
これらのキーバリューペアは SerDe の初期化パラメータを定義します。
## SkewedInfo 構造
テーブルで歪んだ値を指定します。「歪んだ値」とは、非常に高い頻度で発生する値です。
**フィールド**
+ `SkewedColumnNames` – UTF-8 文字列の配列。
歪んだ値を含む列名のリスト。
+ `SkewedColumnValues` – UTF-8 文字列の配列。
頻繁に出現するため、歪んだとみなされる値のリスト。
+ `SkewedColumnValueLocationMaps` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列。
各値は UTF-8 文字列。
歪んだ値が含まれている列へのマッピング。
## 操作
+ [CreatePartition アクション (Python: create\$1partition)](#aws-glue-api-catalog-partitions-CreatePartition)
+ [BatchCreatePartition アクション (Python: batch\$1create\$1partition)](#aws-glue-api-catalog-partitions-BatchCreatePartition)
+ [UpdatePartition アクション (Python: update\$1partition)](#aws-glue-api-catalog-partitions-UpdatePartition)
+ [DeletePartition アクション (Python: delete\$1partition)](#aws-glue-api-catalog-partitions-DeletePartition)
+ [BatchDeletePartition アクション (Python: batch\$1delete\$1partition)](#aws-glue-api-catalog-partitions-BatchDeletePartition)
+ [GetPartition アクション (Python: get\$1partition)](#aws-glue-api-catalog-partitions-GetPartition)
+ [GetPartitions アクション (Python: get\$1partitions)](#aws-glue-api-catalog-partitions-GetPartitions)
+ [BatchGetPartition アクション (Python: batch\$1get\$1partition)](#aws-glue-api-catalog-partitions-BatchGetPartition)
+ [BatchUpdatePartition アクション (Python: batch\$1update\$1partition)](#aws-glue-api-catalog-partitions-BatchUpdatePartition)
+ [GetColumnStatisticsForPartition アクション (Python: get\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
+ [UpdateColumnStatisticsForPartition アクション (Python: update\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
+ [DeleteColumnStatisticsForPartition アクション (Python: delete\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)
## CreatePartition アクション (Python: create\$1partition)
新しいパーティションを作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
パーティションを作成するカタログの AWS アカウント ID。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが作成されるメタデータデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが作成されるメタデータテーブルの名前。
+ `PartitionInput` – *必須:* [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) オブジェクト。
作成されるパーティションを定義する `PartitionInput` 構造。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## BatchCreatePartition アクション (Python: batch\$1create\$1partition)
バッチオペレーションで 1 つ以上のパーティションを作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
パーティションを作成するカタログの ID。現在、これは AWS アカウント ID である必要があります。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが作成されるメタデータデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが作成されるメタデータテーブルの名前。
+ `PartitionInputList` – *必須:* [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) オブジェクトの配列。構造 100 個以下。
作成されるパーティションを定義する `PartitionInput` 構造のリスト。
**応答**
+ `Errors` – [PartitionError](#aws-glue-api-catalog-partitions-PartitionError) オブジェクトの配列。
リクエストされたパーティションを作成しようとしたときにエラーが発生しました。
**エラー**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdatePartition アクション (Python: update\$1partition)
パーティションを更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
更新されるパーティションが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当する表が存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
更新するパーティションが存在するテーブルの名前。
+ `PartitionValueList` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
更新するパーティションを定義するパーティションキー値のリスト。
+ `PartitionInput` – *必須:* [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput) オブジェクト。
パーティションを更新する新しいパーティションオブジェクト。
`Values` プロパティは変更できません。パーティションのパーティションキー値を変更する場合は、パーティションを削除して再作成します。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeletePartition アクション (Python: delete\$1partition)
指定したパーティションを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
削除されるパーティションが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当する表が存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するパーティションを含むテーブルの名前。
+ `PartitionValues` – *必須:* UTF-8 文字列の配列。
パーティションを定義する値。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchDeletePartition アクション (Python: batch\$1delete\$1partition)
バッチオペレーションで 1 つ以上のパーティションを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
削除されるパーティションが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
該当する表が存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除するパーティションを含むテーブルの名前。
+ `PartitionsToDelete` – *必須:* [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) オブジェクトの配列。構造 25 個以下。
削除されるパーティションを定義する `PartitionInput` 構造のリスト。
**応答**
+ `Errors` – [PartitionError](#aws-glue-api-catalog-partitions-PartitionError) オブジェクトの配列。
リクエストされたパーティションを削除しようとしたときにエラーが発生しました。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetPartition アクション (Python: get\$1partition)
指定したパーティションに関する情報を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
対象のパーティションが存在する Data Catalog の ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `PartitionValues` – *必須:* UTF-8 文字列の配列。
パーティションを定義する値。
**応答**
+ `Partition` – [パーティション](#aws-glue-api-catalog-partitions-Partition) オブジェクト。
`Partition` オブジェクトの形式で、リクエストされた情報。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetPartitions アクション (Python: get\$1partitions)
テーブルのパーティションについての情報を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
該当するパーティションが存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `Expression` – 述語文字列、2048 バイト長以下、[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
返されるパーティションをフィルタリングする式。
この式では、SQL `WHERE` フィルタ句と似た SQL 構文を使用します。SQL ステートメントパーサー [JSQLParser](http://jsqlparser.sourceforge.net/home.php) が式を解析します。
*演算子*: `Expression` API 呼び出しで使用できる演算子を以下に示します。
=
2 つのオペランドの値が等しいかどうかを確認します。「はい」の場合、条件は true です。
例: 「変数 a」が 10、「変数 b」が 20 とします。
(a = b) は true ではありません。
< >
2 つのオペランドの値が等しいかどうかを確認します。値が等しくない場合、条件は true です。
例: (a < > b) は true です。
>
左のオペランドの値が右のオペランドの値よりも大きいかどうかを確認します。「はい」の場合、条件は true です。
例: (a > b) は true ではありません。
<
左のオペランドの値が右のオペランドの値よりも小さいかどうかを確認します。「はい」の場合、条件は true です。
例: (a < b) は true です。
>=
左のオペランドの値が右のオペランドの値以上かどうかを確認します。「はい」の場合、条件は true です。
例: (a >= b) は true ではありません。
<=
左のオペランドの値が右のオペランドの値以下かどうかを確認します。「はい」の場合、条件は true です。
例: (a <= b) は true です。
AND、OR、IN、BETWEEN、LIKE、NOT、IS NULL
論理演算子。
*サポートされているパーティションキーの型*: サポートされているパーティションキーを以下に示します。
+ `string`
+ `date`
+ `timestamp`
+ `int`
+ `bigint`
+ `long`
+ `tinyint`
+ `smallint`
+ `decimal`
無効なタイプが存在した場合は、例外が発生します。
各タイプの有効な演算子のリストを次に示します。クローラを定義する場合、`partitionKey` タイプはカタログパーティションとの互換性を確保するため `STRING` として作成されます。
*サンプル API コール*:
**Example**
このテーブル `twitter_partition` には 3 つのパーティションがあります。
```
year = 2015
year = 2016
year = 2017
```
**Example**
パーティション `year` を 2015 と等しくする
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year*=*'2015'"
```
**Example**
パーティション `year` を 2016-2018 (これらの値を含まない) にする
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>'2016' AND year<'2018'"
```
**Example**
パーティション `year` を 2015-2018 (これらの値を含む) にする 次の API コールは、相互に等しくなります。
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>='2015' AND year<='2018'"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year BETWEEN 2015 AND 2018"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year IN (2015,2016,2017,2018)"
```
**Example**
ワイルドカードパーティションフィルタ。次のコール出力がパーティション year=2017 になります。正規表現は `LIKE` ではサポートされません。
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year LIKE '%7'"
```
+ `NextToken` – UTF–8 文字列。
これらのパーティションを取得する最初の呼び出しでない場合は、継続トークン。
+ `Segment` – [Segment](#aws-glue-api-catalog-partitions-Segment) オブジェクト。
このリクエストでスキャンするテーブルのパーティションのセグメント。
+ `MaxResults` – 1～1000 の数値 (整数)。
1 回の応答で返されるパーティションの最大数。
+ `ExcludeColumnSchema` – ブール。
true の場合、パーティション列スキーマを返さないことを指定します。パーティション値や場所など、他のパーティション属性にのみ関心がある場合に便利です。この方法では、重複データを返さないことで、大きな応答の問題を回避できます。
+ `TransactionId` – UTF-8 文字列。1～255 バイト長。[Custom string pattern #44](aws-glue-api-common.md#regex_44) に一致。
テーブルの内容を更新するトランザクション ID。
+ `QueryAsOfTime` – タイムスタンプ。
パーティションの内容を読み取る時点の時間。設定されていない場合は、最新のトランザクションコミット時間が使用されます。`TransactionId` と一緒に指定することはできません。
**応答**
+ `Partitions` – [パーティション](#aws-glue-api-catalog-partitions-Partition) オブジェクトの配列。
リクエストされたパーティションのリスト。
+ `NextToken` – UTF–8 文字列。
継続トークン (戻されたパーティションのリストに最後のパーティションが含まれていない場合)。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchGetPartition アクション (Python: batch\$1get\$1partition)
バッチリクエストのパーティションを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `PartitionsToGet` – *必須:* [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) オブジェクトの配列。構造 1000 個以下。
取得するパーティションを識別するパーティション値のリスト。
**応答**
+ `Partitions` – [パーティション](#aws-glue-api-catalog-partitions-Partition) オブジェクトの配列。
リクエストされたパーティションのリスト。
+ `UnprocessedKeys` – [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList) オブジェクトの配列。構造 1000 個以下。
パーティションが返されなかったリクエスト内のパーティション値のリスト。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchUpdatePartition アクション (Python: batch\$1update\$1partition)
バッチ操作で 1 つ以上のパーティションを更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
パーティションを更新するカタログの ID。現在、これは AWS アカウント ID である必要があります。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが更新されるメタデータデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが更新されるメタデータテーブルの名前。
+ `Entries` – *必須:* [BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry) オブジェクトの配列。1～100 個の構造。
更新する最大 100 個の `BatchUpdatePartitionRequestEntry` オブジェクトのリスト。
**応答**
+ `Errors` – [BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry) オブジェクトの配列。
リクエストされたパーティションを更新しようとしたときにエラーが発生しました。`BatchUpdatePartitionFailureEntry` オブジェクトのリスト。
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
## GetColumnStatisticsForPartition アクション (Python: get\$1column\$1statistics\$1for\$1partition)
列のパーティション統計を取得します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `GetPartition` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `PartitionValues` – *必須:* UTF-8 文字列の配列。
パーティションを識別するパーティション値のリスト。
+ `ColumnNames` – *必須:* UTF-8 文字列の配列。文字列 100 個以下。
列名のリスト。
**応答**
+ `ColumnStatisticsList` – [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) オブジェクトの配列。
取得に失敗した ColumnStatistics のリスト。
+ `Errors` – [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError) オブジェクトの配列。
列の統計データの取得中にエラーが発生しました。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdateColumnStatisticsForPartition アクション (Python: update\$1column\$1statistics\$1for\$1partition)
カラムのパーティション統計を作成または更新します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `UpdatePartition` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `PartitionValues` – *必須:* UTF-8 文字列の配列。
パーティションを識別するパーティション値のリスト。
+ `ColumnStatisticsList` – *必須:* [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics) オブジェクトの配列。構造 25 個以下。
列の統計のリスト。
**応答**
+ `Errors` – [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError) オブジェクトの配列。
列の統計データの更新中にエラーが発生しました。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteColumnStatisticsForPartition アクション (Python: delete\$1column\$1statistics\$1for\$1partition)
列のパーティション列統計を削除します。
このオペレーションに必要な Identity and Access Management (IAM) アクセス許可は `DeletePartition` です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
該当するパーティションが存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションが存在するカタログデータベースの名前。
+ `TableName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
パーティションのテーブルの名前。
+ `PartitionValues` – *必須:* UTF-8 文字列の配列。
パーティションを識別するパーティション値のリスト。
+ `ColumnName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
列の名前。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# 接続 API
Catalog API では、AWS Glue での接続の操作に関連するデータ型と API について説明します。
**Topics**
+ [接続 API](aws-glue-api-catalog-connections-connections.md)
+ [接続タイプ API](aws-glue-api-catalog-connections-connections-type.md)
+ [接続メタデータとプレビュー API](aws-glue-api-catalog-connections-connections-metadata.md)
# 接続 API
接続 API では、AWS Glue 接続のデータ型と、接続の作成、削除、更新、および一覧表示するための API について説明します。
## データタイプ
+ [接続構造](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput 構造](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput 構造](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements 構造](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter 構造](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration 構造](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput 構造](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Properties 構造](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput 構造](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication 構造](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties 構造](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials 構造](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Credentials 構造](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
## 接続構造
データソースへの接続を定義します。
**フィールド**
+ `Name` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続定義の名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
接続の説明。
+ `ConnectionType` – UTF-8 文字列です (有効な値: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`)。
接続のタイプ。現在、SFTP はサポートされていません。
+ `MatchCriteria` – UTF-8 文字列の配列。文字列 10 個以下。
この接続を選択する際に使用可能な条件のリスト。
+ `ConnectionProperties` – キーと値のペアのマップ配列。100 ペア以下。
各キーは UTF-8 文字列です (有効な値: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。
各値は値の文字列で、1～1,024 バイト長です。
これらのキーと値のペアは、バージョン 1 の接続スキーマを使用する場合の接続のパラメータを定義します。
+ `HOST` - ホスト URI: データベースホストの完全修飾ドメイン名 (FQDN) または IPv4 アドレス。
+ `PORT` - データベースホストがデータベース接続をリッスンするポート番号 (1024 〜 65535)。
+ `USER_NAME` - データベースにログインするための名前。`USER_NAME` の値文字列は「`USERNAME`」です。
+ `PASSWORD` - ユーザー名に対応するパスワード (使用されている場合)。
+ `ENCRYPTED_PASSWORD` - データカタログの暗号化設定で `ConnectionPasswordEncryption` を設定して接続パスワードの保護を有効にすると、このフィールドに暗号化されたパスワードが保存されます。
+ `JDBC_DRIVER_JAR_URI` - 使用する JDBC ドライバーを含む JAR ファイルの Amazon Simple Storage Service (Amazon S3) パス。
+ `JDBC_DRIVER_CLASS_NAME` - 使用する JDBC ドライバーのクラス名。
+ `JDBC_ENGINE` - 使用する JDBC エンジンの名前。
+ `JDBC_ENGINE_VERSION` - 使用する JDBC エンジンのバージョン。
+ `CONFIG_FILES` - (将来の利用のために予約されています。)
+ `INSTANCE_ID` - 使用するインスタンス ID。
+ `JDBC_CONNECTION_URL` - JDBC データソースに接続するための URL。
+ `JDBC_ENFORCE_SSL` - ホスト名のマッチによる Secure Sockets Layer (SSL) がクライアント上の JDBC 接続に適用されるかどうかを指定する大文字と小文字を区別しないブール文字列 (true、false)。デフォルトは False です。
+ `CUSTOM_JDBC_CERT` – お客様のルート証明書を指定する Amazon S3 の場所。AWS Glue では、このルート証明書を使用して、お客様データベースに接続するときにお客様の証明書を検証します。AWS Glue で扱うのは、X.509 証明書のみです。提供する証明書は、DER エンコードし、Base64 エンコード PEM 形式で指定する必要があります。
+ `SKIP_CUSTOM_JDBC_CERT_VALIDATION` – デフォルトでは、`false` です。AWS Glue は、お客様の証明書の署名アルゴリズムとサブジェクトパブリックキーアルゴリズムを検証します。署名アルゴリズムで許可されるアルゴリズムは、SHA256withRSA、SHA384withRSA、または SHA512withRSA のみです。サブジェクトパブリックキーアルゴリズムでは、キーの長さは 2048 以上である必要があります。このプロパティの値を `true` に設定して、AWS Glue によるお客様の証明書の検証をスキップできます。
+ `CUSTOM_JDBC_CERT_STRING` - 中間者 (man-in-the-middle) 攻撃を防ぐためにドメインの一致または識別名の一致に使用するカスタム JDBC 証明書文字列。Oracle データベースでは、これは `SSL_SERVER_CERT_DN` として使用され、Microsoft SQL Server では `hostNameInCertificate` として使用されます。
+ `CONNECTION_URL` - 一般的な (JDBC 以外の) データソースに接続するための URL。
+ `SECRET_ID` – 認証情報のシークレットマネージャーに使用されるシークレット ID。
+ `CONNECTOR_URL` – MARKETPLACE または CUSTOM 接続のコネクタ URL。
+ `CONNECTOR_TYPE` – MARKETPLACE または CUSTOM 接続のコネクタの種類。
+ `CONNECTOR_CLASS_NAME` – MARKETPLACE または CUSTOM 接続のコネクタクラス名。
+ `KAFKA_BOOTSTRAP_SERVERS` - Kafkaクライアントが接続してそれ自身をブートストラップする先である Kafkaクラスター内の Apache Kafka ブローカーのアドレスを示すホストとポートのペアのコンマ区切りリスト。
+ `KAFKA_SSL_ENABLED` – Apache Kafka 接続で SSL を有効にするか無効にするか。デフォルト値は「true」です。
+ `KAFKA_CUSTOM_CERT` – プライベート CA 証明書ファイル (.pem 形式) の Amazon S3 URL。デフォルトは空の文字列です。
+ `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` – CA 証明書ファイルの検証をスキップするかどうか。AWS Glue では、SHA256withRSA、SHA384withRSA、SHA512withRSA の 3 つのアルゴリズムについて検証されます。デフォルト値は「false」です。
+ `KAFKA_CLIENT_KEYSTORE` – Kafka クライアント側認証用のクライアントキーストアファイルの Amazon S3 の場所 (オプション)。
+ `KAFKA_CLIENT_KEYSTORE_PASSWORD` – 指定されたキーストアにアクセスするためのパスワード (オプション)。
+ `KAFKA_CLIENT_KEY_PASSWORD` – キーストアは、複数のキーで構成することができるので、これは Kafka サーバー側のキーで使用するクライアントキーにアクセスするためのパスワードです (オプション)。
+ `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` – Kafka クライアントキーストアのパスワードの暗号化されたバージョン (ユーザーが AWS Glue 暗号化パスワードの設定を選択している場合)。
+ `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` – Kafka クライアントキーパスワードの暗号化されたバージョン (ユーザーが AWS Glue 暗号化パスワードの設定を選択している場合)。
+ `KAFKA_SASL_MECHANISM` – `"SCRAM-SHA-512"`、`"GSSAPI"`、`"AWS_MSK_IAM"`、`"PLAIN"`。これらはサポートされている [SASL メカニズム](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) です。
+ `KAFKA_SASL_PLAIN_USERNAME` – 「PLAIN」メカニズムで認証するときに使用されるプレーンテキストのユーザーネーム。
+ `KAFKA_SASL_PLAIN_PASSWORD` – 「PLAIN」メカニズムで認証するときに使用されるプレーンテキストのパスワード。
+ `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` – Kafka SASL PLAIN パスワードの暗号化バージョン (ユーザーが AWS Glue 暗号化パスワードの設定を選択した場合)。
+ `KAFKA_SASL_SCRAM_USERNAME` - 「SCRAM-SHA-512」メカニズムでの認証に使用されるプレーンテキストのユーザーネーム。
+ `KAFKA_SASL_SCRAM_PASSWORD` - 「SCRAM-SHA-512」メカニズムでの認証に使用されるプレーンテキストのパスワード。
+ `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` – Kafka SASL SCRAM パスワードの暗号化されたバージョン (ユーザーが AWS Glue 暗号化パスワードの設定を選択している場合)。
+ `KAFKA_SASL_SCRAM_SECRETS_ARN` – AWS Secrets Manager のシークレットの Amazon Resource Name。
+ `KAFKA_SASL_GSSAPI_KEYTAB` - Kerberos `keytab` ファイルの S3 の場所。キータブには、1 つ以上のプリンシパルの長期キーが保存されます。詳細については、[MIT Kerberos ドキュメント: キータブ](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html) を参照してください。
+ `KAFKA_SASL_GSSAPI_KRB5_CONF` - Kerberos `krb5.conf` ファイルの S3 の場所。krb5.conf には、KDC サーバーの場所などの Kerberos 構成情報が保存されます。詳細については、[MIT Kerberos ドキュメント: krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html) を参照してください。
+ `KAFKA_SASL_GSSAPI_SERVICE` - [Kafka 構成](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name) の `sasl.kerberos.service.name` で設定した通りのKerberos サービスの名前。
+ `KAFKA_SASL_GSSAPI_PRINCIPAL` - によって使用される Kerberos プリンシパルの名前。AWS Glue詳細については、[Kafka ドキュメント: Kafka ブローカーの構成](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig) を参照してください。
+ `ROLE_ARN` - クエリの実行に使用されるロール。
+ `REGION` - AWS クエリが実行されるリージョン。
+ `WORKGROUP_NAME` - クエリを実行する Amazon Redshift Serverless ワークグループまたは Amazon Athena ワークグループの名前。
+ `CLUSTER_IDENTIFIER` - クエリを実行する Amazon Redshift クラスターのクラスター識別子。
+ `DATABASE` - 接続先の Amazon Redshift データベース。
+ `SparkProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Spark コンピューティング環境に固有の接続プロパティ。
+ `AthenaProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Athena コンピューティング環境に固有の接続プロパティ。
+ `PythonProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Python コンピューティング環境に固有の接続プロパティ。
+ `PhysicalConnectionRequirements` – [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) オブジェクト。
この接続を正常に行うために必要な物理接続要件 (例: 仮想プライベートクラウド (VPC)、`SecurityGroup`)。
+ `CreationTime` – タイムスタンプ。
この接続定義が作成された時刻のタイムスタンプ。
+ `LastUpdatedTime` – タイムスタンプ。
この接続定義が更新された最終時刻のタイムスタンプ。
+ `LastUpdatedBy` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
この接続定義を最終更新したユーザー、グループ、またはロール。
+ `Status` – UTF-8 文字列 (有効な値: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`)。
接続のステータス。`READY`、`IN_PROGRESS`、または `FAILED` のいずれか。
+ `StatusReason` – UTF-8 文字列、1～16384 バイト長。
接続ステータスの理由。
+ `LastConnectionValidationTime` – タイムスタンプ。
この接続が最後に検証された時刻のタイムスタンプ。
+ `AuthenticationConfiguration` – [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration) オブジェクト。
接続の認証プロパティ。
+ `ConnectionSchemaVersion` – 1～2 の数値 (整数)。
この接続の接続スキーマのバージョン。バージョン 2 では、特定のコンピューティング環境のプロパティがサポートされています。
+ `CompatibleComputeEnvironments` – UTF-8 文字列の配列。
接続と互換性のあるコンピューティング環境のリスト。
## ConnectionInput 構造
作成または更新する接続を指定するために使用される構造。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
コレクションの名前。
+ `Description` – 説明文字列。2,048 バイト長以下。[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri) に一致。
接続の説明。
+ `ConnectionType` – *必須:* UTF-8 文字列です (有効な値: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`)。
接続のタイプ。現在、次のタイプがサポートされています。
+ `JDBC` - Java Database Connectivity (JDBC) を介してデータベースへの接続を指定します。
`JDBC` 接続では、次の ConnectionParameters を使用します。
+ 必須: (`HOST`、`PORT`、`JDBC_ENGINE`) のすべて、または `JDBC_CONNECTION_URL`。
+ 必須: (`USERNAME`、`PASSWORD`) の両方、または `SECRET_ID`。
+ オプション: `JDBC_ENFORCE_SSL`、`CUSTOM_JDBC_CERT`、`CUSTOM_JDBC_CERT_STRING`、`SKIP_CUSTOM_JDBC_CERT_VALIDATION`。これらのパラメータは、JDBC で SSL を設定するために使用されます。
+ `KAFKA` - Apache Kafka ストリーミングプラットフォームへの接続を指定します。
`KAFKA` 接続では、次の ConnectionParameters を使用します。
+ 必須: `KAFKA_BOOTSTRAP_SERVERS`。
+ オプション: `KAFKA_SSL_ENABLED`、`KAFKA_CUSTOM_CERT`、`KAFKA_SKIP_CUSTOM_CERT_VALIDATION`。これらのパラメータは `KAFKA` で SSL を設定するために使用されます。
+ オプション: `KAFKA_CLIENT_KEYSTORE`、`KAFKA_CLIENT_KEYSTORE_PASSWORD`、`KAFKA_CLIENT_KEY_PASSWORD`、`ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`、`ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`。これらのパラメータは、`KAFKA` の中で SSL で TLS クライアント設定を設定するために使用されます。
+ オプション: `KAFKA_SASL_MECHANISM`。`SCRAM-SHA-512`、`GSSAPI`、または `AWS_MSK_IAM` として指定できます。
+ オプション: `KAFKA_SASL_SCRAM_USERNAME` 、`KAFKA_SASL_SCRAM_PASSWORD`、`ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`。これらのパラメータは、`KAFKA` で SASL/SCRAM-SHA-512 認証を設定するために使用されます。
+ オプション: `KAFKA_SASL_GSSAPI_KEYTAB`、`KAFKA_SASL_GSSAPI_KRB5_CONF`、`KAFKA_SASL_GSSAPI_SERVICE`、`KAFKA_SASL_GSSAPI_PRINCIPAL`。これらのパラメータは、`KAFKA` で SASL/GSSAPI 認証を設定するために使用されます。
+ `MONGODB` - MongoDB ドキュメントデータベースへの接続を指定します。
`MONGODB` 接続では、次の ConnectionParameters を使用します。
+ 必須: `CONNECTION_URL`。
+ 必須: (`USERNAME`、`PASSWORD`) のすべて、または `SECRET_ID`。
+ `VIEW_VALIDATION_REDSHIFT` - Amazon Redshift によるビューの検証に使用される接続を指定します。
+ `VIEW_VALIDATION_ATHENA` - Amazon Athena によるビューの検証に使用される接続を指定します。
+ `NETWORK` - Amazon Virtual Private Cloud 環境 (Amazon VPC) 内のデータソースへのネットワーク接続を指定します。
`NETWORK` 接続には、ConnectionParameters は必要ありません。代わりに、PhysicalConnectionRequirements を用意します。
+ `MARKETPLACE` – AWS Marketplace から購入したコネクタに含まれる構成設定を使用して、AWS Glue がネイティブにサポートしていないデータストアからの読み取りと書き込みを行います。
`MARKETPLACE` 接続では、次の ConnectionParameters を使用します。
+ 必須: `CONNECTOR_TYPE`、`CONNECTOR_URL`、`CONNECTOR_CLASS_NAME`、`CONNECTION_URL`。
+ `JDBC` `CONNECTOR_TYPE` 接続に必須: (`USERNAME`、`PASSWORD`) のすべて、または `SECRET_ID`。
+ `CUSTOM` – カスタムコネクタに含まれる設定を使用して、AWS Glue がネイティブにサポートしていないデータストアに対する読み取りと書き込みを行います。
特定のコネクタに必要な接続パラメータの詳細については、AWS Glueユーザーガイドの [AWS Glue 接続の追加](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) にあるコネクタのドキュメントを参照してください。
`SFTP` はサポートされていません。
オプションの ConnectionProperties を使用して AWS Glue の機能を設定する方法の詳細については、「[AWS Glue 接続プロパティ](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html)」を参照してください。
オプションの ConnectionProperties を使用して AWS Glue Studio の機能を設定する方法の詳細については、「[コネクタと接続の使用](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html)」を参照してください。
+ `MatchCriteria` – UTF-8 文字列の配列。文字列 10 個以下。
この接続を選択する際に使用可能な条件のリスト。
+ `ConnectionProperties` – *必須:* キーと値のペアのマップ配列。100 ペア以下。
各キーは UTF-8 文字列です (有効な値: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。
各値は値の文字列で、1～1,024 バイト長です。
以下のキーバリューペアは接続のパラメータを定義します。
+ `SparkProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Spark コンピューティング環境に固有の接続プロパティ。
+ `AthenaProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Athena コンピューティング環境に固有の接続プロパティ。
+ `PythonProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
Python コンピューティング環境に固有の接続プロパティ。
+ `PhysicalConnectionRequirements` – [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) オブジェクト。
この接続を正常に行うために必要な物理接続要件 (例: 仮想プライベートクラウド (VPC)、`SecurityGroup`)。
+ `AuthenticationConfiguration` – [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) オブジェクト。
接続の認証プロパティ。
+ `ValidateCredentials` – ブール。
接続の作成中に認証情報を検証するフラグ。デフォルトは true です。
+ `ValidateForComputeEnvironments` – UTF-8 文字列の配列。
指定された接続プロパティが検証されるコンピューティング環境。
## TestConnectionInput 構造
サービスへの接続テストを指定するために使用される構造。
**フィールド**
+ `ConnectionType` – *必須:* UTF-8 文字列です (有効な値: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`)。
テストする接続のタイプ。このオペレーションは、`JDBC` または `SALESFORCE` 接続タイプのみで使用できます。
+ `ConnectionProperties` – *必須:* キーと値のペアのマップ配列。100 ペア以下。
各キーは UTF-8 文字列です (有効な値: `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。
各値は値の文字列で、1～1,024 バイト長です。
接続のパラメータを定義するキーと値のペア。
JDBC 接続では次の接続プロパティを使用します。
+ 必須: (`HOST`、`PORT`、`JDBC_ENGINE`) のすべて、または `JDBC_CONNECTION_URL`。
+ 必須: (`USERNAME`、`PASSWORD`) の両方、または `SECRET_ID`。
+ オプション: `JDBC_ENFORCE_SSL`、`CUSTOM_JDBC_CERT`、`CUSTOM_JDBC_CERT_STRING`、`SKIP_CUSTOM_JDBC_CERT_VALIDATION`。これらのパラメータは、JDBC で SSL を設定するために使用されます。
SALESFORCE 接続では `AuthenticationConfiguration` メンバーを設定する必要があります。
+ `AuthenticationConfiguration` – [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) オブジェクト。
TestConnection リクエストに認証の設定が含まれる構造。OAuth 認証を使用した Salesforce への接続に必要です。
## PhysicalConnectionRequirements 構造
GetConnection レスポンスの OAuth クライアントアプリ。
**フィールド**
+ `SubnetId` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続で使用されるサブネット ID。
+ `SecurityGroupIdList` - UTF-8 文字列の配列。文字列 50 個以下。
接続で使用されるセキュリティグループ ID のリスト。
+ `AvailabilityZone` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続のアベイラビリティーゾーン。
## GetConnectionsFilter 構造
`GetConnections` API オペレーションによって返る接続定義をフィルタリングします。
**フィールド**
+ `MatchCriteria` – UTF-8 文字列の配列。文字列 10 個以下。
接続定義を返すためにその接続定義に記録された条件と一致する必要がある条件文字列。
+ `ConnectionType` – UTF-8 文字列です (有効な値: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`)。
返す接続のタイプ。現在、SFTP はサポートされていません。
+ `ConnectionSchemaVersion` – 1～2 の数値 (整数)。
接続がスキーマバージョン 1 または 2 で作成されたかどうかを示します。
## AuthenticationConfiguration 構造
認証の設定を含む構造。
**フィールド**
+ `AuthenticationType` – UTF-8 文字列 (有効な値: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`)。
認証の設定を含む構造。
+ `SecretArn` – UTF-8 文字列。[Custom string pattern #36](aws-glue-api-common.md#regex_36) に一致。
認証情報を保存するシークレットマネージャー ARN。
+ `KmsKeyArn` – UTF-8 文字列。[Custom string pattern #42](aws-glue-api-common.md#regex_42) に一致。
機密認証情報の暗号化に使用される KMS キーの Amazon リソースネーム (ARN)。このキーは、認証設定に保存されている認証情報やその他の機密データを保護するために使用されます。
+ `OAuth2Properties` – [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties) オブジェクト。
OAuth2 認証のプロパティ。
## AuthenticationConfigurationInput 構造
CreateConnection リクエストの認証の設定を含む構造。
**フィールド**
+ `AuthenticationType` – UTF-8 文字列 (有効な値: `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`)。
CreateConnection リクエストの認証の設定を含む構造。
+ `OAuth2Properties` – [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput) オブジェクト。
CreateConnection リクエストの OAuth2 認証のプロパティ。
+ `SecretArn`– UTF-8 文字列。[Custom string pattern #36](aws-glue-api-common.md#regex_36) に一致。
CreateConnection リクエストに認証情報を保存するシークレットマネージャー ARN。
+ `KmsKeyArn`– UTF-8 文字列。[Custom string pattern #42](aws-glue-api-common.md#regex_42) に一致。
接続の暗号化に使用される KMS キーの ARN。リクエストの入力情報としてのみ取得され、Secret Manager に保存されます。
+ `BasicAuthenticationCredentials` – [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials) オブジェクト。
認証のタイプが基本認証である場合に使用される認証情報。
+ `CustomAuthenticationCredentials` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～2,048 バイト長です。
認証のタイプがカスタム認証である場合に使用される認証情報。
## OAuth2Properties 構造
OAuth2 認証のプロパティを含む構造。
**フィールド**
+ `OAuth2GrantType` – UTF-8 文字列 (有効な値: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`)。
OAuth2 グラントタイプ。例えば、`AUTHORIZATION_CODE`、`JWT_BEARER`、または `CLIENT_CREDENTIALS` です。
+ `OAuth2ClientApplication` – [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) オブジェクト。
クライアントアプリケーションタイプ。たとえば、AWS\$1MANAGED または USER\$1MANAGED。
+ `TokenUrl` – UTF-8 文字列。256 バイト長以下。[Custom string pattern #40](aws-glue-api-common.md#regex_40) に一致。
認可コードをアクセストークンと交換するための、プロバイダーの認証サーバーの URL。
+ `TokenUrlParametersMap` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～512 バイト長です。
トークン `GET` リクエストに追加されるパラメータのマップ。
## OAuth2PropertiesInput 構造
CreateConnection リクエストの OAuth2 のプロパティを含む構造。
**フィールド**
+ `OAuth2GrantType` – UTF-8 文字列 (有効な値: `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`)。
CreateConnection リクエストの OAuth2 グラントタイプ。例えば、`AUTHORIZATION_CODE`、`JWT_BEARER`、または `CLIENT_CREDENTIALS` です。
+ `OAuth2ClientApplication` – [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) オブジェクト。
CreateConnection リクエストのクライアントアプリケーションタイプ。例えば、`AWS_MANAGED`、`USER_MANAGED` です。
+ `TokenUrl` – UTF-8 文字列、256 バイト長以下。[Custom string pattern #40](aws-glue-api-common.md#regex_40) に一致。
認可コードをアクセストークンと交換するための、プロバイダーの認証サーバーの URL。
+ `TokenUrlParametersMap` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～512 バイト長です。
トークン `GET` リクエストに追加されるパラメータのマップ。
+ `AuthorizationCodeProperties` – [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties) オブジェクト。
OAuth2 `AUTHORIZATION_CODE` グラントタイプに必要なプロパティのセット。
+ `OAuth2Credentials` – [OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials) オブジェクト。
認証のタイプが OAuth2 認証である場合に使用される認証情報。
## OAuth2ClientApplication 構造
接続に使用される OAuth2 クライアントアプリ。
**フィールド**
+ `UserManagedClientApplicationClientId` – UTF-8 文字列。2,048 バイト長以下。[Custom string pattern #37](aws-glue-api-common.md#regex_37) に一致。
ClientAppType が `USER_MANAGED` の場合のクライアントアプリケーションの clientID。
+ `AWSManagedClientApplicationReference` – UTF-8 文字列。2,048 バイト長以下。[Custom string pattern #37](aws-glue-api-common.md#regex_37) に一致。
AWS によって管理されている SaaS 側のクライアントアプリケーションへの参照。
## AuthorizationCodeProperties 構造
OAuth2 `AUTHORIZATION_CODE` グラントタイプのワークフローに必要なプロパティのセット。
**フィールド**
+ `AuthorizationCode` – UTF-8 文字列、1～4096 バイト長、[Custom string pattern #37](aws-glue-api-common.md#regex_37) に一致。
`AUTHORIZATION_CODE` で付与されるワークフローの 3 番目のレッグで使用される認可コード。これは、アクセストークンと交換されると無効になるワンタイムコードであるため、この値をリクエストパラメータとして指定できます。
+ `RedirectUri` - UTF-8 文字列、512 バイト長以下、[Custom string pattern #41](aws-glue-api-common.md#regex_41) に一致。
認可コードの発行時にユーザーが認可サーバーによってリダイレクトされるリダイレクト URI。この URI は、認可コードがアクセストークンと交換されるときに使用されます。
## BasicAuthenticationCredentials 構造
`SecretArn` の値を指定しない場合に基本的な認証情報を提供する。
**フィールド**
+ `Username` – UTF-8 文字列、512 バイト長以下、[Custom string pattern #37](aws-glue-api-common.md#regex_37) に一致。
データソースに接続するためのユーザー名。
+ `Password` – UTF-8 文字列、512 バイト長以下、[Custom string pattern #33](aws-glue-api-common.md#regex_33) に一致。
データソースに接続するためのパスワード。
## OAuth2Credentials 構造
認証のタイプが OAuth2 認証である場合に使用される認証情報。
**フィールド**
+ `UserManagedClientApplicationClientSecret` – UTF-8 文字列、512 バイト長以下、[Custom string pattern #38](aws-glue-api-common.md#regex_38) に一致。
クライアント アプリケーションがユーザー マネージドである場合のクライアント アプリケーション シークレット。
+ `AccessToken` – UTF-8 文字列。4,096 バイト長以下。[Custom string pattern #38](aws-glue-api-common.md#regex_38) に一致。
認証タイプが OAuth2 である場合に使用されるアクセストークン。
+ `RefreshToken` – UTF-8 文字列。4,096 バイト長以下。[Custom string pattern #38](aws-glue-api-common.md#regex_38) に一致。
認証タイプが OAuth2 である場合に使用される更新トークン。
+ `JwtToken` – UTF-8 文字列。8,000 バイト長以下。[Custom string pattern #39](aws-glue-api-common.md#regex_39) に一致。
認証タイプが OAuth2 である場合に使用される JSON ウェブトークン (JWT)。
## 操作
+ [CreateConnection アクション (Python: create\$1connection)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection アクション (Python: delete\$1connection)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection アクション (Python: get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections アクション (Python: get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection アクション (Python: update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection アクション (Python: test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection アクション (Python: batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
## CreateConnection アクション (Python: create\$1connection)
データカタログで接続定義を作成します。
フェデレーションリソースの作成に使用される接続には IAM `glue:PassConnection` 権限が必要です。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続を作成するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `ConnectionInput` – *必須:* [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) オブジェクト。
作成する接続を定義する `ConnectionInput` オブジェクト。
+ `Tags` – キーと値のペアのマップ配列。50 ペア以下。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、256 バイト長以下です。
接続に割り当てるタグ。
**応答**
+ `CreateConnectionStatus` – UTF-8 文字列 (有効な値: `READY` \$1 `IN_PROGRESS` \$1 `FAILED`)。
接続作成リクエストのステータス。リクエストは、VPC 経由でトークン交換を使用して OAuth 接続を作成する場合など、特定の認証タイプでは時間がかかる場合があります。
**エラー**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## DeleteConnection アクション (Python: delete\$1connection)
データカタログから接続を削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `ConnectionName` – *必須:* UTF-8 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除する接続の名前。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
## GetConnection アクション (Python: get\$1connection)
データカタログから接続定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
取得する接続定義の名前。
+ `HidePassword` – ブール。
パスワードを返さずに接続メタデータを取得できます。例えば、AWS Glue コンソールではこのフラグを使用して接続を取得し、パスワードは表示しません。呼び出し元に AWS KMS キーを使用してパスワードを復号するアクセス許可がない可能性があるが、それ以外の接続プロパティへのアクセス許可がある場合は、このパラメータを設定します。
+ `ApplyOverrideForComputeEnvironment` – UTF-8 文字列 (有効な値: `SPARK` \$1 `ATHENA` \$1 `PYTHON`)。
複数のサービスで使用できる接続の場合、指定されたコンピューティング環境の戻りプロパティを指定します。
**応答**
+ `Connection` – [接続](#aws-glue-api-catalog-connections-connections-Connection) オブジェクト。
リクエストされた接続定義。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## GetConnections アクション (Python: get\$1connections)
データカタログから接続定義のリストを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Filter` – [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter) オブジェクト。
返される接続をコントロールするフィルター。
+ `HidePassword` – ブール。
パスワードを返さずに接続メタデータを取得できます。例えば、AWS Glue コンソールではこのフラグを使用して接続を取得し、パスワードは表示しません。呼び出し元に AWS KMS キーを使用してパスワードを復号するアクセス許可がない可能性があるが、それ以外の接続プロパティへのアクセス許可がある場合は、このパラメータを設定します。
+ `NextToken` – UTF-8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 1～1000 の数値 (整数)。
1 回の応答で返す接続の最大数。
**応答**
+ `ConnectionList` – [接続](#aws-glue-api-catalog-connections-connections-Connection) オブジェクトの配列。
リクエストされた接続定義のリスト。
+ `NextToken` – UTF–8 文字列。
返された接続のリストにフィルタリングされた接続の最後のものが含まれていない場合は、継続トークン。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## UpdateConnection アクション (Python: update\$1connection)
データカタログで接続定義を更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `Name` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
更新する接続定義の名前。
+ `ConnectionInput` – *必須:* [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) オブジェクト。
該当する接続を再定義する `ConnectionInput` オブジェクト。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## TestConnection アクション (Python: test\$1connection)
サービスへの接続をテストして、指定したサービス認証情報を検証します。
既存の接続名を指定するか、存在しない接続入力をテストするための `TestConnectionInput` を指定します。両方を同時に指定するとエラーが発生します。
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
**リクエスト**
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
オプション。テストする接続の名前。名前のみを指定すると、オペレーションは接続を取得してそれをテストに使用します。
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するカタログの ID。
+ `TestConnectionInput` – [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput) オブジェクト。
サービスへの接続テストを指定するために使用される構造。
**応答**
+ *応答パラメータはありません。*
**エラー**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`
## BatchDeleteConnection アクション (Python: batch\$1delete\$1connection)
データカタログから接続定義のリストを削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `ConnectionNameList` – *必須:* UTF-8 文字列の配列。文字列 25 個以下。
削除する接続の名前のリスト。
**応答**
+ `Succeeded` – UTF-8 文字列の配列。
正常に削除された接続定義の名前のリスト。
+ `Errors` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列、1～255 バイト長で、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致します。
各値は A [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) オブジェクトです。
エラーの詳細への正常に削除されなかった接続の名前のマップ。
**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`
# 接続タイプ API
接続タイプ API では、接続タイプの説明に関連する AWS Glue API について説明します。
## 接続管理 API
+ [DescribeConnectionType アクション (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes アクション (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief 構造](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant の構造](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
## DescribeConnectionType アクション (Python: describe\$1connection\$1type)
`DescribeConnectionType` API は、AWS Glue の特定の接続タイプでサポートされているオプションの詳細を提供します。
**リクエスト**
+ `ConnectionType` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
説明する接続タイプの名前。
**応答**
+ `ConnectionType` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続タイプの名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
接続タイプの説明。
+ `Capabilities` – [機能](#aws-glue-api-catalog-connections-connections-type-Capabilities) オブジェクト。
サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、コネクタのデータオペレーション。
+ `ConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
コンピューティング環境間で共通の接続プロパティ。
+ `ConnectionOptions` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
`ConnectionInput.ConnectionProperties` で接続を作成するときに設定できるプロパティを返します。`ConnectionOptions` は、データフレームに渡される接続オプションマップの Spark ETL スクリプトで設定できるパラメータを定義します。
+ `AuthenticationConfiguration` – [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) オブジェクト。
接続に使用する認証のタイプ。
+ `ComputeEnvironmentConfigurations` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) オブジェクトです。
接続でサポートされているコンピューティング環境。
+ `PhysicalConnectionRequirements` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
接続の物理的な要件 (VPC、サブネット、セキュリティグループの仕様など)。
+ `AthenaConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Athena コンピューティング環境に固有の接続プロパティ。
+ `PythonConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Python コンピューティング環境に固有の接続プロパティ。
+ `SparkConnectionProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
Spark コンピューティング環境に固有の接続プロパティ。
**エラー**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## ListConnectionTypes アクション (Python: list\$1connection\$1types)
`ListConnectionTypes` API は、AWS Glue で使用可能な接続タイプを学習するための検出メカニズムを提供します。応答には、接続タイプのリストと、各接続タイプでサポートされている内容の概要が含まれます。リストに挙げられている接続タイプは、`CreateConnection` API の `ConnectionType` 値に対してサポートされているオプションのセットです。
**リクエスト**
+ `MaxResults` – 1～1000 の数値 (整数)。
返される結果の最大数。
+ `NextToken` – UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (これが継続呼び出しの場合)。
**応答**
+ `ConnectionTypes` – [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) オブジェクトの配列。
サポートされている接続タイプに関する簡単な情報を含む `ConnectionTypeBrief` オブジェクトのリスト。
+ `NextToken` – UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (現在のリストが最後ではない場合に表示されます)。
**エラー**
+ `InternalServiceException`
## ConnectionTypeBrief 構造
`ListConnectionTypes` API によって返される、サポートされている接続タイプに関する簡単な情報。
**フィールド**
+ `ConnectionType` – UTF-8 文字列です (有効な値: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`)。
接続タイプの名前。
+ `DisplayName` – UTF-8 文字列、1～128 バイト長。
AWS Glue コンソールに表示される接続タイプの人間が読み取れる名前。
+ `Vendor` – UTF-8 文字列、1～128 バイト長。
この接続タイプを作成または管理するベンダーまたはプロバイダーの名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
接続タイプの説明。
+ `Categories` – .
この接続タイプが属するカテゴリのリスト。カテゴリは、ユーザーがユースケースに基づいて適切な接続タイプをフィルタリングして見つけるために役立ちます。
+ `Capabilities` – [機能](#aws-glue-api-catalog-connections-connections-type-Capabilities) オブジェクト。
サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、コネクタのデータオペレーション。
+ `LogoUrl` – UTF–8 文字列。
接続タイプに関連付けられたロゴの URL。
+ `ConnectionTypeVariants` – [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) オブジェクトの配列。
この接続タイプで利用可能なバリアントのリスト。さまざまなバリアントは、同じ一般的な接続タイプの特定ユースケースや実装に特殊な設定を提供する場合があります。
## ConnectionTypeVariant の構造
AWS Glue データカタログの接続タイプバリアントを表します。接続タイプバリアントは、同じ一般的な接続タイプのさまざまな実装に特定の設定および動作があります。
**フィールド**
+ `ConnectionTypeVariantName` – UTF-8 文字列、1～128 バイト長。
接続タイプバリアントの一意の識別子。この名前は、接続タイプの特定バリアントを識別するために内部で使用されます。
+ `DisplayName` – UTF-8 文字列、1～128 バイト長。
AWS Glue コンソールに表示される接続タイプバリアントにおいて、人間が読み取れる名前。
+ `Description` – UTF-8 文字列、1024 バイト長以下。
目的、ユースケース、特定の設定要件など、接続タイプバリアントの詳細な説明。
+ `LogoUrl` – UTF–8 文字列。
接続タイプバリアントに関連付けられたロゴの URL。
## データ型
+ [検証構造](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration 構造](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Capabilities 構造](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Property 構造](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue 構造](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration 構造](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
## 検証構造
接続プロパティでの検証の実行方法を定義します。
**フィールド**
+ `ValidationType` – *必須:* UTF-8 文字列 (有効な値: `REGEX` \$1 `RANGE`)。
実行する検証のタイプ (`REGEX` など)。
+ `Patterns` – .
検証に適用されるパターンのリスト。
+ `Description` – *必須:* UTF-8 文字列、1～1024 バイト長。
検証の説明。
+ `MaxLength` – 数値 (整数)。
文字列接続プロパティの最大長。
+ `Maximum` – 数値 (整数)。
検証の `RANGE` タイプを指定するときの最大値。
+ `Minimum` – 数値 (整数)。
検証の `RANGE` タイプを指定するときの最小値。
## AuthConfiguration 構造
`DescribeConnectionType` API によって返される接続の認証設定。
**フィールド**
+ `AuthenticationType` – *必須:* [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクト。
接続の認証のタイプ。
+ `SecretArn` – [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクト。
Secrets Manager の Amazon リソースネーム (ARN)。
+ `OAuth2Properties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
+ `BasicAuthenticationProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
+ `CustomAuthenticationProperties` – キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
カスタム認証プロパティのキーと値のペアのマップ。各値は A `Property` オブジェクトです。
## Capabilities 構造
`DescribeConnectionType` API によって返される、サポートされている認証タイプを指定します。
**フィールド**
+ `SupportedAuthenticationTypes` – *必須:* UTF-8 文字列の配列。
サポートされている認証タイプのリスト。
+ `SupportedDataOperations` – *必須:* UTF-8 文字列の配列。
サポートされているデータオペレーションのリスト。
+ `SupportedComputeEnvironments` – *必須:* UTF-8 文字列の配列。
サポートされているコンピューティング環境のリスト。
## Property 構造
コンピューティング環境の接続タイプを定義するオブジェクト。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～128 バイト長。
プロパティの名前。
+ `Description` – *必須:* UTF-8 文字列。1024 以下のバイト長。
プロパティの説明。
+ `Required` – *必須:* ブール。
プロパティが必須かどうかを示します。
+ `PropertyTypes` – *必須:* UTF-8 文字列の配列。
プロパティのタイプを説明します。
+ `AllowedValues` – [allowedValues](#aws-glue-api-catalog-connections-connections-type-AllowedValue) オブジェクトの配列。
プロパティに許可される値を表す `AllowedValue` オブジェクトのリスト。
+ `DataOperationScopes` – UTF-8 文字列の配列。
どのデータオペレーションをプロパティに適用できるかを示します。
## AllowedValue 構造
プロパティに許可される値を表すオブジェクト。
**フィールド**
+ `Description` – UTF-8 文字列、1024 バイト長以下。
許可される値の説明。
+ `Value` – *必須:* UTF-8 文字列。1～128 バイト長。
プロパティに許可される値。
## ComputeEnvironmentConfiguration 構造
`DescribeConnectionType` API によって返されるコンピューティング環境 (Spark、Python、Athena など) の設定を含むオブジェクト。
**フィールド**
+ `Name` – *必須:* UTF-8 文字列。1～128 バイト長。
コンピューティング環境設定の名前。
+ `Description` – *必須:* UTF-8 文字列。1,024 以下のバイト長。
コンピューティング環境の説明。
+ `ComputeEnvironment` – *必須:* UTF-8 文字列 (有効な値: `SPARK` \$1 `ATHENA` \$1 `PYTHON`)。
コンピューティング環境のタイプ。
+ `SupportedAuthenticationTypes` – *必須:* UTF-8 文字列の配列。
コンピューティング環境でサポートされている認証タイプ。
+ `ConnectionOptions` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は A [プロパティ](#aws-glue-api-catalog-connections-connections-type-Property) オブジェクトです。
コンピューティング環境の接続オプションとして使用されるパラメータ。
+ `ConnectionPropertyNameOverrides` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続プロパティ名はコンピューティング環境に対して上書きされます。
+ `ConnectionOptionNameOverrides` – *必須:* キーバリューペアのマップ配列。
各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続オプション名はコンピューティング環境に対して上書きされます。
+ `ConnectionPropertiesRequiredOverrides` – *必須:*
コンピューティング環境の上書きとして必要な接続プロパティ。
+ `PhysicalConnectionPropertiesRequired` – ブール。
コンピューティング環境に `PhysicalConnectionProperties` が必要かどうかを示します。
# 接続メタデータとプレビュー API
以下の接続 API では、接続メタデータを記述するオペレーションについて説明します。
## データタイプ
+ [エンティティ構造](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [フィールド構造](#aws-glue-api-catalog-connections-connections-metadata-Field)
## エンティティ構造
特定の `ConnectionType` でサポートされているエンティティ。
**フィールド**
+ `EntityName` – UTF-8 文字列。
エンティティの名前。
+ `Label` – UTF–8 文字列。
エンティティに使用されるラベル。
+ `IsParentEntity` – ブール。
一覧表示できるサブオブジェクトがあるかどうかを判断できるブール値。
+ `Description` – UTF–8 文字列。
エンティティの説明。
+ `Category` – UTF–8 文字列。
応答に含まれるエンティティのタイプ。この値はソース接続によって異なります。例えば、Salesforce の場合は `SObjects`、Amazon Redshift などのソースの場合は `databases`、`schemas`、`tables` です。
+ `CustomProperties` –
コネクタによってエンティティに返される可能性のあるキーのオプションのマップ。
## フィールド構造
`Field` オブジェクトには、コネクタのフィールドに関連付けられたさまざまなプロパティに関する情報が含まれています。
**フィールド**
+ `FieldName` – UTF-8 文字列。
フィールドの一意の識別子。
+ `Label` – UTF–8 文字列。
フィールドに使用される読み取り可能なラベル。
+ `Description` – UTF–8 文字列。
フィールドの説明。
+ `FieldType` – UTF-8 文字列 (有効な値: `INT` \$1 `SMALLINT` \$1 `BIGINT` \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 `STRING` \$1 `TIMESTAMP` \$1 `DECIMAL` \$1 `BYTE` \$1 `SHORT` \$1 `DOUBLE` \$1 `STRUCT`)。
フィールドのデータ型。
+ `IsPrimaryKey` – ブール。
このフィールドを特定のエンティティのプライマリキーとして使用できるかどうかを示します。
+ `IsNullable` – ブール。
このフィールドを null にできるかどうかを示します。
+ `IsRetrievable` – ブール。
このフィールドを SQL クエリの Select 句に追加できるかどうか、または取得可能かどうかを示します。
+ `IsFilterable` – ブール。
データをクエリするときに、このフィールドを SQL ステートメントのフィルター句 (`WHERE` 句) で使用できるかどうかを示します。
+ `IsPartitionable` – ブール。
特定のフィールドを SaaS に対して行われたクエリのパーティション化に使用できるかどうかを示します。
+ `IsCreateable` – ブール。
このフィールドを送信先書き込みの一部として作成できるかどうかを示します。
+ `IsUpdateable` – ブール。
このフィールドを送信先書き込みの一部として更新できるかどうかを示します。
+ `IsUpsertable` – ブール。
このフィールドを送信先書き込みの一部として upsert できるかどうかを示します。
+ `IsDefaultOnCreate` – ブール。
オブジェクトの作成時にこのフィールドが自動的に入力されるかどうかを示します ([作成時刻] のタイムスタンプなど)。
+ `SupportedValues` – .
フィールドのサポートされている値のリスト。
+ `SupportedFilterOperators` – UTF-8 文字列の配列。
このフィールドのサポートされているフィルター演算子を示します。
+ `CustomProperties` –
返される可能性のあるキーのオプションのマップ。
## 操作
+ [ListEntities アクション (Python: list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
+ [DescribeEntity アクション (Python: describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
+ [GetEntityRecords アクション (Python: get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)
## ListEntities アクション (Python: list\$1entities)
接続タイプでサポートされている利用可能なエンティティを返します。
**リクエスト**
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
任意の接続タイプをクエリするために必要な認証情報を持つ接続の名前。
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続を含むカタログのカタログ ID。これは null にすることができます。デフォルトでは、AWS アカウント ID がカタログ ID になります。
+ `ParentEntityName` – UTF–8 文字列。
子エンティティを一覧表示させる親エンティティの名前。このパラメータは、子エンティティを一覧表示するためにエンティティの完全修飾パスを取ります。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (これが継続呼び出しの場合)。
+ `DataStoreApiVersion` – UTF-8 文字列。1～256 バイト長。[Custom string pattern #23](aws-glue-api-common.md#regex_23) に一致。
SaaS コネクタの API バージョン。
**応答**
+ `Entities` – [エンティティ](#aws-glue-api-catalog-connections-connections-metadata-Entity) オブジェクトの配列。
`Entity` オブジェクトのリスト。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (現在のセグメントが最後ではない場合に表示されます)。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## DescribeEntity アクション (Python: describe\$1entity)
接続タイプで使用されるエンティティに関する詳細を、選択したエンティティの各フィールドのデータモデルの説明と併せて表示します。
応答には、エンティティを構成しているすべてのフィールドが含まれます。
**リクエスト**
+ `ConnectionName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続タイプの認証情報を含む接続の名前。
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続を含むカタログのカタログ ID。これは null にすることができます。デフォルトでは、AWS アカウント ID がカタログ ID になります。
+ `EntityName` – *必須:* UTF–8 文字列。
接続タイプから記述するエンティティの名前。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (これが継続呼び出しの場合)。
+ `DataStoreApiVersion` – UTF-8 文字列。1～256 バイト長。[Custom string pattern #23](aws-glue-api-common.md#regex_23) に一致。
データストアに使用される API のバージョン。
**応答**
+ `Fields` – [フィールド](#aws-glue-api-catalog-connections-connections-metadata-Field) オブジェクトの配列。
コネクタエンティティのフィールドを記述します。これは `Field` オブジェクトのリストです。`Field` はデータベースの列に非常によく似ています。`Field` オブジェクトには、コネクタのフィールドに関連付けられたさまざまなプロパティに関する情報が含まれています。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (現在のセグメントが最後ではない場合に表示されます)。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## GetEntityRecords アクション (Python: get\$1entity\$1records)
この API は、特定の接続タイプ、またはネイティブの Amazon S3 ベースの AWS Glue データカタログからプレビューデータをクエリするときに使用します。
JSON BLOB の配列としてレコードを返します。各レコードは、`DescribeEntity` API で定義されたフィールドタイプに基づいて、Jackson JsonNode を使用してフォーマットされます。
Spark コネクタは、`DescribeEntity` API と同じデータ型マッピングに従ってスキーマを生成します。Spark コネクタは、行を返すときに、スキーマに一致する適切なデータ型にデータを変換します。
**リクエスト**
+ `ConnectionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続タイプの認証情報を含む接続の名前。
+ `CatalogId` – カタログ ID 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
接続を含むカタログのカタログ ID。これは null にすることができます。デフォルトでは、AWS アカウント ID がカタログ ID になります。
+ `EntityName` – *必須:* UTF–8 文字列。
指定された接続タイプからプレビューデータをクエリするエンティティの名前。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (これが継続呼び出しの場合)。
+ `DataStoreApiVersion` – UTF-8 文字列。1～256 バイト長。[Custom string pattern #23](aws-glue-api-common.md#regex_23) に一致。
SaaS コネクタの API バージョン。
+ `ConnectionOptions` – キーと値のペアのマップ配列。100 ペア以下。
各キーは UTF-8 文字列、1～256 バイト長で、[Custom string pattern #18](aws-glue-api-common.md#regex_18) に一致します。
各値は UTF-8 文字列、1～256 バイト長で、[Custom string pattern #17](aws-glue-api-common.md#regex_17) に一致します。
データのクエリに必要なコネクタオプション。
+ `FilterPredicate` – UTF-8 文字列。1～100000 バイト長。
クエリリクエストに適用可能なフィルター述語。
+ `Limit` – *必須:* 数値 (長さ)。1～1000。
リクエストで取得されるレコードの数を制限します。
+ `SelectedFields` – UTF-8 文字列の配列。1～1000 の文字列。
プレビューデータの一部として取得するフィールドのリスト。
**応答**
+ `Records` – 構造の配列。
リクエストされた オブジェクトのリスト。
+ `NextToken` - UTF-8 文字列。1 ～ 2,048 バイト長。[Custom string pattern #11](aws-glue-api-common.md#regex_11) に一致。
継続トークン (現在のセグメントが最後ではない場合に表示されます)。
**エラー**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
# ユーザー定義関数 API
ユーザー定義関数 API では、関数の処理に使用する AWS Glue データ型およびオペレーションについて説明します。
## データ型
+ [UserDefinedFunction 構造](#aws-glue-api-catalog-functions-UserDefinedFunction)
+ [UserDefinedFunctionInput 構造](#aws-glue-api-catalog-functions-UserDefinedFunctionInput)
## UserDefinedFunction 構造
Hive ユーザー定義関数 (`UDF`) 定義と同等のものを表します。
**フィールド**
+ `FunctionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の名前
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数を含むカタログデータベースの名前。
+ `ClassName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数コードを含む Java クラス。
+ `OwnerName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の所有者。
+ `OwnerType` – UTF-8 文字列 (有効な値: `USER` \$1 `ROLE` \$1 `GROUP`)。
所有者のタイプ。
+ `CreateTime` – タイムスタンプ。
関数の作成時刻。
+ `ResourceUris` – [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri) オブジェクトの配列。構造 1000 個以下。
関数のリソース URI。
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数が存在する Data Catalog の ID。
## UserDefinedFunctionInput 構造
ユーザー定義関数の作成または更新に使用される構造。
**フィールド**
+ `FunctionName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の名前
+ `ClassName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数コードを含む Java クラス。
+ `OwnerName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の所有者。
+ `OwnerType` – UTF-8 文字列 (有効な値: `USER` \$1 `ROLE` \$1 `GROUP`)。
所有者のタイプ。
+ `ResourceUris` – [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri) オブジェクトの配列。構造 1000 個以下。
関数のリソース URI。
## 操作
+ [CreateUserDefinedFunction アクション (Python: create\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
+ [UpdateUserDefinedFunction アクション (Python: update\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
+ [DeleteUserDefinedFunction アクション (Python: delete\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
+ [GetUserDefinedFunction アクション (Python: get\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-GetUserDefinedFunction)
+ [GetUserDefinedFunctions アクション (Python: get\$1user\$1defined\$1functions)](#aws-glue-api-catalog-functions-GetUserDefinedFunctions)
## CreateUserDefinedFunction アクション (Python: create\$1user\$1defined\$1function)
データカタログで新しい関数定義を作成します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
関数を作成するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数を作成するカタログデータベースの名前。
+ `FunctionInput` – *必須:* [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput) オブジェクト。
データカタログで作成する関数を定義する `FunctionInput` オブジェクト。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## UpdateUserDefinedFunction アクション (Python: update\$1user\$1defined\$1function)
データカタログで既存の関数定義を更新します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
更新する関数が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
更新する関数が存在するカタログデータベースの名前。
+ `FunctionName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の名前
+ `FunctionInput` – *必須:* [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput) オブジェクト。
データカタログで関数を再定義する `FunctionInput` オブジェクト。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteUserDefinedFunction アクション (Python: delete\$1user\$1defined\$1function)
データカタログから既存の関数定義を削除します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
削除する関数が存在するデータカタログの ID。提供されない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除する関数が存在するカタログデータベースの名前。
+ `FunctionName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除する関数定義の名前。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetUserDefinedFunction アクション (Python: get\$1user\$1defined\$1function)
データカタログから指定された関数定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
取得する関数が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
削除する関数が存在するカタログデータベースの名前。
+ `FunctionName` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数の名前
**レスポンス**
+ `UserDefinedFunction` – [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction) オブジェクト。
リクエストされた関数定義。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## GetUserDefinedFunctions アクション (Python: get\$1user\$1defined\$1functions)
データカタログから複数の関数定義を取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
取得する関数が存在するデータカタログの ID。設定しない場合は、AWS アカウント ID がデフォルトで使用されます。
+ `DatabaseName` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
関数が存在するカタログデータベースの名前。何も指定されていない場合は、カタログ全体のすべてのデータベースからの関数が返されます。
+ `Pattern` – *必須:* UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
返される関数定義をフィルタリングするオプションの function-name パターン文字列。
+ `NextToken` – UTF-8 文字列。
継続トークン (これが継続呼び出しの場合)。
+ `MaxResults` – 数値 (integer)。1～100。
1 回の応答で返す関数の最大数。
**応答**
+ `UserDefinedFunctions` – [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction) オブジェクトの配列。
リクエストされた関数定義のリスト。
+ `NextToken` – UTF–8 文字列。
戻された関数のリストに最後のリクエストされた関数が含まれていない場合は、継続トークン。
**エラー**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
# Athena カタログを AWS Glue にインポートする
Migration API では、Athena データカタログの AWS Glue への移行と関係のある AWS Glue データ型とオペレーションについて説明します。
## データ型
+ [CatalogImportStatus 構造](#aws-glue-api-catalog-migration-CatalogImportStatus)
## CatalogImportStatus 構造
移行ステータス情報を含む構造。
**フィールド**
+ `ImportCompleted` – ブール。
移行が完了した場合は `True`、それ以外の場合は `False` です。
+ `ImportTime` – タイムスタンプ。
移行を開始した時刻。
+ `ImportedBy` – UTF-8 文字列。1～255 バイト長。[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine) に一致。
移行を開始したユーザーの名前。
## 操作
+ [ImportCatalogToGlue アクション (Python: import\$1catalog\$1to\$1glue)](#aws-glue-api-catalog-migration-ImportCatalogToGlue)
+ [GetCatalogImportStatus アクション (Python: get\$1catalog\$1import\$1status)](#aws-glue-api-catalog-migration-GetCatalogImportStatus)
## ImportCatalogToGlue アクション (Python: import\$1catalog\$1to\$1glue)
既存の Amazon Athena Data Catalog を AWS Glue にインポートする
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
インポートするカタログの ID。現在、これは AWS アカウント ID である必要があります。
**レスポンス**
+ *応答パラメータはありません。*
**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetCatalogImportStatus アクション (Python: get\$1catalog\$1import\$1status)
移行操作のステータスを取得します。
**リクエスト**
+ `CatalogId` – カタログ ID 文字列、1～255 バイト長、「[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)」に一致。
移行するカタログの ID。現在、これは AWS アカウント ID である必要があります。
**レスポンス**
+ `ImportStatus` – [CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus) オブジェクト。
指定したカタログ移行のステータス。
**エラー**
+ `InternalServiceException`
+ `OperationTimeoutException`