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

# 連線 API
<a name="aws-glue-api-catalog-connections-connections"></a>

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

## 資料類型
<a name="aws-glue-api-catalog-connections-connections-objects"></a>
+ [Connection 結構](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput 結構](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput 結構](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements 結構](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter 結構](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput 結構](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Properties 結構](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput 結構](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication 結構](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties 結構](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials 結構](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Credentials 結構](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)

## Connection 結構
<a name="aws-glue-api-catalog-connections-connections-Connection"></a>

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

**欄位**
+ `Name` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線定義的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此連接的描述。
+ `ConnectionType` – UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` `NETWORK` \$1 `MARKETPLACE` `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 \$1 \$1 \$1 \$1 \$1 `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 \$1 \$1 \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 \$1 \$1 `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \$1 `WOOCOMMERCE` \$1 \$1 `INTERCOM` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` `OPENSEARCH` \$1 \$1 `PIPEDRIVE` \$1 \$1 \$1 \$1 `POSTGRESQL` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`

  連線的類型。目前不支援 SFTP。
+ `MatchCriteria` – UTF-8 字串的陣列，不可超過 10 個字串。

  用於選擇此連線的條件清單。
+ `ConnectionProperties` – 金鑰值對的對應陣列，不超過 100 對

  每個金鑰均是 UTF-8 字串 (有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。

  每個值均為值字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組。

  這些金鑰值對定義使用第 1 版連線結構描述時的連線參數：
  + `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` - 自訂 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` - 是否略過 AWS Glue 三種演算法的 CA 憑證檔案驗證：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 機制](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml)。
  + `KAFKA_SASL_PLAIN_USERNAME` - 用於藉助 "PLAIN" 機制進行身分驗證的純文字使用者名稱。
  + `KAFKA_SASL_PLAIN_PASSWORD` - 用於藉助 "PLAIN" 機制進行身分驗證的純文字密碼。
  + `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` - Kafka SASL PLAIN 密碼的加密版本 （如果使用者已選取 AWS Glue 加密密碼設定）。
  + `KAFKA_SASL_SCRAM_USERNAME` - 用於藉助 "SCRAM-SHA-512" 機制進行身分驗證的純文字使用者名稱。
  + `KAFKA_SASL_SCRAM_PASSWORD` - 用於藉助 "SCRAM-SHA-512" 機制進行身分驗證的純文字密碼。
  + `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` - Kafka SASL SCRAM 密碼的加密版本 （如果使用者已選取 AWS Glue 加密密碼設定）。
  + `KAFKA_SASL_SCRAM_SECRETS_ARN` - AWS Secrets Manager 中秘密的 Amazon Resource Name。
  + `KAFKA_SASL_GSSAPI_KEYTAB` - Kerberos `keytab` 檔案的 S3 位置。Keytab 存放了一個或多個主體的長期金鑰。如需詳細資訊，請參閱 [MIT Kerberos 文件：Keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html)。
  + `KAFKA_SASL_GSSAPI_KRB5_CONF` - Kerberos `krb5.conf` 檔案的 S3 位置。krb5.conf 存放了 Kerberos 組態資訊，例如 KDC 伺服器的位置。如需詳細資訊，請參閱 [MIT Kerberos 文件：krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html)。
  + `KAFKA_SASL_GSSAPI_SERVICE` - Kerberos 服務名稱，如在 [Kafka 配置](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name)使用 `sasl.kerberos.service.name` 進行設定。
  + `KAFKA_SASL_GSSAPI_PRINCIPAL` - 所使用的 Kerberos 權限名稱 AWS Glue。如需詳細資訊，請參閱 [Kafka 文件：設定 Kafka 代理程式](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig)。
  + `ROLE_ARN` - 用於執行查詢的角色。
  + `REGION` - 將執行查詢 AWS 的區域。
  + `WORKGROUP_NAME` - 將在其中執行查詢的 Amazon Redshift 無伺服器工作群組或 Amazon Athena 工作群組的名稱。
  + `CLUSTER_IDENTIFIER` - 將在其中執行查詢的 Amazon Redshift 叢集的叢集識別碼。
  + `DATABASE` - 您要連線的 Amazon Redshift 資料庫。
+ `SparkProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Spark 運算環境特定的連線屬性。
+ `AthenaProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Athena 運算環境特定的連線屬性。
+ `PythonProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Python 運算環境特定的連線屬性。
+ `PhysicalConnectionRequirements` – [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) 物件。

  成功建立此連線所需的實體連線需求，例如虛擬私有雲端 (VPC) 和 `SecurityGroup`。
+ `CreationTime` – 時間戳記。

  建立此連線定義的時間的時間戳記。
+ `LastUpdatedTime` – 時間戳記。

  上次更新連線定義的時間戳記。
+ `LastUpdatedBy` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  上一次更新此連線定義的使用者、群組或角色。
+ `Status` – UTF-8 字串 (有效值：`READY` \$1 `IN_PROGRESS` \$1 `FAILED`)。

  連線狀態。可以是下列其中一個：`READY`、`IN_PROGRESS` 或 `FAILED`。
+ `StatusReason` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 16384 個位元組。

  連線狀態的原因。
+ `LastConnectionValidationTime` – 時間戳記。

  上次驗證此連線的時間的時間戳記。
+ `AuthenticationConfiguration` – [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration) 物件。

  連線的身分驗證屬性。
+ `ConnectionSchemaVersion` – 數字 （整數），不可小於 1 或大於 2。

  此連線的連線結構描述版本。第 2 版支援特定運算環境的屬性。
+ `CompatibleComputeEnvironments` – UTF-8 字串陣列。

  與連線相容的運算環境的清單。

## ConnectionInput 結構
<a name="aws-glue-api-catalog-connections-connections-ConnectionInput"></a>

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

**欄位**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線的名稱。
+ `Description` – 描述字串，長度不可超過 2048 個位元組，需符合[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri)。

  此連接的描述。
+ `ConnectionType` – *必要：*UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` `KAFKA` \$1 `NETWORK` `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 \$1 \$1 \$1 \$1 \$1 `INSTAGRAMADS` \$1 `GOOGLESHEETS` `GOOGLEANALYTICS4` `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` \$1 \$1 \$1 `ZOHOCRM` \$1 \$1 \$1 \$1 `SALESFORCEPARDOT` `SALESFORCEMARKETINGCLOUD` `ADOBEANALYTICS` `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` \$1 `SMARTSHEET` \$1 \$1 `DATADOG` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` \$1 \$1 \$1 `OPENSEARCH` \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `PIPEDRIVE` `POSTGRESQL` `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`

  連線的類型。目前支援這些類型：
  + `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`。
  + `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原生支援。

  如需特定連接器所需連線參數的詳細資訊，請參閱 AWS Glue 《 使用者指南》中的[新增 AWS Glue 連線](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html)中的連接器文件。

  不支援 `SFTP`。

  如需如何使用選用 ConnectionProperties 在 中設定功能的詳細資訊 AWS Glue，請參閱[AWS Glue 連線屬性](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html)。

  如需如何使用選用 ConnectionProperties 在 AWS Glue Studio 中設定功能的詳細資訊，請參閱[使用連接器和連線](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html)。
+ `MatchCriteria` – UTF-8 字串的陣列，不可超過 10 個字串。

  用於選擇此連線的條件清單。
+ `ConnectionProperties` – *必要：*索引鍵/值對的映射陣列，不可超過 100 對。

  每個金鑰均是 UTF-8 字串 (有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。

  每個值均為值字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組。

  這些金鑰值對會定義連線的參數。
+ `SparkProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Spark 運算環境特定的連線屬性。
+ `AthenaProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Athena 運算環境特定的連線屬性。
+ `PythonProperties` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  Python 運算環境特定的連線屬性。
+ `PhysicalConnectionRequirements` – [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements) 物件。

  成功建立此連線所需的實體連線需求，例如虛擬私有雲端 (VPC) 和 `SecurityGroup`。
+ `AuthenticationConfiguration` – [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) 物件。

  連線的身分驗證屬性。
+ `ValidateCredentials` – 布林值。

  在建立連線期間驗證憑證的旗標。預設為 true。
+ `ValidateForComputeEnvironments` – UTF-8 字串陣列。

  驗證指定連線屬性的運算環境。

## TestConnectionInput 結構
<a name="aws-glue-api-catalog-connections-connections-TestConnectionInput"></a>

用於指定測試服務的連線的結構。

**欄位**
+ `ConnectionType` – *必要：*UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` `KAFKA` \$1 `NETWORK` `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$1 `GOOGLEADS` \$1 \$1 \$1 \$1 \$1 `GOOGLESHEETS` `GOOGLEANALYTICS4` `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` \$1 \$1 `INSTAGRAMADS` \$1 \$1 \$1 `ZOHOCRM` \$1 \$1 \$1 \$1 `SALESFORCEPARDOT` `SALESFORCEMARKETINGCLOUD` `ADOBEANALYTICS` `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` \$1 `SMARTSHEET` \$1 \$1 `DATADOG` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` `DYNATRACE` `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` \$1 \$1 \$1 \$1 \$1 \$1 `OPENSEARCH` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` `PIPEDRIVE` `POSTGRESQL` `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`

  要測試的連線類型。此操作僅適用於 `JDBC` 或 `SALESFORCE` 連線類型。
+ `ConnectionProperties` – *必要：*索引鍵/值對的映射陣列，不可超過 100 對。

  每個金鑰均是 UTF-8 字串 (有效值：`HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`)。

  每個值均為值字串，長度不可小於 1 個位元組，也不可以超過 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`。這些參數用於使用 JDBC 設定 SSL。

  SALESFORCE 連線需要設定 `AuthenticationConfiguration` 成員。
+ `AuthenticationConfiguration` – [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput) 物件。

  包含 TestConnection 請求中身分驗證組態的結構。使用 OAuth 身分驗證連線至 Salesforce 時需要。

## PhysicalConnectionRequirements 結構
<a name="aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements"></a>

GetConnection 回應中的 OAuth 用戶端應用程式。

**欄位**
+ `SubnetId` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線使用的子網路 ID。
+ `SecurityGroupIdList` – UTF-8 字串的陣列，不可超過 50 個字串。

  連線使用的安全群組 ID 清單。
+ `AvailabilityZone` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線的可用區域。

## GetConnectionsFilter 結構
<a name="aws-glue-api-catalog-connections-connections-GetConnectionsFilter"></a>

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

**欄位**
+ `MatchCriteria` – UTF-8 字串的陣列，不可超過 10 個字串。

  條件字串必須符合連線定義中記錄的條件，才能傳回該連線定義。
+ `ConnectionType` – UTF-8 字串 （有效值： `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` `NETWORK` \$1 `MARKETPLACE` `CUSTOM` \$1 `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 \$1 \$1 \$1 \$1 `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \$1 \$1 `SALESFORCEPARDOT` \$1 \$1 `SALESFORCEMARKETINGCLOUD` \$1 \$1 `ADOBEANALYTICS` \$1 \$1 \$1 `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \$1 \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` \$1 `DYNATRACE` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `ORACLE` \$1 \$1 \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` `MICROSOFTTEAMS` `BLACKBAUDRAISEREDGENXT` `MAILCHIMP` `GITLAB` `PENDO` `PRODUCTBOARD` `CIRCLECI` `PIPEDIVE` `SENDGRID` `AZURECOSMOS` `AZURESQL` `BIGQUERY` `BLACKBAUD` `CLOUDERAHIVE` `CLOUDERAIMPALA` `CLOUDWATCH` `CLOUDWATCHMETRICS` `CMDB` `DATALAKEGEN2` `DB2` `DB2AS400` `DOCUMENTDB` `DOMO` `DYNAMODB` `GOOGLECLOUDSTORAGE` `HBASE` `KUSTOMER` `MICROSOFTDYNAMICS365CRM` `MONDAY` `MYSQL` `OKTA` `OPENSEARCH` \$1 \$1 \$1 `PIPEDRIVE` \$1 \$1 \$1 `POSTGRESQL` \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 \$1 `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`

  傳回的連線類型。目前不支援 SFTP。
+ `ConnectionSchemaVersion` – 數字 （整數），不可小於 1 或大於 2。

  表示連線是使用結構描述第 1 版還是第 2 版建立。

## AuthenticationConfiguration
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfiguration"></a>

包含身分驗證組態的結構。

**欄位**
+ `AuthenticationType` – UTF-8 字串 (有效值：`BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`)。

  包含身分驗證組態的結構。
+ `SecretArn` – UTF-8 字串，需符合[Custom string pattern #36](aws-glue-api-common.md#regex_36)。

  用於儲存憑證的 Secret Manager ARN。
+ `KmsKeyArn` – UTF-8 字串，需符合[Custom string pattern #42](aws-glue-api-common.md#regex_42)。

  用於加密敏感身分驗證資訊的 KMS 金鑰的 Amazon Resource Name (ARN)。此金鑰用於保護儲存在身分驗證組態中的憑證和其他敏感資料。
+ `OAuth2Properties` – [OAuth2Properties](#aws-glue-api-catalog-connections-connections-OAuth2Properties) 物件。

  OAuth2 身分驗證的屬性。

## AuthenticationConfigurationInput 結構
<a name="aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput"></a>

CreateConnection 請求中包含身分驗證組態的結構。

**欄位**
+ `AuthenticationType` – UTF-8 字串 (有效值：`BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`)。

  CreateConnection 請求中包含身分驗證組態的結構。
+ `OAuth2Properties` – [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput) 物件。

  CreateConnection 請求中的 OAuth2 身分驗證的屬性。
+ `SecretArn` – UTF-8 字串，需符合[Custom string pattern #36](aws-glue-api-common.md#regex_36)。

  用於在 CreateConnection 請求中儲存憑證的 Secret Manager ARN。
+ `KmsKeyArn` – UTF-8 字串，需符合[Custom string pattern #42](aws-glue-api-common.md#regex_42)。

  用於加密連線的 KMS 金鑰的 ARN。僅作為請求中的輸入並儲存在 Secret Manager 中。
+ `BasicAuthenticationCredentials` – [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials) 物件。

  身分驗證類型為基本身分驗證時使用的憑證。
+ `CustomAuthenticationCredentials` – 金鑰值對的映射陣列。

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

  每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2,048 個位元組。

  身分驗證類型為自訂身分驗證時使用的憑證。

## OAuth2Properties 結構
<a name="aws-glue-api-catalog-connections-connections-OAuth2Properties"></a>

包含 OAuth2 身分驗證屬性的結構。

**欄位**
+ `OAuth2GrantType` – UTF-8 字串 (有效值：`AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`)。

  OAuth2 授權類型。例如，`AUTHORIZATION_CODE`、`JWT_BEARER` 或 `CLIENT_CREDENTIALS`。
+ `OAuth2ClientApplication` – [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) 物件。

  用戶端應用程式類型。例如，AWS\$1MANAGED 或 USER\$1MANAGED。
+ `TokenUrl` – UTF-8 字串，長度不可超過 256 個位元組，且需符合 [Custom string pattern #40](aws-glue-api-common.md#regex_40)。

  供應商身分驗證伺服器的 URL，用於交換存取字符的授權碼。
+ `TokenUrlParametersMap` – 金鑰值對的映射陣列。

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

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

  新增至字符 `GET` 請求的參數映射。

## OAuth2PropertiesInput 結構
<a name="aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput"></a>

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

**欄位**
+ `OAuth2GrantType` – UTF-8 字串 (有效值：`AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`)。

  CreateConnection 請求中的 OAuth2 授權類型。例如，`AUTHORIZATION_CODE`、`JWT_BEARER` 或 `CLIENT_CREDENTIALS`。
+ `OAuth2ClientApplication` – [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication) 物件。

  CreateConnection 請求中的用戶端應用程式類型。例如 `AWS_MANAGED` 或 `USER_MANAGED`。
+ `TokenUrl` – UTF-8 字串，長度不可超過 256 個位元組，且需符合 [Custom string pattern #40](aws-glue-api-common.md#regex_40)。

  供應商身分驗證伺服器的 URL，用於交換存取字符的授權碼。
+ `TokenUrlParametersMap` – 金鑰值對的映射陣列。

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

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

  新增至字符 `GET` 請求的參數映射。
+ `AuthorizationCodeProperties` – [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties) 物件。

  OAuth2 `AUTHORIZATION_CODE` 授權類型所需的屬性集。
+ `OAuth2Credentials` – [OAuth2Credentials](#aws-glue-api-catalog-connections-connections-OAuth2Credentials) 物件。

  身分驗證類型為 OAuth2 身分驗證時使用的憑證。

## OAuth2ClientApplication 結構
<a name="aws-glue-api-catalog-connections-connections-OAuth2ClientApplication"></a>

用於連線的 OAuth2 用戶端應用程式。

**欄位**
+ `UserManagedClientApplicationClientId` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [Custom string pattern #37](aws-glue-api-common.md#regex_37)。

  用戶端應用程式 clientID (如果 ClientAppType 為 `USER_MANAGED`)。
+ `AWSManagedClientApplicationReference` – UTF-8 字串，長度不可超過 2048 個位元組，且需符合 [Custom string pattern #37](aws-glue-api-common.md#regex_37)。

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

## AuthorizationCodeProperties 結構
<a name="aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties"></a>

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

**欄位**
+ `AuthorizationCode` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 4096 個位元組，需符合 [Custom string pattern #37](aws-glue-api-common.md#regex_37)。

  在 `AUTHORIZATION_CODE` 授權工作流程的第三階段中使用的授權碼。這是單次使用的程式碼，一旦交換存取字符就會失效，因此可以接受此值作為請求參數。
+ `RedirectUri` – UTF-8 字串，長度不可超過 512 個位元組，需符合 [Custom string pattern #41](aws-glue-api-common.md#regex_41)。

  使用者在發出授權碼時被授權伺服器重新導向至的重新導向 URI。授權碼交換為存取字符時，會接著使用 URI。

## BasicAuthenticationCredentials 結構
<a name="aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials"></a>

用於在未提供 `SecretArn` 值時提供基本身分驗證憑證。

**欄位**
+ `Username` – UTF-8 字串，長度不可超過 512 個位元組，需符合 [Custom string pattern #37](aws-glue-api-common.md#regex_37)。

  連線至資料來源的使用者名稱。
+ `Password` – UTF-8 字串，長度不可超過 512 個位元組，需符合 [Custom string pattern #33](aws-glue-api-common.md#regex_33)。

  連線至資料來源的密碼。

## OAuth2Credentials 結構
<a name="aws-glue-api-catalog-connections-connections-OAuth2Credentials"></a>

身分驗證類型為 OAuth2 身分驗證時使用的憑證。

**欄位**
+ `UserManagedClientApplicationClientSecret` – UTF-8 字串，長度不可超過 512 個位元組，需符合 [Custom string pattern #38](aws-glue-api-common.md#regex_38)。

  用戶端應用程式用戶端機密 (如果用戶端應用程式由使用者管理)。
+ `AccessToken` – UTF-8 字串，長度不可超過 4096 個位元組，需符合 [Custom string pattern #38](aws-glue-api-common.md#regex_38)。

  身分驗證類型為 OAuth2 時使用的存取字符。
+ `RefreshToken` – UTF-8 字串，長度不可超過 4096 個位元組，需符合 [Custom string pattern #38](aws-glue-api-common.md#regex_38)。

  身分驗證類型為 OAuth2 時使用的重新整理字符。
+ `JwtToken` – UTF-8 字串，長度不可超過 8000 個位元組，需符合 [Custom string pattern #39](aws-glue-api-common.md#regex_39)。

  當身分驗證類型為 OAuth2 時使用的 JSON Web Token (JWT)。

## 作業
<a name="aws-glue-api-catalog-connections-connections-actions"></a>
+ [CreateConnection 動作 (Python: create\$1connection)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection 動作 (Python: delete\$1connection)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection 動作 (Python: get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections 動作 (Python: get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection 動作 (Python: update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection 動作 (Python：test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection 動作 (Python: batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)

## CreateConnection 動作 (Python: create\$1connection)
<a name="aws-glue-api-catalog-connections-connections-CreateConnection"></a>

在 Data Catalog 中建立連線定義。

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

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  用於建立連線的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `ConnectionInput` – *必要：*[ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) 物件。

  用於定義所要建立的連線的 `ConnectionInput` 物件。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。

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

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

  指派給連線的標籤。

**回應**
+ `CreateConnectionStatus` – UTF-8 字串 (有效值：`READY` \$1 `IN_PROGRESS` \$1 `FAILED`)。

  連線建立請求的狀態。對於某些身分驗證類型，請求可能需要一些時間，例如在透過 VPC 建立具有字符交換的 OAuth 連線時。

**錯誤**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`

## DeleteConnection 動作 (Python: delete\$1connection)
<a name="aws-glue-api-catalog-connections-connections-DeleteConnection"></a>

從 Data Catalog 刪除連線。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `ConnectionName` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欲刪除的連線的名稱。

**回應**
+ *無回應參數。*

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`

## GetConnection 動作 (Python: get\$1connection)
<a name="aws-glue-api-catalog-connections-connections-GetConnection"></a>

從 Data Catalog 擷取連線定義

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欲擷取的連線定義的名稱。
+ `HidePassword` – 布林值。

  可讓您擷取連線中繼資料，無需傳回密碼。例如， AWS Glue 主控台會使用此旗標來擷取連線，而不會顯示密碼。當發起人可能沒有使用 AWS KMS 金鑰解密密碼的許可，但確實具有存取其餘連線屬性的許可時，請設定此參數。
+ `ApplyOverrideForComputeEnvironment` – UTF-8 字串 (有效值：`SPARK` \$1 `ATHENA` \$1 `PYTHON`)。

  對於可能在多個服務中使用的連線，指定所指定運算環境的傳回屬性。

**回應**
+ `Connection` – [連線](#aws-glue-api-catalog-connections-connections-Connection) 物件。

  要求的連線定義。

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## GetConnections 動作 (Python: get\$1connections)
<a name="aws-glue-api-catalog-connections-connections-GetConnections"></a>

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

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Filter` – [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter) 物件。

  用於控制將傳回哪些連線的篩選條件。
+ `HidePassword` – 布林值。

  可讓您擷取連線中繼資料，無需傳回密碼。例如， AWS Glue 主控台會使用此旗標來擷取連線，而不會顯示密碼。當發起人可能沒有使用 AWS KMS 金鑰解密密碼的許可，但確實具有存取其餘連線屬性的許可時，請設定此參數。
+ `NextToken` – UTF-8 字串。

  接續符記，如果這是接續呼叫。
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。

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

**回應**
+ `ConnectionList` – 一個 [連線](#aws-glue-api-catalog-connections-connections-Connection) 物件陣列。

  要求的連線定義的清單。
+ `NextToken` – UTF-8 字串。

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

**錯誤**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## UpdateConnection 動作 (Python: update\$1connection)
<a name="aws-glue-api-catalog-connections-connections-UpdateConnection"></a>

更新 Data Catalog 中的連線定義。

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  欲更新的連線定義的名稱。
+ `ConnectionInput` – *必要：*[ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput) 物件。

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

**回應**
+ *無回應參數。*

**錯誤**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`

## TestConnection 動作 (Python：test\$1connection)
<a name="aws-glue-api-catalog-connections-connections-TestConnection"></a>

測試服務的連線，以驗證您提供的服務憑證。

您可以提供現有的連線名稱或 `TestConnectionInput` 來測試不存在的連線輸入。同時提供兩者會導致錯誤。

如果動作成功，則服務傳回 HTTP 200 回應。

**請求**
+ `ConnectionName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  選用。測試連線的名稱。如果僅提供名稱，操作會取得連線並使用其進行測試。
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的目錄 ID。
+ `TestConnectionInput` – [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput) 物件。

  用於指定測試服務的連線的結構。

**回應**
+ *無回應參數。*

**錯誤**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`

## BatchDeleteConnection 動作 (Python: batch\$1delete\$1connection)
<a name="aws-glue-api-catalog-connections-connections-BatchDeleteConnection"></a>

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

**請求**
+ `CatalogId` – 目錄 ID 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  連線所在的 Data Catalog 之 ID。如果未提供，預設會使用 AWS 帳戶 ID。
+ `ConnectionNameList` – *必要：*UTF-8 字串的陣列，不可超過 25 個字串。

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

**回應**
+ `Succeeded` – UTF-8 字串陣列。

  已成功刪除的連線定義名稱清單。
+ `Errors` – 金鑰值對的映射陣列。

  每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。

  每個值都是 [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail) 物件。

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

**錯誤**
+ `InternalServiceException`
+ `OperationTimeoutException`