List Connections

datazone_list_connections

R Documentation

Lists connections

Description

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

Usage

datazone_list_connections(domainIdentifier, environmentIdentifier,
  maxResults, name, nextToken, projectIdentifier, sortBy, sortOrder, type)

Arguments

domainIdentifier

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

environmentIdentifier

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

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.

name

The name of the connection.

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.

projectIdentifier

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

sortBy

Specifies how you want to sort the listed connections.

sortOrder

Specifies the sort order for the listed connections.

type

The type of connection.

Value

A list with the following syntax:

list(
  items = list(
    list(
      connectionId = "string",
      domainId = "string",
      domainUnitId = "string",
      environmentId = "string",
      name = "string",
      physicalEndpoints = list(
        list(
          awsLocation = list(
            accessRole = "string",
            awsAccountId = "string",
            awsRegion = "string",
            iamConnectionId = "string"
          ),
          glueConnection = list(
            athenaProperties = list(
              "string"
            ),
            authenticationConfiguration = list(
              authenticationType = "BASIC"|"OAUTH2"|"CUSTOM",
              oAuth2Properties = list(
                authorizationCodeProperties = list(
                  authorizationCode = "string",
                  redirectUri = "string"
                ),
                oAuth2ClientApplication = list(
                  aWSManagedClientApplicationReference = "string",
                  userManagedClientApplicationClientId = "string"
                ),
                oAuth2Credentials = list(
                  accessToken = "string",
                  jwtToken = "string",
                  refreshToken = "string",
                  userManagedClientApplicationClientSecret = "string"
                ),
                oAuth2GrantType = "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER",
                tokenUrl = "string",
                tokenUrlParametersMap = list(
                  "string"
                )
              ),
              secretArn = "string"
            ),
            compatibleComputeEnvironments = list(
              "SPARK"|"ATHENA"|"PYTHON"
            ),
            connectionProperties = list(
              "string"
            ),
            connectionSchemaVersion = 123,
            connectionType = "ATHENA"|"BIGQUERY"|"DATABRICKS"|"DOCUMENTDB"|"DYNAMODB"|"HYPERPOD"|"IAM"|"MYSQL"|"OPENSEARCH"|"ORACLE"|"POSTGRESQL"|"REDSHIFT"|"SAPHANA"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"VERTICA"|"WORKFLOWS_MWAA",
            creationTime = as.POSIXct(
              "2015-01-01"
            ),
            description = "string",
            lastConnectionValidationTime = as.POSIXct(
              "2015-01-01"
            ),
            lastUpdatedBy = "string",
            lastUpdatedTime = as.POSIXct(
              "2015-01-01"
            ),
            matchCriteria = list(
              "string"
            ),
            name = "string",
            physicalConnectionRequirements = list(
              availabilityZone = "string",
              securityGroupIdList = list(
                "string"
              ),
              subnetId = "string",
              subnetIdList = list(
                "string"
              )
            ),
            pythonProperties = list(
              "string"
            ),
            sparkProperties = list(
              "string"
            ),
            status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
            statusReason = "string"
          ),
          glueConnectionName = "string",
          host = "string",
          port = 123,
          protocol = "ATHENA"|"GLUE_INTERACTIVE_SESSION"|"HTTPS"|"JDBC"|"LIVY"|"ODBC"|"PRISM",
          stage = "string"
        )
      ),
      projectId = "string",
      props = list(
        athenaProperties = list(
          workgroupName = "string"
        ),
        glueProperties = list(
          errorMessage = "string",
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED"
        ),
        hyperPodProperties = list(
          clusterArn = "string",
          clusterName = "string",
          orchestrator = "EKS"|"SLURM"
        ),
        iamProperties = list(
          environmentId = "string",
          glueLineageSyncEnabled = TRUE|FALSE
        ),
        redshiftProperties = list(
          credentials = list(
            secretArn = "string",
            usernamePassword = list(
              password = "string",
              username = "string"
            )
          ),
          databaseName = "string",
          isProvisionedSecret = TRUE|FALSE,
          jdbcIamUrl = "string",
          jdbcUrl = "string",
          lineageSync = list(
            enabled = TRUE|FALSE,
            lineageJobId = "string",
            schedule = list(
              schedule = "string"
            )
          ),
          redshiftTempDir = "string",
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
          storage = list(
            clusterName = "string",
            workgroupName = "string"
          )
        ),
        sparkEmrProperties = list(
          computeArn = "string",
          credentials = list(
            password = "string",
            username = "string"
          ),
          credentialsExpiration = as.POSIXct(
            "2015-01-01"
          ),
          governanceType = "AWS_MANAGED"|"USER_MANAGED",
          instanceProfileArn = "string",
          javaVirtualEnv = "string",
          livyEndpoint = "string",
          logUri = "string",
          pythonVirtualEnv = "string",
          runtimeRole = "string",
          trustedCertificatesS3Uri = "string"
        ),
        sparkGlueProperties = list(
          additionalArgs = list(
            connection = "string"
          ),
          glueConnectionName = "string",
          glueVersion = "string",
          idleTimeout = 123,
          javaVirtualEnv = "string",
          numberOfWorkers = 123,
          pythonVirtualEnv = "string",
          workerType = "string"
        )
      ),
      type = "ATHENA"|"BIGQUERY"|"DATABRICKS"|"DOCUMENTDB"|"DYNAMODB"|"HYPERPOD"|"IAM"|"MYSQL"|"OPENSEARCH"|"ORACLE"|"POSTGRESQL"|"REDSHIFT"|"SAPHANA"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"VERTICA"|"WORKFLOWS_MWAA"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_connections(
  domainIdentifier = "string",
  environmentIdentifier = "string",
  maxResults = 123,
  name = "string",
  nextToken = "string",
  projectIdentifier = "string",
  sortBy = "NAME",
  sortOrder = "ASCENDING"|"DESCENDING",
  type = "ATHENA"|"BIGQUERY"|"DATABRICKS"|"DOCUMENTDB"|"DYNAMODB"|"HYPERPOD"|"IAM"|"MYSQL"|"OPENSEARCH"|"ORACLE"|"POSTGRESQL"|"REDSHIFT"|"SAPHANA"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"VERTICA"|"WORKFLOWS_MWAA"
)