Get Connections

glue_get_connections

R Documentation

Retrieves a list of connection definitions from the Data Catalog

Description

Retrieves a list of connection definitions from the Data Catalog.

Usage

glue_get_connections(CatalogId, Filter, HidePassword, NextToken,
  MaxResults)

Arguments

CatalogId

The ID of the Data Catalog in which the connections reside. If none is provided, the Amazon Web Services account ID is used by default.

Filter

A filter that controls which connections are returned.

HidePassword

Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

NextToken

A continuation token, if this is a continuation call.

MaxResults

The maximum number of connections to return in one response.

Value

A list with the following syntax:

list(
  ConnectionList = list(
    list(
      Name = "string",
      Description = "string",
      ConnectionType = "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA",
      MatchCriteria = list(
        "string"
      ),
      ConnectionProperties = list(
        "string"
      ),
      PhysicalConnectionRequirements = list(
        SubnetId = "string",
        SecurityGroupIdList = list(
          "string"
        ),
        AvailabilityZone = "string"
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedBy = "string",
      Status = "READY"|"IN_PROGRESS"|"FAILED",
      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"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_connections(
  CatalogId = "string",
  Filter = list(
    MatchCriteria = list(
      "string"
    ),
    ConnectionType = "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"
  ),
  HidePassword = TRUE|FALSE,
  NextToken = "string",
  MaxResults = 123
)