Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateConnection

Creates a new connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Request Syntax


POST /v2/domains/domainIdentifier/connections HTTP/1.1
Content-type: application/json

{
   "awsLocation": { 
      "accessRole": "string",
      "awsAccountId": "string",
      "awsRegion": "string",
      "iamConnectionId": "string"
   },
   "clientToken": "string",
   "description": "string",
   "environmentIdentifier": "string",
   "name": "string",
   "props": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain where the connection is created.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

awsLocation

The location where the connection is created.

Type: AwsLocation object

Required: No

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Type: String

Required: No

description

A connection description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

environmentIdentifier

The ID of the environment where the connection is created.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

name

The connection name.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 64.

Required: Yes

props

The connection props.

Type: ConnectionPropertiesInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "connectionId": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentId": "string",
   "name": "string",
   "physicalEndpoints": [ 
      { 
         "awsLocation": { 
            "accessRole": "string",
            "awsAccountId": "string",
            "awsRegion": "string",
            "iamConnectionId": "string"
         },
         "glueConnection": { 
            "athenaProperties": { 
               "string" : "string" 
            },
            "authenticationConfiguration": { 
               "authenticationType": "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"
            },
            "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",
               "subnetIdList": [ "string" ]
            },
            "pythonProperties": { 
               "string" : "string" 
            },
            "sparkProperties": { 
               "string" : "string" 
            },
            "status": "string",
            "statusReason": "string"
         },
         "glueConnectionName": "string",
         "host": "string",
         "port": number,
         "protocol": "string",
         "stage": "string"
      }
   ],
   "projectId": "string",
   "props": { ... },
   "type": "string"
}