# Connection Types API The Connection Type API describes Amazon Glue APIs related to describing connection types. ## Connection management APIs + [DescribeConnectionType action (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType) + [ListConnectionTypes action (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes) + [ConnectionTypeBrief structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) + [ConnectionTypeVariant structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) ## DescribeConnectionType action (Python: describe\$1connection\$1type) The `DescribeConnectionType` API provides full details of the supported options for a given connection type in Amazon Glue. **Request** + `ConnectionType` – *Required:* UTF-8 string, not less than 1 or more than 255 bytes long, matching the [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). The name of the connection type to be described. **Response** + `ConnectionType` – UTF-8 string, not less than 1 or more than 255 bytes long, matching the [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). The name of the connection type. + `Description` – UTF-8 string, not more than 1024 bytes long. A description of the connection type. + `Capabilities` – A [Capabilities](#aws-glue-api-catalog-connections-connections-type-Capabilities) object. The supported authentication types, data interface types (compute environments), and data operations of the connector. + `ConnectionProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. Connection properties which are common across compute environments. + `ConnectionOptions` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. 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. + `AuthenticationConfiguration` – An [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) object. The type of authentication used for the connection. + `ComputeEnvironmentConfigurations` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) object. The compute environments that are supported by the connection. + `PhysicalConnectionRequirements` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. Physical requirements for a connection, such as VPC, Subnet and Security Group specifications. + `AthenaConnectionProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. Connection properties specific to the Athena compute environment. + `PythonConnectionProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. Connection properties specific to the Python compute environment. + `SparkConnectionProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. Connection properties specific to the Spark compute environment. **Errors** + `ValidationException` + `InvalidInputException` + `InternalServiceException` ## ListConnectionTypes action (Python: list\$1connection\$1types) The `ListConnectionTypes` API provides a discovery mechanism to learn available connection types in Amazon Glue. The response contains a list of connection types with high-level details of what is supported for each connection type. The connection types listed are the set of supported options for the `ConnectionType` value in the `CreateConnection` API. **Request** + `MaxResults` – Number (integer), not less than 1 or more than 1000. The maximum number of results to return. + `NextToken` – UTF-8 string, not less than 1 or more than 2048 bytes long, matching the [Custom string pattern #11](aws-glue-api-common.md#regex_11). A continuation token, if this is a continuation call. **Response** + `ConnectionTypes` – An array of [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief) objects. A list of `ConnectionTypeBrief` objects containing brief information about the supported connection types. + `NextToken` – UTF-8 string, not less than 1 or more than 2048 bytes long, matching the [Custom string pattern #11](aws-glue-api-common.md#regex_11). A continuation token, if the current list segment is not the last. **Errors** + `InternalServiceException` ## ConnectionTypeBrief structure Brief information about a supported connection type returned by the `ListConnectionTypes` API. **Fields** + `ConnectionType` – UTF-8 string (valid values: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`). The name of the connection type. + `DisplayName` – UTF-8 string, not less than 1 or more than 128 bytes long. The human-readable name for the connection type that is displayed in the Amazon Glue console. + `Vendor` – UTF-8 string, not less than 1 or more than 128 bytes long. The name of the vendor or provider that created or maintains this connection type. + `Description` – UTF-8 string, not more than 1024 bytes long. A description of the connection type. + `Categories` – . A list of categories that this connection type belongs to. Categories help users filter and find appropriate connection types based on their use cases. + `Capabilities` – A [Capabilities](#aws-glue-api-catalog-connections-connections-type-Capabilities) object. The supported authentication types, data interface types (compute environments), and data operations of the connector. + `LogoUrl` – UTF-8 string. The URL of the logo associated with a connection type. + `ConnectionTypeVariants` – An array of [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant) objects. A list of variants available for this connection type. Different variants may provide specialized configurations for specific use cases or implementations of the same general connection type. ## ConnectionTypeVariant structure Represents a variant of a connection type in Amazon Glue Data Catalog. Connection type variants provide specific configurations and behaviors for different implementations of the same general connection type. **Fields** + `ConnectionTypeVariantName` – UTF-8 string, not less than 1 or more than 128 bytes long. The unique identifier for the connection type variant. This name is used internally to identify the specific variant of a connection type. + `DisplayName` – UTF-8 string, not less than 1 or more than 128 bytes long. The human-readable name for the connection type variant that is displayed in the Amazon Glue console. + `Description` – UTF-8 string, not more than 1024 bytes long. A detailed description of the connection type variant, including its purpose, use cases, and any specific configuration requirements. + `LogoUrl` – UTF-8 string. The URL of the logo associated with a connection type variant. ## datatypes + [Validation structure](#aws-glue-api-catalog-connections-connections-type-Validation) + [AuthConfiguration structure](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration) + [Capabilities structure](#aws-glue-api-catalog-connections-connections-type-Capabilities) + [Property structure](#aws-glue-api-catalog-connections-connections-type-Property) + [AllowedValue structure](#aws-glue-api-catalog-connections-connections-type-AllowedValue) + [ComputeEnvironmentConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) ## Validation structure Defines how a validation is performed on a connection property. **Fields** + `ValidationType` – *Required:* UTF-8 string (valid values: `REGEX` \$1 `RANGE`). The type of validation to be performed, such as `REGEX`. + `Patterns` – . A list of patterns that apply to the validation. + `Description` – *Required:* UTF-8 string, not less than 1 or more than 1024 bytes long. A description for the validation. + `MaxLength` – Number (integer). A maximum length for a string connection property. + `Maximum` – Number (integer). A maximum value when specifying a `RANGE` type of validation. + `Minimum` – Number (integer). A minimum value when specifying a `RANGE` type of validation. ## AuthConfiguration structure The authentication configuration for a connection returned by the `DescribeConnectionType` API. **Fields** + `AuthenticationType` – *Required:* A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. The type of authentication for a connection. + `SecretArn` – A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. The Amazon Resource Name (ARN) for the Secrets Manager. + `OAuth2Properties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. A map of key-value pairs for the OAuth2 properties. Each value is a a `Property` object. + `BasicAuthenticationProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. A map of key-value pairs for the OAuth2 properties. Each value is a a `Property` object. + `CustomAuthenticationProperties` – A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. A map of key-value pairs for the custom authentication properties. Each value is a a `Property` object. ## Capabilities structure Specifies the supported authentication types returned by the `DescribeConnectionType` API. **Fields** + `SupportedAuthenticationTypes` – *Required:* An array of UTF-8 strings. A list of supported authentication types. + `SupportedDataOperations` – *Required:* An array of UTF-8 strings. A list of supported data operations. + `SupportedComputeEnvironments` – *Required:* An array of UTF-8 strings. A list of supported compute environments. ## Property structure An object that defines a connection type for a compute environment. **Fields** + `Name` – *Required:* UTF-8 string, not less than 1 or more than 128 bytes long. The name of the property. + `Description` – *Required:* UTF-8 string, not more than 1024 bytes long. A description of the property. + `Required` – *Required:* Boolean. Indicates whether the property is required. + `PropertyTypes` – *Required:* An array of UTF-8 strings. Describes the type of property. + `AllowedValues` – An array of [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue) objects. A list of `AllowedValue` objects representing the values allowed for the property. + `DataOperationScopes` – An array of UTF-8 strings. Indicates which data operations are applicable to the property. ## AllowedValue structure An object representing a value allowed for a property. **Fields** + `Description` – UTF-8 string, not more than 1024 bytes long. A description of the allowed value. + `Value` – *Required:* UTF-8 string, not less than 1 or more than 128 bytes long. The value allowed for the property. ## ComputeEnvironmentConfiguration structure An object containing configuration for a compute environment (such as Spark, Python or Athena) returned by the `DescribeConnectionType` API. **Fields** + `Name` – *Required:* UTF-8 string, not less than 1 or more than 128 bytes long. A name for the compute environment configuration. + `Description` – *Required:* UTF-8 string, not more than 1024 bytes long. A description of the compute environment. + `ComputeEnvironment` – *Required:* UTF-8 string (valid values: `SPARK` \$1 `ATHENA` \$1 `PYTHON`). The type of compute environment. + `SupportedAuthenticationTypes` – *Required:* An array of UTF-8 strings. The supported authentication types for the compute environment. + `ConnectionOptions` – *Required:* A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a A [Property](#aws-glue-api-catalog-connections-connections-type-Property) object. The parameters used as connection options for the compute environment. + `ConnectionPropertyNameOverrides` – *Required:* A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not less than 1 or more than 128 bytes long. The connection property name overrides for the compute environment. + `ConnectionOptionNameOverrides` – *Required:* A map array of key-value pairs. Each key is a UTF-8 string, not less than 1 or more than 128 bytes long. Each value is a UTF-8 string, not less than 1 or more than 128 bytes long. The connection option name overrides for the compute environment. + `ConnectionPropertiesRequiredOverrides` – *Required:* . The connection properties that are required as overrides for the compute environment. + `PhysicalConnectionPropertiesRequired` – Boolean. Indicates whether `PhysicalConnectionProperties` are required for the compute environment.