连接 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 | | 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_USERNAME | | KAFKA_SASL_PLAIN_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | | KAFKA_SASL_SCRAM_USERNAMEKAFKA_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 | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE)。

  每个值是一个值字符串，不超过 1024 个字节。

  这些键值对用于定义连接的参数：

  • HOST-主机URI：要么是完全限定的域名 (FQDN)，要么是数据库主机IPv4的地址。

  • PORT- 端口的端口号，介于 1024 和 65535 之间，数据库主机在这些端口上侦听数据库连接。

  • USER_NAME- 登录数据库时使用的名称。USER_NAME 的值字符串为“USERNAME”。

  • PASSWORD- 用户名使用的密码（如果使用的话）。

  • ENCRYPTED_PASSWORD - 通过在数据目录加密设置中设置 ConnectionPasswordEncryption 来启用连接密码保护时，此字段会存储加密的密码。

  • JDBC_DRIVER_JAR_URI-包含JDBC要使用的驱动程序的文件的 Amazon Simple Storage Service (Amazon S3) 路径。JAR

  • 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 位置。 Amazon Glue 在连接到客户数据库时，使用此根证书来验证客户的证书。 Amazon Glue 仅处理 X.509 证书。提供的证书必须DER经过编码并以 Base64 编码格式提供。PEM

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION-默认情况下，这是false。 Amazon Glue 验证客户证书的签名算法和主题公钥算法。签名算法唯一允许的算法是SHA256withRSA、SHA384withRSA或SHA512withRSA。对于主题公有密钥算法，密钥长度必须至少为 2048 位。您可以将该属性的值设置为 true 以跳过 Amazon Glue对客户证书进行的验证。

  • CUSTOM_JDBC_CERT_STRING-用于域匹配或可分辨名称匹配以防止 man-in-the-middle攻击的自定义JDBC证书字符串。在 Oracle 数据库中，它被用作SSL_SERVER_CERT_DN；在 Microsoft SQL Server 中，它被用作hostNameInCertificate。

  • CONNECTION_URL-URL 用于连接到常规（非JDBC）数据源。

  • SECRET_ID – 用于凭证的 Secret Manager 的密钥 ID。

  • CONNECTOR_URL-MARKETPLACE 或连接URL的CUSTOM连接器。

  • CONNECTOR_TYPE-MARKETPLACE 或连接的CUSTOM连接器类型。

  • CONNECTOR_CLASS_NAME-MARKETPLACE 或CUSTOM连接的连接器类名。

  • KAFKA_BOOTSTRAP_SERVERS - 以逗号分隔的主机和端口对列表，它们是 Kafka 集群中 Apache Kafka 代理商的地址，Kafka 客户端将连接到该集群并自行引导。

  • KAFKA_SSL_ENABLED-是在 Apache Kafka 连接SSL上启用还是禁用。默认值为“true”。

  • KAFKA_CUSTOM_CERT-URL 用于私有 CA 证书文件的 Amazon S3（.pem 格式）。默认值是空字符串。

  • KAFKA_SKIP_CUSTOM_CERT_VALIDATION-是否跳过 CA 证书文件的验证。 Amazon Glue 适用于三种算法：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 客户端密钥库密码的加密版本（如果用户选择了 Amazon Glue 加密密码设置）。

  • ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD-Kafka 客户端密钥密码的加密版本（如果用户选择了 Amazon Glue 加密密码设置）。

  • KAFKA_SASL_MECHANISM – "SCRAM-SHA-512"、"GSSAPI"、"AWS_MSK_IAM" 或 "PLAIN"。这些是支持的SASL机制。

  • KAFKA_SASL_PLAIN_USERNAME-用于通过 “PLAIN” 机制进行身份验证的纯文本用户名。

  • KAFKA_SASL_PLAIN_PASSWORD-用于通过 “PLAIN” 机制进行身份验证的纯文本密码。

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD-Kafka SASL PLAIN 密码的加密版本（如果用户选择了 Amazon Glue 加密密码设置）。

  • KAFKA_SASL_SCRAM_USERNAME-用于通过 “SCRAM-SHA -512” 机制进行身份验证的纯文本用户名。

  • KAFKA_SASL_SCRAM_PASSWORD-用于通过 “SCRAM-SHA -512” 机制进行身份验证的纯文本密码。

  • ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD-Kafka SASL SCRAM 密码的加密版本（如果用户选择了 Amazon Glue 加密密码设置）。

  • KAFKA_SASL_SCRAM_SECRETS_ARN-Secrets Manager 中 Amazon 密钥的亚马逊资源名称。

  • KAFKA_SASL_GSSAPI_KEYTAB – Kerberos keytab 文件的 S3 位置。keytab 可存储一个或多个主体的长期密钥。有关更多信息，请参阅 MITKerberos 文档：Keytab。

  • KAFKA_SASL_GSSAPI_KRB5_CONF – Kerberos krb5.conf 文件的 S3 位置。krb5.conf 存储 Kerberos 的配置信息，例如服务器的位置。KDC有关更多信息，请参阅 MITKerberos 文档：krb5.conf。

  • KAFKA_SASL_GSSAPI_SERVICE – Kerberos 服务名称，如您的 Kafka 配置中的 sasl.kerberos.service.name 设置。

  • KAFKA_SASL_GSSAPI_PRINCIPAL-使用的 Kerberos 校长的名字。 Amazon Glue有关更多信息，请参阅 Kafka 文档：配置 Kafka 代理。

  • ROLE_ARN – 用于运行查询的角色。

  • REGION-将运行查询的 Amazon 区域。

  • WORKGROUP_NAME – 将在其中运行查询的 Amazon Redshift Serverless 工作组或 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 数据库连接 (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。这些参数用于配置SSLJDBC。

  • KAFKA - 指定与 Apache Kafka 流平台的连接。

    KAFKA连接使用以下内容 ConnectionParameters。

    • 必需：KAFKA_BOOTSTRAP_SERVERS。

    • 可选：KAFKA_SSL_ENABLED、KAFKA_CUSTOM_CERT、KAFKA_SKIP_CUSTOM_CERT_VALIDATION。这些参数用于配置SSLKAFKA。

    • 可选：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-使用OAuth身份验证指定与 Salesforce 的连接。

    • 需要配置 AuthenticationConfiguration 成员。

  • VIEW_VALIDATION_REDSHIFT – 指定 Amazon Redshift 用于视图验证的连接。

  • VIEW_VALIDATION_ATHENA – 指定 Amazon Athena 用于视图验证的连接。

  • NETWORK-指定与 Amazon Virtual Private Cloud 环境 (AmazonVPC) 中数据源的网络连接。

    NETWORK不需要连接 ConnectionParameters。相反，请提供一个 PhysicalConnectionRequirements。

  • MARKETPLACE-使用从中购买的连接器中包含的配置设置 Amazon Web Services Marketplace 来读取和写入本机不支持的数据 Amazon Glue存储。

    MARKETPLACE连接使用以下内容 ConnectionParameters。

    • 必需：CONNECTOR_TYPE、CONNECTOR_URL、CONNECTOR_CLASS_NAME、CONNECTION_URL。

    • JDBC CONNECTOR_TYPE 连接必需：所有（USERNAME、PASSWORD）或 SECRET_ID。

  • CUSTOM – 使用自定义连接器中包含的配置设置来读取和写入 Amazon Glue本地不支持的数据存储。

  不支持 SFTP。

  有关如何使用 ConnectionProperties 可选配置中的功能的更多信息 Amazon Glue，请参阅Amazon Glue 连接属性。

  有关如何使用可选功能 ConnectionProperties 在 Amazon 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 | | 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_USERNAME | | KAFKA_SASL_PLAIN_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | | KAFKA_SASL_SCRAM_USERNAMEKAFKA_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 | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE)。

  每个值是一个值字符串，不超过 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 | | 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_USERNAME | | KAFKA_SASL_PLAIN_PASSWORD | | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD | | KAFKA_SASL_SCRAM_USERNAMEKAFKA_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 | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE)。

  每个值是一个值字符串，不超过 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。这些参数用于配置SSLJDBC。

  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：创建连接）

