Menu
AWS Glue
Web API Reference (API Version 2017-03-31)

GetConnection

Retrieves a connection definition from the Data Catalog.

Request Syntax

{ "CatalogId": "string", "Name": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CatalogId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: No

Name

The name of the connection definition to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

Response Syntax

{ "Connection": { "ConnectionProperties": { "string" : "string" }, "ConnectionType": "string", "CreationTime": number, "Description": "string", "LastUpdatedBy": "string", "LastUpdatedTime": number, "MatchCriteria": [ "string" ], "Name": "string", "PhysicalConnectionRequirements": { "AvailabilityZone": "string", "SecurityGroupIdList": [ "string" ], "SubnetId": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connection

The requested connection definition.

Type: Connection object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityNotFoundException

A specified entity does not exist

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: