import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GlueClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GlueClient"; import type { DescribeConnectionTypeRequest, DescribeConnectionTypeResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeConnectionTypeCommand}. */ export interface DescribeConnectionTypeCommandInput extends DescribeConnectionTypeRequest { } /** * @public * * The output of {@link DescribeConnectionTypeCommand}. */ export interface DescribeConnectionTypeCommandOutput extends DescribeConnectionTypeResponse, __MetadataBearer { } declare const DescribeConnectionTypeCommand_base: { new (input: DescribeConnectionTypeCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeConnectionTypeCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

The DescribeConnectionType 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 RegisterConnectionType.

*

See also: ListConnectionTypes, RegisterConnectionType, DeleteConnectionType *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { GlueClient, DescribeConnectionTypeCommand } from "@aws-sdk/client-glue"; // ES Modules import * // const { GlueClient, DescribeConnectionTypeCommand } = require("@aws-sdk/client-glue"); // CommonJS import * // import type { GlueClientConfig } from "@aws-sdk/client-glue"; * const config = {}; // type is GlueClientConfig * const client = new GlueClient(config); * const input = { // DescribeConnectionTypeRequest * ConnectionType: "STRING_VALUE", // required * }; * const command = new DescribeConnectionTypeCommand(input); * const response = await client.send(command); * // { // DescribeConnectionTypeResponse * // ConnectionType: "STRING_VALUE", * // Description: "STRING_VALUE", * // Capabilities: { // Capabilities * // SupportedAuthenticationTypes: [ // AuthenticationTypes // required * // "BASIC" || "OAUTH2" || "CUSTOM" || "IAM", * // ], * // SupportedDataOperations: [ // DataOperations // required * // "READ" || "WRITE", * // ], * // SupportedComputeEnvironments: [ // ComputeEnvironments // required * // "SPARK" || "ATHENA" || "PYTHON", * // ], * // }, * // ConnectionProperties: { // PropertiesMap * // "": { // Property * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // PropertyTypes: [ // PropertyTypes // required * // "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", * // ], * // AllowedValues: [ // AllowedValues * // { // AllowedValue * // Description: "STRING_VALUE", * // Value: "STRING_VALUE", // required * // }, * // ], * // DataOperationScopes: [ * // "READ" || "WRITE", * // ], * // KeyOverride: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // }, * // }, * // ConnectionOptions: { * // "": { * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // PropertyTypes: [ // required * // "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", * // ], * // AllowedValues: [ * // { * // Description: "STRING_VALUE", * // Value: "STRING_VALUE", // required * // }, * // ], * // DataOperationScopes: [ * // "READ" || "WRITE", * // ], * // KeyOverride: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // }, * // }, * // AuthenticationConfiguration: { // AuthConfiguration * // AuthenticationType: { * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // PropertyTypes: [ // required * // "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", * // ], * // AllowedValues: [ * // { * // Description: "STRING_VALUE", * // Value: "STRING_VALUE", // required * // }, * // ], * // DataOperationScopes: [ * // "READ" || "WRITE", * // ], * // KeyOverride: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // }, * // SecretArn: { * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // PropertyTypes: [ // required * // "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", * // ], * // AllowedValues: [ * // { * // Description: "STRING_VALUE", * // Value: "STRING_VALUE", // required * // }, * // ], * // DataOperationScopes: [ * // "READ" || "WRITE", * // ], * // KeyOverride: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // }, * // OAuth2Properties: { * // "": { * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // PropertyTypes: [ // required * // "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", * // ], * // AllowedValues: [ * // { * // Description: "STRING_VALUE", * // Value: "STRING_VALUE", // required * // }, * // ], * // DataOperationScopes: "", * // KeyOverride: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // }, * // }, * // BasicAuthenticationProperties: { * // "": "", * // }, * // CustomAuthenticationProperties: { * // "": "", * // }, * // }, * // ComputeEnvironmentConfigurations: { // ComputeEnvironmentConfigurationMap * // "": { // ComputeEnvironmentConfiguration * // Name: "STRING_VALUE", // required * // Description: "STRING_VALUE", // required * // ComputeEnvironment: "SPARK" || "ATHENA" || "PYTHON", // required * // SupportedAuthenticationTypes: [ // required * // "BASIC" || "OAUTH2" || "CUSTOM" || "IAM", * // ], * // ConnectionOptions: "", // required * // ConnectionPropertyNameOverrides: { // PropertyNameOverrides // required * // "": "STRING_VALUE", * // }, * // ConnectionOptionNameOverrides: { // required * // "": "STRING_VALUE", * // }, * // ConnectionPropertiesRequiredOverrides: [ // ListOfString // required * // "STRING_VALUE", * // ], * // PhysicalConnectionPropertiesRequired: true || false, * // }, * // }, * // PhysicalConnectionRequirements: "", * // AthenaConnectionProperties: "", * // PythonConnectionProperties: "", * // SparkConnectionProperties: "", * // RestConfiguration: { // RestConfiguration * // GlobalSourceConfiguration: { // SourceConfiguration * // RequestMethod: "GET" || "POST", * // RequestPath: "STRING_VALUE", * // RequestParameters: [ // ConnectorPropertyList * // { // ConnectorProperty * // Name: "STRING_VALUE", // required * // KeyOverride: "STRING_VALUE", * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // AllowedValues: [ * // "STRING_VALUE", * // ], * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // PropertyType: "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", // required * // }, * // ], * // ResponseConfiguration: { // ResponseConfiguration * // ResultPath: "STRING_VALUE", // required * // ErrorPath: "STRING_VALUE", * // }, * // PaginationConfiguration: { // PaginationConfiguration * // CursorConfiguration: { // CursorConfiguration * // NextPage: { // ExtractedParameter * // Key: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // Value: { // ResponseExtractionMapping * // ContentPath: "STRING_VALUE", * // HeaderKey: "STRING_VALUE", * // }, * // }, * // LimitParameter: { * // Key: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // Value: { * // ContentPath: "STRING_VALUE", * // HeaderKey: "STRING_VALUE", * // }, * // }, * // }, * // OffsetConfiguration: { // OffsetConfiguration * // OffsetParameter: { * // Key: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // Value: { * // ContentPath: "STRING_VALUE", * // HeaderKey: "STRING_VALUE", * // }, * // }, * // LimitParameter: { * // Key: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // Value: { * // ContentPath: "STRING_VALUE", * // HeaderKey: "STRING_VALUE", * // }, * // }, * // }, * // }, * // }, * // ValidationEndpointConfiguration: { * // RequestMethod: "GET" || "POST", * // RequestPath: "STRING_VALUE", * // RequestParameters: [ * // { * // Name: "STRING_VALUE", // required * // KeyOverride: "STRING_VALUE", * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // AllowedValues: [ * // "STRING_VALUE", * // ], * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // PropertyType: "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", // required * // }, * // ], * // ResponseConfiguration: { * // ResultPath: "STRING_VALUE", // required * // ErrorPath: "STRING_VALUE", * // }, * // PaginationConfiguration: { * // CursorConfiguration: { * // NextPage: { * // Key: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // Value: { * // ContentPath: "STRING_VALUE", * // HeaderKey: "STRING_VALUE", * // }, * // }, * // LimitParameter: "", * // }, * // OffsetConfiguration: { * // OffsetParameter: "", // required * // LimitParameter: "", // required * // }, * // }, * // }, * // EntityConfigurations: { // EntityConfigurationMap * // "": { // EntityConfiguration * // SourceConfiguration: { * // RequestMethod: "GET" || "POST", * // RequestPath: "STRING_VALUE", * // RequestParameters: [ * // { * // Name: "STRING_VALUE", // required * // KeyOverride: "STRING_VALUE", * // Required: true || false, // required * // DefaultValue: "STRING_VALUE", * // AllowedValues: "", * // PropertyLocation: "HEADER" || "BODY" || "QUERY_PARAM" || "PATH", * // PropertyType: "USER_INPUT" || "SECRET" || "READ_ONLY" || "UNUSED" || "SECRET_OR_USER_INPUT", // required * // }, * // ], * // ResponseConfiguration: { * // ResultPath: "STRING_VALUE", // required * // ErrorPath: "STRING_VALUE", * // }, * // PaginationConfiguration: { * // CursorConfiguration: { * // NextPage: "", // required * // LimitParameter: "", * // }, * // OffsetConfiguration: { * // OffsetParameter: "", // required * // LimitParameter: "", // required * // }, * // }, * // }, * // Schema: { // FieldDefinitionMap * // "": { // FieldDefinition * // Name: "STRING_VALUE", // required * // FieldDataType: "INT" || "SMALLINT" || "BIGINT" || "FLOAT" || "LONG" || "DATE" || "BOOLEAN" || "MAP" || "ARRAY" || "STRING" || "TIMESTAMP" || "DECIMAL" || "BYTE" || "SHORT" || "DOUBLE" || "STRUCT" || "BINARY" || "UNION", // required * // }, * // }, * // }, * // }, * // }, * // }; * * ``` * * @param DescribeConnectionTypeCommandInput - {@link DescribeConnectionTypeCommandInput} * @returns {@link DescribeConnectionTypeCommandOutput} * @see {@link DescribeConnectionTypeCommandInput} for command's `input` shape. * @see {@link DescribeConnectionTypeCommandOutput} for command's `response` shape. * @see {@link GlueClientResolvedConfig | config} for GlueClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Access to a resource was denied.

* * @throws {@link InternalServiceException} (server fault) *

An internal service error occurred.

* * @throws {@link InvalidInputException} (client fault) *

The input provided was not valid.

* * @throws {@link ValidationException} (client fault) *

A value could not be validated.

* * @throws {@link GlueServiceException} *

Base exception class for all service exceptions from Glue service.

* * * @public */ export declare class DescribeConnectionTypeCommand extends DescribeConnectionTypeCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeConnectionTypeRequest; output: DescribeConnectionTypeResponse; }; sdk: { input: DescribeConnectionTypeCommandInput; output: DescribeConnectionTypeCommandOutput; }; }; }