接続 API

• 接続構造

• ConnectionInput 構造

• TestConnectionInput 構造

• PhysicalConnectionRequirements 構造

• GetConnectionsFilter 構造

フィールド

• Name – UTF-8 文字列。1 バイト以上、または 255 バイト以下であり、 と一致しますSingle-line string pattern。

  接続定義の名前。

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

  接続の説明。

• ConnectionType – UTF-8 文字列 (有効な値: JDBC | | SFTP | MONGODB | KAFKA | NETWORK MARKETPLACE | CUSTOM SALESFORCE | | VIEW_VALIDATION_REDSHIFT | | VIEW_VALIDATION_ATHENA）。

  接続のタイプ。現在、SFTP はサポートされていません。

• MatchCriteria – UTF-8 文字列の配列。10 文字列以下。

  この接続を選択する際に使用可能な条件のリスト。

• ConnectionProperties – キーと値のペアのマップ配列。100 ペア以下。

  各キーは UTF-8 文字列です (有効な値: HOST | | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | | | JDBC_DRIVER_JAR_URI | | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE JDBC_ENGINE_VERSION | | | JDBC_ENFORCE_SSL | CONFIG_FILES INSTANCE_ID JDBC_CONNECTION_URL | | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | | | | | CUSTOM_JDBC_CERT_STRING CONNECTION_URL KAFKA_BOOTSTRAP_SERVERS KAFKA_SSL_ENABLED KAFKA_CUSTOM_CERT KAFKA_SKIP_CUSTOM_CERT_VALIDATION KAFKA_CLIENT_KEYSTORE KAFKA_CLIENT_KEYSTORE_PASSWORD KAFKA_CLIENT_KEY_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | | | SECRET_ID CONNECTOR_URL | | | | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | | | CONNECTOR_TYPE CONNECTOR_CLASS_NAME KAFKA_SASL_MECHANISM KAFKA_SASL_PLAIN_USERNAME KAFKA_SASL_PLAIN_PASSWORD ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD KAFKA_SASL_SCRAM_SECRETS_ARN | | | | KAFKA_SASL_GSSAPI_KEYTAB | | | | KAFKA_SASL_GSSAPI_KRB5_CONF | | KAFKA_SASL_GSSAPI_SERVICE | | | | | | | | CLUSTER_IDENTIFIER | | | | KAFKA_SASL_GSSAPI_PRINCIPAL ROLE_ARN REGION WORKGROUP_NAME | )DATABASE。

  各値は Value 文字列で、1,024 バイト長以下です。

  以下のキー/値ペアは接続のパラメータを定義します。

  • 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 () がクライアント上のJDBC接続に適用されるかどうかを指定するブール文字列 (true、falseSSL）。デフォルトは False です。

  • CUSTOM_JDBC_CERT - 顧客のルート証明書を指定する Amazon S3 の場所。このルート証明書 AWS Glue を使用して、顧客データベースに接続するときに顧客の証明書を検証します。 は X.509 証明書 AWS Glue のみを処理します。提供される証明書はDERエンコードされ、Base64 エンコードPEM形式で提供される必要があります。

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION - デフォルトでは、これは false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the Customer Certificate です。Signature アルゴリズムで許可されるアルゴリズムは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 証明書ファイルの検証をスキップするかどうか。 SHA256withRSASHA384withRSAと の 3 つのアルゴリズムの not. AWS Glue validatesSHA512withRSA。デフォルト値は「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メカニズム です。

  • KAFKA_SASL_PLAIN_USERNAME - PLAIN「」メカニズムによる認証に使用されるプレーンテキストユーザー名。

  • KAFKA_SASL_PLAIN_PASSWORD - PLAIN「」メカニズムによる認証に使用されるプレーンテキストパスワード。

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD - Kafka SASLPLAINパスワードの暗号化バージョン (ユーザーが AWS Glue 暗号化パスワード設定を選択した場合）。

  • KAFKA_SASL_SCRAM_USERNAME - SCRAM「-SHA-512」メカニズムによる認証に使用されるプレーンテキストユーザー名。

  • KAFKA_SASL_SCRAM_PASSWORD - SCRAM「-SHA-512」メカニズムによる認証に使用されるプレーンテキストパスワード。

  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - Kafka SASLSCRAMパスワードの暗号化バージョン (ユーザーが AWS Glue 暗号化パスワード設定を選択した場合）。

  • KAFKA_SASL_SCRAM_SECRETS_ARN - AWS Secrets Manager のシークレットの Amazon リソース名。

  • KAFKA_SASL_GSSAPI_KEYTAB - Kerberos keytab ファイルの S3 の場所。キータブには、1 つ以上のプリンシパルの長期キーが保存されます。詳細については、MITKerberos ドキュメント: Keytab を参照してください。

  • KAFKA_SASL_GSSAPI_KRB5_CONF - Kerberos krb5.conf ファイルの S3 の場所。krb5.conf は、KDCサーバーの場所などの Kerberos 設定情報を保存します。詳細については、MITKerberos ドキュメント: krb5.conf を参照してください。

  • KAFKA_SASL_GSSAPI_SERVICE - Kafka 構成 の sasl.kerberos.service.name で設定した通りのKerberos サービスの名前。

  • KAFKA_SASL_GSSAPI_PRINCIPAL - が使用する Kerberos プリニシャルの名前 AWS Glue。詳細については、「Kafka ドキュメント: Kafka ブローカーの構成」を参照してください。

  • ROLE_ARN - クエリの実行に使用されるロール。

  • REGION - クエリを実行する AWS リージョン。

  • WORKGROUP_NAME - クエリを実行する Amazon Redshift Serverless ワークグループまたは Amazon Athena ワークグループの名前。

  • CLUSTER_IDENTIFIER - クエリを実行する Amazon Redshift クラスターのクラスター識別子。

  • DATABASE - 接続先の Amazon Redshift データベース。

• PhysicalConnectionRequirements – PhysicalConnectionRequirements オブジェクト。

  この接続を成功させるSecurityGroupために必要な仮想プライベートクラウド (VPC) や などの物理接続要件。

• CreationTime – タイムスタンプ。

  この接続定義が作成された時刻のタイムスタンプ。

• LastUpdatedTime – タイムスタンプ。

  この接続定義が更新された最終時刻のタイムスタンプ。

• LastUpdatedBy – UTF-8 文字列。1 バイト以上、または 255 バイト以下であり、 と一致しますSingle-line string pattern。

  この接続定義を最終更新したユーザー、グループ、またはロール。

• Status – UTF-8 文字列 (有効な値: READY | IN_PROGRESS | FAILED）。

  接続のステータス。READY、IN_PROGRESS、または FAILED のいずれか。

• StatusReason – UTF-8 文字列、1 バイト以上、または 16384 バイト以下。

  接続ステータスの理由。

• LastConnectionValidationTime – タイムスタンプ。

  この接続が最後に検証された時刻のタイムスタンプ。

• AuthenticationConfiguration – AuthenticationConfiguration オブジェクト。

  接続の認証プロパティ。

フィールド

• Name – 必須： UTF-8 文字列、1 バイト以上、または 255 バイト以上、 に一致しますSingle-line string pattern。

  コレクションの名前。

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

  接続の説明。

• ConnectionType – 必須： UTF-8 文字列 (有効な値: JDBC | | SFTP | MONGODB | KAFKA NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA）。

  接続のタイプ。現在、次のタイプがサポートされています。

  • 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。これらのパラメータは、 SSLで を設定するために使用されますJDBC。

  • KAFKA - Apache Kafka ストリーミングプラットフォームへの接続を指定します。

    KAFKA 接続では、次の を使用します ConnectionParameters。

    • 必須: KAFKA_BOOTSTRAP_SERVERS。

    • オプション: KAFKA_SSL_ENABLED、KAFKA_CUSTOM_CERT、KAFKA_SKIP_CUSTOM_CERT_VALIDATION。これらのパラメータは、 SSLで を設定するために使用されますKAFKA。

    • オプション: KAFKA_CLIENT_KEYSTORE、KAFKA_CLIENT_KEYSTORE_PASSWORD、KAFKA_CLIENT_KEY_PASSWORD、ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD、ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD。これらのパラメータは、 SSL で を使用してTLSクライアント設定を行うために使用されますKAFKA。

    • オプション: KAFKA_SASL_MECHANISM。SCRAM-SHA-512、GSSAPI、または AWS_MSK_IAM として指定できます。

    • オプション: KAFKA_SASL_SCRAM_USERNAME、KAFKA_SASL_SCRAM_PASSWORD、ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD。これらのパラメータは、 で SASL/SCRAM-SHA-512 認証を設定するために使用されますKAFKA。

    • オプション: KAFKA_SASL_GSSAPI_KEYTAB、KAFKA_SASL_GSSAPI_KRB5_CONF、KAFKA_SASL_GSSAPI_SERVICE、KAFKA_SASL_GSSAPI_PRINCIPAL。これらのパラメータは、 で SASL/GSSAPI 認証を設定するために使用されますKAFKA。

  • MONGODB - MongoDB ドキュメントデータベースへの接続を指定します。

    MONGODB 接続では、次の を使用します ConnectionParameters。

    • 必須: CONNECTION_URL。

    • 必須: (USERNAME、PASSWORD) のすべて、または SECRET_ID。

  • SALESFORCE - 認証を使用して Salesforce OAuth への接続を指定します。

    • AuthenticationConfiguration メンバーを設定する必要があります。

  • 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がネイティブにサポートしていないデータストアに対する読み取りと書き込みを行います。

  SFTP はサポートされていません。

  で機能を設定するためにオプション ConnectionProperties を使用する方法の詳細については AWS Glue、AWS Glue 接続プロパティを参照してください。

  AWS Glue Studio で機能を設定するためにオプション ConnectionProperties を使用する方法の詳細については、「コネクタと接続の使用」を参照してください。

• MatchCriteria – UTF-8 文字列の配列。10 文字列以下。

  この接続を選択する際に使用可能な条件のリスト。

• ConnectionProperties – 必須: キーと値のペアのマップ配列。100 ペア以下。

  各キーは UTF-8 文字列です (有効な値: HOST | | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | | | JDBC_DRIVER_JAR_URI | | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE JDBC_ENGINE_VERSION | | | JDBC_ENFORCE_SSL | CONFIG_FILES INSTANCE_ID JDBC_CONNECTION_URL | | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | | | | | CUSTOM_JDBC_CERT_STRING CONNECTION_URL KAFKA_BOOTSTRAP_SERVERS KAFKA_SSL_ENABLED KAFKA_CUSTOM_CERT KAFKA_SKIP_CUSTOM_CERT_VALIDATION KAFKA_CLIENT_KEYSTORE KAFKA_CLIENT_KEYSTORE_PASSWORD KAFKA_CLIENT_KEY_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | | | SECRET_ID CONNECTOR_URL | | | | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | | | CONNECTOR_TYPE CONNECTOR_CLASS_NAME KAFKA_SASL_MECHANISM KAFKA_SASL_PLAIN_USERNAME KAFKA_SASL_PLAIN_PASSWORD ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD KAFKA_SASL_SCRAM_SECRETS_ARN | | | | KAFKA_SASL_GSSAPI_KEYTAB | | | | KAFKA_SASL_GSSAPI_KRB5_CONF | | KAFKA_SASL_GSSAPI_SERVICE | | | | | | | | CLUSTER_IDENTIFIER | | | | KAFKA_SASL_GSSAPI_PRINCIPAL ROLE_ARN REGION WORKGROUP_NAME | )DATABASE。

  各値は Value 文字列で、1,024 バイト長以下です。

  以下のキーバリューペアは接続のパラメータを定義します。

• PhysicalConnectionRequirements – PhysicalConnectionRequirements オブジェクト。

  この接続を成功させるために必要な仮想プライベートクラウド (VPC) SecurityGroupや などの物理接続要件。

• AuthenticationConfiguration – AuthenticationConfigurationInput オブジェクト。

  接続の認証プロパティ。Salesforce 接続に使用されます。

• ValidateCredentials – ブール。

  接続の作成中に認証情報を検証するフラグ。Salesforce 接続に使用されます。デフォルトは true です。

フィールド

• ConnectionType – 必須： UTF-8 文字列 (有効な値: JDBC | | SFTP | MONGODB | KAFKA NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA）。

  テストする接続のタイプ。このオペレーションは、 JDBCまたは SALESFORCE接続タイプでのみ使用できます。

• ConnectionProperties – 必須: キーと値のペアのマップ配列。100 ペア以下。

  各キーは UTF-8 文字列です (有効な値: HOST | | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | | | JDBC_DRIVER_JAR_URI | | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE JDBC_ENGINE_VERSION | | | JDBC_ENFORCE_SSL | CONFIG_FILES INSTANCE_ID JDBC_CONNECTION_URL | | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | | | | | CUSTOM_JDBC_CERT_STRING CONNECTION_URL KAFKA_BOOTSTRAP_SERVERS KAFKA_SSL_ENABLED KAFKA_CUSTOM_CERT KAFKA_SKIP_CUSTOM_CERT_VALIDATION KAFKA_CLIENT_KEYSTORE KAFKA_CLIENT_KEYSTORE_PASSWORD KAFKA_CLIENT_KEY_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | | | SECRET_ID CONNECTOR_URL | | | | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | | | CONNECTOR_TYPE CONNECTOR_CLASS_NAME KAFKA_SASL_MECHANISM KAFKA_SASL_PLAIN_USERNAME KAFKA_SASL_PLAIN_PASSWORD ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD KAFKA_SASL_SCRAM_SECRETS_ARN | | | | KAFKA_SASL_GSSAPI_KEYTAB | | | | KAFKA_SASL_GSSAPI_KRB5_CONF | | KAFKA_SASL_GSSAPI_SERVICE | | | | | | | | CLUSTER_IDENTIFIER | | | | KAFKA_SASL_GSSAPI_PRINCIPAL ROLE_ARN REGION WORKGROUP_NAME | )DATABASE。

  各値は Value 文字列で、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。これらのパラメータは、 SSLで を設定するために使用されますJDBC。

  SALESFORCE 接続では、AuthenticationConfigurationメンバーを設定する必要があります。

• AuthenticationConfiguration – AuthenticationConfigurationInput オブジェクト。

  リクエストの TestConnection認証設定を含む構造。OAuth 認証を使用した Salesforce への接続に必要です。

フィールド

• SubnetId – UTF-8 文字列。1 バイト以上、または 255 バイト以下であり、 と一致しますSingle-line string pattern。

  接続で使用されるサブネット ID。

• SecurityGroupIdList — UTF-8 文字列の配列。50 文字列以下。

  接続で使用されるセキュリティグループ ID のリスト。

• AvailabilityZone – UTF-8 文字列。1 バイト以上、または 255 バイト以上の長さで、 と一致しますSingle-line string pattern。

  接続のアベイラビリティーゾーン。

フィールド

• MatchCriteria – UTF-8 文字列の配列。10 文字列以下。

  接続定義を返すためにその接続定義に記録された条件と一致する必要がある条件文字列。

• ConnectionType – UTF-8 文字列 (有効な値: JDBC | | SFTP | MONGODB | KAFKA | NETWORK MARKETPLACE | CUSTOM SALESFORCE | | | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA）。

  返す接続のタイプ。現在、SFTP はサポートされていません。

• CreateConnection アクション (Python: create_connection)

• DeleteConnection アクション (Python: delete_connection)

• GetConnection アクション (Python: get_connection)

• GetConnections アクション (Python: get_connections)

• UpdateConnection アクション (Python: update_connection)

• TestConnection アクション (Python: test_connection)

• BatchDeleteConnection アクション (Python: batch_delete_connection)

リクエスト

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

  接続を作成するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• ConnectionInput – 必須: ConnectionInput オブジェクト。

  作成する接続を定義する ConnectionInput オブジェクト。

• Tags – キーと値のペアのマップ配列。50 ペア以下。

  各キーは UTF-8 文字列で、1 バイト以上、または 128 バイト以下です。

  各値は UTF-8 文字列で、長さは 256 バイト以下です。

  接続に割り当てるタグ。

レスポンス

• CreateConnectionStatus – UTF-8 文字列 (有効な値: READY | IN_PROGRESS | FAILED）。

  接続作成リクエストのステータス。リクエストは、 経由でトークン交換とOAuth接続を作成する場合など、特定の認証タイプには時間がかかる場合がありますVPC。

エラー

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

リクエスト

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

  接続が存在するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• ConnectionName – 必須： UTF-8 文字列、1 バイト以上、または 255 バイト以下の長さで、 に一致しますSingle-line string pattern。

  削除する接続の名前。

レスポンス

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

エラー

• EntityNotFoundException

• OperationTimeoutException

リクエスト

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

  接続が存在するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• Name – 必須： UTF-8 文字列、1 バイト以上、または 255 バイト以下、 に一致しますSingle-line string pattern。

  取得する接続定義の名前。

• HidePassword – ブール。

  パスワードを返さずに接続メタデータを取得できます。例えば、 AWS Glue コンソールはこのフラグを使用して接続を取得し、パスワードは表示しません。呼び出し元が AWS KMS キーを使用してパスワードを復号するアクセス許可を持っていないが、残りの接続プロパティにアクセスするアクセス許可がある場合、このパラメータを設定します。

レスポンス

• Connection – 接続 オブジェクト。

  リクエストされた接続定義。

エラー

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

リクエスト

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

  接続が存在するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• Filter – GetConnectionsFilter オブジェクト。

  返される接続をコントロールするフィルター。

• HidePassword – ブール。

  パスワードを返さずに接続メタデータを取得できます。例えば、 AWS Glue コンソールはこのフラグを使用して接続を取得し、パスワードは表示しません。呼び出し元が AWS KMS キーを使用してパスワードを復号するアクセス許可を持っていないが、残りの接続プロパティにアクセスするアクセス許可がある場合、このパラメータを設定します。

• NextToken – UTF-8 文字列。

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

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

  1 回の応答で返す接続の最大数。

応答

• ConnectionList – 接続 オブジェクトの配列。

  リクエストされた接続定義のリスト。

• NextToken – UTF-8 文字列。

  返された接続のリストにフィルタリングされた接続の最後のものが含まれていない場合は、継続トークン。

エラー

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

リクエスト

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

  接続が存在するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• Name – 必須： UTF-8 文字列、1 バイト以上、または 255 バイト以上、 に一致しますSingle-line string pattern。

  更新する接続定義の名前。

• ConnectionInput – 必須: ConnectionInput オブジェクト。

  該当する接続を再定義する ConnectionInput オブジェクト。

レスポンス

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

エラー

• InvalidInputException

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

リクエスト

• ConnectionName – UTF-8 文字列。1 バイト以上、または 255 バイト以下であり、 と一致しますSingle-line string pattern。

  オプション。テストする接続の名前。名前のみを指定した場合、オペレーションは接続を取得し、テストに使用します。

• TestConnectionInput – TestConnectionInput オブジェクト。

  サービスへの接続のテストを指定するために使用される構造。

レスポンス

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

エラー

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

• FederationSourceException

• AccessDeniedException

• EntityNotFoundException

• ConflictException

• InternalServiceException

リクエスト

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

  接続が存在するデータカタログの ID。何も指定されていない場合、 AWS アカウント ID はデフォルトで使用されます。

• ConnectionNameList – 必須： UTF-8 文字列の配列。25 文字列以下。

  削除する接続の名前のリスト。

レスポンス

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

  正常に削除された接続定義の名前のリスト。

• Errors – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1 バイト以上、または 255 バイト以下であり、 と一致しますSingle-line string pattern。

  各値は ErrorDetail オブジェクトです。

  エラーの詳細への正常に削除されなかった接続の名前のマップ。

エラー

• InternalServiceException

• OperationTimeoutException

• AuthenticationConfiguration 構造

• AuthenticationConfigurationInput 構造

• OAuth2Properties 構造

• OAuth2PropertiesInput 構造

• OAuth2ClientApplication 構造

• AuthorizationCodeProperties 構造

フィールド

• AuthenticationType – UTF-8 文字列 (有効な値: BASIC | OAUTH2 | CUSTOM）。

  認証の設定を含む構造。

• SecretArn – UTF-8 文字列。 と一致しますCustom string pattern #11。

  認証情報ARNを保存するシークレットマネージャー。

• OAuth2Properties – OAuth2Properties オブジェクト。

  OAuth2 認証のプロパティ。

フィールド

• AuthenticationType – UTF-8 文字列 (有効な値: BASIC | OAUTH2 | CUSTOM）。

  リクエストの CreateConnection認証設定を含む構造。

• SecretArn – UTF-8 文字列。 と一致しますCustom string pattern #11。

  CreateConnection リクエストに認証情報ARNを保存するシークレットマネージャー。

• OAuth2Properties – OAuth2PropertiesInput オブジェクト。

  CreateConnection リクエスト内のOAuth2認証のプロパティ。

フィールド

• OAuth2GrantType – UTF-8 文字列 (有効な値: AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER）。

  OAuth2 許可タイプ。例えば、AUTHORIZATION_CODE、JWT_BEARER、または CLIENT_CREDENTIALS です。

• OAuth2ClientApplication – OAuth2ClientApplication オブジェクト。

  クライアントアプリケーションタイプ。例えば、 AWS_MANAGEDまたは USER_MANAGED。

• TokenUrl – UTF-8 文字列、長さ 256 バイト以下、 と一致しますCustom string pattern #12。

  アクセストークンに認可コードを交換するための、プロバイダーURLの認証サーバーの 。

• TokenUrlParametersMap – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1 バイト以上、または 128 バイト以下です。

  各値は UTF-8 文字列で、1 バイト以上、または 512 バイト以下です。

  トークン GET リクエストに追加されるパラメータのマップ。

フィールド

• OAuth2GrantType – UTF-8 文字列 (有効な値: AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER）。

  CreateConnection リクエストのOAuth2許可タイプ。例えば、AUTHORIZATION_CODE、JWT_BEARER、または CLIENT_CREDENTIALS です。

• OAuth2ClientApplication – OAuth2ClientApplication オブジェクト。

  CreateConnection リクエスト内のクライアントアプリケーションタイプ。例えば、AWS_MANAGED、USER_MANAGED です。

• TokenUrl – UTF-8 文字列、256 バイト以下、 と一致しますCustom string pattern #12。

  アクセストークンに認可コードを交換するための、プロバイダーURLの認証サーバーの 。

• TokenUrlParametersMap – キーバリューペアのマップ配列。

  各キーは UTF-8 文字列で、1 バイト以上、または 128 バイト以下です。

  各値は UTF-8 文字列で、1 バイト以上、または 512 バイト以下です。

  トークン GET リクエストに追加されるパラメータのマップ。

• AuthorizationCodeProperties – AuthorizationCodeProperties オブジェクト。

  OAuth2 AUTHORIZATION_CODE グラントタイプに必要なプロパティのセット。

フィールド

• UserManagedClientApplicationClientId – UTF-8 文字列、長さ 2048 バイト以下、 と一致しますCustom string pattern #13。

  ClientAppType が の場合、クライアントアプリケーションclientIDUSER_MANAGED。

• AWSManagedClientApplicationReference – UTF-8 文字列、長さ 2048 バイト以下、 と一致しますCustom string pattern #13。

  AWS 管理されている SaaS 側のクライアントアプリケーションへの参照。

フィールド

• AuthorizationCode – UTF-8 文字列。1 バイト以上、または 4096 バイト以下であり、 と一致しますCustom string pattern #13。

  AUTHORIZATION_CODE で付与されるワークフローの 3 番目のレッグで使用される認可コード。これは、アクセストークンと交換されると無効になるワンタイムコードであるため、この値をリクエストパラメータとして指定できます。

• RedirectUri – UTF-8 文字列、長さ 512 バイト以下、 と一致しますCustom string pattern #14。

  認可コードの発行時に認可サーバーによってURIユーザーがリダイレクトされるリダイレクト。その後、 URIは認可コードがアクセストークンと交換されるときに使用されます。