register_connection_type
¶
register_connection_type(
connection_type: NameString,
integration_type: IntegrationType,
connection_properties: ConnectionPropertiesConfiguration,
connector_authentication_configuration: ConnectorAuthenticationConfiguration,
rest_configuration: RestConfiguration,
*,
config_overrides: Optional[GlueClientConfig] = 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/glue.py
16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 | |