— data types —Connection ConnectionInput PhysicalConnectionRequirements GetConnectionsFilter — operations —CreateConnection (create_connection)DeleteConnection (delete_connection)GetConnection (get_connection)GetConnections (get_connections)UpdateConnection (update_connection)BatchDeleteConnection (batch_delete_connection)

Connection API

The Connection API describes AWS Glue connection data types, and the API for creating, deleting, updating, and listing connections.

Connection structure

Defines a connection to a data source.

Fields

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

The name of the connection definition.
Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

The description of the connection.
ConnectionType – UTF-8 string (valid values: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM).

The type of the connection. Currently, SFTP is not supported.
MatchCriteria – An array of UTF-8 strings, not more than 10 strings.

A list of criteria that can be used in selecting this connection.
ConnectionProperties – A map array of key-value pairs, not more than 100 pairs.

Each key is a UTF-8 string (valid values: HOST | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM | AUTHENTICATION_SECRET_ARN | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME).

Each value is a Value string, not more than 1024 bytes long.

These key-value pairs define parameters for the connection:
- HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.
- PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.
- USER_NAME - The name under which to log in to the database. The value string for USER_NAME is "USERNAME".
- PASSWORD - A password, if one is used, for the user name.
- ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.
- JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.
- JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
- JDBC_ENGINE - The name of the JDBC engine to use.
- JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
- CONFIG_FILES - (Reserved for future use.)
- INSTANCE_ID - The instance ID to use.
- JDBC_CONNECTION_URL - The URL for connecting to a JDBC data source.
- JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.
- CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer's certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.
- SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip AWS Glue's validation of the customer certificate.
- CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
- CONNECTION_URL - The URL for connecting to a general (non-JDBC) data source.
- SECRET_ID - The secret ID used for the secret manager of credentials.
- CONNECTOR_URL - The connector URL for a MARKETPLACE or CUSTOM connection.
- CONNECTOR_TYPE - The connector type for a MARKETPLACE or CUSTOM connection.
- CONNECTOR_CLASS_NAME - The connector class name for a MARKETPLACE or CUSTOM connection.
- KAFKA_BOOTSTRAP_SERVERS - A comma-separated list of host and port pairs that are the addresses of the Apache Kafka brokers in a Kafka cluster to which a Kafka client will connect to and bootstrap itself.
- KAFKA_SSL_ENABLED - Whether to enable or disable SSL on an Apache Kafka connection. Default value is "true".
- KAFKA_CUSTOM_CERT - The Amazon S3 URL for the private CA cert file (.pem format). The default is an empty string.
- KAFKA_SKIP_CUSTOM_CERT_VALIDATION - Whether to skip the validation of the CA cert file or not. AWS Glue validates for three algorithms: SHA256withRSA, SHA384withRSA and SHA512withRSA. Default value is "false".
- KAFKA_CLIENT_KEYSTORE - The Amazon S3 location of the client keystore file for Kafka client side authentication (Optional).
- KAFKA_CLIENT_KEYSTORE_PASSWORD - The password to access the provided keystore (Optional).
- KAFKA_CLIENT_KEY_PASSWORD - A keystore can consist of multiple keys, so this is the password to access the client key to be used with the Kafka server side key (Optional).
- ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD - The encrypted version of the Kafka client keystore password (if the user has the AWS Glue encrypt passwords setting selected).
- ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD - The encrypted version of the Kafka client key password (if the user has the AWS Glue encrypt passwords setting selected).
- KAFKA_SASL_MECHANISM - "SCRAM-SHA-512", "GSSAPI", or "AWS_MSK_IAM". These are the supported SASL Mechanisms.
- KAFKA_SASL_SCRAM_USERNAME - A plaintext username used to authenticate with the "SCRAM-SHA-512" mechanism.
- KAFKA_SASL_SCRAM_PASSWORD - A plaintext password used to authenticate with the "SCRAM-SHA-512" mechanism.
- ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD - The encrypted version of the Kafka SASL SCRAM password (if the user has the AWS Glue encrypt passwords setting selected).
- KAFKA_SASL_GSSAPI_KEYTAB - The S3 location of a Kerberos keytab file. A keytab stores long-term keys for one or more principals. For more information, see MIT Kerberos Documentation: Keytab.
- KAFKA_SASL_GSSAPI_KRB5_CONF - The S3 location of a Kerberos krb5.conf file. A krb5.conf stores Kerberos configuration information, such as the location of the KDC server. For more information, see MIT Kerberos Documentation: krb5.conf.
- KAFKA_SASL_GSSAPI_SERVICE - The Kerberos service name, as set with sasl.kerberos.service.name in your Kafka Configuration.
- KAFKA_SASL_GSSAPI_PRINCIPAL - The name of the Kerberos princial used by AWS Glue. For more information, see Kafka Documentation: Configuring Kafka Brokers.
PhysicalConnectionRequirements – A PhysicalConnectionRequirements object.

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.
CreationTime – Timestamp.

The time that this connection definition was created.
LastUpdatedTime – Timestamp.

The last time that this connection definition was updated.
LastUpdatedBy – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The user, group, or role that last updated this connection definition.

ConnectionInput structure

A structure that is used to specify a connection to create or update.

Fields

Name – 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. Connection will not function as expected without a name.
Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

