連接 API

• Connection 結構

• ConnectionInput 結構

• PhysicalConnectionRequirements 結構

• GetConnectionsFilter 結構

欄位

• Name— UTF -8 個字串，長度不小於 1 或超過 255 個位元組，符合Single-line string pattern.

  連線定義的名稱。

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

  此連接的描述。

• ConnectionType-UTF -8 字符串（有效值：JDBCSFTPMONGODB| KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA）。

  連線的類型。目前不支援 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 | REGION WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE）。

  每個值都是 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 簡易儲存服務 (Amazon S3) 路徑。

  • JDBC_DRIVER_CLASS_NAME-要使用的JDBC驅動程式類別名稱。

  • JDBC_ENGINE-要使用的JDBC引擎名稱。

  • JDBC_ENGINE_VERSION-要使用的JDBC引擎版本。

  • CONFIG_FILES - (保留以供日後使用)。

  • INSTANCE_ID- 要使用的執行個體 ID。

  • JDBC_CONNECTION_URL-用URL於連接到數JDBC據源的。

  • JDBC_ENFORCE_SSL-一個布林字串 (true, false)，指定是否針對用戶端上的JDBC連線強制執行具有主機名稱比對的安全通訊端層 (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 服務器中，這被用作hostNameInCertificate.

  • CONNECTION_URL-用URL於連線至一般 (非JDBC) 資料來源的。

  • SECRET_ID - 用於憑證的秘密管理器的秘密 ID。

  • CONNECTOR_URL-URL 用於MARKETPLACE或CUSTOM連接的連接器。

  • CONNECTOR_TYPE-MARKETPLACE 或連接的CUSTOM連接器類型。

  • CONNECTOR_CLASS_NAME-MARKETPLACE 或連接的CUSTOM連接器類別名稱。

  • KAFKA_BOOTSTRAP_SERVERS - 主機和連接埠對的逗號分隔清單，列出 Kafka 叢集中 Kafka 用戶端即將連線以引導自身的 Apache Kafka 中介裝置地址。

  • KAFKA_SSL_ENABLED-是否啟用或禁用SSL阿帕奇卡夫卡連接。預設值為 "true"。

  • KAFKA_CUSTOM_CERT-URL 用於私有 CA 憑證檔案的 Amazon S3 (.pem 格式)。預設為空字串。

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION-是否跳過 CA 憑證檔案的驗證。 AWS Glue 驗證三種演算法：SHA256withRSA、SHA384withRSA和SHA512withRSA。預設值為 "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-卡夫卡密碼的加SASLPLAIN密版本（如果使用者已選擇 AWS Glue 加密密碼設定）。

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

  • KAFKA_SASL_SCRAM_PASSWORD-用於透過 "SCRAM-512" 機制進行驗證的純文字密碼。SHA

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

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

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

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

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

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

  • ROLE_ARN-用於執行查詢的角色。

  • REGION-將執行查詢的 AWS 區域。

  • WORKGROUP_NAME-將在其中執行查詢的 Amazon Redshift 無伺服器工作群組或 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 字符串（有效值：READYIN_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 字串 (有效值：JDBCSFTPMONGODB| KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA)。

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

  • 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。這些參數可用來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-使OAuth用驗證指定與 Salesforce 的連線。

    • 需要設定AuthenticationConfiguration成員。

  • VIEW_VALIDATION_REDSHIFT-指定 Amazon Redshift 用於檢視驗證的連線。

  • VIEW_VALIDATION_ATHENA-指定由 Amazon Athena 用於檢視驗證的連線。

  • NETWORK-指定與 Amazon 虛擬私有雲環境 (AmazonVPC) 內資料來源的網路連線。

    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 | REGION WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE）。

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

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

• PhysicalConnectionRequirements – PhysicalConnectionRequirements 物件。

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

• AuthenticationConfiguration – AuthenticationConfigurationInput 物件。

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

• ValidateCredentials – 布林值。

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

欄位

• 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 字符串（有效值：JDBCSFTPMONGODB| KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA）。

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

• CreateConnection 動作（Python：創建連接）

• DeleteConnection 行動（Python：刪除連接）

• GetConnection 行動（Python：獲取連接）

• GetConnections 行動（Python：獲取連接）

• UpdateConnection 行動（Python：更新連接）

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

請求

• 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 字符串（有效值：READYIN_PROGRESS| |FAILED）。

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

錯誤

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

請求

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

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

• ConnectionName— 必要：UTF-8 個字串，長度不小於 1 或超過 255 個位元組，符合Single-line string pattern.

  欲刪除的連線的名稱。

回應

• 無回應參數。

錯誤

• EntityNotFoundException

• OperationTimeoutException

請求

• 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

請求

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

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

• Filter – GetConnectionsFilter 物件。

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

• HidePassword – 布林值。

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

• NextToken— UTF -8 個字符串。

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

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

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

回應

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

  要求的連線定義的清單。

• NextToken— UTF -8 個字符串。

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

錯誤

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

請求

• 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

請求

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

• AuthenticationConfigurationInput 結構

• OAuth2Properties結構

• OAuth2PropertiesInput結構

• OAuth2ClientApplication結構

• AuthorizationCodeProperties 結構

欄位

• AuthenticationType-UTF -8 字符串（有效值：BASICOAUTH2| |CUSTOM）。

  包含驗證組態的結構。

• SecretArn-UTF -8 字符串，匹配Custom string pattern #11.

  存儲憑據的秘密管理器ARN。

• OAuth2Properties – OAuth2Properties 物件。

  OAuth2驗證的屬性。

欄位

• AuthenticationType-UTF -8 字符串（有效值：BASICOAUTH2| |CUSTOM）。

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

• SecretArn-UTF -8 字符串，匹配Custom string pattern #11.

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

• OAuth2Properties – OAuth2PropertiesInput 物件。

  CreateConnection 要求中OAuth2驗證的屬性。

欄位

• OAuth2GrantType-UTF -8 字符串（有效值：AUTHORIZATION_CODECLIENT_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_CODECLIENT_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 物件。

  OAuth2AUTHORIZATION_CODE授權類型所需的一組屬性。

欄位

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

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

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

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

欄位

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

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

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

  發出授權碼時，用戶被授權服務器重定向URI到的重定向。隨後URI在授權碼交換為存取權杖時使用。