GetConnections
Retrieves a list of connection definitions from the Data Catalog.
Request Syntax
{
"CatalogId": "string",
"Filter": {
"ConnectionSchemaVersion": number,
"ConnectionType": "string",
"MatchCriteria": [ "string" ]
},
"HidePassword": boolean,
"MaxResults": number,
"NextToken": "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 connections reside. 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
- Filter
-
A filter that controls which connections are returned.
Type: GetConnectionsFilter object
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
- MaxResults
-
The maximum number of connections to return in one response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
- NextToken
-
A continuation token, if this is a continuation call.
Type: String
Required: No
Response Syntax
{
"ConnectionList": [
{
"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"
}
],
"NextToken": "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.
- ConnectionList
-
A list of requested connection definitions.
Type: Array of Connection objects
- NextToken
-
A continuation token, if the list of connections returned does not include the last of the filtered connections.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
