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

ListConnections

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

Request Syntax


GET /v2/domains/domainIdentifier/connections?environmentIdentifier=environmentIdentifier&maxResults=maxResults&name=name&nextToken=nextToken&projectIdentifier=projectIdentifier&sortBy=sortBy&sortOrder=sortOrder&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

environmentIdentifier

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

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

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 50.

name

The name of the connection.

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

nextToken

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.

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

projectIdentifier

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

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

Required: Yes

sortBy

Specifies how you want to sort the listed connections.

Valid Values: NAME

sortOrder

Specifies the sort order for the listed connections.

Valid Values: ASCENDING | DESCENDING

type

The type of connection.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "connectionId": "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"
      }
   ],
   "nextToken": "string"
}

Response Elements

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

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

items

The results of the ListConnections action.

Type: Array of ConnectionSummary objects

nextToken

Type: String

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

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

InternalServerException

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

HTTP Status Code: 500

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