Connection Types API

• DescribeConnectionType action (Python: describe_connection_type)

• ListConnectionTypes action (Python: list_connection_types)

• ConnectionTypeBrief structure

• ConnectionTypeVariant structure

Request

• ConnectionType – Required: UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

  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.

  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 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 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 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 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 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 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 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 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 object.

  Connection properties specific to the Spark compute environment.

Errors

• ValidationException

• InvalidInputException

• InternalServiceException

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.

  A continuation token, if this is a continuation call.

Response

• ConnectionTypes – An array of 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.

  A continuation token, if the current list segment is not the last.

Errors

• InternalServiceException

Fields

• ConnectionType – UTF-8 string (valid values: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

  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 – An array of UTF-8 strings.

  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 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 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.

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.

• Validation structure

• AuthConfiguration structure

• Capabilities structure

• Property structure

• AllowedValue structure

• ComputeEnvironmentConfiguration structure

Fields

• ValidationType – Required: UTF-8 string (valid values: REGEX | RANGE).

  The type of validation to be performed, such as REGEX.

• Patterns – An array of UTF-8 strings.

  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.

Fields

• AuthenticationType – Required: A Property object.

  The type of authentication for a connection.

• SecretArn – A 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 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 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 object.

  A map of key-value pairs for the custom authentication properties. Each value is a a Property object.

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.

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.

• DefaultValue – UTF-8 string.

  The default value for the property.

• PropertyTypes – Required: An array of UTF-8 strings.

  Describes the type of property.

• AllowedValues – An array of 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.

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.

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 | ATHENA | 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 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: An array of UTF-8 strings.

  The connection properties that are required as overrides for the compute environment.

• PhysicalConnectionPropertiesRequired – Boolean.

  Indicates whether PhysicalConnectionProperties are required for the compute environment.