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, maxResults, nextToken,
  sortBy, sortOrder, name, environmentIdentifier, projectIdentifier, type,
  scope)

Arguments

domainIdentifier	[required] The ID of the domain 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.
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.
sortBy	Specifies how you want to sort the listed connections.
sortOrder	Specifies the sort order for the listed connections.
name	The name of the connection.
environmentIdentifier	The ID of the environment where you want to list connections.
projectIdentifier	The ID of the project where you want to list connections.
type	The type of connection.
scope	The scope of the connection.

Value

A list with the following syntax:

list(
  items = list(
    list(
      configurations = list(
        list(
          classification = "string",
          properties = list(
            "string"
          )
        )
      ),
      connectionId = "string",
      domainId = "string",
      domainUnitId = "string",
      environmentId = "string",
      name = "string",
      physicalEndpoints = list(
        list(
          awsLocation = list(
            accessRole = "string",
            awsAccountId = "string",
            awsRegion = "string",
            iamConnectionId = "string"
          ),
          glueConnectionName = "string",
          glueConnectionNames = list(
            "string"
          ),
          glueConnection = list(
            name = "string",
            description = "string",
            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",
            matchCriteria = list(
              "string"
            ),
            connectionProperties = list(
              "string"
            ),
            sparkProperties = list(
              "string"
            ),
            athenaProperties = list(
              "string"
            ),
            pythonProperties = list(
              "string"
            ),
            physicalConnectionRequirements = list(
              subnetId = "string",
              subnetIdList = list(
                "string"
              ),
              securityGroupIdList = list(
                "string"
              ),
              availabilityZone = "string"
            ),
            creationTime = as.POSIXct(
              "2015-01-01"
            ),
            lastUpdatedTime = as.POSIXct(
              "2015-01-01"
            ),
            lastUpdatedBy = "string",
            status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
            statusReason = "string",
            lastConnectionValidationTime = as.POSIXct(
              "2015-01-01"
            ),
            authenticationConfiguration = list(
              authenticationType = "BASIC"|"OAUTH2"|"CUSTOM",
              secretArn = "string",
              oAuth2Properties = list(
                oAuth2GrantType = "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER",
                oAuth2ClientApplication = list(
                  userManagedClientApplicationClientId = "string",
                  aWSManagedClientApplicationReference = "string"
                ),
                tokenUrl = "string",
                tokenUrlParametersMap = list(
                  "string"
                ),
                authorizationCodeProperties = list(
                  authorizationCode = "string",
                  redirectUri = "string"
                ),
                oAuth2Credentials = list(
                  userManagedClientApplicationClientSecret = "string",
                  accessToken = "string",
                  refreshToken = "string",
                  jwtToken = "string"
                )
              )
            ),
            connectionSchemaVersion = 123,
            compatibleComputeEnvironments = list(
              "SPARK"|"ATHENA"|"PYTHON"
            )
          ),
          enableTrustedIdentityPropagation = TRUE|FALSE,
          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(
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
          errorMessage = "string"
        ),
        hyperPodProperties = list(
          clusterName = "string",
          clusterArn = "string",
          orchestrator = "EKS"|"SLURM"
        ),
        iamProperties = list(
          environmentId = "string",
          glueLineageSyncEnabled = TRUE|FALSE
        ),
        redshiftProperties = list(
          storage = list(
            clusterName = "string",
            workgroupName = "string"
          ),
          credentials = list(
            secretArn = "string",
            usernamePassword = list(
              password = "string",
              username = "string"
            )
          ),
          isProvisionedSecret = TRUE|FALSE,
          jdbcIamUrl = "string",
          jdbcUrl = "string",
          redshiftTempDir = "string",
          lineageSync = list(
            lineageJobId = "string",
            enabled = TRUE|FALSE,
            schedule = list(
              schedule = "string"
            )
          ),
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
          databaseName = "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",
          certificateData = "string",
          managedEndpointArn = "string",
          managedEndpointCredentials = list(
            id = "string",
            token = "string"
          )
        ),
        sparkGlueProperties = list(
          additionalArgs = list(
            connection = "string"
          ),
          glueConnectionName = "string",
          glueConnectionNames = list(
            "string"
          ),
          glueVersion = "string",
          idleTimeout = 123,
          javaVirtualEnv = "string",
          numberOfWorkers = 123,
          pythonVirtualEnv = "string",
          workerType = "string"
        ),
        s3Properties = list(
          s3Uri = "string",
          s3AccessGrantLocationId = "string",
          registerS3AccessGrantLocation = TRUE|FALSE,
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
          errorMessage = "string"
        ),
        amazonQProperties = list(
          isEnabled = TRUE|FALSE,
          profileArn = "string",
          authMode = "string"
        ),
        mlflowProperties = list(
          trackingServerArn = "string"
        ),
        workflowsMwaaProperties = list(
          mwaaEnvironmentName = "string"
        ),
        workflowsServerlessProperties = list(),
        lakehouseProperties = list(
          glueLineageSyncEnabled = TRUE|FALSE
        ),
        vpcProperties = list(
          vpcId = "string",
          subnetIds = list(
            "string"
          ),
          status = "CREATING"|"CREATE_FAILED"|"DELETING"|"DELETE_FAILED"|"READY"|"UPDATING"|"UPDATE_FAILED"|"DELETED",
          securityGroupId = "string",
          glueConnectionNames = list(
            "string"
          )
        )
      ),
      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",
      scope = "DOMAIN"|"PROJECT"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_connections(
  domainIdentifier = "string",
  maxResults = 123,
  nextToken = "string",
  sortBy = "NAME",
  sortOrder = "ASCENDING"|"DESCENDING",
  name = "string",
  environmentIdentifier = "string",
  projectIdentifier = "string",
  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",
  scope = "DOMAIN"|"PROJECT"
)