Get Connection

glue_get_connection

R Documentation

Retrieves a connection definition from the Data Catalog

Description

Retrieves a connection definition from the Data Catalog.

Usage

glue_get_connection(CatalogId, Name, HidePassword)

Arguments

CatalogId

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

Name

[required] The name of the connection definition to retrieve.

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.

Value

A list with the following syntax:

list(
  Connection = 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"
        )
      )
    )
  )
)

Request syntax

svc$get_connection(
  CatalogId = "string",
  Name = "string",
  HidePassword = TRUE|FALSE
)