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. The response includes authentication configuration details that show supported authentication types and properties, and RestConfiguration for custom REST-based connection types registered via register_connection_type.

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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    ),
    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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    ),
    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"
        ),
        KeyOverride = "string",
        PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
      )
    ),
    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"
        ),
        KeyOverride = "string",
        PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
      )
    ),
    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"
        ),
        KeyOverride = "string",
        PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
      )
    )
  ),
  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"
          ),
          KeyOverride = "string",
          PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
        )
      ),
      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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  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"
      ),
      KeyOverride = "string",
      PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH"
    )
  ),
  RestConfiguration = list(
    GlobalSourceConfiguration = list(
      RequestMethod = "GET"|"POST",
      RequestPath = "string",
      RequestParameters = list(
        list(
          Name = "string",
          KeyOverride = "string",
          Required = TRUE|FALSE,
          DefaultValue = "string",
          AllowedValues = list(
            "string"
          ),
          PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          PropertyType = "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT",
          Format = "string"
        )
      ),
      ResponseConfiguration = list(
        ResultPath = "string",
        ErrorPath = "string"
      ),
      PaginationConfiguration = list(
        CursorConfiguration = list(
          NextPage = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          ),
          LimitParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          )
        ),
        OffsetConfiguration = list(
          OffsetParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          ),
          LimitParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          )
        )
      ),
      FilterConfiguration = list(
        FilterMode = "QUERY_PARAMS"|"FILTER_STRING",
        OperatorMappings = list(
          "string"
        ),
        DateTimeFormat = "string",
        StripQuotes = TRUE|FALSE,
        BetweenConfiguration = list(
          LowBoundKey = "string",
          HighBoundKey = "string",
          Template = "string"
        ),
        FilterStringConfiguration = list(
          QueryParameterName = "string",
          QuoteStringValues = TRUE|FALSE,
          QuoteCharacter = "string"
        )
      )
    ),
    ValidationEndpointConfiguration = list(
      RequestMethod = "GET"|"POST",
      RequestPath = "string",
      RequestParameters = list(
        list(
          Name = "string",
          KeyOverride = "string",
          Required = TRUE|FALSE,
          DefaultValue = "string",
          AllowedValues = list(
            "string"
          ),
          PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
          PropertyType = "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT",
          Format = "string"
        )
      ),
      ResponseConfiguration = list(
        ResultPath = "string",
        ErrorPath = "string"
      ),
      PaginationConfiguration = list(
        CursorConfiguration = list(
          NextPage = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          ),
          LimitParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          )
        ),
        OffsetConfiguration = list(
          OffsetParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          ),
          LimitParameter = list(
            Key = "string",
            DefaultValue = "string",
            PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
            Value = list(
              ContentPath = "string",
              HeaderKey = "string"
            )
          )
        )
      ),
      FilterConfiguration = list(
        FilterMode = "QUERY_PARAMS"|"FILTER_STRING",
        OperatorMappings = list(
          "string"
        ),
        DateTimeFormat = "string",
        StripQuotes = TRUE|FALSE,
        BetweenConfiguration = list(
          LowBoundKey = "string",
          HighBoundKey = "string",
          Template = "string"
        ),
        FilterStringConfiguration = list(
          QueryParameterName = "string",
          QuoteStringValues = TRUE|FALSE,
          QuoteCharacter = "string"
        )
      )
    ),
    EntityConfigurations = list(
      list(
        SourceConfiguration = list(
          RequestMethod = "GET"|"POST",
          RequestPath = "string",
          RequestParameters = list(
            list(
              Name = "string",
              KeyOverride = "string",
              Required = TRUE|FALSE,
              DefaultValue = "string",
              AllowedValues = list(
                "string"
              ),
              PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
              PropertyType = "USER_INPUT"|"SECRET"|"READ_ONLY"|"UNUSED"|"SECRET_OR_USER_INPUT",
              Format = "string"
            )
          ),
          ResponseConfiguration = list(
            ResultPath = "string",
            ErrorPath = "string"
          ),
          PaginationConfiguration = list(
            CursorConfiguration = list(
              NextPage = list(
                Key = "string",
                DefaultValue = "string",
                PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                Value = list(
                  ContentPath = "string",
                  HeaderKey = "string"
                )
              ),
              LimitParameter = list(
                Key = "string",
                DefaultValue = "string",
                PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                Value = list(
                  ContentPath = "string",
                  HeaderKey = "string"
                )
              )
            ),
            OffsetConfiguration = list(
              OffsetParameter = list(
                Key = "string",
                DefaultValue = "string",
                PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                Value = list(
                  ContentPath = "string",
                  HeaderKey = "string"
                )
              ),
              LimitParameter = list(
                Key = "string",
                DefaultValue = "string",
                PropertyLocation = "HEADER"|"BODY"|"QUERY_PARAM"|"PATH",
                Value = list(
                  ContentPath = "string",
                  HeaderKey = "string"
                )
              )
            )
          ),
          FilterConfiguration = list(
            FilterMode = "QUERY_PARAMS"|"FILTER_STRING",
            OperatorMappings = list(
              "string"
            ),
            DateTimeFormat = "string",
            StripQuotes = TRUE|FALSE,
            BetweenConfiguration = list(
              LowBoundKey = "string",
              HighBoundKey = "string",
              Template = "string"
            ),
            FilterStringConfiguration = list(
              QueryParameterName = "string",
              QuoteStringValues = TRUE|FALSE,
              QuoteCharacter = "string"
            )
          )
        ),
        Schema = list(
          list(
            Name = "string",
            FieldDataType = "INT"|"SMALLINT"|"BIGINT"|"FLOAT"|"LONG"|"DATE"|"BOOLEAN"|"MAP"|"ARRAY"|"STRING"|"TIMESTAMP"|"DECIMAL"|"BYTE"|"SHORT"|"DOUBLE"|"STRUCT"|"BINARY"|"UNION",
            ResponseDateFormat = "string",
            IsPartitionable = TRUE|FALSE,
            IsNullable = TRUE|FALSE,
            IsQueryable = TRUE|FALSE,
            IsOrderable = TRUE|FALSE,
            FilterOverrides = list(
              FieldName = "string",
              OperatorMappings = list(
                "string"
              ),
              BetweenConfiguration = list(
                LowBoundKey = "string",
                HighBoundKey = "string",
                Template = "string"
              ),
              DateTimeFormat = "string"
            )
          )
        )
      )
    )
  )
)

Request syntax¶

svc$describe_connection_type(
  ConnectionType = "string"
)