--- title: "GET /v2/domains/{domainIdentifier}/connections/{identifier}" method: GET path: "/v2/domains/{domainIdentifier}/connections/{identifier}" --- # GET /v2/domains/{domainIdentifier}/connections/{identifier} `GET /v2/domains/{domainIdentifier}/connections/{identifier}` Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services. ## Path parameters - `domainIdentifier` string, required - `identifier` string, required ## Query parameters - `withSecret` boolean ## Response `200` Success - GetConnectionOutput - `connectionCredentials` object — Connection credentials. - `accessKeyId` string — The access key ID of a connection. - `secretAccessKey` string — The secret access key of a connection. - `sessionToken` string — The session token of a connection credentials. - `expiration` string, date-time — The expiration of the connection credentials. - `configurations` Configuration[] — The configurations of the connection. - `classification` string — The classification of the connection configuration. - `properties` unknown - `connectionId` string, required — The ID of the connection. - `description` string, password — Connection description. - `domainId` string, required — The domain ID of the connection. - `domainUnitId` string, required — The domain unit ID of the connection. - `environmentId` string — The ID of the environment. - `environmentUserRole` string — The environment user role. - `name` string, required — The name of the connection. - `physicalEndpoints` PhysicalEndpoint[], required — The physical endpoints of the connection. - `awsLocation` object — The location of a connection. - `accessRole` string — The access role of a connection. - `awsAccountId` string — The account ID of a connection. - `awsRegion` string — The Region of a connection. - `iamConnectionId` string — The IAM connection ID of a connection. - `glueConnectionName` string — The Amazon Web Services Glue connection name. - `glueConnectionNames` GlueConnectionName[] — The Amazon Web Services Glue connection names in the physical endpoint. - `glueConnection` object — The Amazon Web Services Glue connection. - `name` string — The name of the Amazon Web Services Glue connection. - `description` string — The description of the Amazon Web Services Glue connection. - `connectionType` '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 the Amazon Web Services Glue connection. - `matchCriteria` String[] — The match criteria of the Amazon Web Services Glue connection. - `connectionProperties` object — The properties of the Amazon Web Services Glue connection. - `sparkProperties` object — The Spark properties of the Amazon Web Services Glue connection. - `athenaProperties` object — The Amazon Athena properties of the Amazon Web Services Glue connection. - `pythonProperties` object — The Python properties of the Amazon Web Services Glue connection. - `physicalConnectionRequirements` object — The physical connection requirements of the Amazon Web Services Glue connection. - `subnetId` string — The subnet ID of the physical connection requirements of a connection. - `subnetIdList` SubnetId[] — The subnet ID list of the physical connection requirements of a connection. - `securityGroupIdList` SecurityGroupIdListMemberString[] — The group ID list of the physical connection requirements of a connection. - `availabilityZone` string — The availability zone of the physical connection requirements of a connection. - `creationTime` string, date-time — The creation time of the Amazon Web Services Glue connection. - `lastUpdatedTime` string, date-time — The timestamp at which the Amazon Web Services Glue connection was last updated. - `lastUpdatedBy` string — The user who last updated the Amazon Web Services Glue connection. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED' — The status of the Amazon Web Services Glue connection. - `statusReason` string — The status reason of the Amazon Web Services Glue connection. - `lastConnectionValidationTime` string, date-time — The last validation time of the Amazon Web Services Glue connection. - `authenticationConfiguration` object — The authentication configuration of the Amazon Web Services Glue connection. - `authenticationType` 'BASIC' | 'OAUTH2' | 'CUSTOM' — The authentication type of a connection. - `secretArn` string — The secret ARN of a connection. - `oAuth2Properties` object — The oAuth2 properties of a connection. - `oAuth2GrantType` 'AUTHORIZATION_CODE' | 'CLIENT_CREDENTIALS' | 'JWT_BEARER' — The OAuth2 grant type of the OAuth2 properties. - `oAuth2ClientApplication` object — The OAuth2 client application of the OAuth2 properties. - `userManagedClientApplicationClientId` string — The user managed client application client ID in the OAuth2Client application. - `aWSManagedClientApplicationReference` string — The Amazon Web Services managed client application reference in the OAuth2Client application. - `tokenUrl` string — The OAuth2 token URL of the OAuth2 properties. - `tokenUrlParametersMap` object — The OAuth2 token URL parameter map of the OAuth2 properties. - `authorizationCodeProperties` object — The authorization code properties of the OAuth2 properties. - `authorizationCode` string — The authorization code of a connection. - `redirectUri` string — The redirect URI of a connection. - `oAuth2Credentials` object — The OAuth2 credentials of the OAuth2 properties. - `userManagedClientApplicationClientSecret` string — The user managed client application client secret of the connection. - `accessToken` string — The access token of a connection. - `refreshToken` string — The refresh token of the connection. - `jwtToken` string — The jwt token of the connection. - `connectionSchemaVersion` integer — The connection schema version of the Amazon Web Services Glue connection. - `compatibleComputeEnvironments` ComputeEnvironments[] — The compatible compute environments of the Amazon Web Services Glue connection. - `enableTrustedIdentityPropagation` boolean — Specified whether trusted identity propagation for the connection is enabled. - `host` string — The host in the physical endpoints of a connection. - `port` integer — The port in the physical endpoints of a connection. - `protocol` 'ATHENA' | 'GLUE_INTERACTIVE_SESSION' | 'HTTPS' | 'JDBC' | 'LIVY' | 'ODBC' | 'PRISM' — The protocol in the physical endpoints of a connection. - `stage` string — The stage in the physical endpoints of a connection. - `projectId` string — The ID of the project. - `props` object — Connection props. - `athenaProperties` object — The Amazon Athena properties of a connection. - `workgroupName` string — The Amazon Athena workgroup name of a connection. - `glueProperties` object — The Amazon Web Services Glue properties of a connection. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED' — The status of a connection. - `errorMessage` string — The error message generated if the action is not completed successfully. - `hyperPodProperties` object — The hyper pod properties of a connection. - `clusterName` string, required — The cluster name the hyper pod properties. - `clusterArn` string — The cluster ARN of the hyper pod properties. - `orchestrator` 'EKS' | 'SLURM' — The orchestrator of the hyper pod properties. - `iamProperties` object — The IAM properties of a connection. - `environmentId` string — The environment ID of the connection. - `glueLineageSyncEnabled` boolean — Specifies whether Amazon Web Services Glue lineage sync is enabled for a connection. - `redshiftProperties` object — The Amazon Redshift properties of a connection. - `storage` object — The storage in the Amazon Redshift properties. - `clusterName` string — The cluster name in the Amazon Redshift storage properties. - `workgroupName` string — The workgroup name in the Amazon Redshift storage properties. - `credentials` object — The Amazon Redshift credentials. - `secretArn` string — The secret ARN of the Amazon Redshift credentials of a connection. - `usernamePassword` object — The username and password of the Amazon Redshift credentials of a connection. - `password` string, password, required — The password of a connection. - `username` string, required — The username of a connection. - `isProvisionedSecret` boolean — Specifies whether Amaon Redshift properties has a provisioned secret. - `jdbcIamUrl` string — The jdbcIam URL of the Amazon Redshift properties. - `jdbcUrl` string — The jdbcURL of the Amazon Redshift properties. - `redshiftTempDir` string — The redshiftTempDir of the Amazon Redshift properties. - `lineageSync` object — The lineage syn of the Amazon Redshift properties. - `lineageJobId` string — The lineage job ID of the Amaon Redshift lineage sync configuration. - `enabled` boolean — Specifies whether the Amaon Redshift lineage sync configuration is enabled. - `schedule` object — The schedule of teh Amaon Redshift lineage sync configuration. - `schedule` string — The lineage sync schedule. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED' — The status in the Amazon Redshift properties. - `databaseName` string — The Amazon Redshift database name. - `sparkEmrProperties` object — The Spark EMR properties of a connection. - `computeArn` string — The compute ARN of the Spark EMR. - `credentials` object — The credentials of the Spark EMR. - `password` string, password, required — The password of a connection. - `username` string, required — The username of a connection. - `credentialsExpiration` string, date-time — The credential expiration of the Spark EMR. - `governanceType` 'AWS_MANAGED' | 'USER_MANAGED' — The governance type of the Spark EMR. - `instanceProfileArn` string — The instance profile ARN of the Spark EMR. - `javaVirtualEnv` string — The Java virtual env of the Spark EMR. - `livyEndpoint` string — The livy endpoint of the Spark EMR. - `logUri` string — The log URI of the Spark EMR. - `pythonVirtualEnv` string — The Python virtual env of the Spark EMR. - `runtimeRole` string — The runtime role of the Spark EMR. - `trustedCertificatesS3Uri` string — The trusted certificate S3 URL of the Spark EMR. - `certificateData` string — The certificate data of the EMR on EKS cluster. - `managedEndpointArn` string — The managed endpoint ARN of the EMR on EKS cluster. - `managedEndpointCredentials` object — The managed endpoint credentials of the EMR on EKS cluster. - `id` string — The identifier of the managed endpoint credentials. - `token` string — The ARN of the managed endpoint credentials. - `sparkGlueProperties` object — The Spark Amazon Web Services Glue properties of a connection. - `additionalArgs` object — The additional args in the Spark Amazon Web Services Glue properties. - `connection` string — The connection in the Spark Amazon Web Services Glue args. - `glueConnectionName` string — The Amazon Web Services Glue connection name in the Spark Amazon Web Services Glue properties. - `glueConnectionNames` GlueConnectionName[] — The Amazon Web Services Glue connection names in the Spark Amazon Web Services Glue properties. - `glueVersion` string — The Amazon Web Services Glue version in the Spark Amazon Web Services Glue properties. - `idleTimeout` integer — The idle timeout in the Spark Amazon Web Services Glue properties. - `javaVirtualEnv` string — The Java virtual env in the Spark Amazon Web Services Glue properties. - `numberOfWorkers` integer — The number of workers in the Spark Amazon Web Services Glue properties. - `pythonVirtualEnv` string — The Python virtual env in the Spark Amazon Web Services Glue properties. - `workerType` string — The worker type in the Spark Amazon Web Services Glue properties. - `s3Properties` object — The Amazon S3 properties of a connection. - `s3Uri` string, required — The Amazon S3 URI that's part of the Amazon S3 properties of a connection. - `s3AccessGrantLocationId` string — The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection. - `registerS3AccessGrantLocation` boolean — Specifies whether to register the Amazon S3 Access Grant location. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED' — The status of the Amazon S3 connection. - `errorMessage` string — The error message that gets displayed. - `snowflakeProperties` object — The Snowflake-specific connection properties for an existing connection. - `snowflakeRole` string, required — The Snowflake role used to access Snowflake resources. - `identityMapping` object, required — The identity mapping configuration for the Snowflake connection. - `usernameAttribute` string, required — The username attribute used for the identity mapping. - `prefix` string — The prefix used for the identity mapping. - `lineageSync` object, required — The lineage sync configuration for the Snowflake connection. - `lineageJobId` string — The ID of the lineage sync job. - `timezone` 'UTC' | 'AFRICA_JOHANNESBURG' | 'AMERICA_MONTREAL' | 'AMERICA_SAO_PAULO' | 'ASIA_BAHRAIN' | 'ASIA_BANGKOK' | 'ASIA_CALCUTTA' | 'ASIA_DUBAI' | 'ASIA_HONG_KONG' | 'ASIA_JAKARTA' | 'ASIA_KUALA_LUMPUR' | 'ASIA_SEOUL' | 'ASIA_SHANGHAI' | 'ASIA_SINGAPORE' | 'ASIA_TAIPEI' | 'ASIA_TOKYO' | 'AUSTRALIA_MELBOURNE' | 'AUSTRALIA_SYDNEY' | 'CANADA_CENTRAL' | 'CET' | 'CST6CDT' | 'ETC_GMT' | 'ETC_GMT0' | 'ETC_GMT_ADD_0' | 'ETC_GMT_ADD_1' | 'ETC_GMT_ADD_10' | 'ETC_GMT_ADD_11' | 'ETC_GMT_ADD_12' | 'ETC_GMT_ADD_2' | 'ETC_GMT_ADD_3' | 'ETC_GMT_ADD_4' | 'ETC_GMT_ADD_5' | 'ETC_GMT_ADD_6' | 'ETC_GMT_ADD_7' | 'ETC_GMT_ADD_8' | 'ETC_GMT_ADD_9' | 'ETC_GMT_NEG_0' | 'ETC_GMT_NEG_1' | 'ETC_GMT_NEG_10' | 'ETC_GMT_NEG_11' | 'ETC_GMT_NEG_12' | 'ETC_GMT_NEG_13' | 'ETC_GMT_NEG_14' | 'ETC_GMT_NEG_2' | 'ETC_GMT_NEG_3' | 'ETC_GMT_NEG_4' | 'ETC_GMT_NEG_5' | 'ETC_GMT_NEG_6' | 'ETC_GMT_NEG_7' | 'ETC_GMT_NEG_8' | 'ETC_GMT_NEG_9' | 'EUROPE_DUBLIN' | 'EUROPE_LONDON' | 'EUROPE_PARIS' | 'EUROPE_STOCKHOLM' | 'EUROPE_ZURICH' | 'ISRAEL' | 'MEXICO_GENERAL' | 'MST7MDT' | 'PACIFIC_AUCKLAND' | 'US_CENTRAL' | 'US_EASTERN' | 'US_MOUNTAIN' | 'US_PACIFIC' — The timezone of the lineage sync schedule. - `enabled` boolean — Specifies whether lineage sync is enabled. - `schedule` string — The schedule of the lineage sync. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED', required — The status of the Snowflake connection. - `errorMessage` string — An error message returned if the Snowflake connection failed to establish or validate. - `amazonQProperties` object — The Amazon Q properties of the connection. - `isEnabled` boolean, required — Specifies whether Amazon Q is enabled for the connection. - `profileArn` string — The profile ARN of the connection's Amazon Q properties. - `authMode` string — The authentication mode of the connection's Amazon Q properties. - `mlflowProperties` object — The MLflow properties of a connection. - `trackingServerArn` string — The tracking server ARN as part of the MLflow properties of a connection. - `workflowsMwaaProperties` object — The Amazon MWAA properties of a connection. - `mwaaEnvironmentName` string — The MWAA environment name. - `workflowsServerlessProperties` object — The MWAA serverless properties of a connection. - `lakehouseProperties` object — The lakehouse properties of a connection. - `glueLineageSyncEnabled` boolean — Specifies whether Glue lineage sync is enabled for tables managed by Glue crawlers. - `vpcProperties` object — The VPC properties of a connection. - `vpcId` string, required — The identifier of the VPC. - `subnetIds` SubnetId[], required — The subnet IDs of the VPC connection. - `status` 'CREATING' | 'CREATE_FAILED' | 'DELETING' | 'DELETE_FAILED' | 'READY' | 'UPDATING' | 'UPDATE_FAILED' | 'DELETED', required — The status of the VPC connection. - `securityGroupId` string — The security group ID of the VPC connection. - `glueConnectionNames` GlueConnectionName[] — The Amazon Web Services Glue connection names associated with the VPC connection. - `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. ## Other responses - `480` — InternalServerException - `481` — ResourceNotFoundException - `482` — AccessDeniedException - `483` — ThrottlingException - `484` — ValidationException - `485` — UnauthorizedException --- [API](https://skmtc.net/aws/apis/datazone.md) · [All operations](https://skmtc.net/aws/apis/datazone/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/datazone/versions/055599054b53/schema)