register_connection_type
async
¶
register_connection_type(
connection_type: NameString,
integration_type: IntegrationType,
connection_properties: ConnectionPropertiesConfiguration,
connector_authentication_configuration: ConnectorAuthenticationConfiguration,
rest_configuration: RestConfiguration,
*,
config_overrides: Optional[AsyncGlueClientConfig] = None,
description: Optional[Description] = None,
tags: Optional[TagsMap] = None,
) -> RegisterConnectionTypeResponse
Registers a custom connection type in Glue based on the configuration provided. This operation enables customers to configure custom connectors for any data source with REST-based APIs, eliminating the need for building custom Lambda connectors.
The registered connection type stores details about how requests and responses are interpreted by REST sources, including connection properties, authentication configuration, and REST configuration with entity definitions. Once registered, customers can create connections using this connection type and work with them the same way as natively supported Glue connectors.
Supports multiple authentication types including Basic, OAuth2 (Client Credentials, JWT Bearer, Authorization Code), and Custom Auth configurations.
Parameters:
-
connection_type(NameString) –The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.
-
integration_type(IntegrationType) –The integration type for the connection. Currently only "REST" protocol is supported.
-
description(Optional[Description], default:None) –A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.
-
connection_properties(ConnectionPropertiesConfiguration) –Defines the base URL and additional request parameters needed during connection creation for this connection type.
-
connector_authentication_configuration(ConnectorAuthenticationConfiguration) –Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.
-
rest_configuration(RestConfiguration) –Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.
-
tags(Optional[TagsMap], default:None) –The tags you assign to the connection type.
Raises:
-
AccessDeniedException–Access to a resource was denied.
-
InternalServiceException–An internal service error occurred.
-
InvalidInputException–The input provided was not valid.
-
OperationTimeoutException–The operation timed out.
-
ResourceNumberLimitExceededException–A resource numerical limit was exceeded.
-
ValidationException–A value could not be validated.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_glue/_services/async_glue.py
17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 | |