AWS Glue
Developer Guide

Connection API

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

Data Types

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

    The type of the connection. Currently, only JDBC is supported; 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).

    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 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 the JDBC connection.

    • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching will be enforced for the JDBC connection on the client. The default is false.

  • 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

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

    The name of the connection.

  • Description – Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

    The description of the connection.

  • ConnectionTypeRequired: UTF-8 string (valid values: JDBC | SFTP).

    The type of the connection. Currently, only JDBC is supported; 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.

  • ConnectionPropertiesRequired: 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).

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

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

Operations

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.

  • ConnectionInputRequired: A ConnectionInput object.

    A ConnectionInput object defining the connection to create.

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.

  • ConnectionNameRequired: 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.

  • NameRequired: 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 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 will be 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 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.

  • NameRequired: 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.

  • ConnectionInputRequired: 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.

  • ConnectionNameListRequired: 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