接続タイプ API では、接続タイプの説明に関連する AWS Glue API について説明します。
接続管理 API
DescribeConnectionType アクション (Python: describe_connection_type)
DescribeConnectionType API は、AWS Glue の特定の接続タイプでサポートされているオプションの詳細を提供します。
リクエスト
-
ConnectionType– 必須: UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。説明する接続タイプの名前。
レスポンス
-
ConnectionType– UTF-8 文字列。1～255 バイト長。Single-line string pattern に一致。接続タイプの名前。
-
Description– UTF-8 文字列、1024 バイト長以下。接続タイプの説明。
-
Capabilities– 機能 オブジェクト。サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、コネクタのデータオペレーション。
-
ConnectionProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
コンピューティング環境間で共通の接続プロパティ。
-
ConnectionOptions– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
ConnectionInput.ConnectionPropertiesで接続を作成するときに設定できるプロパティを返します。ConnectionOptionsは、データフレームに渡される接続オプションマップの Spark ETL スクリプトで設定できるパラメータを定義します。 -
AuthenticationConfiguration– AuthConfiguration オブジェクト。接続に使用する認証のタイプ。
-
ComputeEnvironmentConfigurations– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は ComputeEnvironmentConfiguration オブジェクトです。
接続でサポートされているコンピューティング環境。
-
PhysicalConnectionRequirements– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
接続の物理的な要件 (VPC、サブネット、セキュリティグループの仕様など)。
-
AthenaConnectionProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
Athena コンピューティング環境に固有の接続プロパティ。
-
PythonConnectionProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
Python コンピューティング環境に固有の接続プロパティ。
-
SparkConnectionProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
Spark コンピューティング環境に固有の接続プロパティ。
エラー
ValidationExceptionInvalidInputExceptionInternalServiceException
ListConnectionTypes アクション (Python: list_connection_types)
ListConnectionTypes API は、AWS Glue で使用可能な接続タイプを学習するための検出メカニズムを提供します。応答には、接続タイプのリストと、各接続タイプでサポートされている内容の概要が含まれます。リストに挙げられている接続タイプは、CreateConnection API の ConnectionType 値に対してサポートされているオプションのセットです。
リクエスト
-
MaxResults– 1～1000 の数値 (整数)。返される結果の最大数。
-
NextToken- UTF-8 文字列。1 ～ 2,048 バイト長。Custom string pattern #11 に一致。継続トークン (これが継続呼び出しの場合)。
応答
-
ConnectionTypes– ConnectionTypeBrief オブジェクトの配列。サポートされている接続タイプに関する簡単な情報を含む
ConnectionTypeBriefオブジェクトのリスト。 -
NextToken- UTF-8 文字列。1 ～ 2,048 バイト長。Custom string pattern #11 に一致。継続トークン (現在のリストが最後ではない場合に表示されます)。
エラー
InternalServiceException
ConnectionTypeBrief 構造
ListConnectionTypes API によって返される、サポートされている接続タイプに関する簡単な情報。
[フィールド]
-
ConnectionType– UTF-8 文字列 (有効な値:JDBC|SFTP|MONGODB|KAFKA|NETWORK|MARKETPLACE|CUSTOM|SALESFORCE|VIEW_VALIDATION_REDSHIFT|VIEW_VALIDATION_ATHENA|GOOGLEADS|GOOGLESHEETS|GOOGLEANALYTICS4|SERVICENOW|MARKETO|SAPODATA|ZENDESK|JIRACLOUD|NETSUITEERP|HUBSPOT|FACEBOOKADS|INSTAGRAMADS|ZOHOCRM|SALESFORCEPARDOT|SALESFORCEMARKETINGCLOUD|SLACK|STRIPE|INTERCOM|SNAPCHATADS)。接続タイプの名前。
-
Description– UTF-8 文字列、1024 バイト長以下。接続タイプの説明。
-
Capabilities– 機能 オブジェクト。サポートされている認証タイプ、データインターフェイスタイプ (コンピューティング環境)、コネクタのデータオペレーション。
データ型
検証構造
接続プロパティでの検証の実行方法を定義します。
[フィールド]
-
ValidationType– 必須: UTF-8 文字列 (有効な値:REGEX|RANGE)。実行する検証のタイプ (
REGEXなど)。 -
Patterns– UTF-8 文字列の配列。検証に適用されるパターンのリスト。
-
Description– 必須: UTF-8 文字列、1～1024 バイト長。検証の説明。
-
MaxLength– 数値 (整数)。文字列接続プロパティの最大長。
-
Maximum– 数値 (整数)。検証の
RANGEタイプを指定するときの最大値。 -
Minimum– 数値 (整数)。検証の
RANGEタイプを指定するときの最小値。
AuthConfiguration 構造
DescribeConnectionType API によって返される接続の認証設定。
[フィールド]
-
AuthenticationType– 必須: プロパティ オブジェクト。接続の認証のタイプ。
-
SecretArn– プロパティ オブジェクト。Secrets Manager の Amazon リソースネーム (ARN)。
-
OAuth2Properties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は
Propertyオブジェクトです。 -
BasicAuthenticationProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
OAuth2 プロパティのキーと値のペアのマップ。各値は
Propertyオブジェクトです。 -
CustomAuthenticationProperties– キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
カスタム認証プロパティのキーと値のペアのマップ。各値は
Propertyオブジェクトです。
Capabilities 構造
DescribeConnectionType API によって返される、サポートされている認証タイプを指定します。
[フィールド]
-
SupportedAuthenticationTypes– 必須: UTF-8 文字列の配列。サポートされている認証タイプのリスト。
-
SupportedDataOperations– 必須: UTF-8 文字列の配列。サポートされているデータオペレーションのリスト。
-
SupportedComputeEnvironments– 必須: UTF-8 文字列の配列。サポートされているコンピューティング環境のリスト。
Property 構造
コンピューティング環境の接続タイプを定義するオブジェクト。
[フィールド]
-
Name– 必須: UTF-8 文字列。1～128 バイト長。プロパティの名前。
-
Description– 必須: UTF-8 文字列。1024 以下のバイト長。プロパティの説明。
-
DataType– 必須: UTF-8 文字列 (有効な値:STRING|INTEGER|BOOLEAN|STRING_LIST)。プロパティのデータタイプ。
-
Required– 必須: Boolean。プロパティが必須かどうかを示します。
-
DefaultValue– UTF-8 文字列。プロパティのデフォルト値。
-
PropertyTypes– 必須: UTF-8 文字列の配列。プロパティのタイプを説明します。
-
AllowedValues– allowedValues オブジェクトの配列。プロパティに許可される値を表す
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|ATHENA|PYTHON)。コンピューティング環境のタイプ。
-
SupportedAuthenticationTypes– 必須: UTF-8 文字列の配列。コンピューティング環境でサポートされている認証タイプ。
-
ConnectionOptions– 必須: キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は プロパティ オブジェクトです。
コンピューティング環境の接続オプションとして使用されるパラメータ。
-
ConnectionPropertyNameOverrides– 必須: キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続プロパティ名はコンピューティング環境に対して上書きされます。
-
ConnectionOptionNameOverrides– 必須: キーバリューペアのマップ配列。各キーは UTF-8 文字列で、1～128 バイト長です。
各値は UTF-8 文字列で、1～128 バイト長です。
接続オプション名はコンピューティング環境に対して上書きされます。
-
ConnectionPropertiesRequiredOverrides– 必須: UTF-8 文字列の配列。コンピューティング環境の上書きとして必要な接続プロパティ。
-
PhysicalConnectionPropertiesRequired– ブール。コンピューティング環境に
PhysicalConnectionPropertiesが必要かどうかを示します。