• DeleteConnection 操作（Python：删除连接）

• GetConnection 操作（Python：获取连接）

• GetConnections 操作（Python：获取连接）

• UpdateConnection 操作（Python：更新连接）

• TestConnection 动作（Python：测试连接）

• BatchDeleteConnection 操作（Python：batch_delete_connection）

请求

• CatalogId – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  要在其中创建连接的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 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 匹配。

  连接所在的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 ID。

• ConnectionName— 必填：UTF-8 个字符串，长度不小于 1 或超过 255 字节，匹配。Single-line string pattern

  要删除的连接的名称。

响应

• 无响应参数。

错误

• EntityNotFoundException

• OperationTimeoutException

请求

• CatalogId – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  连接所在的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 ID。

• Name— 必填：UTF-8 个字符串，长度不小于 1 或超过 255 字节，匹配。Single-line string pattern

  要检索的连接定义的名称。

• HidePassword – 布尔值。

  允许您在不返回密码的情况下检索连接元数据。例如， Amazon Glue 控制台使用此标志来检索连接，并且不显示密码。当呼叫者可能无权使用密 Amazon KMS 钥解密密码，但却有权访问其余连接属性时，请设置此参数。

响应

• Connection – 一个 Connection 对象。

  请求的连接定义。

错误

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

