本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
# 連線類型 API
Connection Type API 說明用於註冊、描述、刪除和列出連線類型的 AWS Glue API。
## Connection Management API
+ [RegisterConnectionType 動作 (Python：register\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-RegisterConnectionType)
+ [DeleteConnectionType 動作 (Python：Delete\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DeleteConnectionType)
+ [DescribeConnectionType 動作 (Python：describe\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes 動作 (Python：list\_connection\_types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief 結構](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant 結構](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
## RegisterConnectionType 動作 (Python：register\_connection\_type)
AWS Glue 根據提供的組態，在 中註冊自訂連線類型。此操作可讓客戶使用 REST 型 APIs 為任何資料來源設定自訂連接器，無需建置自訂 Lambda 連接器。
註冊的連線類型會儲存 REST 來源如何解譯請求和回應的詳細資訊，包括連線屬性、身分驗證組態，以及具有實體定義的 REST 組態。註冊後，客戶可以使用此連線類型建立連線，並以與原生支援的 AWS Glue 連接器相同的方式使用。
支援多種身分驗證類型，包括基本、OAuth2 （用戶端登入資料、JWT 承載、授權碼） 和自訂身分驗證組態。
**請求**
+ `ConnectionType` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。
連線類型的名稱。必須介於 1 到 255 個字元之間，且字首必須加上 "REST-"，以表示它是以 REST 為基礎的 connector。
+ `IntegrationType` – *必要：*UTF-8 字串 (有效值：`REST`)。
連線的整合類型。目前僅支援「REST」通訊協定。
+ `Description` – UTF-8 字串，長度不可超過 1024 個位元組。
連線類型的描述。最多可達 2048 個字元，並提供連線類型用途和功能的詳細資訊。
+ `ConnectionProperties` – *必要：*[ConnectionPropertiesConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration) 物件。
定義此連線類型建立連線期間所需的基本 URL 和其他請求參數。
+ `ConnectorAuthenticationConfiguration` – *必要：*[ConnectorAuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration) 物件。
定義此連線類型的支援身分驗證類型和必要屬性，包括基本、OAuth2 和自訂身分驗證方法。
+ `RestConfiguration` – *必要：*[RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration) 物件。
定義 REST API 互動的 HTTP 請求和回應組態、驗證端點和實體組態。
+ `Tags` – 金鑰值對的映射陣列，不超過 50 對。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 UTF-8 字串，長度不可超過 256 個位元組。
您指派給連線類型的標籤。
**回應**
包含新註冊連線類型的 Amazon Resource Name (ARN)。
+ `ConnectionTypeArn` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 10240 個位元組，且需符合 [Custom string pattern #47](aws-glue-api-common.md#regex_47)。
已註冊連線類型的 Amazon Resource Name (ARN)。此唯一識別符可用於參考其他 AWS Glue 操作中的連線類型。
**錯誤**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
## DeleteConnectionType 動作 (Python：Delete\_connection\_type)
在 中刪除自訂連線類型 AWS Glue。
連線類型必須存在並註冊，才能刪除。此操作支援清除連線類型資源，並有助於維持自訂連線類型的適當生命週期管理。
**請求**
+ `ConnectionType` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。
要刪除的連線類型名稱。必須參考現有的已註冊連線類型。
**回應**
+ *無回應參數。*
**錯誤**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`
## DescribeConnectionType 動作 (Python：describe\_connection\_type)
`DescribeConnectionType` API 提供 AWS Glue中所指定連線類型的支援選項的完整詳細資訊。回應包含身分驗證組態詳細資訊，其中顯示支援的身分驗證類型和屬性，以及透過 註冊之自訂 REST 型連線類型的 RestConfiguration`RegisterConnectionType`。
另請參閱：`ListConnectionTypes`、`RegisterConnectionType`、 `DeleteConnectionType`
**請求**
+ `ConnectionType` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，且需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。
要描述的連線類型名稱。
**回應**
+ `ConnectionType` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 255 個位元組，需符合[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine)。
連線類型的名稱。
+ `Description` – UTF-8 字串，長度不可超過 1024 個位元組。
連線類型的描述。
+ `Capabilities` – [功能](#aws-glue-api-catalog-connections-connections-type-Capabilities) 物件。
支援的身分驗證類型、資料界面類型 （運算環境） 和 的資料操作 connector。
+ `ConnectionProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
運算環境中通用的連線屬性。
+ `ConnectionOptions` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
傳回在 `ConnectionInput.ConnectionProperties` 中建立連線時可設定的屬性。`ConnectionOptions` 定義可在傳遞至資料框的連線選項映射中的 Spark ETL 指令碼中設定的參數。
+ `AuthenticationConfiguration` – [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) 物件。
用於連線的身分驗證類型。
+ `ComputeEnvironmentConfigurations` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) 物件。
連線支援的運算環境。
+ `PhysicalConnectionRequirements` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
連線的實體需求，例如 VPC、子網路和安全群組規格。
+ `AthenaConnectionProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
Athena 運算環境特有的連線屬性。
+ `PythonConnectionProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
Python 運算環境特定的連線屬性。
+ `SparkConnectionProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
Spark 運算環境特定的連線屬性。
+ `RestConfiguration` – [RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration) 物件。
以 REST 為基礎的資料來源的 HTTP 請求和回應組態、驗證端點和實體組態。
**錯誤**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## ListConnectionTypes 動作 (Python：list\_connection\_types)
`ListConnectionTypes` API 提供了一種探索機制來了解 AWS Glue中可用的連線類型。回應包含連線類型的清單，其中包含每個連線類型支援的高階詳細資訊，包括內建連線類型和透過 註冊的自訂連線類型`RegisterConnectionType`。列出的連線類型是 `CreateConnection` API 中 `ConnectionType` 值的一組支援選項。
另請參閱：`DescribeConnectionType`、`RegisterConnectionType`、 `DeleteConnectionType`
**請求**
+ `MaxResults` – 數字 (整數)，不可小於 1，也不可以大於 1000。
回傳結果的數量上限。
+ `NextToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，需符合[Custom string pattern #11](aws-glue-api-common.md#regex_11)。
接續符記，如果這是接續呼叫。
**回應**
+ `ConnectionTypes` – 一個 [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) 物件陣列。
`ConnectionTypeBrief` 物件清單，其中包含所支援連線類型的簡短資訊。
+ `NextToken` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，需符合[Custom string pattern #11](aws-glue-api-common.md#regex_11)。
接續字元 (如果目前清單區段不是最後一個)。
**錯誤**
+ `InternalServiceException`
## ConnectionTypeBrief 結構
`ListConnectionTypes` API 傳回的支援連線類型的簡短資訊。
**欄位**
+ `ConnectionType` – UTF-8 字串 （有效值： `JDBC` \| `SFTP` \| `MONGODB` \| `KAFKA` `NETWORK` \| `MARKETPLACE` `CUSTOM` \| `SALESFORCE` `VIEW_VALIDATION_REDSHIFT` \| `VIEW_VALIDATION_ATHENA` \| `GOOGLEADS` `GOOGLESHEETS` \| \| `GOOGLEANALYTICS4` \| \| \| \| \| \| `SERVICENOW` `MARKETO` `SAPODATA` `ZENDESK` `JIRACLOUD` `NETSUITEERP` `HUBSPOT` `FACEBOOKADS` `INSTAGRAMADS` `ZOHOCRM` \| `SALESFORCEPARDOT` \| \| \| \| `SALESFORCEMARKETINGCLOUD` \| \| \| \| `ADOBEANALYTICS` `SLACK` `LINKEDIN` `MIXPANEL` `ASANA` `STRIPE` `SMARTSHEET` `DATADOG` \| `WOOCOMMERCE` \| \| `INTERCOM` \| \| \| \| \| \| \| \| \| `SNAPCHATADS` `PAYPAL` `QUICKBOOKS` `FACEBOOKPAGEINSIGHTS` `FRESHDESK` `TWILIO` `DOCUSIGNMONITOR` `FRESHSALES` `ZOOM` `GOOGLESEARCHCONSOLE` `SALESFORCECOMMERCECLOUD` `SAPCONCUR` `DYNATRACE` \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| \| `ORACLE` \| \| \| `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` \| \| \| \| `PIPEDRIVE` \| \| `POSTGRESQL` \| \| \| \| \| \| \| \| \| \| `SAPHANA` `SQLSERVER` `SYNAPSE` `TERADATA` `TERADATANOS` `TIMESTREAM` `TPCDS` `VERTICA`
連線類型的名稱。
+ `DisplayName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
顯示在 AWS Glue 主控台中連線類型的可供人類讀取的名稱。
+ `Vendor` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
建立或維護此連線類型的廠商或供應商名稱。
+ `Description` – UTF-8 字串，長度不可超過 1024 個位元組。
連線類型的描述。
+ `Categories` – UTF-8 字串陣列。
此連線類型所屬的類別清單。類別可協助使用者根據使用案例篩選和尋找適當的連線類型。
+ `Capabilities` – [功能](#aws-glue-api-catalog-connections-connections-type-Capabilities) 物件。
支援的身分驗證類型、資料界面類型 （運算環境） 和 的資料操作 connector。
+ `LogoUrl` – UTF-8 字串。
與連線類型關聯的標誌 URL。
+ `ConnectionTypeVariants` – 一個 [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) 物件陣列。
此連線類型可用的變體清單。不同的變體可能會針對特定使用案例或相同一般連線類型的實作，提供特殊組態。
## ConnectionTypeVariant 結構
代表 中連線類型的變體 AWS Glue。連線類型變體為相同一般連線類型的不同實作提供了特定的組態和行為。
**欄位**
+ `ConnectionTypeVariantName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
連線類型變體的唯一識別碼。此名稱會在內部用於識別連線類型的特定變體。
+ `DisplayName` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
AWS Glue 主控台中顯示的連線類型變體的人類可讀取名稱。
+ `Description` – UTF-8 字串，長度不可超過 1024 個位元組。
連線類型變體的詳細描述，包括其用途、使用案例和任何特定組態需求。
+ `LogoUrl` – UTF-8 字串。
與連線類型變體關聯的標誌 URL。
## 資料類型
+ [驗證結構](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [功能結構](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [屬性結構](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue 結構](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
## 驗證結構
定義如何在連線屬性上執行驗證。
**欄位**
+ `ValidationType` – *必要：*UTF-8 字串 (有效值：`REGEX` \| `RANGE`)。
要執行的驗證類型，例如 `REGEX`。
+ `Patterns` – UTF-8 字串陣列。
套用至驗證的模式清單。
+ `Description` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組。
驗證的描述。
+ `MaxLength` – 數字 (整數)。
字串連線屬性的長度上限。
+ `Maximum` – 數字 (整數)。
指定 `RANGE` 類型驗證時的最大值。
+ `Minimum` – 數字 (整數)。
指定 `RANGE` 類型驗證時的最小值。
## AuthConfiguration 結構
`DescribeConnectionType` API 傳回的連線的身分驗證組態。
**欄位**
+ `AuthenticationType` – *必要：*[屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
用於連線的身分驗證類型。
+ `SecretArn` – [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
Secrets Manager 的 Amazon Resource Name (ARN)。
+ `OAuth2Properties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
OAuth2 屬性的金鑰值對映射。每個值都是 `Property` 物件。
+ `BasicAuthenticationProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
OAuth2 屬性的金鑰值對映射。每個值都是 `Property` 物件。
+ `CustomAuthenticationProperties` – 金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
自訂身分驗證屬性的金鑰值對映射。每個值都是 `Property` 物件。
## 功能結構
指定 `DescribeConnectionType` API 傳回的支援的身分驗證類型。
**欄位**
+ `SupportedAuthenticationTypes` – *必要：*UTF-8 字串陣列。
支援的身分驗證類型清單。
+ `SupportedDataOperations` – *必要：*UTF-8 字串陣列。
支援的資料操作清單。
+ `SupportedComputeEnvironments` – *必要：*UTF-8 字串陣列。
支援的運算環境清單。
## 屬性結構
定義運算環境連線類型的物件。
**欄位**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
屬性的名稱。
+ `Description` – *必要：*UTF-8 字串，長度不可超過 1024 個位元組。
屬性的描述。
+ `Required` – *必要：*布林值。
指示屬性是否為必要。
+ `DefaultValue` – UTF-8 字串。
屬性的預設值。
+ `PropertyTypes` – *必要：*UTF-8 字串陣列。
描述屬性的類型。
+ `AllowedValues` – 一個 [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue) 物件陣列。
`AllowedValue` 物件清單，代表屬性允許的值。
+ `DataOperationScopes` – UTF-8 字串陣列。
指出哪些資料操作適用於屬性。
+ `KeyOverride` – UTF-8 字串。
在 API 請求中傳送此屬性時所用的金鑰名稱，如果與顯示名稱不同。
+ `PropertyLocation` – UTF-8 字串 (有效值：`HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
指定此屬性應包含在 REST 請求中的位置，例如標頭、查詢參數或請求內文。
## AllowedValue 結構
代表屬性允許值的物件。
**欄位**
+ `Description` – UTF-8 字串，長度不可超過 1024 個位元組。
允許值的描述。
+ `Value` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
屬性允許的值。
## ComputeEnvironmentConfiguration 結構
包含 `DescribeConnectionType` API 傳回的運算環境 (例如 Spark、Python 或 Athena) 組態的物件。
**欄位**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
運算環境組態的名稱。
+ `Description` – *必要：*UTF-8 字串，長度不可超過 1024 個位元組。
運算環境的描述。
+ `ComputeEnvironment` – *必要：*UTF-8 字串 (有效值：`SPARK` \| `ATHENA` \| `PYTHON`)。
運算環境類型。
+ `SupportedAuthenticationTypes` – *必要：*UTF-8 字串陣列。
運算環境的支援的身分驗證類型。
+ `ConnectionOptions` – *必要：*金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值都是 [屬性](#aws-glue-api-catalog-connections-connections-type-Property) 物件。
用作運算環境連線選項的參數。
+ `ConnectionPropertyNameOverrides` – *必要：*金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
連線屬性名稱會覆寫運算環境。
+ `ConnectionOptionNameOverrides` – *必要：*金鑰值對的映射陣列。
每個金鑰均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
每個值均為 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
連線選項名稱會覆寫運算環境。
+ `ConnectionPropertiesRequiredOverrides` – *必要：*UTF-8 字串陣列。
運算環境的覆寫所需的連線屬性。
+ `PhysicalConnectionPropertiesRequired` – 布林值。
指出運算環境是否需要 `PhysicalConnectionProperties`。
## 自訂連接器資料類型
+ [ConnectionPropertiesConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration)
+ [ConnectorAuthenticationConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration)
+ [ConnectorProperty 結構](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty)
+ [RestConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-RestConfiguration)
+ [SourceConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration)
+ [EntityConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration)
+ [ResponseConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration)
+ [ResponseExtractionMapping 結構](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping)
+ [PaginationConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration)
+ [CursorConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration)
+ [OffsetConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration)
+ [ExtractedParameter 結構](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter)
+ [FieldDefinition 結構](#aws-glue-api-catalog-connections-connections-type-FieldDefinition)
+ [ConnectorOAuth2Properties 結構](#aws-glue-api-catalog-connections-connections-type-ConnectorOAuth2Properties)
+ [ClientCredentialsProperties 結構](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties)
+ [JWTBearerProperties 結構](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties)
+ [ConnectorAuthorizationCodeProperties 結構](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties)
+ [BasicAuthenticationProperties 結構](#aws-glue-api-catalog-connections-connections-type-BasicAuthenticationProperties)
+ [CustomAuthenticationProperties 結構](#aws-glue-api-catalog-connections-connections-type-CustomAuthenticationProperties)
+ [FilterConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration)
+ [FilterOverrides 結構](#aws-glue-api-catalog-connections-connections-type-FilterOverrides)
+ [BetweenConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration)
+ [FilterStringConfiguration 結構](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration)
## ConnectionPropertiesConfiguration 結構
定義連線建立期間所需的基本 URL 和其他請求參數的組態。
**欄位**
+ `Url` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
此連線類型將連線之端點的基本執行個體 URL。
+ `AdditionalRequestParameters` – 一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件陣列。
連線建立期間可能需要的其他請求參數的鍵值對，例如 API 版本或服務特定的組態選項。
## ConnectorAuthenticationConfiguration 結構
定義連線類型支援的身分驗證類型和必要屬性的組態。
**欄位**
+ `AuthenticationTypes` – *必要：*UTF-8 字串陣列。
此連線類型支援的身分驗證類型清單，例如基本、OAuth2 或自訂身分驗證方法。
## ConnectorProperty 結構
定義連線類型的屬性組態、預設值，以及應該在請求中使用 屬性的位置。
**欄位**
+ `Name` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組。
屬性的名稱。
+ `KeyOverride` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，且需符合 [Custom string pattern #15](aws-glue-api-common.md#regex_15)。
在 API 請求中傳送此屬性時所用的金鑰名稱，如果與顯示名稱不同。
+ `Required` – *必要：*布林值。
指示屬性是否為必要。
+ `DefaultValue` – UTF-8 字串。
屬性的預設值。
+ `AllowedValues` – UTF-8 字串陣列。
`AllowedValue` 物件清單，代表屬性允許的值。
+ `PropertyLocation` – UTF-8 字串 (有效值：`HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
指定此屬性應包含在 REST 請求中的位置，例如標頭、查詢參數或請求內文。
+ `PropertyType` – *必要*：UTF-8 字串 (有效值：`USER_INPUT` \| `SECRET` \| `READ_ONLY` \| `UNUSED` \| `SECRET_OR_USER_INPUT`)。
此屬性的資料類型
+ `Format` – UTF-8 字串。
屬性值的格式範本，定義在 API 請求中傳送值之前應如何格式化該值。使用 `{value}`做為實際屬性值的預留位置 （例如 `SSWS {value}`)。
## RestConfiguration 結構
為 REST API 互動定義 HTTP 請求和回應處理、驗證端點和實體組態的組態。
**欄位**
+ `GlobalSourceConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) 物件。
套用至此連線類型所有 REST API 請求的全域組態設定，包括常見的請求方法、路徑和參數。
+ `ValidationEndpointConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) 物件。
用於在建立連線期間驗證連線登入資料和測試連線的端點組態。
+ `EntityConfigurations` – 金鑰值對的映射陣列。
每個金鑰都是 UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，需符合 [Custom string pattern #12](aws-glue-api-common.md#regex_12)。
每個值都是 [EntityConfiguration](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration) 物件。
實體組態的映射，定義如何與透過 REST API 提供的不同資料實體互動，包括其結構描述和存取模式。
## SourceConfiguration 結構
定義如何向端點提出請求的組態，包括請求方法、路徑、參數和回應處理。
**欄位**
+ `RequestMethod` – UTF-8 字串 (有效值：`GET` \| `POST`)。
用於對此端點提出請求的 HTTP 方法，例如 GET、POST。
+ `RequestPath` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Custom string pattern #14](aws-glue-api-common.md#regex_14)。
REST 端點的 URL 路徑，其中可能包含參數預留位置，這些預留位置將在請求期間以實際值取代。
+ `RequestParameters` – 一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件陣列。
應包含在 API 呼叫中的請求參數組態，例如查詢參數、標頭或內文內容。
+ `ResponseConfiguration` – [ResponseConfiguration](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration) 物件。
定義如何從 API 回應剖析和擷取資料的組態，包括成功和錯誤處理。
+ `PaginationConfiguration` – [PaginationConfiguration](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration) 物件。
處理來自 REST API 分頁回應的組態，支援游標型和位移型分頁策略。
+ `FilterConfiguration` – [FilterConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration) 物件。
將篩選條件下推套用至 REST API 請求的組態，定義篩選條件述詞如何轉譯為查詢參數或篩選條件字串。
## EntityConfiguration 結構
定義如何透過 REST API 與特定資料實體互動的組態，包括其存取模式和結構描述定義。
**欄位**
+ `SourceConfiguration` – [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration) 物件。
定義如何透過 REST API 請求存取此實體資料的來源組態。
+ `Schema` – 金鑰值對的映射陣列。
每個金鑰都是 UTF-8 字串，長度至少為 1 個位元組。
每個值都是 [FieldDefinition](#aws-glue-api-catalog-connections-connections-type-FieldDefinition) 物件。
此實體的結構描述定義，包括欄位名稱、類型和其他描述資料結構的中繼資料。
## ResponseConfiguration 結構
定義如何從 REST API 呼叫剖析 JSON 回應的組態，包括結果資料的路徑和錯誤資訊。
**欄位**
+ `ResultPath` – *必要：*UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，需符合 [Custom string pattern #10](aws-glue-api-common.md#regex_10)。
JSON 路徑表達式，可識別實際結果資料在 API 回應中的位置。
+ `ErrorPath` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Custom string pattern #10](aws-glue-api-common.md#regex_10)。
JSON 路徑表達式，可識別請求失敗時，錯誤資訊位於 API 回應中的位置。
## ResponseExtractionMapping 結構
定義如何從 HTTP 回應內容或標頭擷取值以用於後續請求或參數映射的組態。
**欄位**
+ `ContentPath` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 512 個位元組，且需符合 [Custom string pattern #10](aws-glue-api-common.md#regex_10)。
指定如何從回應內文內容擷取值的 JSON 路徑表達式。
+ `HeaderKey` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，且需符合 [Custom string pattern #15](aws-glue-api-common.md#regex_15)。
要從中擷取值的 HTTP 回應標頭名稱。
## PaginationConfiguration 結構
定義如何處理來自 REST APIs 分頁回應的組態，支援各種 服務使用的不同分頁策略。
**欄位**
+ `CursorConfiguration` – [CursorConfiguration](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration) 物件。
游標型分頁的組態，其中 API 提供游標或字符來擷取結果的下一頁。
+ `OffsetConfiguration` – [OffsetConfiguration](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration) 物件。
以位移為基礎的分頁組態，其中 API 使用數值位移和限制來控制傳回的結果。
## CursorConfiguration 結構
以游標為基礎的分頁組態，定義如何使用游標字符或下一頁識別符處理分頁。
**欄位**
+ `NextPage` – *必要：*[ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) 物件。
參數名稱或 JSON 路徑，其中包含用於擷取結果下一頁的游標或字符。
+ `LimitParameter` – [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) 物件。
用來指定每頁傳回結果數目上限的參數名稱。
## OffsetConfiguration 結構
以位移為基礎的分頁組態，定義如何使用數值位移和限制來處理分頁。
**欄位**
+ `OffsetParameter` – *必要：*[ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) 物件。
用來指定開始位置或位移以擷取結果的參數名稱。
+ `LimitParameter` – *必要：*[ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter) 物件。
用來指定每頁傳回結果數目上限的參數名稱。
## ExtractedParameter 結構
參數擷取組態，定義如何從 API 回應擷取和映射值至請求參數。
**欄位**
+ `Key` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 128 個位元組，且需符合 [Custom string pattern #15](aws-glue-api-common.md#regex_15)。
將在後續請求中使用的參數金鑰名稱。
+ `DefaultValue` – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 1024 個位元組，需符合 [Custom string pattern #16](aws-glue-api-common.md#regex_16)。
如果無法從回應擷取 參數，要使用的預設值。
+ `PropertyLocation` – UTF-8 字串 (有效值：`HEADER` \| `BODY` \| `QUERY_PARAM` \| `PATH`)。
指定應在後續請求中放置此擷取參數的位置，例如在標頭、查詢參數或請求內文中。
+ `Value` – [ResponseExtractionMapping](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping) 物件。
定義如何從 API 回應擷取參數值的 JSON 路徑或擷取映射。
## FieldDefinition 結構
在 REST 連接器資料來源的實體結構描述中定義欄位，指定欄位名稱和資料類型。
**欄位**
+ `Name` – *必要：*UTF-8 字串。
實體結構描述中的 欄位名稱。
+ `FieldDataType` – *必要：*UTF-8 字串 （有效值： `INT` \| `SMALLINT` \| `BIGINT` `FLOAT` \| `LONG` \| `DATE` \| `BOOLEAN` \| `MAP` \| \| `ARRAY` \| `STRING` `TIMESTAMP` \| `DECIMAL` \| `BYTE` `SHORT` \| `DOUBLE` `STRUCT` \| \| `BINARY` \| \| `UNION`)。
欄位的資料類型。
+ `ResponseDateFormat` – UTF-8 字串。
從 API 回應剖析日期值的格式模式。當 API 使用non-ISO-8601 格式時為必要。接受 Java `DateTimeFormatter` 模式 （例如，`EEE, d MMM yyyy HH:mm:ss Z`)、`EPOCH_SECONDS`Unix epoch 秒或 `EPOCH_MILLIS` Unix epoch 毫秒。
+ `IsPartitionable` – 布林值。
指出此欄位是否可用於將查詢分割至資料來源。
+ `IsNullable` – 布林值。
指出此欄位是否可以包含 null 值。
+ `IsQueryable` – 布林值。
指出在查詢資料時，此欄位是否可用於篩選條件述詞。
+ `IsOrderable` – 布林值。
指出此欄位是否可用於排序結果。
+ `FilterOverrides` – [FilterOverrides](#aws-glue-api-catalog-connections-connections-type-FilterOverrides) 物件。
每個欄位覆寫篩選條件行為，允許自訂篩選條件如何套用至此特定欄位。
## ConnectorOAuth2Properties 結構
OAuth2 組態容器，定義 OAuth2-based連線的身分驗證屬性和流程特定組態。
**欄位**
+ `OAuth2GrantType` – *必要：*UTF-8 字串 (有效值：`CLIENT_CREDENTIALS` \| `JWT_BEARER` \| `AUTHORIZATION_CODE`)。
用於身分驗證的 OAuth2 授權類型，例如 CLIENT\_CREDENTIALS、JWT\_BEARER 或 AUTHORIZATION\_CODE。
+ `ClientCredentialsProperties` – [ClientCredentialsProperties](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties) 物件。
OAuth2 用戶端登入資料授予類型流程特定的組態屬性。
+ `JWTBearerProperties` – [JWTBearerProperties](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties) 物件。
OAuth2 JWT 承載授權類型流程特定的組態屬性。
+ `AuthorizationCodeProperties` – [ConnectorAuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties) 物件。
OAuth2 授權碼授予類型流程特定的組態屬性。
## ClientCredentialsProperties 結構
OAuth2 用戶端登入資料組態，定義用戶端登入資料授予類型流程所需的屬性。
**欄位**
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
權杖端點 URL，其中用戶端將使用用戶端登入資料請求存取權杖。
+ `RequestMethod` – UTF-8 字串 (有效值：`GET` \| `POST`)。
提出字符請求時使用的 HTTP 方法，通常是 POST。
+ `ContentType` – UTF-8 字串 (有效值：`APPLICATION_JSON` \| `URL_ENCODED`)。
用於字符請求的內容類型，例如 application/x-www-form-urlencoded 或 application/json。
+ `ClientId` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
授權伺服器提供的 OAuth2 用戶端識別符。
+ `ClientSecret` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
授權伺服器提供的 OAuth2 用戶端秘密。
+ `Scope` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
OAuth2 範圍，定義用戶端登入資料流程請求的存取層級。
+ `TokenUrlParameters` – 一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件陣列。
要做為鍵值對包含在字符 URL 請求中的其他參數。
## JWTBearerProperties 結構
JWT 承載字符組態，定義 JWT 承載授予類型流程所需的屬性。
**欄位**
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
權杖端點 URL，其中 JWT 承載權杖將交換為存取權杖。
+ `RequestMethod` – UTF-8 字串 (有效值：`GET` \| `POST`)。
提出 JWT 承載字符請求時使用的 HTTP 方法，通常是 POST。
+ `ContentType` – UTF-8 字串 (有效值：`APPLICATION_JSON` \| `URL_ENCODED`)。
用於 JWT 承載字符請求的內容類型，例如 application/x-www-form-urlencoded 或 application/json。
+ `JwtToken` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
在承載字符授予流程中用於身分驗證的 JWT 字符。
+ `TokenUrlParameters` – 一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件陣列。
要做為鍵值對包含在字符 URL 請求中的其他參數。
## ConnectorAuthorizationCodeProperties 結構
OAuth2 授權碼組態，定義授權碼授予類型流程所需的屬性。
**欄位**
+ `AuthorizationCodeUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
將使用者重新導向至授予授權的授權端點 URL。
+ `AuthorizationCode` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
使用者同意後從授權伺服器收到的授權碼。
+ `RedirectUri` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
必須與向授權伺服器註冊的 URI 相符的重新導向 URI。
+ `TokenUrl` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
將授權碼交換為存取字符的字符端點 URL。
+ `RequestMethod` – UTF-8 字串 (有效值：`GET` \| `POST`)。
發出權杖交換請求時使用的 HTTP 方法，通常是 POST。
+ `ContentType` – UTF-8 字串 (有效值：`APPLICATION_JSON` \| `URL_ENCODED`)。
用於字符交換請求的內容類型，例如 application/x-www-form-urlencoded 或 application/json。
+ `ClientId` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
授權伺服器提供的 OAuth2 用戶端識別符。
+ `ClientSecret` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
授權伺服器提供的 OAuth2 用戶端秘密。
+ `Scope` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
定義授權碼流程請求之存取層級的 OAuth2 範圍。
+ `Prompt` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
在使用者身分驗證期間控制授權伺服器行為的 OAuth2 提示參數。
+ `TokenUrlParameters` – 一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件陣列。
要做為鍵值對包含在字符 URL 請求中的其他參數。
## BasicAuthenticationProperties 結構
基本身分驗證組態，定義 HTTP 基本身分驗證的使用者名稱和密碼屬性。
**欄位**
+ `Username` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
用於基本身分驗證憑證的使用者名稱屬性名稱。
+ `Password` – [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
用於基本身分驗證憑證的密碼屬性名稱。
## CustomAuthenticationProperties 結構
允許超出標準 Basic 和 OAuth2 流程的彈性身分驗證機制的自訂身分驗證組態。
**欄位**
+ `AuthenticationParameters` – *必要：*一個 [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty) 物件。
自訂身分驗證參數的映射，可定義特定的身分驗證機制和所需的屬性。
## FilterConfiguration 結構
定義篩選條件述詞如何套用至 REST API 請求的組態，同時支援查詢參數和篩選條件字串策略。
**欄位**
+ `FilterMode` – *必要：*UTF-8 字串 (有效值：`QUERY_PARAMS` \| `FILTER_STRING`)。
將篩選條件套用至請求的策略。使用 `QUERY_PARAMS` 將篩選條件做為個別查詢參數傳遞，或`FILTER_STRING`建構單一篩選條件表達式字串。
+ `OperatorMappings` – 金鑰值對的映射陣列。
每個金鑰都是 UTF-8 字串。
每個值都是 UTF-8 字串。
邏輯篩選條件運算子映射至其 API 特定的字串表示法。支援的運算子金鑰為：`EQUAL_TO`、`NOT_EQUAL_TO`、`LESS_THAN`、`GREATER_THAN``LESS_THAN_OR_EQUAL_TO`、`GREATER_THAN_OR_EQUAL_TO`、`CONTAINS`、`BETWEEN`、 `AND`和 `OR`。
+ `DateTimeFormat` – UTF-8 字串。
篩選條件表達式的全域日期和時間格式。接受 Java `DateTimeFormatter` 模式 （例如，`EEE, d MMM yyyy HH:mm:ss Z`)、`EPOCH_SECONDS`Unix epoch 秒或 `EPOCH_MILLIS` Unix epoch 毫秒。如果未指定，值會以 ISO-8601 格式依原狀傳遞。
+ `StripQuotes` – 布林值。
指出是否應該在處理之前從篩選條件值中除去周圍的雙引號。
+ `BetweenConfiguration` – [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration) 物件。
處理 BETWEEN 範圍篩選操作的組態。
+ `FilterStringConfiguration` – [FilterStringConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration) 物件。
`FilterMode` 將 設定為 時建構篩選條件表達式的組態`FILTER_STRING`。
## FilterOverrides 結構
定義篩選行為每個欄位覆寫的組態，允許個別欄位自訂篩選條件操作的套用方式。
**欄位**
+ `FieldName` – UTF-8 字串。
如果欄位名稱與結構描述欄位名稱不同，則會覆寫要在篩選條件表達式中使用的欄位名稱。
+ `OperatorMappings` – 金鑰值對的映射陣列。
每個金鑰都是 UTF-8 字串。
每個值都是 UTF-8 字串。
邏輯篩選條件運算子映射到其欄位特定的 API 表示法，覆寫全域運算子映射。支援的運算子金鑰為：`EQUAL_TO`、`NOT_EQUAL_TO`、`LESS_THAN`、`GREATER_THAN``LESS_THAN_OR_EQUAL_TO`、`GREATER_THAN_OR_EQUAL_TO`、`CONTAINS`、`BETWEEN`、 `AND`和 `OR`。
+ `BetweenConfiguration` – [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration) 物件。
處理 BETWEEN 範圍篩選操作的欄位特定組態。
+ `DateTimeFormat` – UTF-8 字串。
此欄位上篩選條件表達式的日期和時間格式，覆寫全域 `DateTimeFormat`。接受 Java `DateTimeFormatter` 模式 （例如，`EEE, d MMM yyyy HH:mm:ss Z`)、`EPOCH_SECONDS`Unix epoch 秒或 `EPOCH_MILLIS` Unix epoch 毫秒。
## BetweenConfiguration 結構
定義 BETWEEN 範圍篩選操作如何轉譯為 REST API 請求參數的組態。
**欄位**
+ `LowBoundKey` – UTF-8 字串。
BETWEEN 篩選條件操作中用於下限值的參數名稱。
+ `HighBoundKey` – UTF-8 字串。
BETWEEN 篩選條件操作中用於上限值的參數名稱。
+ `Template` – UTF-8 字串。
用於建構 BETWEEN 篩選條件表達式的範本字串。
## FilterStringConfiguration 結構
使用篩選條件模式時建構`FILTER_STRING`篩選條件表達式字串的組態。
**欄位**
+ `QueryParameterName` – *必要：*UTF-8 字串。
用於在 API 請求中傳送建構篩選條件表達式字串的查詢參數名稱。
+ `QuoteStringValues` – 布林值。
指出是否應使用篩選條件表達式中的引號字元包裝字串和日期值。
+ `QuoteCharacter` – UTF-8 字串。
當 `QuoteStringValues`為 true 時，用來引號值的字元。如果未指定，則預設為雙引號。