2026/02/05 - AWS Glue - 2 new2 updated api methods
Changes This release adds the capability to easily create custom AWS Glue connections to data sources with REST APIs.
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.
See also: AWS API Documentation
Request Syntax
client.register_connection_type(
ConnectionType='string',
IntegrationType='REST',
Description='string',
ConnectionProperties={
'Url': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'AdditionalRequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
]
},
ConnectorAuthenticationConfiguration={
'AuthenticationTypes': [
'BASIC'|'OAUTH2'|'CUSTOM'|'IAM',
],
'OAuth2Properties': {
'OAuth2GrantType': 'CLIENT_CREDENTIALS'|'JWT_BEARER'|'AUTHORIZATION_CODE',
'ClientCredentialsProperties': {
'TokenUrl': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'RequestMethod': 'GET'|'POST',
'ContentType': 'APPLICATION_JSON'|'URL_ENCODED',
'ClientId': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'ClientSecret': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'Scope': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'TokenUrlParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
]
},
'JWTBearerProperties': {
'TokenUrl': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'RequestMethod': 'GET'|'POST',
'ContentType': 'APPLICATION_JSON'|'URL_ENCODED',
'JwtToken': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'TokenUrlParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
]
},
'AuthorizationCodeProperties': {
'AuthorizationCodeUrl': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'AuthorizationCode': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'RedirectUri': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'TokenUrl': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'RequestMethod': 'GET'|'POST',
'ContentType': 'APPLICATION_JSON'|'URL_ENCODED',
'ClientId': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'ClientSecret': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'Scope': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'Prompt': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'TokenUrlParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
]
}
},
'BasicAuthenticationProperties': {
'Username': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
'Password': {
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
}
},
'CustomAuthenticationProperties': {
'AuthenticationParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
]
}
},
RestConfiguration={
'GlobalSourceConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'ValidationEndpointConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'EntityConfigurations': {
'string': {
'SourceConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'Schema': {
'string': {
'Name': 'string',
'FieldDataType': 'INT'|'SMALLINT'|'BIGINT'|'FLOAT'|'LONG'|'DATE'|'BOOLEAN'|'MAP'|'ARRAY'|'STRING'|'TIMESTAMP'|'DECIMAL'|'BYTE'|'SHORT'|'DOUBLE'|'STRUCT'|'BINARY'|'UNION'
}
}
}
}
},
Tags={
'string': 'string'
}
)
string
[REQUIRED]
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.
string
[REQUIRED]
The integration type for the connection. Currently only "REST" protocol is supported.
string
A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.
dict
[REQUIRED]
Defines the base URL and additional request parameters needed during connection creation for this connection type.
Url (dict) --
The base instance URL for the endpoint that this connection type will connect to.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
AdditionalRequestParameters (list) --
Key-value pairs of additional request parameters that may be needed during connection creation, such as API versions or service-specific configuration options.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
dict
[REQUIRED]
Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.
AuthenticationTypes (list) -- [REQUIRED]
A list of authentication types supported by this connection type, such as Basic, OAuth2, or Custom authentication methods.
(string) --
OAuth2Properties (dict) --
OAuth2 configuration container that defines the authentication properties and flow-specific configurations for OAuth2-based connections.
OAuth2GrantType (string) -- [REQUIRED]
The OAuth2 grant type to use for authentication, such as CLIENT_CREDENTIALS, JWT_BEARER, or AUTHORIZATION_CODE.
ClientCredentialsProperties (dict) --
Configuration properties specific to the OAuth2 Client Credentials grant type flow.
TokenUrl (dict) --
The token endpoint URL where the client will request access tokens using client credentials.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
RequestMethod (string) --
The HTTP method to use when making token requests, typically POST.
ContentType (string) --
The content type to use for token requests, such as application/x-www-form-urlencoded or application/json.
ClientId (dict) --
The OAuth2 client identifier provided by the authorization server.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
ClientSecret (dict) --
The OAuth2 client secret provided by the authorization server.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
Scope (dict) --
The OAuth2 scope that defines the level of access requested for the client credentials flow.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
TokenUrlParameters (list) --
Additional parameters to include in token URL requests as key-value pairs.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
JWTBearerProperties (dict) --
Configuration properties specific to the OAuth2 JWT Bearer grant type flow.
TokenUrl (dict) --
The token endpoint URL where the JWT bearer token will be exchanged for an access token.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
RequestMethod (string) --
The HTTP method to use when making JWT bearer token requests, typically POST.
ContentType (string) --
The content type to use for JWT bearer token requests, such as application/x-www-form-urlencoded or application/json.
JwtToken (dict) --
The JWT token to be used in the bearer token grant flow for authentication.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
TokenUrlParameters (list) --
Additional parameters to include in token URL requests as key-value pairs.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
AuthorizationCodeProperties (dict) --
Configuration properties specific to the OAuth2 Authorization Code grant type flow.
AuthorizationCodeUrl (dict) --
The authorization endpoint URL where users will be redirected to grant authorization.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
AuthorizationCode (dict) --
The authorization code received from the authorization server after user consent.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
RedirectUri (dict) --
The redirect URI that must match the URI registered with the authorization server.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
TokenUrl (dict) --
The token endpoint URL where the authorization code will be exchanged for an access token.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
RequestMethod (string) --
The HTTP method to use when making token exchange requests, typically POST.
ContentType (string) --
The content type to use for token exchange requests, such as application/x-www-form-urlencoded or application/json.
ClientId (dict) --
The OAuth2 client identifier provided by the authorization server.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
ClientSecret (dict) --
The OAuth2 client secret provided by the authorization server.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
Scope (dict) --
The OAuth2 scope that defines the level of access requested for the authorization code flow.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
Prompt (dict) --
The OAuth2 prompt parameter that controls the authorization server's behavior during user authentication.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
TokenUrlParameters (list) --
Additional parameters to include in token URL requests as key-value pairs.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
BasicAuthenticationProperties (dict) --
Basic authentication configuration that defines the username and password properties for HTTP Basic authentication.
Username (dict) --
The username property name to use for Basic authentication credentials.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
Password (dict) --
The password property name to use for Basic authentication credentials.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
CustomAuthenticationProperties (dict) --
Custom authentication configuration that allows for flexible authentication mechanisms beyond standard Basic and OAuth2 flows.
AuthenticationParameters (list) -- [REQUIRED]
A map of custom authentication parameters that define the specific authentication mechanism and required properties.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
dict
[REQUIRED]
Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.
GlobalSourceConfiguration (dict) --
Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) -- [REQUIRED]
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) -- [REQUIRED]
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) -- [REQUIRED]
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) -- [REQUIRED]
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
ValidationEndpointConfiguration (dict) --
Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) -- [REQUIRED]
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) -- [REQUIRED]
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) -- [REQUIRED]
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) -- [REQUIRED]
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
EntityConfigurations (dict) --
A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
(string) --
(dict) --
Configuration that defines how to interact with a specific data entity through the REST API, including its access patterns and schema definition.
SourceConfiguration (dict) --
The source configuration that defines how to make requests to access this entity's data through the REST API.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) -- [REQUIRED]
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) -- [REQUIRED]
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) -- [REQUIRED]
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) -- [REQUIRED]
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) -- [REQUIRED]
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) -- [REQUIRED]
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) -- [REQUIRED]
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
Schema (dict) --
The schema definition for this entity, including field names, types, and other metadata that describes the structure of the data.
(string) --
(dict) --
Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.
Name (string) -- [REQUIRED]
The name of the field in the entity schema.
FieldDataType (string) -- [REQUIRED]
The data type of the field.
dict
The tags you assign to the connection type.
(string) --
(string) --
dict
Response Syntax
{
'ConnectionTypeArn': 'string'
}
Response Structure
(dict) --
Contains the Amazon Resource Name (ARN) of the newly registered connection type.
ConnectionTypeArn (string) --
The Amazon Resource Name (ARN) of the registered connection type. This unique identifier can be used to reference the connection type in other Glue operations.
Deletes a custom connection type in Glue.
The connection type must exist and be registered before it can be deleted. This operation supports cleanup of connection type resources and helps maintain proper lifecycle management of custom connection types.
See also: AWS API Documentation
Request Syntax
client.delete_connection_type(
ConnectionType='string'
)
string
[REQUIRED]
The name of the connection type to delete. Must reference an existing registered connection type.
dict
Response Syntax
{}
Response Structure
(dict) --
{'AthenaConnectionProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | '
'QUERY_PARAM | PATH'},
'AuthenticationConfiguration': {'AuthenticationType': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH'},
'BasicAuthenticationProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH'},
'CustomAuthenticationProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH'},
'OAuth2Properties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH'},
'SecretArn': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | '
'BODY | '
'QUERY_PARAM '
'| PATH'}},
'ComputeEnvironmentConfigurations': {'ConnectionOptions': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH'}},
'ConnectionOptions': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | QUERY_PARAM | '
'PATH'},
'ConnectionProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | QUERY_PARAM | '
'PATH'},
'PhysicalConnectionRequirements': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | '
'QUERY_PARAM | PATH'},
'PythonConnectionProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | '
'QUERY_PARAM | PATH'},
'RestConfiguration': {'EntityConfigurations': {'string': {'Schema': {'string': {'FieldDataType': 'INT '
'| '
'SMALLINT '
'| '
'BIGINT '
'| '
'FLOAT '
'| '
'LONG '
'| '
'DATE '
'| '
'BOOLEAN '
'| '
'MAP '
'| '
'ARRAY '
'| '
'STRING '
'| '
'TIMESTAMP '
'| '
'DECIMAL '
'| '
'BYTE '
'| '
'SHORT '
'| '
'DOUBLE '
'| '
'STRUCT '
'| '
'BINARY '
'| '
'UNION',
'Name': 'string'}},
'SourceConfiguration': {'PaginationConfiguration': {'CursorConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'NextPage': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}},
'OffsetConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'OffsetParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}}},
'RequestMethod': 'GET '
'| '
'POST',
'RequestParameters': [{'AllowedValues': ['string'],
'DefaultValue': 'string',
'KeyOverride': 'string',
'Name': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'PropertyType': 'USER_INPUT '
'| '
'SECRET '
'| '
'READ_ONLY '
'| '
'UNUSED '
'| '
'SECRET_OR_USER_INPUT',
'Required': 'boolean'}],
'RequestPath': 'string',
'ResponseConfiguration': {'ErrorPath': 'string',
'ResultPath': 'string'}}}},
'GlobalSourceConfiguration': {'PaginationConfiguration': {'CursorConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'NextPage': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}},
'OffsetConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'OffsetParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}}},
'RequestMethod': 'GET | '
'POST',
'RequestParameters': [{'AllowedValues': ['string'],
'DefaultValue': 'string',
'KeyOverride': 'string',
'Name': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'PropertyType': 'USER_INPUT '
'| '
'SECRET '
'| '
'READ_ONLY '
'| '
'UNUSED '
'| '
'SECRET_OR_USER_INPUT',
'Required': 'boolean'}],
'RequestPath': 'string',
'ResponseConfiguration': {'ErrorPath': 'string',
'ResultPath': 'string'}},
'ValidationEndpointConfiguration': {'PaginationConfiguration': {'CursorConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'NextPage': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}},
'OffsetConfiguration': {'LimitParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}},
'OffsetParameter': {'DefaultValue': 'string',
'Key': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'Value': {'ContentPath': 'string',
'HeaderKey': 'string'}}}},
'RequestMethod': 'GET '
'| '
'POST',
'RequestParameters': [{'AllowedValues': ['string'],
'DefaultValue': 'string',
'KeyOverride': 'string',
'Name': 'string',
'PropertyLocation': 'HEADER '
'| '
'BODY '
'| '
'QUERY_PARAM '
'| '
'PATH',
'PropertyType': 'USER_INPUT '
'| '
'SECRET '
'| '
'READ_ONLY '
'| '
'UNUSED '
'| '
'SECRET_OR_USER_INPUT',
'Required': 'boolean'}],
'RequestPath': 'string',
'ResponseConfiguration': {'ErrorPath': 'string',
'ResultPath': 'string'}}},
'SparkConnectionProperties': {'KeyOverride': 'string',
'PropertyLocation': 'HEADER | BODY | '
'QUERY_PARAM | PATH'}}
The DescribeConnectionType API provides full details of the supported options for a given connection type in Glue. The response includes authentication configuration details that show supported authentication types and properties, and RestConfiguration for custom REST-based connection types registered via RegisterConnectionType.
See also: ListConnectionTypes, RegisterConnectionType, DeleteConnectionType
See also: AWS API Documentation
Request Syntax
client.describe_connection_type(
ConnectionType='string'
)
string
[REQUIRED]
The name of the connection type to be described.
dict
Response Syntax
{
'ConnectionType': 'string',
'Description': 'string',
'Capabilities': {
'SupportedAuthenticationTypes': [
'BASIC'|'OAUTH2'|'CUSTOM'|'IAM',
],
'SupportedDataOperations': [
'READ'|'WRITE',
],
'SupportedComputeEnvironments': [
'SPARK'|'ATHENA'|'PYTHON',
]
},
'ConnectionProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'ConnectionOptions': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'AuthenticationConfiguration': {
'AuthenticationType': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
},
'SecretArn': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
},
'OAuth2Properties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'BasicAuthenticationProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'CustomAuthenticationProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
}
},
'ComputeEnvironmentConfigurations': {
'string': {
'Name': 'string',
'Description': 'string',
'ComputeEnvironment': 'SPARK'|'ATHENA'|'PYTHON',
'SupportedAuthenticationTypes': [
'BASIC'|'OAUTH2'|'CUSTOM'|'IAM',
],
'ConnectionOptions': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'ConnectionPropertyNameOverrides': {
'string': 'string'
},
'ConnectionOptionNameOverrides': {
'string': 'string'
},
'ConnectionPropertiesRequiredOverrides': [
'string',
],
'PhysicalConnectionPropertiesRequired': True|False
}
},
'PhysicalConnectionRequirements': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'AthenaConnectionProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'PythonConnectionProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'SparkConnectionProperties': {
'string': {
'Name': 'string',
'Description': 'string',
'Required': True|False,
'DefaultValue': 'string',
'PropertyTypes': [
'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT',
],
'AllowedValues': [
{
'Description': 'string',
'Value': 'string'
},
],
'DataOperationScopes': [
'READ'|'WRITE',
],
'KeyOverride': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH'
}
},
'RestConfiguration': {
'GlobalSourceConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'ValidationEndpointConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'EntityConfigurations': {
'string': {
'SourceConfiguration': {
'RequestMethod': 'GET'|'POST',
'RequestPath': 'string',
'RequestParameters': [
{
'Name': 'string',
'KeyOverride': 'string',
'Required': True|False,
'DefaultValue': 'string',
'AllowedValues': [
'string',
],
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'PropertyType': 'USER_INPUT'|'SECRET'|'READ_ONLY'|'UNUSED'|'SECRET_OR_USER_INPUT'
},
],
'ResponseConfiguration': {
'ResultPath': 'string',
'ErrorPath': 'string'
},
'PaginationConfiguration': {
'CursorConfiguration': {
'NextPage': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
},
'OffsetConfiguration': {
'OffsetParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
},
'LimitParameter': {
'Key': 'string',
'DefaultValue': 'string',
'PropertyLocation': 'HEADER'|'BODY'|'QUERY_PARAM'|'PATH',
'Value': {
'ContentPath': 'string',
'HeaderKey': 'string'
}
}
}
}
},
'Schema': {
'string': {
'Name': 'string',
'FieldDataType': 'INT'|'SMALLINT'|'BIGINT'|'FLOAT'|'LONG'|'DATE'|'BOOLEAN'|'MAP'|'ARRAY'|'STRING'|'TIMESTAMP'|'DECIMAL'|'BYTE'|'SHORT'|'DOUBLE'|'STRUCT'|'BINARY'|'UNION'
}
}
}
}
}
}
Response Structure
(dict) --
ConnectionType (string) --
The name of the connection type.
Description (string) --
A description of the connection type.
Capabilities (dict) --
The supported authentication types, data interface types (compute environments), and data operations of the connector.
SupportedAuthenticationTypes (list) --
A list of supported authentication types.
(string) --
SupportedDataOperations (list) --
A list of supported data operations.
(string) --
SupportedComputeEnvironments (list) --
A list of supported compute environments.
(string) --
ConnectionProperties (dict) --
Connection properties which are common across compute environments.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
ConnectionOptions (dict) --
Returns properties that can be set when creating a connection in the ConnectionInput.ConnectionProperties. ConnectionOptions defines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
AuthenticationConfiguration (dict) --
The type of authentication used for the connection.
AuthenticationType (dict) --
The type of authentication for a connection.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
SecretArn (dict) --
The Amazon Resource Name (ARN) for the Secrets Manager.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
OAuth2Properties (dict) --
A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
BasicAuthenticationProperties (dict) --
A map of key-value pairs for the OAuth2 properties. Each value is a a Property object.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
CustomAuthenticationProperties (dict) --
A map of key-value pairs for the custom authentication properties. Each value is a a Property object.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
ComputeEnvironmentConfigurations (dict) --
The compute environments that are supported by the connection.
(string) --
(dict) --
An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the DescribeConnectionType API.
Name (string) --
A name for the compute environment configuration.
Description (string) --
A description of the compute environment.
ComputeEnvironment (string) --
The type of compute environment.
SupportedAuthenticationTypes (list) --
The supported authentication types for the compute environment.
(string) --
ConnectionOptions (dict) --
The parameters used as connection options for the compute environment.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
ConnectionPropertyNameOverrides (dict) --
The connection property name overrides for the compute environment.
(string) --
(string) --
ConnectionOptionNameOverrides (dict) --
The connection option name overrides for the compute environment.
(string) --
(string) --
ConnectionPropertiesRequiredOverrides (list) --
The connection properties that are required as overrides for the compute environment.
(string) --
PhysicalConnectionPropertiesRequired (boolean) --
Indicates whether PhysicalConnectionProperties are required for the compute environment.
PhysicalConnectionRequirements (dict) --
Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
AthenaConnectionProperties (dict) --
Connection properties specific to the Athena compute environment.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PythonConnectionProperties (dict) --
Connection properties specific to the Python compute environment.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
SparkConnectionProperties (dict) --
Connection properties specific to the Spark compute environment.
(string) --
(dict) --
An object that defines a connection type for a compute environment.
Name (string) --
The name of the property.
Description (string) --
A description of the property.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
PropertyTypes (list) --
Describes the type of property.
(string) --
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(dict) --
An object representing a value allowed for a property.
Description (string) --
A description of the allowed value.
Value (string) --
The value allowed for the property.
DataOperationScopes (list) --
Indicates which data operations are applicable to the property.
(string) --
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
RestConfiguration (dict) --
HTTP request and response configuration, validation endpoint, and entity configurations for REST based data source.
GlobalSourceConfiguration (dict) --
Global configuration settings that apply to all REST API requests for this connection type, including common request methods, paths, and parameters.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) --
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) --
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) --
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) --
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) --
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
ValidationEndpointConfiguration (dict) --
Configuration for the endpoint used to validate connection credentials and test connectivity during connection creation.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) --
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) --
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) --
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) --
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) --
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
EntityConfigurations (dict) --
A map of entity configurations that define how to interact with different data entities available through the REST API, including their schemas and access patterns.
(string) --
(dict) --
Configuration that defines how to interact with a specific data entity through the REST API, including its access patterns and schema definition.
SourceConfiguration (dict) --
The source configuration that defines how to make requests to access this entity's data through the REST API.
RequestMethod (string) --
The HTTP method to use for requests to this endpoint, such as GET, POST.
RequestPath (string) --
The URL path for the REST endpoint, which may include parameter placeholders that will be replaced with actual values during requests.
RequestParameters (list) --
Configuration for request parameters that should be included in API calls, such as query parameters, headers, or body content.
(dict) --
Defines a property configuration for connection types, default values, and where the property should be used in requests.
Name (string) --
The name of the property.
KeyOverride (string) --
A key name to use when sending this property in API requests, if different from the display name.
Required (boolean) --
Indicates whether the property is required.
DefaultValue (string) --
The default value for the property.
AllowedValues (list) --
A list of AllowedValue objects representing the values allowed for the property.
(string) --
PropertyLocation (string) --
Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
PropertyType (string) --
The data type of this property
ResponseConfiguration (dict) --
Configuration that defines how to parse and extract data from API responses, including success and error handling.
ResultPath (string) --
The JSON path expression that identifies where the actual result data is located within the API response.
ErrorPath (string) --
The JSON path expression that identifies where error information is located within API responses when requests fail.
PaginationConfiguration (dict) --
Configuration for handling paginated responses from the REST API, supporting both cursor-based and offset-based pagination strategies.
CursorConfiguration (dict) --
Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
NextPage (dict) --
The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
OffsetConfiguration (dict) --
Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
OffsetParameter (dict) --
The parameter name used to specify the starting position or offset for retrieving results.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
LimitParameter (dict) --
The parameter name used to specify the maximum number of results to return per page.
Key (string) --
The parameter key name that will be used in subsequent requests.
DefaultValue (string) --
The default value to use if the parameter cannot be extracted from the response.
PropertyLocation (string) --
Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.
Value (dict) --
The JSON path or extraction mapping that defines how to extract the parameter value from API responses.
ContentPath (string) --
A JSON path expression that specifies how to extract a value from the response body content.
HeaderKey (string) --
The name of an HTTP response header from which to extract the value.
Schema (dict) --
The schema definition for this entity, including field names, types, and other metadata that describes the structure of the data.
(string) --
(dict) --
Defines a field in an entity schema for REST connector data sources, specifying the field name and data type.
Name (string) --
The name of the field in the entity schema.
FieldDataType (string) --
The data type of the field.
{'Fields': {'FieldType': {'UNION', 'BINARY'}}}
Provides details regarding the entity used with the connection type, with a description of the data model for each field in the selected entity.
The response includes all the fields which make up the entity.
See also: AWS API Documentation
Request Syntax
client.describe_entity(
ConnectionName='string',
CatalogId='string',
EntityName='string',
NextToken='string',
DataStoreApiVersion='string'
)
string
[REQUIRED]
The name of the connection that contains the connection type credentials.
string
The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.
string
[REQUIRED]
The name of the entity that you want to describe from the connection type.
string
A continuation token, included if this is a continuation call.
string
The version of the API used for the data store.
dict
Response Syntax
{
'Fields': [
{
'FieldName': 'string',
'Label': 'string',
'Description': 'string',
'FieldType': 'INT'|'SMALLINT'|'BIGINT'|'FLOAT'|'LONG'|'DATE'|'BOOLEAN'|'MAP'|'ARRAY'|'STRING'|'TIMESTAMP'|'DECIMAL'|'BYTE'|'SHORT'|'DOUBLE'|'STRUCT'|'BINARY'|'UNION',
'IsPrimaryKey': True|False,
'IsNullable': True|False,
'IsRetrievable': True|False,
'IsFilterable': True|False,
'IsPartitionable': True|False,
'IsCreateable': True|False,
'IsUpdateable': True|False,
'IsUpsertable': True|False,
'IsDefaultOnCreate': True|False,
'SupportedValues': [
'string',
],
'SupportedFilterOperators': [
'LESS_THAN'|'GREATER_THAN'|'BETWEEN'|'EQUAL_TO'|'NOT_EQUAL_TO'|'GREATER_THAN_OR_EQUAL_TO'|'LESS_THAN_OR_EQUAL_TO'|'CONTAINS'|'ORDER_BY',
],
'ParentField': 'string',
'NativeDataType': 'string',
'CustomProperties': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Fields (list) --
Describes the fields for that connector entity. This is the list of Field objects. Field is very similar to column in a database. The Field object has information about different properties associated with fields in the connector.
(dict) --
The Field object has information about the different properties associated with a field in the connector.
FieldName (string) --
A unique identifier for the field.
Label (string) --
A readable label used for the field.
Description (string) --
A description of the field.
FieldType (string) --
The type of data in the field.
IsPrimaryKey (boolean) --
Indicates whether this field can used as a primary key for the given entity.
IsNullable (boolean) --
Indicates whether this field can be nullable or not.
IsRetrievable (boolean) --
Indicates whether this field can be added in Select clause of SQL query or whether it is retrievable or not.
IsFilterable (boolean) --
Indicates whether this field can used in a filter clause ( WHERE clause) of a SQL statement when querying data.
IsPartitionable (boolean) --
Indicates whether a given field can be used in partitioning the query made to SaaS.
IsCreateable (boolean) --
Indicates whether this field can be created as part of a destination write.
IsUpdateable (boolean) --
Indicates whether this field can be updated as part of a destination write.
IsUpsertable (boolean) --
Indicates whether this field can be upserted as part of a destination write.
IsDefaultOnCreate (boolean) --
Indicates whether this field is populated automatically when the object is created, such as a created at timestamp.
SupportedValues (list) --
A list of supported values for the field.
(string) --
SupportedFilterOperators (list) --
Indicates the support filter operators for this field.
(string) --
ParentField (string) --
A parent field name for a nested field.
NativeDataType (string) --
The data type returned by the SaaS API, such as “picklist” or “textarea” from Salesforce.
CustomProperties (dict) --
Optional map of keys which may be returned.
(string) --
(string) --
NextToken (string) --
A continuation token, present if the current segment is not the last.