Describe Connection Type

glue_describe_connection_type

R Documentation

The DescribeConnectionType API provides full details of the supported options for a given connection type in Glue

Description

The describe_connection_type API provides full details of the supported options for a given connection type in Glue.

Usage

glue_describe_connection_type(ConnectionType)

Arguments

ConnectionType

[required] The name of the connection type to be described.

Value

A list with the following syntax:

list(
  ConnectionType = "string",
  Description = "string",
  Capabilities = list(
    SupportedAuthenticationTypes = list(
      "BASIC"|"OAUTH2"|"CUSTOM"|"IAM"
    ),
    SupportedDataOperations = list(
      "READ"|"WRITE"
    ),
    SupportedComputeEnvironments = list(
      "SPARK"|"ATHENA"|"PYTHON"
    )
  ),
  ConnectionProperties = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  ),
  ConnectionOptions = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  ),
  AuthenticationConfiguration = list(
    AuthenticationType = list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    ),
    SecretArn = list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    ),
    OAuth2Properties = list(
      list(
        Name = "string",
        Description = "string",
        Required = TRUE|FALSE,
        DefaultValue = "string",
        PropertyTypes = list(
          "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        ),
        AllowedValues = list(
          list(
            Description = "string",
            Value = "string"
          )
        ),
        DataOperationScopes = list(
          "READ"|"WRITE"
        )
      )
    ),
    BasicAuthenticationProperties = list(
      list(
        Name = "string",
        Description = "string",
        Required = TRUE|FALSE,
        DefaultValue = "string",
        PropertyTypes = list(
          "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        ),
        AllowedValues = list(
          list(
            Description = "string",
            Value = "string"
          )
        ),
        DataOperationScopes = list(
          "READ"|"WRITE"
        )
      )
    ),
    CustomAuthenticationProperties = list(
      list(
        Name = "string",
        Description = "string",
        Required = TRUE|FALSE,
        DefaultValue = "string",
        PropertyTypes = list(
          "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
        ),
        AllowedValues = list(
          list(
            Description = "string",
            Value = "string"
          )
        ),
        DataOperationScopes = list(
          "READ"|"WRITE"
        )
      )
    )
  ),
  ComputeEnvironmentConfigurations = list(
    list(
      Name = "string",
      Description = "string",
      ComputeEnvironment = "SPARK"|"ATHENA"|"PYTHON",
      SupportedAuthenticationTypes = list(
        "BASIC"|"OAUTH2"|"CUSTOM"|"IAM"
      ),
      ConnectionOptions = list(
        list(
          Name = "string",
          Description = "string",
          Required = TRUE|FALSE,
          DefaultValue = "string",
          PropertyTypes = list(
            "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
          ),
          AllowedValues = list(
            list(
              Description = "string",
              Value = "string"
            )
          ),
          DataOperationScopes = list(
            "READ"|"WRITE"
          )
        )
      ),
      ConnectionPropertyNameOverrides = list(
        "string"
      ),
      ConnectionOptionNameOverrides = list(
        "string"
      ),
      ConnectionPropertiesRequiredOverrides = list(
        "string"
      ),
      PhysicalConnectionPropertiesRequired = TRUE|FALSE
    )
  ),
  PhysicalConnectionRequirements = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  ),
  AthenaConnectionProperties = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  ),
  PythonConnectionProperties = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  ),
  SparkConnectionProperties = list(
    list(
      Name = "string",
      Description = "string",
      Required = TRUE|FALSE,
      DefaultValue = "string",
      PropertyTypes = list(
        "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT"
      ),
      AllowedValues = list(
        list(
          Description = "string",
          Value = "string"
        )
      ),
      DataOperationScopes = list(
        "READ"|"WRITE"
      )
    )
  )
)

Request syntax

svc$describe_connection_type(
  ConnectionType = "string"
)