連線 API

• Connection 結構

• 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 | | 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 | | KAFKA_SASL_PLAIN_USERNAME | 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_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | | REGION | | 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 | | 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 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 - 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 - 用於網域比對或辨別名稱比對的自訂JDBC憑證字串，以防止 man-in-the-middle攻擊。在 Oracle 資料庫中，這用作 SSL_SERVER_CERT_DN；在 Microsoft SQL Server 中，這用作 hostNameInCertificate。

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

  • 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 憑證檔案URL的 Amazon S3 （.pem 格式）。預設為空字串。

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION - 是否略過 CA 憑證檔案的驗證，或針對三種演算法的 not. AWS Glue validates：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"、"AWS_MSK_IAM"、 "GSSAPI"或 "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 Resource Name。

  • 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 代理程式。

  • 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 字串 （有效值： 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 連線屬性 。

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

• 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 | | 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 | | KAFKA_SASL_PLAIN_USERNAME | 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_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | | REGION | | 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 | | WORKGROUP_NAME | | | | | | CLUSTER_IDENTIFIER | | | | |）DATABASE。

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

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

• PhysicalConnectionRequirements – PhysicalConnectionRequirements 物件。

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

• 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 | | 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 | | KAFKA_SASL_PLAIN_USERNAME | 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_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | KAFKA_SASL_SCRAM_USERNAME | | REGION | | 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 | | WORKGROUP_NAME | | | | | | CLUSTER_IDENTIFIER | | | | |）DATABASE。

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

  定義連線參數的鍵值對。

  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：creat_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。

  用於建立連線的 Data Catalog 之 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。

  連線所在的 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

請求

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

  連線所在的 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 字串 （有效值： 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授予工作流程的第三個部分中使用的授權碼。這是單次使用的程式碼，一旦交換存取權杖就會變成無效，因此將此值作為請求參數是可接受的。

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

  使用者在發出授權碼時，由授權伺服器URI重新導向的重新導向。URI 隨後會在授權碼交換為存取權杖時使用 。