連線類型 API

Connection Type API 說明與描述連線類型相關的 AWS Glue APIs。

連線管理 APIs

• DescribeConnectionType 動作 (Python： describe_connection_type)

• ListConnectionTypes 動作 (Python：list_connection_types)

• ConnectionTypeBrief 結構

DescribeConnectionType 動作 (Python： describe_connection_type)

DescribeConnectionType API 提供指定連線類型支援選項的完整詳細資訊 AWS Glue。

請求

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

  要描述的連線類型名稱。

回應

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

  連線類型的名稱。

• Description – UTF-8 字串，長度不可超過 1024 個位元組。

  連線類型的描述。

• Capabilities – 功能 物件。

  支援的身分驗證類型、資料介面類型 （運算環境） 和連接器的資料操作。

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

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

  每個值都是 屬性 物件。

  運算環境中常見的連線屬性。

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

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

  每個值都是 屬性 物件。

  傳回在 中建立連線時可設定的屬性ConnectionInput.ConnectionProperties。 ConnectionOptions定義可在傳遞至資料架構的連線選項映射中的 Spark ETL 指令碼中設定的參數。

• AuthenticationConfiguration – AuthConfiguration 物件。

  用於連線的身分驗證類型。

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

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

  每個值都是 ComputeEnvironmentConfiguration 物件。

  連線支援的運算環境。

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

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

  每個值都是 屬性 物件。

  連線的實體需求，例如 VPC、子網路和安全群組規格。

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

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

  每個值都是 屬性 物件。

  Athena 運算環境特有的連線屬性。

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

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

  每個值都是 屬性 物件。

  Python 運算環境特有的連線屬性。

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

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

  每個值都是 屬性 物件。

  Spark 運算環境特有的連線屬性。

錯誤

• ValidationException

• InvalidInputException

• InternalServiceException

ListConnectionTypes 動作 (Python：list_connection_types)

ListConnectionTypes API 提供探索機制來學習 中的可用連線類型 AWS Glue。回應包含連線類型的清單，其中包含每個連線類型支援的高階詳細資訊。列出的連線類型是 CreateConnection API 中 ConnectionType值的一組支援選項。

請求

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

  回傳結果的數量上限。

• NextToken – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，需符合Custom string pattern #11。

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

回應

• ConnectionTypes – 一個 ConnectionTypeBrief 物件陣列。

  物件清單，ConnectionTypeBrief其中包含有關支援連線類型的簡短資訊。

• NextToken – UTF-8 字串，長度不可小於 1 個位元組，也不可以超過 2048 個位元組，需符合Custom string pattern #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 | SLACK | STRIPE | | INTERCOM | |)SNAPCHATADS。

  連線類型的名稱。

• Description – UTF-8 字串，長度不可超過 1024 個位元組。

  連線類型的描述。

• Capabilities – 功能 物件。

  支援的身分驗證類型、資料介面類型 （運算環境） 和連接器的資料操作。

資料類型

• 驗證結構

• AuthConfiguration 結構

• 功能結構

• 屬性結構

• AllowedValue 結構

• ComputeEnvironmentConfiguration 結構

驗證結構

定義如何在連線屬性上執行驗證。

欄位

• ValidationType – 必要：UTF-8 字串 (有效值：REGEX | RANGE)。

  要執行的驗證類型，例如 REGEX。

• Patterns – UTF-8 字串陣列。

  套用至驗證的模式清單。

• Description – 必要：UTF-8 字串，長度不可小於 1 個位元組或超過 1024 個位元組。

  驗證的說明。

• MaxLength – 數字 (整數)。

  字串連線屬性的長度上限。

• Maximum – 數字 (整數)。

  指定驗證RANGE類型的最大值。

• Minimum – 數字 (整數)。

  指定驗證RANGE類型的最小值。

AuthConfiguration 結構

DescribeConnectionType API 傳回之連線的身分驗證組態。

欄位

• AuthenticationType – 必要：屬性 物件。

  連線的身分驗證類型。

• SecretArn – 屬性 物件。

  Secrets Manager 的 Amazon Resource Name (ARN)。

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

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

  每個值都是 屬性 物件。

  OAuth2 屬性的鍵值對映射。每個值都是一個Property物件。

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

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

  每個值都是 屬性 物件。

  OAuth2 屬性的鍵值對映射。每個值都是一個Property物件。

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

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

  每個值都是 屬性 物件。

  自訂身分驗證屬性的鍵值對映射。每個值都是一個Property物件。

功能結構

指定 DescribeConnectionType API 傳回的支援身分驗證類型。

欄位

• SupportedAuthenticationTypes – 必要：UTF-8 字串陣列。

  支援的身分驗證類型清單。

• SupportedDataOperations – 必要：UTF-8 字串陣列。

  支援的資料操作清單。

• SupportedComputeEnvironments – 必要：UTF-8 字串陣列。

  支援的運算環境清單。

屬性結構

定義運算環境連線類型的物件。

欄位

• Name – 必要：UTF-8 字串，長度不可小於 1 個位元組或超過 128 個位元組。

  屬性的名稱。

• Description – 必要：UTF-8 字串，長度不可超過 1024 個位元組。

  屬性的描述。

• DataType – 必要：UTF-8 字串 (有效值：STRING | INTEGER | BOOLEAN | STRING_LIST)。

  屬性的資料類型。

• Required – 必要：布林值。

  指示屬性是否為必要。

• DefaultValue – UTF-8 字串。

  屬性的預設值。

• PropertyTypes – 必要：UTF-8 字串陣列。

  描述 屬性的類型。

• AllowedValues – 一個 AllowedValue 物件陣列。

  物件清單，AllowedValue代表 屬性允許的值。

• DataOperationScopes – UTF-8 字串陣列。

  指出哪些資料操作適用於 屬性。

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 個位元組。

  每個值都是 屬性 物件。

  用作運算環境連線選項的參數。

• ConnectionPropertyNameOverrides – 必要：金鑰值對的映射陣列。

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

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

  連線屬性名稱會覆寫運算環境。

• ConnectionOptionNameOverrides – 必要：金鑰值對的映射陣列。

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

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

  連線選項名稱會覆寫運算環境。

• ConnectionPropertiesRequiredOverrides – 必要：UTF-8 字串陣列。

  運算環境的覆寫所需的連線屬性。

• PhysicalConnectionPropertiesRequired – 布林值。

  指出運算環境PhysicalConnectionProperties是否需要 。