# 连接类型 API
连接类型

连接类型 API 描述与描述连接类型相关的 Amazon Glue API。

## 连接管理 API
 —  连接管理 API  —
+ [DescribeConnectionType 操作（Python：describe\$1connection\$1type）](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes 操作（Python：list\$1connection\$1types）](#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)

## DescribeConnectionType 操作（Python：describe\$1connection\$1type）
DescribeConnectionType (describe\$1connection\$1type)

`DescribeConnectionType` API 提供 Amazon Glue 中给定连接类型支持的选项的完整详细信息。

**请求**
+ `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) 对象。

  连接器支持的身份验证类型、数据接口类型（计算环境）以及数据操作。
+ `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` 定义可以在传递给 DataFrame 的连接选项映射中的 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 计算环境的连接属性。

**错误**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`

## ListConnectionTypes 操作（Python：list\$1connection\$1types）
ListConnectionTypes (list\$1connection\$1types)

`ListConnectionTypes` API 提供了一种发现机制，用于了解 Amazon Glue 中可用的连接类型。响应包含连接类型列表以及每种连接类型支持的内容的高级详细信息。列出的连接类型是 `CreateConnection` API 中 `ConnectionType` 值支持的选项集。

**请求**
+ `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 结构
ConnectionTypeBrief

`ListConnectionTypes` API 返回的有关支持的连接类型的简要信息。

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

  连接类型的名称。
+ `DisplayName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  Amazon Glue 控制台中显示的连接类型的人类可读名称。
+ `Vendor` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  创建或维护此连接类型的供应商或者提供商的名称。
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  连接类型的描述。
+ `Categories` – .

  此连接类型所属的类别列表。类别可帮助用户根据其用例筛选并找到合适的连接类型。
+ `Capabilities` – 一个 [功能](#aws-glue-api-catalog-connections-connections-type-Capabilities) 对象。

  连接器支持的身份验证类型、数据接口类型（计算环境）以及数据操作。
+ `LogoUrl` – UTF-8 字符串。

  与连接类型相关联的徽标的 URL。
+ `ConnectionTypeVariants` – [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) 对象的数组。

  此连接类型可用的变体列表。不同的变体可能会为特定用例或相同通用连接类型的实现提供专门的配置。

## ConnectionTypeVariant 结构
ConnectionTypeVariant

表示 Amazon Glue Data Catalog 中连接类型的变体。连接类型变体为同一通用连接类型的不同实现提供特定的配置和行为。

**Fields**
+ `ConnectionTypeVariantName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  连接类型变体的唯一标识符。此名称在内部用于标识连接类型的特定变体。
+ `DisplayName` – UTF-8 字符串，长度不少于 1 个字节或超过 128 个字节。

  Amazon 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)

## 验证结构
验证

定义如何对连接属性执行验证。

**Fields**
+ `ValidationType` – *必填：*UTF-8 字符串（有效值：`REGEX` \$1 `RANGE`）。

  要执行的验证类型，例如 `REGEX`。
+ `Patterns` – .

  适用于验证的模式列表。
+ `Description` – *必填项：*UTF-8 字符串，长度不少于 1 个字节，不超过 1024 个字节。

  验证的描述。
+ `MaxLength` – 数字（整数）。

  字符串连接属性的最大长度。
+ `Maximum` – 数字（整数）。

  指定 `RANGE` 类型验证时的最大值。
+ `Minimum` – 数字（整数）。

  指定 `RANGE` 类型验证时的最小值。

## AuthConfiguration 结构
AuthConfiguration

`DescribeConnectionType` API 返回的连接的身份验证配置。

**Fields**
+ `AuthenticationType` – *必填：*一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  连接的身份验证类型。
+ `SecretArn` – 一个 [属性](#aws-glue-api-catalog-connections-connections-type-Property) 对象。

  Secrets Manager 的 Amazon 资源名称 (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 返回的支持的身份验证类型。

**Fields**
+ `SupportedAuthenticationTypes` – *必填*：UTF-8 字符串数组。

  支持的身份验证类型列表。
+ `SupportedDataOperations` – *必填*：UTF-8 字符串数组。

  支持的数据操作列表。
+ `SupportedComputeEnvironments` – *必填*：UTF-8 字符串数组。

  支持的计算环境列表。

## 属性结构
属性

定义计算环境的连接类型的对象。

**Fields**
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性的名称。
+ `Description`：*必需：*UTF-8 字符串，长度不超过 1024 个字节。

  属性的描述。
+ `Required` – *必填：*布尔值。

  指示属性是否为必需属性。
+ `PropertyTypes` – *必填*：UTF-8 字符串数组。

  描述属性的类型。
+ `AllowedValues` – [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue) 对象的数组。

  表示属性允许的值的 `AllowedValue` 对象列表。
+ `DataOperationScopes` – UTF-8 字符串数组。

  指示哪些数据操作适用于该属性。

## AllowedValue 结构
AllowedValue

表示属性允许的值的对象。

**Fields**
+ `Description` – UTF-8 字符串，长度不超过 1024 个字节。

  允许的值的描述。
+ `Value`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  属性允许的值。

## ComputeEnvironmentConfiguration 结构
ComputeEnvironmentConfiguration

包含 `DescribeConnectionType` API 返回的计算环境（如 Spark、Python 或 Athena）配置的对象。

**Fields**
+ `Name`：*必需：*UTF-8 字符串，长度不少于 1 个字节，不超过 128 个字节。

  计算环境配置的名称。
+ `Description`：*必需：*UTF-8 字符串，长度不超过 1024 个字节。

  计算环境的描述。
+ `ComputeEnvironment` – *必填：* UTF-8 字符串（有效值：`SPARK` \$1 `ATHENA` \$1 `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` – *必填：*。

  计算环境需要覆盖的连接属性。
+ `PhysicalConnectionPropertiesRequired` – 布尔值。

  指示计算环境是否需要 `PhysicalConnectionProperties`。