TestConnection
Tests a connection to a service to validate the service credentials that you provide.
You can either provide an existing connection name or a TestConnectionInput
for testing a non-existing connection input. Providing both at the same time will cause an error.
If the action is successful, the service sends back an HTTP 200 response.
Request Syntax
{
"CatalogId": "string
",
"ConnectionName": "string
",
"TestConnectionInput": {
"AuthenticationConfiguration": {
"AuthenticationType": "string
",
"BasicAuthenticationCredentials": {
"Password": "string
",
"Username": "string
"
},
"CustomAuthenticationCredentials": {
"string
" : "string
"
},
"KmsKeyArn": "string
",
"OAuth2Properties": {
"AuthorizationCodeProperties": {
"AuthorizationCode": "string
",
"RedirectUri": "string
"
},
"OAuth2ClientApplication": {
"AWSManagedClientApplicationReference": "string
",
"UserManagedClientApplicationClientId": "string
"
},
"OAuth2Credentials": {
"AccessToken": "string
",
"JwtToken": "string
",
"RefreshToken": "string
",
"UserManagedClientApplicationClientSecret": "string
"
},
"OAuth2GrantType": "string
",
"TokenUrl": "string
",
"TokenUrlParametersMap": {
"string
" : "string
"
}
},
"SecretArn": "string
"
},
"ConnectionProperties": {
"string
" : "string
"
},
"ConnectionType": "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 catalog ID where the connection resides.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- ConnectionName
-
Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*
Required: No
- TestConnectionInput
-
A structure that is used to specify testing a connection to a service.
Type: TestConnectionInput object
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access to a resource was denied.
HTTP Status Code: 400
- ConflictException
-
The
CreatePartitions
API was called on a table that has indexes enabled.HTTP Status Code: 400
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- FederationSourceException
-
A federation source failed.
HTTP Status Code: 400
- GlueEncryptionException
-
An encryption operation failed.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
- ResourceNumberLimitExceededException
-
A resource numerical limit was exceeded.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: