# API de tipos de conexão
<a name="aws-glue-api-catalog-connections-connections-type"></a>

A API de tipo de conexão descreve as APIs do AWS Glue relacionadas à descrição dos tipos de conexão.

## APIs de gerenciamento de conexões
<a name="aws-glue-api-catalog-connections-connections-type-connection-management"></a>
+ [Ação DescribeConnectionType (Python: describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [Ação ListConnectionTypes (Python: list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [Estrutura ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [Estrutura de ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)

## Ação DescribeConnectionType (Python: describe\$1connection\$1type)
<a name="aws-glue-api-catalog-connections-connections-type-DescribeConnectionType"></a>

A API `DescribeConnectionType` fornece detalhes completos das opções válidas para um determinado tipo de conexão no AWS Glue.

**Solicitação**
+ `ConnectionType`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 255 bytes de comprimento e correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do tipo de conexão a ser descrito.

**Resposta**
+ `ConnectionType` – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  O nome do tipo de conexão.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do tipo de conexão.
+ `Capabilities` – Um objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do conector.
+ `ConnectionProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Propriedades da conexão que são comuns entre ambientes computacionais.
+ `ConnectionOptions` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Retorna propriedades que podem ser definidas ao criar uma conexão no `ConnectionInput.ConnectionProperties`. `ConnectionOptions` define parâmetros que podem ser definidos em um script ETL do Spark no mapa de opções de conexão passado para um quadro de dados.
+ `AuthenticationConfiguration` – Um objeto [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration).

  O tipo da autenticação usada para a conexão.
+ `ComputeEnvironmentConfigurations` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration) A.

  Os ambientes computacionais aceitos pela conexão.
+ `PhysicalConnectionRequirements` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Requisitos físicos para uma conexão, como especificações de VPC, sub-rede e grupo de segurança.
+ `AthenaConnectionProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Propriedades de conexão específicas para o ambiente computacional Athena.
+ `PythonConnectionProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Propriedades de conexão específicas para o ambiente computacional Python.
+ `SparkConnectionProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Propriedades de conexão específicas para o ambiente computacional Spark.

**Erros**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`

## Ação ListConnectionTypes (Python: list\$1connection\$1types)
<a name="aws-glue-api-catalog-connections-connections-type-ListConnectionTypes"></a>

A API `ListConnectionTypes` fornece um mecanismo de descoberta para aprender os tipos de conexão disponíveis no AWS Glue. A resposta contém uma lista de tipos de conexão com detalhes de alto nível do que é aceito para cada tipo de conexão. Os tipos de conexão listados são o conjunto de opções válidas para o valor `ConnectionType` na API `CreateConnection`.

**Solicitação**
+ `MaxResults` – Número (inteiro), superior a 1 ou mais que 1000.

  O número máximo de resultados a serem retornados.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Um token de continuação, se esta for uma chamada de continuação.

**Resposta**
+ `ConnectionTypes`: um array de objetos [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief).

  Uma lista de objetos `ConnectionTypeBrief` contendo informações breves sobre os tipos de conexão válidos.
+ `NextToken` – String UTF-8, superior a 1 e inferior a 2048 bytes de comprimento, correspondente a [Custom string pattern #11](aws-glue-api-common.md#regex_11).

  Um token de continuação, se o segmento de lista atual não for o último.

**Erros**
+ `InternalServiceException`

## Estrutura ConnectionTypeBrief
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief"></a>

Informações breves sobre um tipo de conexão compatível retornado pela API `ListConnectionTypes`.

**Campos**
+ `ConnectionType` – String UTF-8 (valores válidos: `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` \$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` \$1 `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` \$1 `TPCDS` \$1 `VERTICA`).

  O nome do tipo de conexão.
+ `DisplayName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome legível por humanos para o tipo de conexão exibido no console do AWS Glue.
+ `Vendor` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome do fornecedor ou provedor que criou ou mantém esse tipo de conexão.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do tipo de conexão.
+ `Categories` – .

  Uma lista das categorias às quais esse tipo de conexão pertence. As categorias ajudam os usuários a filtrar e encontrar os tipos de conexões apropriados com base em seus casos de uso.
+ `Capabilities` – Um objeto [Capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Os tipos de autenticação, os tipos de interface de dados (ambientes de computação) e as operações de dados compatíveis do conector.
+ `LogoUrl` – String UTF-8.

  O URL do logotipo associado a um tipo de conexão.
+ `ConnectionTypeVariants`: um array de objetos [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant).

  Uma lista das variantes disponíveis para esse tipo de conexão. Variantes diferentes podem oferecer configurações especializadas para determinados casos de uso ou implementações do mesmo tipo geral de conexão.

## Estrutura de ConnectionTypeVariant
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant"></a>

Representa uma variante de um tipo de conexão do AWS Glue Data Catalog. Variantes de tipos de conexões oferecem configurações e comportamentos específicos para diferentes implementações do mesmo tipo geral de conexão.

**Campos**
+ `ConnectionTypeVariantName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O identificador exclusivo da variante de tipo de conexão. Esse nome é usado internamente para identificar a variante específica de um tipo de conexão. 
+ `DisplayName` – String UTF-8, superior a 1 e inferior a 128 bytes de comprimento.

  O nome legível por humanos da variante de tipo de conexão que é exibida no console do AWS Glue.
+ `Description`: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição detalhada da variante de tipo de conexão, incluindo finalidade, casos de uso e requisitos específicos de configuração.
+ `LogoUrl` – String UTF-8.

  A URL do logotipo associado a uma variante de tipo de conexão.

## datatypes
<a name="aws-glue-api-catalog-connections-connections-type-connection-types"></a>
+ [Estrutura Validation](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [Estrutura AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Estrutura de capacidades](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Estrutura Property](#aws-glue-api-catalog-connections-connections-type-Property)
+ [Estrutura AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [Estrutura ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)

## Estrutura Validation
<a name="aws-glue-api-catalog-connections-connections-type-Validation"></a>

Define como a validação é executada em uma propriedade de conexão.

**Campos**
+ `ValidationType` – *Obrigatório:* string UTF-8 (valores válidos: `REGEX` \$1 `RANGE`).

  O tipo de validação a ser realizada, como `REGEX`.
+ `Patterns` – .

  Uma lista de padrões que se aplicam à validação.
+ `Description` *(obrigatório):* string UTF-8, podendo ter entre 1 e 1.024 bytes.

  Uma descrição da validação.
+ `MaxLength` – Número (íntegro).

  Um comprimento máximo para uma propriedade de conexão de string.
+ `Maximum` – Número (íntegro).

  Um valor máximo ao especificar um tipo de validação `RANGE`.
+ `Minimum` – Número (íntegro).

  Um valor mínimo ao especificar um tipo de validação `RANGE`.

## Estrutura AuthConfiguration
<a name="aws-glue-api-catalog-connections-connections-type-AuthConfiguration"></a>

A configuração de autenticação para uma conexão retornada pela API `DescribeConnectionType`.

**Campos**
+ `AuthenticationType` – *Obrigatório:* um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property).

  O tipo da autenticação de uma conexão.
+ `SecretArn` – Um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property).

  O nome do recurso da Amazon (ARN) do Secrets Manager.
+ `OAuth2Properties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto `Property`.
+ `BasicAuthenticationProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Um mapa de pares de chave-valore para as propriedades da OAuth2. Cada valor é um objeto `Property`.
+ `CustomAuthenticationProperties` – Um array de mapa dos pares de valor-chave.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Um mapa de pares de chave-valore para as propriedades da autenticação personalizada. Cada valor é um objeto `Property`.

## Estrutura de capacidades
<a name="aws-glue-api-catalog-connections-connections-type-Capabilities"></a>

Especifica os tipos de autenticação compatíveis retornados pela API `DescribeConnectionType`.

**Campos**
+ `SupportedAuthenticationTypes`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista dos tipos de autenticação compatíveis.
+ `SupportedDataOperations`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista das operações de dados compatíveis.
+ `SupportedComputeEnvironments`: *obrigatório:* uma matriz de strings UTF-8.

  Uma lista de ambientes computacionais compatíveis.

## Estrutura Property
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

Um objeto que define um tipo de conexão para um ambiente computacional.

**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da propriedade.
+ `Description`: *obrigatório:* string UTF-8 com no máximo 1.024 bytes de comprimento.

  Uma descrição da propriedade.
+ `Required`: *obrigatório:* booleano.

  Indica se a propriedade é obrigatória.
+ `PropertyTypes`: *obrigatório:* uma matriz de strings UTF-8.

  Descreve o tipo de propriedade.
+ `AllowedValues`: um array de objetos [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue).

  Uma lista de objetos `AllowedValue` representando os valores permitidos para a propriedade.
+ `DataOperationScopes` – Uma matriz de strings UTF-8.

  Indica quais operações de dados são aplicáveis à propriedade.

## Estrutura AllowedValue
<a name="aws-glue-api-catalog-connections-connections-type-AllowedValue"></a>

Um objeto que representa um valor permitido para uma propriedade.

**Campos**
+ `Description`: string UTF-8, com no máximo 1.024 bytes.

  Uma descrição do valor permitido.
+ `Value`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O valor permitido para a propriedade.

## Estrutura ComputeEnvironmentConfiguration
<a name="aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration"></a>

Um objeto contendo a configuração de um ambiente computacional (como Spark, Python ou Athena) retornado pela API `DescribeConnectionType`.

**Campos**
+ `Name`: *obrigatório:* string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Um nome para a configuração do ambiente computacional.
+ `Description`: *obrigatório:* string UTF-8 com no máximo 1.024 bytes de comprimento.

  Uma descrição do ambiente computacional.
+ `ComputeEnvironment` – *Obrigatório:* string UTF-8 (valores válidos: `SPARK` \$1 `ATHENA` \$1 `PYTHON`).

  O tipo do ambiente de computação.
+ `SupportedAuthenticationTypes`: *obrigatório:* uma matriz de strings UTF-8.

  Os tipos de autenticação com suporte para o ambiente computacional.
+ `ConnectionOptions`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é um objeto [Propriedade](#aws-glue-api-catalog-connections-connections-type-Property) A.

  Os parâmetros usados como opções de conexão para o ambiente computacional.
+ `ConnectionPropertyNameOverrides`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da propriedade de conexão é substituído para ambiente computacional.
+ `ConnectionOptionNameOverrides`: *obrigatório:* uma matriz de mapa dos pares de chave-valor.

  Cada chave é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  Cada valor é uma string UTF-8 com no mínimo 1 e no máximo 128 bytes de comprimento.

  O nome da opção de conexão é substituído para ambiente computacional.
+ `ConnectionPropertiesRequiredOverrides` – *Obrigatório:* .

  As propriedades de conexão que são necessárias como substituição para o ambiente computacional.
+ `PhysicalConnectionPropertiesRequired` – Booleano.

  Indica se as `PhysicalConnectionProperties` são necessários para o ambiente computacional.