DescribeConnectionType
The DescribeConnectionType API provides full details of the supported options for a given connection type in AWS Glue.
Request Syntax
{
"ConnectionType": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConnectionType
-
The name of the connection type to be described.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
Response Syntax
{
"AthenaConnectionProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"AuthenticationConfiguration": {
"AuthenticationType": {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
},
"BasicAuthenticationProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"CustomAuthenticationProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"OAuth2Properties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"SecretArn": {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"Capabilities": {
"SupportedAuthenticationTypes": [ "string" ],
"SupportedComputeEnvironments": [ "string" ],
"SupportedDataOperations": [ "string" ]
},
"ComputeEnvironmentConfigurations": {
"string" : {
"ComputeEnvironment": "string",
"ConnectionOptionNameOverrides": {
"string" : "string"
},
"ConnectionOptions": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"ConnectionPropertiesRequiredOverrides": [ "string" ],
"ConnectionPropertyNameOverrides": {
"string" : "string"
},
"Description": "string",
"Name": "string",
"PhysicalConnectionPropertiesRequired": boolean,
"SupportedAuthenticationTypes": [ "string" ]
}
},
"ConnectionOptions": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"ConnectionProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"ConnectionType": "string",
"Description": "string",
"PhysicalConnectionRequirements": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"PythonConnectionProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
},
"SparkConnectionProperties": {
"string" : {
"AllowedValues": [
{
"Description": "string",
"Value": "string"
}
],
"DataOperationScopes": [ "string" ],
"DefaultValue": "string",
"Description": "string",
"Name": "string",
"PropertyTypes": [ "string" ],
"Required": boolean
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AthenaConnectionProperties
-
Connection properties specific to the Athena compute environment.
Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- AuthenticationConfiguration
-
The type of authentication used for the connection.
Type: AuthConfiguration object
- Capabilities
-
The supported authentication types, data interface types (compute environments), and data operations of the connector.
Type: Capabilities object
- ComputeEnvironmentConfigurations
-
The compute environments that are supported by the connection.
Type: String to ComputeEnvironmentConfiguration object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- ConnectionOptions
-
Returns properties that can be set when creating a connection in the
ConnectionInput.ConnectionProperties.ConnectionOptionsdefines parameters that can be set in a Spark ETL script in the connection options map passed to a dataframe.Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- ConnectionProperties
-
Connection properties which are common across compute environments.
Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- ConnectionType
-
The name of the connection type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]* - Description
-
A description of the connection type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- PhysicalConnectionRequirements
-
Physical requirements for a connection, such as VPC, Subnet and Security Group specifications.
Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- PythonConnectionProperties
-
Connection properties specific to the Python compute environment.
Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
- SparkConnectionProperties
-
Connection properties specific to the Spark compute environment.
Type: String to Property object map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- ValidationException
-
A value could not be validated.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