The description of the connection.
ConnectionType – Required: UTF-8 string (valid values: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM).

The type of the connection. Currently, these types are supported:
- JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
  
  JDBC Connections use the following ConnectionParameters.
  - Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.
  - Required: All of (USERNAME, PASSWORD) or SECRET_ID.
  - Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
- KAFKA - Designates a connection to an Apache Kafka streaming platform.
  
  KAFKA Connections use the following ConnectionParameters.
  - Required: KAFKA_BOOTSTRAP_SERVERS.
  - Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.
  - Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.
  - Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.
  - Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.
  - Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.
- MONGODB - Designates a connection to a MongoDB document database.
  
  MONGODB Connections use the following ConnectionParameters.
  - Required: CONNECTION_URL.
  - Required: All of (USERNAME, PASSWORD) or SECRET_ID.
- NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
  
  NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.
- MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.
  
  MARKETPLACE Connections use the following ConnectionParameters.
  - Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.
  - Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.
- CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.
SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in AWS Glue, consult AWS Glue connection properties.

For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult Using connectors and connections.
MatchCriteria – An array of UTF-8 strings, not more than 10 strings.

A list of criteria that can be used in selecting this connection.
ConnectionProperties – Required: A map array of key-value pairs, not more than 100 pairs.

Each key is a UTF-8 string (valid values: HOST | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES | INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | KAFKA_SASL_MECHANISM | AUTHENTICATION_SECRET_ARN | KAFKA_SASL_SCRAM_USERNAME | KAFKA_SASL_SCRAM_PASSWORD | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB | KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME).

Each value is a Value string, not more than 1024 bytes long.

These key-value pairs define parameters for the connection.
PhysicalConnectionRequirements – A PhysicalConnectionRequirements object.

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

PhysicalConnectionRequirements structure

Specifies the physical requirements for a connection.

Fields

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

The subnet ID used by the connection.
SecurityGroupIdList – An array of UTF-8 strings, not more than 50 strings.

The security group ID list used by the connection.
AvailabilityZone – UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

GetConnectionsFilter structure

Filters the connection definitions that are returned by the GetConnections API operation.

Fields

MatchCriteria – An array of UTF-8 strings, not more than 10 strings.

A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.
ConnectionType – UTF-8 string (valid values: JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM).

The type of connections to return. Currently, SFTP is not supported.

Operations

CreateConnection action (Python: create_connection)
DeleteConnection action (Python: delete_connection)
GetConnection action (Python: get_connection)
GetConnections action (Python: get_connections)
UpdateConnection action (Python: update_connection)
BatchDeleteConnection action (Python: batch_delete_connection)

CreateConnection action (Python: create_connection)

Creates a connection definition in the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default.
ConnectionInput – Required: A ConnectionInput object.

A ConnectionInput object defining the connection to create.
Tags – A map array of key-value pairs, not more than 50 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 more than 256 bytes long.

The tags you assign to the connection.

Response

No Response parameters.

Errors

AlreadyExistsException
InvalidInputException
OperationTimeoutException
ResourceNumberLimitExceededException
GlueEncryptionException

DeleteConnection action (Python: delete_connection)

Deletes a connection from the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
ConnectionName – 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 to delete.

Response

No Response parameters.

Errors

EntityNotFoundException
OperationTimeoutException

GetConnection action (Python: get_connection)

Retrieves a connection definition from the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
Name – 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 definition to retrieve.
HidePassword – Boolean.

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

Response

Connection – A Connection object.

The requested connection definition.

Errors

EntityNotFoundException
OperationTimeoutException
InvalidInputException
GlueEncryptionException

GetConnections action (Python: get_connections)

Retrieves a list of connection definitions from the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.
Filter – A GetConnectionsFilter object.

A filter that controls which connections are returned.
HidePassword – Boolean.

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.
NextToken – UTF-8 string.

A continuation token, if this is a continuation call.
MaxResults – Number (integer), not less than 1 or more than 1000.

The maximum number of connections to return in one response.

Response

ConnectionList – An array of Connection objects.

A list of requested connection definitions.
NextToken – UTF-8 string.

A continuation token, if the list of connections returned does not include the last of the filtered connections.

Errors

EntityNotFoundException
OperationTimeoutException
InvalidInputException
GlueEncryptionException

UpdateConnection action (Python: update_connection)

Updates a connection definition in the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.
Name – 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 definition to update.
ConnectionInput – Required: A ConnectionInput object.

A ConnectionInput object that redefines the connection in question.

Response

No Response parameters.

Errors

InvalidInputException
EntityNotFoundException
OperationTimeoutException
InvalidInputException
GlueEncryptionException

BatchDeleteConnection action (Python: batch_delete_connection)

Deletes a list of connection definitions from the Data Catalog.

Request

CatalogId – Catalog id string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.
ConnectionNameList – Required: An array of UTF-8 strings, not more than 25 strings.

A list of names of the connections to delete.

Response

Succeeded – An array of UTF-8 strings.

A list of names of the connection definitions that were successfully deleted.
Errors – A map array of key-value pairs.

Each key is a UTF-8 string, not less than 1 or more than 255 bytes long, matching the Single-line string pattern.

Each value is a An ErrorDetail object.

A map of the names of connections that were not successfully deleted to error details.

Errors

InternalServiceException
OperationTimeoutException

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Partitions

User-defined Functions