Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . glue ]



Retrieves a connection definition from the Data Catalog.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--catalog-id <value>]
--name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--catalog-id (string)

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)

The name of the connection definition to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


Connection -> (structure)

The requested connection definition.

Name -> (string)

The name of the connection definition.

Description -> (string)

Description of the connection.

ConnectionType -> (string)

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

MatchCriteria -> (list)

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


ConnectionProperties -> (map)

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

key -> (string)

value -> (string)

PhysicalConnectionRequirements -> (structure)

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

SubnetId -> (string)

The subnet ID used by the connection.

SecurityGroupIdList -> (list)

The security group ID list used by the connection.


AvailabilityZone -> (string)

The connection's availability zone. This field is deprecated and has no effect.

CreationTime -> (timestamp)

The time this connection definition was created.

LastUpdatedTime -> (timestamp)

The last time this connection definition was updated.

LastUpdatedBy -> (string)

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