Test Connection

glue_test_connection

R Documentation

Tests a connection to a service to validate the service credentials that you provide¶

Description¶

Tests a connection to a service to validate the service credentials that you provide.

You can either provide an existing connection name or a TestConnectionInput for testing a non-existing connection input. Providing both at the same time will cause an error.

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

Usage¶

glue_test_connection(ConnectionName, CatalogId, TestConnectionInput)

Arguments¶

ConnectionName: Optional. The name of the connection to test. If only name is provided, the operation will get the connection and use that for testing.
CatalogId: The catalog ID where the connection resides.
TestConnectionInput: A structure that is used to specify testing a connection to a service.

Value¶

An empty list.

Request syntax¶

svc$test_connection(
  ConnectionName = "string",
  CatalogId = "string",
  TestConnectionInput = list(
    ConnectionType = "JDBC"|"SFTP"|"MONGODB"|"KAFKA"|"NETWORK"|"MARKETPLACE"|"CUSTOM"|"SALESFORCE"|"VIEW_VALIDATION_REDSHIFT"|"VIEW_VALIDATION_ATHENA"|"GOOGLEADS"|"GOOGLESHEETS"|"GOOGLEANALYTICS4"|"SERVICENOW"|"MARKETO"|"SAPODATA"|"ZENDESK"|"JIRACLOUD"|"NETSUITEERP"|"HUBSPOT"|"FACEBOOKADS"|"INSTAGRAMADS"|"ZOHOCRM"|"SALESFORCEPARDOT"|"SALESFORCEMARKETINGCLOUD"|"SLACK"|"STRIPE"|"INTERCOM"|"SNAPCHATADS",
    ConnectionProperties = list(
      "string"
    ),
    AuthenticationConfiguration = list(
      AuthenticationType = "BASIC"|"OAUTH2"|"CUSTOM"|"IAM",
      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"
        )
      ),
      SecretArn = "string",
      KmsKeyArn = "string",
      BasicAuthenticationCredentials = list(
        Username = "string",
        Password = "string"
      ),
      CustomAuthenticationCredentials = list(
        "string"
      )
    )
  )
)