CreateConnection - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee 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",
   "enableTrustedIdentityPropagation": boolean,
   "environmentIdentifier": "string",
   "name": "string",
   "props": { ... },
   "scope": "string"
}

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

enableTrustedIdentityPropagation

Specifies whether the trusted identity propagation is enabled.

Type: Boolean

Required: No

environmentIdentifier

The ID of the environment where the connection is created.

Type: String

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

Required: No

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

scope

The scope of the connection.

Type: String

Valid Values: DOMAIN | PROJECT

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"
         },
         "enableTrustedIdentityPropagation": boolean,
         "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": { ... },
   "scope": "string",
   "type": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

connectionId

The ID of the connection.

Type: String

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

description

The connection description.

Type: String

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

domainId

The ID of the domain where the connection is created.

Type: String

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

domainUnitId

The ID of the domain unit where the connection is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-z0-9_\-]+

environmentId

The ID of the environment where the connection is created.

Type: String

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

name

The connection name.

Type: String

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

physicalEndpoints

The physical endpoints of the connection.

Type: Array of PhysicalEndpoint objects

projectId

The ID of the project where the connection is created.

Type: String

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

props

The connection props.

Type: ConnectionPropertiesOutput object

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

scope

The scope of the connection.

Type: String

Valid Values: DOMAIN | PROJECT

type

The connection type.

Type: String

Valid Values: ATHENA | BIGQUERY | DATABRICKS | DOCUMENTDB | DYNAMODB | HYPERPOD | IAM | MYSQL | OPENSEARCH | ORACLE | POSTGRESQL | REDSHIFT | S3 | SAPHANA | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | VERTICA | WORKFLOWS_MWAA | AMAZON_Q | MLFLOW

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

There is a conflict while performing this action.

HTTP Status Code: 409

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: