Sign in

v1

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

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

Path parameters

domainIdentifierstring required

The ID of the domain where you want to list connections.

Query parameters

maxResultsinteger

The maximum number of connections to return in a single call to ListConnections. When the number of connections to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListConnections to list the next set of connections.

nextTokenstring

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.

sortBy'NAME'

Specifies how you want to sort the listed connections.

sortOrder'ASCENDING' | 'DESCENDING'

Specifies the sort order for the listed connections.

namestring

The name of the connection.

environmentIdentifierstring

The ID of the environment where you want to list connections.

projectIdentifierstring

The ID of the project where you want to list connections.

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'

The type of connection.

scope'DOMAIN' | 'PROJECT'

The scope of the connection.

Response

Success

nextTokenstring

When the number of connections is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of connections, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListConnections to list the next set of connections.