Request Syntax Request Parameters Response Elements Errors See Also

UpdateConnection

Updates a connection definition in the Data Catalog.

Request Syntax


{
   "CatalogId": "string",
   "ConnectionInput": { 
      "AthenaProperties": { 
         "string" : "string" 
      },
      "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",
      "Description": "string",
      "MatchCriteria": [ "string" ],
      "Name": "string",
      "PhysicalConnectionRequirements": { 
         "AvailabilityZone": "string",
         "SecurityGroupIdList": [ "string" ],
         "SubnetId": "string"
      },
      "PythonProperties": { 
         "string" : "string" 
      },
      "SparkProperties": { 
         "string" : "string" 
      },
      "ValidateCredentials": boolean,
      "ValidateForComputeEnvironments": [ "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 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

ConnectionInput

A ConnectionInput object that redefines the connection in question.

Type: ConnectionInput object

Required: Yes

Name

The name of the connection definition to update.

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 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.

EntityNotFoundException

A specified entity does not exist

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

GlueEncryptionException

An encryption operation failed.

Message: The message describing the problem.

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400