Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

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

get/v2/domains/{domainIdentifier}/connections/{identifier}

Path parameters

domainIdentifierstring required

The ID of the domain where we get the connection.

identifierstring required

The connection ID.

Query parameters

withSecretboolean

Specifies whether a connection has a secret.

Response

Success

connectionIdstring required

The ID of the connection.

descriptionstring password

Connection description.

domainIdstring required

The domain ID of the connection.

domainUnitIdstring required

The domain unit ID of the connection.

environmentIdstring

The ID of the environment.

environmentUserRolestring

The environment user role.

namestring required

The name of the connection.

projectIdstring

The ID of the project.

type'ATHENA' | 'BIGQUERY' | 'DATABRICKS' | 'DOCUMENTDB' | 'DYNAMODB' | 'HYPERPOD' | 'IAM' | 'MYSQL' | 'OPENSEARCH' | 'ORACLE' | 'POSTGRESQL' | 'REDSHIFT' | 'S3' | 'SAPHANA' | 'SNOWFLAKE' | 'SPARK' | 'SQLSERVER' | 'TERADATA' | 'VERTICA' | 'WORKFLOWS_MWAA' | 'AMAZON_Q' | 'MLFLOW' | 'VPC' required

The type of the connection.

scope'DOMAIN' | 'PROJECT'

The scope of the connection.