Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetConnection

Retrieves a connection definition from the Data Catalog.

Request Syntax


{
   "ApplyOverrideForComputeEnvironment": "string",
   "CatalogId": "string",
   "HidePassword": boolean,
   "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.

ApplyOverrideForComputeEnvironment

For connections that may be used in multiple services, specifies returning properties for the specified compute environment.

Type: String

Valid Values: SPARK | ATHENA | PYTHON

Required: No

CatalogId

The ID of the Data Catalog in which the connection resides. If none is provided, 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

HidePassword

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.

Type: Boolean

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": { 
      "AthenaProperties": { 
         "string" : "string" 
      },
      "AuthenticationConfiguration": { 
         "AuthenticationType": "string",
         "OAuth2Properties": { 
            "OAuth2ClientApplication": { 
               "AWSManagedClientApplicationReference": "string",
               "UserManagedClientApplicationClientId": "string"
            },
            "OAuth2GrantType": "string",
            "TokenUrl": "string",
            "TokenUrlParametersMap": { 
               "string" : "string" 
            }
         },
         "SecretArn": "string"
      },
      "CompatibleComputeEnvironments": [ "string" ],
      "ConnectionProperties": { 
         "string" : "string" 
      },
      "ConnectionSchemaVersion": number,
      "ConnectionType": "string",
      "CreationTime": number,
      "Description": "string",
      "LastConnectionValidationTime": number,
      "LastUpdatedBy": "string",
      "LastUpdatedTime": number,
      "MatchCriteria": [ "string" ],
      "Name": "string",
      "PhysicalConnectionRequirements": { 
         "AvailabilityZone": "string",
         "SecurityGroupIdList": [ "string" ],
         "SubnetId": "string"
      },
      "PythonProperties": { 
         "string" : "string" 
      },
      "SparkProperties": { 
         "string" : "string" 
      },
      "Status": "string",
      "StatusReason": "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

GlueEncryptionException

An encryption operation failed.

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

HTTP Status Code: 400