请求

• CatalogId – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  连接所在的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 ID。

• Filter – 一个 GetConnectionsFilter 对象。

  控制将返回哪些连接的筛选器。

• HidePassword – 布尔值。

  允许您在不返回密码的情况下检索连接元数据。例如， Amazon Glue 控制台使用此标志来检索连接，并且不显示密码。当呼叫者可能无权使用密 Amazon KMS 钥解密密码，但却有权访问其余连接属性时，请设置此参数。

• NextToken— UTF -8 字符串。

  延续标记 (如果这是延续调用)。

• MaxResults – 数字（整数），不小于 1 或大于 1000。

  要在一个响应中返回的连接的最大数量。

响应

• ConnectionList – Connection 对象的数组。

  请求的连接定义的列表。

• NextToken— UTF -8 字符串。

  延续令牌 (如果返回的连接列表不包括最后一个筛选的连接)。

错误

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

请求

• CatalogId – 目录 id 字符串，长度不少于 1 个字节或超过 255 个字节，与 Single-line string pattern 匹配。

  连接所在的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 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 匹配。

  连接所在的数据目录的 ID。如果未提供任何信息，则默认使用 Amazon 账户 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 对象。

  该OAuth2AUTHORIZATION_CODE授权类型所需的属性集。

字段

• UserManagedClientApplicationClientId— UTF -8 个字符串，长度不超过 2048 字节，与. Custom string pattern #13

  如果是，则为客户端应用程序 clientID。 ClientAppType USER_MANAGED

• AWSManagedClientApplicationReference— UTF -8 个字符串，长度不超过 2048 字节，与. Custom string pattern #13

  对托管的 SaaS 端客户端应用程序的引用。 Amazon

字段

• AuthorizationCode— UTF -8 个字符串，长度不小于 1 或超过 4096 个字节，与. Custom string pattern #13

  将在 AUTHORIZATION_CODE 授权工作流的第三分支中使用的授权代码。这是一次性代码，一旦用于交换访问令牌后就会失效，因此可以将此值作为请求参数。

• RedirectUri— UTF -8 个字符串，长度不超过 512 字节，与. Custom string pattern #14

  用户URI在发出授权码时被授权服务器重定向到的重定向。随后URI在将授权码交换为访问令牌时使用。