CreateConnection
Creates a connection definition in the Data Catalog.
Connections used for creating federated resources require the IAM glue:PassConnection permission.
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" ]
},
"Tags": {
"string" : "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 to create the connection. 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
ConnectionInputobject defining the connection to create.Type: ConnectionInput object
Required: Yes
- Tags
-
The tags you assign to the connection.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
Response Syntax
{
"CreateConnectionStatus": "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.
- CreateConnectionStatus
-
The status of the connection creation request. The request can take some time for certain authentication types, for example when creating an OAuth connection with token exchange over VPC.
Type: String
Valid Values:
READY | IN_PROGRESS | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AlreadyExistsException
-
A resource to be created or added already exists.
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
- 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:
