連線 API - AWS Glue
 —  data types  —連線ConnectionInputPhysicalConnection要求GetConnections過濾器 —  operations  —CreateConnection (建立 _ 連線)DeleteConnection (刪除連線)GetConnection （獲取連接）GetConnections （獲取連接）UpdateConnection （更新連接）BatchDeleteConnection (批次刪除連線) — 驗證配置 —AuthenticationConfigurationAuthenticationConfiguration輸入OAuth2PropertiesOAuth2 PropertiesInputOAuth2 ClientApplicationAuthorizationCode性質

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

連線 API

連線 API 說明 AWS Glue 連線資料類型，以及建立、刪除、更新和列出連線的 API。

資料類型

Connection 結構

定義連接至資料來源的連線

欄位

  • 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)。

    連線的類型。目前不支援 SFTP。

  • MatchCriteria – UTF-8 字串的陣列，不可超過 10 個字串。

    用於選擇此連線的條件清單。

  • ConnectionProperties – 金鑰值對的對應陣列，不超過 100 對

    每個關鍵字都是一個 UTF-8 字串 (有效值：HOSTPORTUSERNAME="USER_NAME"PASSWORDENCRYPTED_PASSWORDJDBC_DRIVER_JAR_URIJDBC_DRIVER_CLASS_NAME| JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | 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 | 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 | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL |ROLE_ARN）。

    每個值都是 Value 字串，長度不可超過 1024 個位元組。

    這些金鑰值對會定義連線的參數：

    • HOST- 主機 URI：完整網域名稱 (FQDN) 或資料庫主機 IPv4 地址。

    • PORT- 資料庫主機用來監聽資料庫連線之連接埠的連接埠號碼 (介於 1024 和 65535 之間)。

    • USER_NAME- 用來登入資料庫的名稱。USER_NAME 的值字串為 "USERNAME"。

    • PASSWORD- 使用者名稱的密碼 (如果有使用)。

    • ENCRYPTED_PASSWORD - 當您在 Data Catalog 加密設定中的 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 - 布林值字串 (true、false)，會指定是否對用戶端上的 JDBC 連線強制使用主機名稱相符的 Secure Sockets Layer (SSL)。預設值為 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 憑證檔的 Amazon S3 URL (.pem 格式)。預設為空字串。

    • KAFKA_SKIP_CUSTOM_CERT_VALIDATION-是否跳過 CA 憑證檔案的驗證。 AWS Glue 驗證三種演算法：具有 RSA 的 SHA256、與 RSA 和 RSA 的 SHA512。預設值為 "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-卡夫卡 SASL 普通密碼的加密版本 (如果使用者已選取 AWS Glue 加密密碼設定)。

    • KAFKA_SASL_SCRAM_USERNAME - 用於藉助 "SCRAM-SHA-512" 機制進行身分驗證的純文字使用者名稱。

    • KAFKA_SASL_SCRAM_PASSWORD - 用於藉助 "SCRAM-SHA-512" 機制進行身分驗證的純文字密碼。

    • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD-卡夫卡 SASL SCRAM 密碼的加密版本（如果使用者已選取 AWS Glue 加密密碼設定）。

    • KAFKA_SASL_SCRAM_SECRETS_ARN-秘 AWS 密管理器中秘密的 Amazon 資源名稱。

    • KAFKA_SASL_GSSAPI_KEYTAB - Kerberos keytab 檔案的 S3 位置。Keytab 存放了一個或多個主體的長期金鑰。如需詳細資訊，請參閱 MIT Kerberos 文件：Keytab。

    • KAFKA_SASL_GSSAPI_KRB5_CONF - Kerberos krb5.conf 檔案的 S3 位置。krb5.conf 存放了 Kerberos 組態資訊，例如 KDC 伺服器的位置。如需詳細資訊，請參閱 MIT Kerberos 文件：krb5.conf。

    • KAFKA_SASL_GSSAPI_SERVICE - Kerberos 服務名稱，如在 Kafka 配置使用 sasl.kerberos.service.name 進行設定。

    • KAFKA_SASL_GSSAPI_PRINCIPAL-使用的 Kerberos 印刷品的名稱。 AWS Glue如需詳細資訊，請參閱 Kafka 文件：設定 Kafka 代理程式。

  • PhysicalConnectionRequirements – PhysicalConnection要求 物件。

    成功建立此連線所需的實體連線需求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 物件。

    連線的驗證內容。

ConnectionInput 結構

結構用於指定要建立或更新的連線。

欄位

  • Name – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合Single-line string pattern。

    連線的名稱。

  • Description – 描述字串，長度不可超過 2048 個位元組，需符合URI address multi-line string pattern。

    此連接的描述。

  • ConnectionType— 必要項目：UTF-8 字串 (有效值：JDBCSFTPMONGODBKAFKA| NETWORK | MARKETPLACE | | CUSTOM |SALESFORCE)。

    連線的類型。目前支援這些類型：

    • JDBC - 指定透過 Java 資料庫連接 (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。

    • SALESFORCE-使用 OAuth 驗證指定與銷售力量的連線。

      • 需要設定AuthenticationConfiguration成員。

    • 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 連線內容。

    如需 ConnectionProperties 有關如何使用選用性來設定 AWS Glue Studio 中功能的詳細資訊，請參閱使用連接器和連線。

  • MatchCriteria – UTF-8 字串的陣列，不可超過 10 個字串。

    用於選擇此連線的條件清單。

  • ConnectionProperties – 必要：索引鍵/值對的映射陣列，不可超過 100 對。

    每個關鍵字都是一個 UTF-8 字串 (有效值：HOSTPORTUSERNAME="USER_NAME"PASSWORDENCRYPTED_PASSWORDJDBC_DRIVER_JAR_URIJDBC_DRIVER_CLASS_NAME| JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | 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 | 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 | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL |ROLE_ARN）。

    每個值都是 Value 字串，長度不可超過 1024 個位元組。

    這些金鑰值對會定義連線的參數。

  • PhysicalConnectionRequirements – PhysicalConnection要求 物件。

    成功建立此連線所需的實體連線需求SecurityGroup，例如虛擬私有雲 (VPC) 和。

  • AuthenticationConfiguration – AuthenticationConfiguration輸入 物件。

    連線的驗證內容。用於銷售力量連線。

  • ValidateCredentials – 布林值。

    在建立連線期間驗證認證的旗標。用於銷售力量連線。預設為 true。

PhysicalConnectionRequirements 結構

作為回應的 OAuth 用戶端 GetConnection 應用程式。

欄位

  • SubnetId – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線使用的子網路 ID。

  • SecurityGroupIdList – UTF-8 字串的陣列，不可超過 50 個字串。

    連線使用的安全群組 ID 清單。

  • AvailabilityZone – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線的可用區域。

GetConnectionsFilter 結構

篩選 GetConnections API 操作傳回的連線定義。

欄位

  • MatchCriteria – UTF-8 字串的陣列，不可超過 10 個字串。

    條件字串必須符合連線定義中記錄的條件，才能傳回該連線定義。

  • ConnectionType – UTF-8 字串 (有效值：JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE)。

    傳回的連線類型。目前不支援 SFTP。

作業

CreateConnection 動作（Python：創建連接）

在 Data Catalog 中建立連線定義。

用於建立聯合資源的連線需要 IAM glue:PassConnection 許可。

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    用於建立連線的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • ConnectionInput – 必要：ConnectionInput 物件。

    用於定義所要建立的連線的 ConnectionInput 物件。

  • Tags – 金鑰值對的映射陣列，不超過 50 對。

    每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

    每個值都是 UTF-8 字串，長度不可超過 256 個位元組。

    指派給連線的標籤。

回應

  • CreateConnectionStatus – UTF-8 字串 (有效值：READY | IN_PROGRESS | FAILED)。

    連線建立要求的狀態。對於某些身份驗證類型，請求可能需要一些時間，例如在通過 VPC 上使用令牌交換創建 OAuth 連接時。

錯誤

  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

DeleteConnection 行動（Python：刪除連接）

從 Data Catalog 刪除連線。

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線所在的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • ConnectionName – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合Single-line string pattern。

    欲刪除的連線的名稱。

回應

  • 無回應參數。

錯誤

  • EntityNotFoundException

  • OperationTimeoutException

GetConnection 行動（Python：獲取連接）

從 Data Catalog 擷取連線定義

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線所在的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • Name – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合Single-line string pattern。

    欲擷取的連線定義的名稱。

  • HidePassword – 布林值。

    可讓您擷取連線中繼資料，無需傳回密碼。例如， AWS Glue 控制台使用此標誌來檢索連接，並且不顯示密碼。當呼叫者可能沒有使用密 AWS KMS 鑰解密密碼的權限時，請設置此參數，但它確實具有訪問其餘連接屬性的權限。

回應

  • Connection – 連線 物件。

    要求的連線定義。

錯誤

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

GetConnections 行動（Python：獲取連接）

從 Data Catalog 擷取連線定義清單。

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線所在的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • Filter – GetConnections過濾器 物件。

    用於控制將傳回哪些連線的篩選條件。

  • HidePassword – 布林值。

    可讓您擷取連線中繼資料，無需傳回密碼。例如， AWS Glue 控制台使用此標誌來檢索連接，並且不顯示密碼。當呼叫者可能沒有使用密 AWS KMS 鑰解密密碼的權限時，請設置此參數，但它確實具有訪問其餘連接屬性的權限。

  • NextToken – UTF-8 字串。

    接續符記，如果這是接續呼叫。

  • MaxResults – 數字 (整數)，不可小於 1，也不可以大於 1000。

    一次回應傳回的最大連線數量。

回應

  • ConnectionList – 一個 連線 物件陣列。

    要求的連線定義的清單。

  • NextToken – UTF-8 字串。

    接續符記 (如果傳回的連線清單不包括最後篩選的連線)。

錯誤

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

UpdateConnection 行動（Python：更新連接）

更新 Data Catalog 中的連線定義。

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線所在的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • Name – 必要：UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合Single-line string pattern。

    欲更新的連線定義的名稱。

  • ConnectionInput – 必要：ConnectionInput 物件。

    用於重新定義有問題的連線的 ConnectionInput 物件。

回應

  • 無回應參數。

錯誤

  • InvalidInputException

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

BatchDeleteConnection 行動（Python：批處理刪除連接）

從 Data Catalog 刪除連線定義清單。

請求

  • CatalogId – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    連線所在的 Data Catalog 之 ID。如果未提供任何內容，則預設會使用 AWS 帳號 ID。

  • ConnectionNameList – 必要：UTF-8 字串的陣列，不可超過 25 個字串。

    欲刪除的連線名稱的清單。

回應

  • Succeeded – UTF-8 字串陣列。

    已成功刪除的連線定義名稱清單。

  • Errors – 金鑰值對的映射陣列。

    每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合Single-line string pattern。

    每個值都是 ErrorDetail 物件。

    未成功刪除的連線名稱與錯誤詳細資訊的映射。

錯誤

  • InternalServiceException

  • OperationTimeoutException

驗證組態

AuthenticationConfiguration 結構

包含驗證組態的結構。

欄位

  • AuthenticationType – UTF-8 字串 (有效值：BASIC | OAUTH2 | CUSTOM)。

    包含驗證組態的結構。

  • SecretArn – UTF-8 字串，需符合Custom string pattern #11。

    秘密管理器 ARN 存儲憑據。

  • OAuth2Properties – OAuth2Properties 物件。

    OAuth2 驗證的內容。

AuthenticationConfigurationInput 結構

包含 CreateConnection要求中驗證組態的結構。

欄位

  • AuthenticationType – UTF-8 字串 (有效值：BASIC | OAUTH2 | CUSTOM)。

    包含 CreateConnection要求中驗證組態的結構。

  • SecretArn – UTF-8 字串，需符合Custom string pattern #11。

    秘密管理器 ARN 在 CreateConnection 請求中存儲憑據。

  • OAuth2Properties – OAuth2 PropertiesInput 物件。

    要求中 OAuth2 驗證的 CreateConnection 內容。

物業結構

包含 OAuth2 驗證之屬性的結構。

欄位

  • OAuth2GrantType – UTF-8 字串 (有效值：AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER)。

    OAuth2 授權類型。例如，AUTHORIZATION_CODE、JWT_BEARER 或 CLIENT_CREDENTIALS。

  • OAuth2ClientApplication – OAuth2 ClientApplication 物件。

    用戶端應用程式類型。例如，AW_ 受管或使用者管理。

  • TokenUrl – UTF-8 字串，長度不可超過 256 個位元組，且需符合 Custom string pattern #12。

    提供程序的身份驗證服務器的 URL，用於交換訪問令牌的授權代碼。

  • TokenUrlParametersMap – 金鑰值對的映射陣列。

    每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。

    每個值都是一個 UTF-8 字符串，長度不小於 1 個或大於 512 字節。

    新增至權杖GET要求的參數對映。

OAuth2 PropertiesInput 結構

包含要 CreateConnection求中 OAuth2 屬性的結構。

欄位

  • OAuth2GrantType – UTF-8 字串 (有效值：AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER)。

    要求中的 OAuth2 授與類型。 CreateConnection 例如，AUTHORIZATION_CODE、JWT_BEARER 或 CLIENT_CREDENTIALS。

  • OAuth2ClientApplication – OAuth2 ClientApplication 物件。

    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 – AuthorizationCode性質 物件。

    OAuth2 AUTHORIZATION_CODE 授權類型所需的屬性集。

OAuth2 ClientApplication 結構

用於連接的 OAuth2 客戶端應用程序。

欄位

  • UserManagedClientApplicationClientId – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 Custom string pattern #13。

    用戶端應用程式 clientID 如果是 ClientAppType )。USER_MANAGED

  • AWSManagedClientApplicationReference – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 Custom string pattern #13。

    受管理的 SaaS 端用戶端應用程式的參考。 AWS

AuthorizationCodeProperties 結構

OAuth2 AUTHORIZATION_CODE 授與類型工作流程所需的屬性集。

欄位

  • AuthorizationCode— UTF-8 字串，長度不小於 1 或超過 4096 個位元組，符合Custom string pattern #13.

    在授權工作流程的第三階段使用的AUTHORIZATION_CODE授權碼。這是一個單次使用的代碼，一旦交換了訪問令牌，就會變為無效，因此將此值作為請求參數是可以接受的。

  • RedirectUri— UTF-8 字串，長度不超過 512 個位元組，符合Custom string pattern #14.

    發出授權代碼時，用戶被授權服務器重定向到的重定向 URI。當授權代碼交換為訪問令牌時，隨後使用 URI。