Menu
AWS Glue
Developer Guide

Connection API

Data Types

Connection Structure

Defines a connection to a data source.

Fields

  • Name – String, matching the Single-line string pattern.

    The name of the connection definition.

  • Description – Description string, matching the URI address multi-line string pattern.

    Description of the connection.

  • ConnectionType – 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.

    A list of criteria that can be used in selecting this connection.

  • ConnectionProperties – An array of UTF-8 string–to–UTF-8 string mappings.

    A list of key-value pairs used as parameters for this connection.

  • PhysicalConnectionRequirements – A PhysicalConnectionRequirements object.

    A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

  • CreationTime – Timestamp.

    The time this connection definition was created.

  • LastUpdatedTime – Timestamp.

    The last time this connection definition was updated.

  • LastUpdatedBy – String, matching the Single-line string pattern.

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

ConnectionInput Structure

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

Fields

  • Name – String, matching the Single-line string pattern.

    The name of the connection.

  • Description – Description string, matching the URI address multi-line string pattern.

    Description of the connection.

  • ConnectionType – 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.

    A list of criteria that can be used in selecting this connection.

  • ConnectionProperties – An array of UTF-8 string–to–UTF-8 string mappings.

    A list of key-value pairs used as parameters for this connection.

  • PhysicalConnectionRequirements – A PhysicalConnectionRequirements object.

    A map of physical connection requirements, such as VPC and SecurityGroup, needed for making this connection successfully.

PhysicalConnectionRequirements Structure

Specifies the physical requirements for a connection.

Fields

  • SubnetId – String, matching the Single-line string pattern.

    The subnet ID used by the connection.

  • SecurityGroupIdList – An array of UTF-8 strings.

    The security group ID list used by the connection.

  • AvailabilityZone – String, matching the Single-line string pattern.

    The connection's availability zone.

GetConnectionsFilter Structure

Filters the connection definitions returned by the GetConnections API.

Fields

  • MatchCriteria – An array of UTF-8 strings.

    A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.

  • ConnectionType – 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, matching the Single-line string pattern.

    The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.

  • ConnectionInput – A ConnectionInput object. Required.

    A ConnectionInput object defining the connection to create.

Response

  • No Response parameters.

Errors

  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

DeleteConnection Action (Python: delete_connection)

Deletes a connection from the Data Catalog.

Request

  • CatalogId – Catalog id string, matching the Single-line string pattern.

    The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.

  • ConnectionName – String, matching the Single-line string pattern. Required.

    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, matching the Single-line string pattern.

    The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.

  • Name – String, matching the Single-line string pattern. Required.

    The name of the connection definition to retrieve.

Response

  • Connection – A Connection object.

    The requested connection definition.

Errors

  • EntityNotFoundException

  • OperationTimeoutException

GetConnections Action (Python: get_connections)

Retrieves a list of connection definitions from the Data Catalog.

Request

  • CatalogId – Catalog id string, matching the Single-line string pattern.

    The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.

  • Filter – A GetConnectionsFilter object.

    A filter that controls which connections will be returned.

  • NextToken – String.

    A continuation token, if this is a continuation call.

  • MaxResults – Number (integer).

    The maximum number of connections to return in one response.

Response

  • ConnectionList – An array of Connections.

    A list of requested connection definitions.

  • NextToken – String.

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

Errors

  • EntityNotFoundException

  • OperationTimeoutException

UpdateConnection Action (Python: update_connection)

Updates a connection definition in the Data Catalog.

Request

  • CatalogId – Catalog id string, matching the Single-line string pattern.

    The ID of the Data Catalog in which the connection resides. If none is supplied, the AWS account ID is used by default.

  • Name – String, matching the Single-line string pattern. Required.

    The name of the connection definition to update.

  • ConnectionInput – A ConnectionInput object. Required.

    A ConnectionInput object that redefines the connection in question.

Response

  • No Response parameters.

Errors

  • InvalidInputException

  • EntityNotFoundException

  • OperationTimeoutException

BatchDeleteConnection Action (Python: batch_delete_connection)

Deletes a list of connection definitions from the Data Catalog.

Request

  • CatalogId – Catalog id string, matching the Single-line string pattern.

    The ID of the Data Catalog in which the connections reside. If none is supplied, the AWS account ID is used by default.

  • ConnectionNameList – An array of UTF-8 strings. Required.

    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 – An array of UTF-8 string–to–ErrorDetail mappings.

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

Errors

  • InternalServiceException

  • OperationTimeoutException