

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Type de connexion API
<a name="aws-glue-api-catalog-connections-connections-type"></a>

L'API Connection Type décrit l' AWS Glue API permettant d'enregistrer, de décrire, de supprimer et de répertorier les types de connexion.

## API de gestion des connexions
<a name="aws-glue-api-catalog-connections-connections-type-connection-management"></a>
+ [RegisterConnectionType action (Python : register\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-RegisterConnectionType)
+ [DeleteConnectionType action (Python : delete\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DeleteConnectionType)
+ [DescribeConnectionType action (Python : describe\_connection\_type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes action (Python : list\_connection\_types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)

## RegisterConnectionType action (Python : register\_connection\_type)
<a name="aws-glue-api-catalog-connections-connections-type-RegisterConnectionType"></a>

Enregistre un type de connexion personnalisé en AWS Glue fonction de la configuration fournie. Cette opération permet aux clients de configurer des connecteurs personnalisés pour n'importe quelle source de données avec REST-based des API, éliminant ainsi la nécessité de créer des Lambda connecteurs personnalisés.

Le type de connexion enregistré stocke des informations sur la manière dont les demandes et les réponses sont interprétées par les sources REST, notamment les propriétés de connexion, la configuration d'authentification et la configuration REST avec des définitions d'entités. Une fois enregistrés, les clients peuvent créer des connexions à l'aide de ce type de connexion et travailler avec eux de la même manière que les AWS Glue connecteurs pris en charge en mode natif.

Prend en charge plusieurs types d'authentification, notamment les configurations de base, OAuth2 (informations d'identification du client, support JWT, code d'autorisation) et les configurations d'authentification personnalisées.

**Demande**
+ `ConnectionType`— * Obligatoire : * UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nom du type de connexion. Doit comporter entre 1 et 255 caractères et doit être préfixé par « REST- » pour indiquer qu'il s'agit d'un REST-based connector.
+ `IntegrationType`— * Obligatoire : * UTF-8 chaîne (valeurs valides :`REST`).

  Type d'intégration pour la connexion. Actuellement, seul le protocole « REST » est pris en charge.
+ `Description`— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion. Peut contenir jusqu'à 2 048 caractères et fournit des détails sur l'objectif et les fonctionnalités du type de connexion.
+ `ConnectionProperties` – *Obligatoire :* un objet [ConnectionPropertiesConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration).

  Définit l'URL de base et les paramètres de demande supplémentaires nécessaires lors de la création de connexion pour ce type de connexion.
+ `ConnectorAuthenticationConfiguration` – *Obligatoire :* un objet [ConnectorAuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration).

  Définit les types d'authentification pris en charge et les propriétés requises pour ce type de connexion, notamment les méthodes d'authentification de base, OAuth2 et personnalisées.
+ `RestConfiguration` – *Obligatoire :* un objet [RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration).

  Définit la configuration des requêtes et réponses HTTP, le point de terminaison de validation et les configurations des entités pour les interactions avec l'API REST.
+ `Tags` – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne ne dépassant pas 256 octets.

  Les balises que vous attribuez au type de connexion.

**Réponse**

Contient le nom de ressource Amazon (ARN) du type de connexion nouvellement enregistré.
+ `ConnectionTypeArn`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 10240 octets, correspondant à. [Custom string pattern #47](aws-glue-api-common.md#regex_47)

  Le nom de ressource Amazon (ARN) du type de connexion enregistré. Cet identifiant unique peut être utilisé pour référencer le type de connexion dans d'autres AWS Glue opérations.

**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`

## DeleteConnectionType action (Python : delete\_connection\_type)
<a name="aws-glue-api-catalog-connections-connections-type-DeleteConnectionType"></a>

Supprime un type de connexion personnalisé dans. AWS Glue

Le type de connexion doit exister et être enregistré pour pouvoir être supprimé. Cette opération prend en charge le nettoyage des ressources de type de connexion et contribue à maintenir une gestion appropriée du cycle de vie des types de connexion personnalisés.

**Demande**
+ `ConnectionType`— * Obligatoire : * UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Le nom du type de connexion à supprimer. Doit faire référence à un type de connexion enregistré existant.

**Réponse**
+ *Paramètres d’absence de réponse.*

**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `AccessDeniedException`

## DescribeConnectionType action (Python : describe\_connection\_type)
<a name="aws-glue-api-catalog-connections-connections-type-DescribeConnectionType"></a>

L’API `DescribeConnectionType` fournit des informations complètes sur les options prises en charge pour un type de connexion donné dans AWS Glue. La réponse inclut les détails de configuration de l'authentification qui indiquent les types et propriétés d'authentification pris en charge, ainsi que RestConfiguration les types de REST-based connexion personnalisés enregistrés via`RegisterConnectionType`.

Voir également :`ListConnectionTypes`,`RegisterConnectionType`, `DeleteConnectionType`

**Demande**
+ `ConnectionType`— * Obligatoire : * UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nom du type de connexion à décrire.

**Réponse**
+ `ConnectionType`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).

  Nom du type de connexion.
+ `Description`— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion.
+ `Capabilities` – Un objet [Fonctionnalités](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Les types d'authentification, les types d'interfaces de données (environnements informatiques) et les opérations de données pris en charge par connector.
+ `ConnectionProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Propriétés de connexion communes à tous les environnements de calcul.
+ `ConnectionOptions` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Renvoie les propriétés qui peuvent être définies lors de la création d’une connexion dans les `ConnectionInput.ConnectionProperties`. `ConnectionOptions` définit les paramètres qui peuvent être définis dans un script Spark ETL dans la carte des options de connexion transmise à un DataFrame.
+ `AuthenticationConfiguration` : un objet [AuthConfiguration](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration).

  Le type d’autorisation utilisé pour la connexion.
+ `ComputeEnvironmentConfigurations` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [ComputeEnvironmentConfiguration](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration).

  Les environnements de calcul pris en charge par la connexion.
+ `PhysicalConnectionRequirements` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Exigences physiques pour une connexion, telles que les spécifications VPC, Sous-réseau et Groupe de sécurité.
+ `AthenaConnectionProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Propriétés de connexion spécifiques à l'environnement Athena informatique.
+ `PythonConnectionProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Propriétés de connexion propres à l’environnement de calcul Python.
+ `SparkConnectionProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Propriétés de connexion propres à l’environnement de calcul Spark.
+ `RestConfiguration` – Un objet [RestConfiguration](#aws-glue-api-catalog-connections-connections-type-RestConfiguration).

  Configuration des requêtes et réponses HTTP, point de terminaison de validation et configurations d'entités pour les sources de données basées sur REST.

**Erreurs**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`

## ListConnectionTypes action (Python : list\_connection\_types)
<a name="aws-glue-api-catalog-connections-connections-type-ListConnectionTypes"></a>

L’API `ListConnectionTypes` fournit un mécanisme de découverte permettant de connaître les types de connexion disponibles dans AWS Glue. La réponse contient une liste de types de connexion avec des informations détaillées sur ce qui est pris en charge pour chaque type de connexion, y compris les types de connexion intégrés et les types de connexion personnalisés enregistrés via`RegisterConnectionType`. Les types de connexion répertoriés sont l’ensemble des options prises en charge pour la valeur `ConnectionType` dans l’API `CreateConnection`.

Voir également :`DescribeConnectionType`,`RegisterConnectionType`, `DeleteConnectionType`

**Demande**
+ `MaxResults` – Nombre (entier), compris entre 1 et 1 000.

  Nombre maximal de résultats à renvoyer.
+ `NextToken`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets, correspondant à. [Custom string pattern #11](aws-glue-api-common.md#regex_11)

  Jeton de continuation, s’il s’agit d’un appel de continuation.

**Réponse**
+ `ConnectionTypes` : un tableau d’objets [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief).

  Une liste d’objets `ConnectionTypeBrief` contenant de brèves informations sur les types de connexion pris en charge.
+ `NextToken`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 2 048 octets, correspondant à. [Custom string pattern #11](aws-glue-api-common.md#regex_11)

  Jeton de continuation, si le segment de liste actuel n’est pas le dernier.

**Erreurs**
+ `InternalServiceException`

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

Brèves informations sur un type de connexion pris en charge renvoyées par l’API `ListConnectionTypes`.

**Champs**
+ `ConnectionType`— UTF-8 chaîne (valeurs valides : `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` \| `ADOBEANALYTICS` \| `SLACK` \| `LINKEDIN` \| `MIXPANEL` \| `ASANA` \| `STRIPE` \| `SMARTSHEET` \| `DATADOG` \| `WOOCOMMERCE` \| `INTERCOM`\| `SNAPCHATADS` \| `PAYPAL` \| `QUICKBOOKS` \| `FACEBOOKPAGEINSIGHTS` \| `FRESHDESK` \| `TWILIO` \| `DOCUSIGNMONITOR` \| `FRESHSALES` `ZOOM` \| `GOOGLESEARCHCONSOLE` \| `SALESFORCECOMMERCECLOUD` \| `SAPCONCUR` \| `DYNATRACE` \| `MICROSOFTDYNAMIC365FINANCEANDOPS` \| `MICROSOFTTEAMS` \| `BLACKBAUDRAISEREDGENXT` \| `MAILCHIMP` \| `GITLAB` \| `PENDO` \| `PRODUCTBOARD` \| `CIRCLECI` \| `PIPEDIVE` \| `SENDGRID` \| `AZURECOSMOS` \| `AZURESQL` \| `BIGQUERY` \| `BLACKBAUD` `CLOUDERAHIVE` \| `CLOUDERAIMPALA` \| `CLOUDWATCH` \| `CLOUDWATCHMETRICS` \| `CMDB` \| `DATALAKEGEN2` \| `DB2` \| `DB2AS400` \| `DOCUMENTDB` \| `DOMO` \| `DYNAMODB`\| `GOOGLECLOUDSTORAGE` \| `HBASE` \| `KUSTOMER` \| `MICROSOFTDYNAMICS365CRM` `MONDAY` \| `MYSQL` \| `OKTA` \| `OPENSEARCH` \| `ORACLE` \| `PIPEDRIVE` \| `POSTGRESQL` \| `SAPHANA` \| `SQLSERVER` \| `SYNAPSE` `TERADATA` \| `TERADATANOS` \| `TIMESTREAM` \| `TPCDS` \|`VERTICA`).

  Nom du type de connexion.
+ `DisplayName`— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom lisible par l’utilisateur du type de connexion affiché dans la console AWS Glue .
+ `Vendor`— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom du fournisseur qui a créé ou qui gère ce type de connexion.
+ `Description`— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description du type de connexion.
+ `Categories`— Un tableau de UTF-8 chaînes.

  Liste des catégories auxquelles appartient ce type de connexion. Les catégories aident les utilisateurs à filtrer et à trouver les types de connexion appropriés en fonction de leurs cas d’utilisation.
+ `Capabilities` – Un objet [Fonctionnalités](#aws-glue-api-catalog-connections-connections-type-Capabilities).

  Les types d'authentification, les types d'interfaces de données (environnements informatiques) et les opérations de données pris en charge par connector.
+ `LogoUrl`— UTF-8 ficelle.

  URL du logo associé à un type de connexion.
+ `ConnectionTypeVariants` : un tableau d’objets [ConnectionTypeVariant](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant).

  Liste des variantes disponibles pour ce type de connexion. Différentes variantes peuvent fournir des configurations spécialisées pour des cas d’utilisation ou des mises en œuvre spécifiques du même type de connexion général.

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

Représente une variante d'un type de connexion dans AWS Glue. Les variantes de type de connexion fournissent des configurations et des comportements spécifiques pour différentes implémentations du même type de connexion général.

**Champs**
+ `ConnectionTypeVariantName`— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Identifiant unique pour la variante du type de connexion. Ce nom est utilisé en interne pour identifier la variante spécifique d’un type de connexion. 
+ `DisplayName`— UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom lisible par l'homme de la variante de type de connexion qui s'affiche dans la AWS Glue console.
+ `Description`— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description détaillée de la variante du type de connexion, y compris son objectif, ses cas d’utilisation et les exigences de configuration spécifiques.
+ `LogoUrl`— UTF-8 ficelle.

  URL du logo associé à une variante du type de connexion.

## types de données
<a name="aws-glue-api-catalog-connections-connections-type-connection-types"></a>
+ [Structure de validation](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration structure](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Structure des fonctionnalités](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Structure de la propriété](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue structure](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)

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

Définit la manière dont une validation est effectuée sur une propriété de connexion.

**Champs**
+ `ValidationType`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `REGEX` \|`RANGE`).

  Type de validation à effectuer, tel que `REGEX`.
+ `Patterns`— Un tableau de UTF-8 chaînes.

  Liste des modèles qui s’appliquent à la validation.
+ `Description`— * Obligatoire : * UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 1 024 octets.

  Description de la validation.
+ `MaxLength` : nombre (entier).

  Longueur maximale d’une propriété de connexion de chaîne.
+ `Maximum` : nombre (entier).

  Valeur maximale lors de la spécification d’un type `RANGE` de validation.
+ `Minimum` : nombre (entier).

  Valeur minimale lors de la spécification d’un type `RANGE` de validation.

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

Configuration d’authentification pour une connexion renvoyée par l’API `DescribeConnectionType`.

**Champs**
+ `AuthenticationType` – *Obligatoire :* un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Type d’autorisation pour une connexion.
+ `SecretArn` – Un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Amazon Resource Name (ARN) pour Secrets Manager.
+ `OAuth2Properties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Une mappage de paires clé-valeur pour les propriétés OAuth2. Chaque valeur est un objet `Property`.
+ `BasicAuthenticationProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Une mappage de paires clé-valeur pour les propriétés OAuth2. Chaque valeur est un objet `Property`.
+ `CustomAuthenticationProperties` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Mappage de paires clé-valeur pour les propriétés d’authentification personnalisées. Chaque valeur est un objet `Property`.

## Structure des fonctionnalités
<a name="aws-glue-api-catalog-connections-connections-type-Capabilities"></a>

Spécifie les types d’authentification pris en charge renvoyés par l’API `DescribeConnectionType`.

**Champs**
+ `SupportedAuthenticationTypes`— * * Obligatoire : tableau de UTF-8 chaînes.

  Liste des types d’authentification pris en charge.
+ `SupportedDataOperations`— * * Obligatoire : tableau de UTF-8 chaînes.

  Liste des opérations de données prises en charge.
+ `SupportedComputeEnvironments`— * * Obligatoire : tableau de UTF-8 chaînes.

  Liste des environnements de calcul pris en charge.

## Structure de la propriété
<a name="aws-glue-api-catalog-connections-connections-type-Property"></a>

Objet qui définit un type de connexion pour un environnement de calcul.

**Champs**
+ `Name`— * Obligatoire : * UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de la propriété.
+ `Description`— * Obligatoire : * UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de la propriété.
+ `Required` – *obligatoire :* booléen.

  Indique si la propriété est obligatoire.
+ `DefaultValue`— UTF-8 ficelle.

  Valeur par défaut de la propriété.
+ `PropertyTypes`— * * Obligatoire : tableau de UTF-8 chaînes.

  Décrit le type de propriété.
+ `AllowedValues` : un tableau d’objets [AllowedValue](#aws-glue-api-catalog-connections-connections-type-AllowedValue).

  Liste d’objets `AllowedValue` représentant les valeurs autorisées pour la propriété.
+ `DataOperationScopes`— Un tableau de UTF-8 chaînes.

  Indique les opérations de données applicables à la propriété.
+ `KeyOverride`— UTF-8 ficelle.

  Nom de clé à utiliser lors de l'envoi de cette propriété dans les requêtes d'API, s'il est différent du nom d'affichage.
+ `PropertyLocation`— UTF-8 chaîne (valeurs valides : `HEADER` \| `BODY` \| `QUERY_PARAM` \|`PATH`).

  Spécifie où cette propriété doit être incluse dans les requêtes REST, par exemple dans les en-têtes, les paramètres de requête ou le corps de la requête.

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

Objet représentant une valeur autorisée pour une propriété.

**Champs**
+ `Description`— UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de la valeur autorisée.
+ `Value`— * Obligatoire : * UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Valeur autorisée pour la propriété.

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

Objet contenant la configuration d’un environnement de calcul (tel que Spark, Python ou Athena) renvoyé par l’API `DescribeConnectionType`.

**Champs**
+ `Name`— * Obligatoire : * UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Nom de la configuration de l’environnement de calcul.
+ `Description`— * Obligatoire : * UTF-8 chaîne ne dépassant pas 1 024 octets.

  Description de l’environnement de calcul.
+ `ComputeEnvironment`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `SPARK` `ATHENA` \| \|`PYTHON`).

  Type d'environnement de calcul.
+ `SupportedAuthenticationTypes`— * * Obligatoire : tableau de UTF-8 chaînes.

  Types d’authentification pris en charge pour l’environnement de calcul.
+ `ConnectionOptions` – *obligatoire :* tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).

  Paramètres utilisés comme options de connexion pour l’environnement de calcul.
+ `ConnectionPropertyNameOverrides` – *obligatoire :* tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de propriété de connexion est remplacé pour l’environnement de calcul.
+ `ConnectionOptionNameOverrides` – *obligatoire :* tableau de mappage de paires clé-valeur.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Chaque valeur est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom d’option de connexion est remplacé pour l’environnement de calcul.
+ `ConnectionPropertiesRequiredOverrides`— * * Obligatoire : tableau de UTF-8 chaînes.

  Les propriétés de connexion requises en tant que remplacements pour l’environnement de calcul.
+ `PhysicalConnectionPropertiesRequired` : booléen.

  Indique si les `PhysicalConnectionProperties` sont requises pour l’environnement de calcul.

## Types de données de connecteurs personnalisés
<a name="aws-glue-api-catalog-connections-connections-type-connector-types"></a>
+ [ConnectionPropertiesConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration)
+ [ConnectorAuthenticationConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration)
+ [ConnectorProperty structure](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty)
+ [RestConfiguration structure](#aws-glue-api-catalog-connections-connections-type-RestConfiguration)
+ [SourceConfiguration structure](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration)
+ [EntityConfiguration structure](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration)
+ [ResponseConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration)
+ [ResponseExtractionMapping structure](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping)
+ [PaginationConfiguration structure](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration)
+ [CursorConfiguration structure](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration)
+ [OffsetConfiguration structure](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration)
+ [ExtractedParameter structure](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter)
+ [FieldDefinition structure](#aws-glue-api-catalog-connections-connections-type-FieldDefinition)
+ [ConnectorOAuth2Properties structure](#aws-glue-api-catalog-connections-connections-type-ConnectorOAuth2Properties)
+ [ClientCredentialsProperties structure](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties)
+ [JWTBearerProperties structure](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties)
+ [ConnectorAuthorizationCodeProperties structure](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties)
+ [BasicAuthenticationProperties structure](#aws-glue-api-catalog-connections-connections-type-BasicAuthenticationProperties)
+ [CustomAuthenticationProperties structure](#aws-glue-api-catalog-connections-connections-type-CustomAuthenticationProperties)
+ [FilterConfiguration structure](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration)
+ [FilterOverrides structure](#aws-glue-api-catalog-connections-connections-type-FilterOverrides)
+ [BetweenConfiguration structure](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration)
+ [FilterStringConfiguration structure](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration)

## ConnectionPropertiesConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-ConnectionPropertiesConfiguration"></a>

Configuration qui définit l'URL de base et les paramètres de demande supplémentaires nécessaires lors de la création de la connexion.

**Champs**
+ `Url` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  URL de l'instance de base du point de terminaison auquel ce type de connexion va se connecter.
+ `AdditionalRequestParameters` : un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Key-value paires de paramètres de demande supplémentaires qui peuvent être nécessaires lors de la création de la connexion, tels que les versions d'API ou les options de configuration spécifiques à un service.

## ConnectorAuthenticationConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-ConnectorAuthenticationConfiguration"></a>

Configuration qui définit les types d'authentification pris en charge et les propriétés requises pour le type de connexion.

**Champs**
+ `AuthenticationTypes`— * * Obligatoire : tableau de UTF-8 chaînes.

  Liste des types d'authentification pris en charge par ce type de connexion, tels que les méthodes d'authentification de base, OAuth2 ou personnalisées.

## ConnectorProperty structure
<a name="aws-glue-api-catalog-connections-connections-type-ConnectorProperty"></a>

Définit une configuration de propriété pour les types de connexion, les valeurs par défaut et l'endroit où la propriété doit être utilisée dans les demandes.

**Champs**
+ `Name`— * Obligatoire : * UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

  Le nom de la propriété.
+ `KeyOverride`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant à[Custom string pattern #15](aws-glue-api-common.md#regex_15).

  Nom de clé à utiliser lors de l'envoi de cette propriété dans les requêtes d'API, s'il est différent du nom d'affichage.
+ `Required` – *obligatoire :* booléen.

  Indique si la propriété est obligatoire.
+ `DefaultValue`— UTF-8 ficelle.

  Valeur par défaut de la propriété.
+ `AllowedValues`— Un tableau de UTF-8 chaînes.

  Liste d’objets `AllowedValue` représentant les valeurs autorisées pour la propriété.
+ `PropertyLocation`— UTF-8 chaîne (valeurs valides : `HEADER` \| `BODY` \| `QUERY_PARAM` \|`PATH`).

  Spécifie où cette propriété doit être incluse dans les requêtes REST, par exemple dans les en-têtes, les paramètres de requête ou le corps de la requête.
+ `PropertyType`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `USER_INPUT` `SECRET` \| `READ_ONLY` \| `UNUSED` \| \|`SECRET_OR_USER_INPUT`).

  Le type de données de cette propriété
+ `Format`— UTF-8 ficelle.

  Un modèle de format pour la valeur de propriété qui définit la manière dont la valeur doit être formatée avant de l'envoyer dans des requêtes d'API. `{value}`Utilisez-le comme espace réservé pour la valeur réelle de la propriété (par exemple,`SSWS {value}`).

## RestConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-RestConfiguration"></a>

Configuration qui définit la gestion des requêtes et réponses HTTP, les points de terminaison de validation et les configurations d'entités pour les interactions avec l'API REST.

**Champs**
+ `GlobalSourceConfiguration` – Un objet [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration).

  Paramètres de configuration globaux qui s'appliquent à toutes les demandes d'API REST pour ce type de connexion, y compris les méthodes de demande, les chemins et les paramètres courants.
+ `ValidationEndpointConfiguration` – Un objet [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration).

  Configuration du point de terminaison utilisé pour valider les informations de connexion et tester la connectivité lors de la création de la connexion.
+ `EntityConfigurations` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant à[Custom string pattern #12](aws-glue-api-common.md#regex_12).

  Chaque valeur est un objet [EntityConfiguration](#aws-glue-api-catalog-connections-connections-type-EntityConfiguration).

  Carte des configurations d'entités qui définissent comment interagir avec les différentes entités de données disponibles via l'API REST, y compris leurs schémas et modèles d'accès.

## SourceConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-SourceConfiguration"></a>

Configuration qui définit comment envoyer des requêtes aux points de terminaison, y compris les méthodes de demande, les chemins, les paramètres et la gestion des réponses.

**Champs**
+ `RequestMethod`— UTF-8 chaîne (valeurs valides : `GET` \|`POST`).

  Méthode HTTP à utiliser pour les requêtes adressées à ce point de terminaison, telle que GET, POST.
+ `RequestPath`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant à[Custom string pattern #14](aws-glue-api-common.md#regex_14).

  Le chemin URL du point de terminaison REST, qui peut inclure des espaces réservés pour les paramètres qui seront remplacés par des valeurs réelles lors des requêtes.
+ `RequestParameters` : un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Configuration des paramètres de demande qui doivent être inclus dans les appels d'API, tels que les paramètres de requête, les en-têtes ou le contenu du corps.
+ `ResponseConfiguration` – Un objet [ResponseConfiguration](#aws-glue-api-catalog-connections-connections-type-ResponseConfiguration).

  Configuration qui définit comment analyser et extraire les données des réponses de l'API, y compris la gestion des succès et des erreurs.
+ `PaginationConfiguration` – Un objet [PaginationConfiguration](#aws-glue-api-catalog-connections-connections-type-PaginationConfiguration).

  Configuration pour gérer les réponses paginées à partir de l'API REST, prenant en charge les stratégies de pagination basées sur le curseur et basées sur le décalage.
+ `FilterConfiguration` – Un objet [FilterConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterConfiguration).

  Configuration pour appliquer un filtre pushdown aux requêtes d'API REST, définissant la manière dont les prédicats de filtre sont traduits en paramètres de requête ou en chaînes de filtre.

## EntityConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-EntityConfiguration"></a>

Configuration qui définit comment interagir avec une entité de données spécifique via l'API REST, y compris ses modèles d'accès et sa définition de schéma.

**Champs**
+ `SourceConfiguration` – Un objet [SourceConfiguration](#aws-glue-api-catalog-connections-connections-type-SourceConfiguration).

  La configuration source qui définit comment effectuer des demandes pour accéder aux données de cette entité via l'API REST.
+ `Schema` – Tableau de mappage de paires valeur-clé.

  Chaque clé est une UTF-8 chaîne d'au moins 1 octet de long.

  Chaque valeur est un objet [FieldDefinition](#aws-glue-api-catalog-connections-connections-type-FieldDefinition).

  La définition du schéma de cette entité, y compris les noms de champs, les types et les autres métadonnées qui décrivent la structure des données.

## ResponseConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-ResponseConfiguration"></a>

Configuration qui définit comment analyser les réponses JSON provenant d'appels d'API REST, y compris les chemins vers les données de résultats et les informations d'erreur.

**Champs**
+ `ResultPath`— * Obligatoire : * UTF-8 chaîne d'au moins 1 ou plus de 512 octets, correspondant à[Custom string pattern #10](aws-glue-api-common.md#regex_10).

  Expression de chemin JSON qui identifie l'emplacement des données de résultat réelles dans la réponse de l'API.
+ `ErrorPath`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant à[Custom string pattern #10](aws-glue-api-common.md#regex_10).

  Expression de chemin JSON qui identifie l'emplacement des informations d'erreur dans les réponses de l'API en cas d'échec des demandes.

## ResponseExtractionMapping structure
<a name="aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping"></a>

Configuration qui définit comment extraire des valeurs du contenu ou des en-têtes de réponse HTTP pour les utiliser dans les requêtes suivantes ou dans le mappage des paramètres.

**Champs**
+ `ContentPath`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 512 octets, correspondant à[Custom string pattern #10](aws-glue-api-common.md#regex_10).

  Expression de chemin JSON qui spécifie comment extraire une valeur du contenu du corps de la réponse.
+ `HeaderKey`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant à[Custom string pattern #15](aws-glue-api-common.md#regex_15).

  Nom de l'en-tête de réponse HTTP dont la valeur doit être extraite.

## PaginationConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-PaginationConfiguration"></a>

Configuration qui définit comment gérer les réponses paginées des API REST, prenant en charge différentes stratégies de pagination utilisées par différents services.

**Champs**
+ `CursorConfiguration` – Un objet [CursorConfiguration](#aws-glue-api-catalog-connections-connections-type-CursorConfiguration).

  Configuration pour la pagination basée sur le curseur, dans laquelle l'API fournit un curseur ou un jeton pour récupérer la page de résultats suivante.
+ `OffsetConfiguration` : un objet [OffsetConfiguration](#aws-glue-api-catalog-connections-connections-type-OffsetConfiguration).

  Configuration pour la pagination basée sur le décalage, dans laquelle l'API utilise des décalages et des limites numériques pour contrôler les résultats renvoyés.

## CursorConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-CursorConfiguration"></a>

Cursor-based configuration de pagination qui définit comment gérer la pagination à l'aide de jetons de curseur ou d'identifiants de page suivante.

**Champs**
+ `NextPage` – *Obligatoire :* un objet [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter).

  Le nom du paramètre ou le chemin JSON qui contient le curseur ou le jeton permettant de récupérer la page de résultats suivante.
+ `LimitParameter` : un objet [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter).

  Nom du paramètre utilisé pour spécifier le nombre maximum de résultats à renvoyer par page.

## OffsetConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-OffsetConfiguration"></a>

Offset-based configuration de pagination qui définit comment gérer la pagination à l'aide de décalages et de limites numériques.

**Champs**
+ `OffsetParameter` – *Obligatoire :* un objet [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter).

  Nom du paramètre utilisé pour spécifier la position de départ ou le décalage pour récupérer les résultats.
+ `LimitParameter` – *Obligatoire :* un objet [ExtractedParameter](#aws-glue-api-catalog-connections-connections-type-ExtractedParameter).

  Nom du paramètre utilisé pour spécifier le nombre maximum de résultats à renvoyer par page.

## ExtractedParameter structure
<a name="aws-glue-api-catalog-connections-connections-type-ExtractedParameter"></a>

Configuration d'extraction de paramètres qui définit la manière d'extraire et de mapper les valeurs des réponses de l'API aux paramètres de demande.

**Champs**
+ `Key`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 128 octets, correspondant à[Custom string pattern #15](aws-glue-api-common.md#regex_15).

  Le nom de la clé de paramètre qui sera utilisé dans les requêtes suivantes.
+ `DefaultValue`— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 1 024 octets, correspondant à[Custom string pattern #16](aws-glue-api-common.md#regex_16).

  La valeur par défaut à utiliser si le paramètre ne peut pas être extrait de la réponse.
+ `PropertyLocation`— UTF-8 chaîne (valeurs valides : `HEADER` \| `BODY` \| `QUERY_PARAM` \|`PATH`).

  Spécifie où ce paramètre extrait doit être placé dans les requêtes suivantes, par exemple dans les en-têtes, les paramètres de requête ou le corps de la demande.
+ `Value` – Un objet [ResponseExtractionMapping](#aws-glue-api-catalog-connections-connections-type-ResponseExtractionMapping).

  Le chemin JSON ou mappage d'extraction qui définit comment extraire la valeur du paramètre à partir des réponses de l'API.

## FieldDefinition structure
<a name="aws-glue-api-catalog-connections-connections-type-FieldDefinition"></a>

Définit un champ dans un schéma d'entité pour les sources de données du connecteur REST, en spécifiant le nom du champ et le type de données.

**Champs**
+ `Name`— * Obligatoire : * UTF-8 chaîne.

  Le nom du champ dans le schéma de l'entité.
+ `FieldDataType`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `INT` `SMALLINT` `BIGINT` `FLOAT` \| `LONG` \| `DATE` \| `BOOLEAN` \| `MAP` \| `ARRAY` \| `STRING` \| `TIMESTAMP` \| `DECIMAL` \| `BYTE` \| `SHORT` \| `DOUBLE` \| `STRUCT` \| `BINARY` \|`UNION`).

  Type de données du champ.
+ `ResponseDateFormat`— UTF-8 ficelle.

  Modèle de format pour l'analyse des valeurs de date provenant des réponses de l'API. Obligatoire lorsque l'API utilise un ISO-8601 format non formaté. Accepte `DateTimeFormatter` les modèles Java (par exemple`EEE, d MMM yyyy HH:mm:ss Z`), `EPOCH_SECONDS` pour les secondes d'époque Unix ou `EPOCH_MILLIS` pour les millisecondes d'époque Unix.
+ `IsPartitionable` : booléen.

  Indique si ce champ peut être utilisé pour partitionner les requêtes adressées à la source de données.
+ `IsNullable` : booléen.

  Indique si ce champ peut contenir des valeurs nulles.
+ `IsQueryable` : booléen.

  Indique si ce champ peut être utilisé dans les prédicats de filtre lors de l'interrogation de données.
+ `IsOrderable` : booléen.

  Indique si ce champ peut être utilisé pour trier les résultats.
+ `FilterOverrides` – Un objet [FilterOverrides](#aws-glue-api-catalog-connections-connections-type-FilterOverrides).

  Per-field remplace le comportement des filtres, ce qui permet de personnaliser la façon dont les filtres sont appliqués à ce champ spécifique.

## ConnectorOAuth2Properties structure
<a name="aws-glue-api-catalog-connections-connections-type-ConnectorOAuth2Properties"></a>

Conteneur de configuration OAuth2 qui définit les propriétés d'authentification et les configurations spécifiques au flux pour les connexions. OAuth2-based 

**Champs**
+ `OAuth2GrantType`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `CLIENT_CREDENTIALS` `JWT_BEARER` \| \|`AUTHORIZATION_CODE`).

  Type d'autorisation OAuth2 à utiliser pour l'authentification, tel que CLIENT\_CREDENTIALS, JWT\_BEARER ou AUTHORIZATION\_CODE.
+ `ClientCredentialsProperties` – Un objet [ClientCredentialsProperties](#aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties).

  Propriétés de configuration spécifiques au flux de type d'autorisation des informations d'identification du client OAuth2.
+ `JWTBearerProperties` – Un objet [JWTBearerProperties](#aws-glue-api-catalog-connections-connections-type-JWTBearerProperties).

  Propriétés de configuration spécifiques au flux de type d'autorisation OAuth2 JWT Bearer.
+ `AuthorizationCodeProperties` – Un objet [ConnectorAuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties).

  Propriétés de configuration spécifiques au flux de type d'autorisation du code d'autorisation OAuth2.

## ClientCredentialsProperties structure
<a name="aws-glue-api-catalog-connections-connections-type-ClientCredentialsProperties"></a>

Configuration des informations d'identification du client OAuth2 qui définit les propriétés nécessaires pour le flux de type d'autorisation des informations d'identification du client.

**Champs**
+ `TokenUrl` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  URL du point de terminaison du jeton où le client demandera des jetons d'accès à l'aide des informations d'identification du client.
+ `RequestMethod`— UTF-8 chaîne (valeurs valides : `GET` \|`POST`).

  La méthode HTTP à utiliser pour effectuer des demandes de jetons, généralement POST.
+ `ContentType`— UTF-8 chaîne (valeurs valides : `APPLICATION_JSON` \|`URL_ENCODED`).

  Type de contenu à utiliser pour les demandes de jetons, par exemple application/x -www-form-urlencoded ou. application/json
+ `ClientId` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  L'identifiant du client OAuth2 fourni par le serveur d'autorisation.
+ `ClientSecret` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Le secret client OAuth2 fourni par le serveur d'autorisation.
+ `Scope` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  La portée OAuth2 qui définit le niveau d'accès demandé pour le flux d'informations d'identification du client.
+ `TokenUrlParameters` : un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

## JWTBearerProperties structure
<a name="aws-glue-api-catalog-connections-connections-type-JWTBearerProperties"></a>

Configuration du jeton JWT Bearer qui définit les propriétés nécessaires pour le flux de type d'autorisation JWT Bearer.

**Champs**
+ `TokenUrl` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  URL du point de terminaison du jeton où le jeton porteur JWT sera échangé contre un jeton d'accès.
+ `RequestMethod`— UTF-8 chaîne (valeurs valides : `GET` \|`POST`).

  La méthode HTTP à utiliser pour effectuer des demandes de jetons JWT bearer, généralement POST.
+ `ContentType`— UTF-8 chaîne (valeurs valides : `APPLICATION_JSON` \|`URL_ENCODED`).

  Type de contenu à utiliser pour les demandes de jetons JWT bearer, par exemple application/x -www-form-urlencoded ou. application/json
+ `JwtToken` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Le jeton JWT à utiliser dans le flux d'octroi du jeton du porteur pour l'authentification.
+ `TokenUrlParameters` : un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

## ConnectorAuthorizationCodeProperties structure
<a name="aws-glue-api-catalog-connections-connections-type-ConnectorAuthorizationCodeProperties"></a>

Configuration du code d'autorisation OAuth2 qui définit les propriétés nécessaires pour le flux de type d'octroi du code d'autorisation.

**Champs**
+ `AuthorizationCodeUrl` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  URL du point de terminaison d'autorisation où les utilisateurs seront redirigés pour accorder l'autorisation.
+ `AuthorizationCode` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Code d'autorisation reçu du serveur d'autorisation après le consentement de l'utilisateur.
+ `RedirectUri` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  L'URI de redirection qui doit correspondre à l'URI enregistré auprès du serveur d'autorisation.
+ `TokenUrl` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  URL du point de terminaison du jeton où le code d'autorisation sera échangé contre un jeton d'accès.
+ `RequestMethod`— UTF-8 chaîne (valeurs valides : `GET` \|`POST`).

  Méthode HTTP à utiliser pour effectuer des demandes d'échange de jetons, généralement POST.
+ `ContentType`— UTF-8 chaîne (valeurs valides : `APPLICATION_JSON` \|`URL_ENCODED`).

  Type de contenu à utiliser pour les demandes d'échange de jetons, par exemple application/x -www-form-urlencoded ou. application/json
+ `ClientId` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  L'identifiant du client OAuth2 fourni par le serveur d'autorisation.
+ `ClientSecret` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Le secret client OAuth2 fourni par le serveur d'autorisation.
+ `Scope` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  La portée OAuth2 qui définit le niveau d'accès demandé pour le flux de code d'autorisation.
+ `Prompt` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Paramètre d'invite OAuth2 qui contrôle le comportement du serveur d'autorisation lors de l'authentification des utilisateurs.
+ `TokenUrlParameters` : un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Paramètres supplémentaires à inclure dans les demandes d'URL de jetons sous forme de paires clé-valeur.

## BasicAuthenticationProperties structure
<a name="aws-glue-api-catalog-connections-connections-type-BasicAuthenticationProperties"></a>

Configuration d'authentification de base qui définit les propriétés du nom d'utilisateur et du mot de passe pour l'authentification HTTP Basic.

**Champs**
+ `Username` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Le nom de propriété du nom d'utilisateur à utiliser pour les informations d'authentification de base.
+ `Password` – Un objet [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Le nom de propriété du mot de passe à utiliser pour les informations d'authentification de base.

## CustomAuthenticationProperties structure
<a name="aws-glue-api-catalog-connections-connections-type-CustomAuthenticationProperties"></a>

Configuration d'authentification personnalisée qui permet des mécanismes d'authentification flexibles au-delà des flux standard Basic et OAuth2.

**Champs**
+ `AuthenticationParameters` – *Obligatoire :* un tableau d’objets [ConnectorProperty](#aws-glue-api-catalog-connections-connections-type-ConnectorProperty).

  Carte des paramètres d'authentification personnalisés qui définissent le mécanisme d'authentification spécifique et les propriétés requises.

## FilterConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-FilterConfiguration"></a>

Configuration qui définit la manière dont les prédicats de filtre sont appliqués aux requêtes d'API REST, prenant en charge à la fois les stratégies de paramètres de requête et de chaîne de filtre.

**Champs**
+ `FilterMode`— * Obligatoire : * UTF-8 chaîne (valeurs valides : `QUERY_PARAMS` \|`FILTER_STRING`).

  Stratégie d'application de filtres aux demandes. Utilisez-le `QUERY_PARAMS` pour transmettre des filtres en tant que paramètres de requête individuels ou `FILTER_STRING` pour créer une chaîne d'expression de filtre unique.
+ `OperatorMappings` – Tableau de mappage de paires valeur-clé.

  Chaque touche est une UTF-8 chaîne.

  Chaque valeur est une UTF-8 chaîne.

  Une carte entre les opérateurs de filtres logiques et leurs représentations API-specific sous forme de chaîne. Les touches d'opérateur prises en charge sont les suivantes : `EQUAL_TO` `NOT_EQUAL_TO` `LESS_THAN` `GREATER_THAN` `LESS_THAN_OR_EQUAL_TO``GREATER_THAN_OR_EQUAL_TO`,`CONTAINS`,,`BETWEEN`,`AND`, et`OR`.
+ `DateTimeFormat`— UTF-8 ficelle.

  Format de date et d'heure global pour les expressions de filtre. Accepte `DateTimeFormatter` les modèles Java (par exemple`EEE, d MMM yyyy HH:mm:ss Z`), `EPOCH_SECONDS` pour les secondes d'époque Unix ou `EPOCH_MILLIS` pour les millisecondes d'époque Unix. Si aucune valeur n'est spécifiée, les valeurs sont transmises telles quelles dans le ISO-8601 format.
+ `StripQuotes` : booléen.

  Indique si les guillemets doubles environnants doivent être supprimés des valeurs de filtre avant le traitement.
+ `BetweenConfiguration` – Un objet [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration).

  Configuration permettant de gérer les opérations de filtrage entre les plages.
+ `FilterStringConfiguration` – Un objet [FilterStringConfiguration](#aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration).

  Configuration permettant de créer des expressions de filtre lorsqu'elle `FilterMode` est définie sur`FILTER_STRING`.

## FilterOverrides structure
<a name="aws-glue-api-catalog-connections-connections-type-FilterOverrides"></a>

Configuration qui définit les remplacements par champ pour le comportement des filtres, permettant aux champs individuels de personnaliser la façon dont les opérations de filtrage sont appliquées.

**Champs**
+ `FieldName`— UTF-8 ficelle.

  Un remplacement pour le nom du champ à utiliser dans les expressions de filtre, s'il est différent du nom du champ du schéma.
+ `OperatorMappings` – Tableau de mappage de paires valeur-clé.

  Chaque touche est une UTF-8 chaîne.

  Chaque valeur est une UTF-8 chaîne.

  Une carte des opérateurs de filtres logiques avec leurs représentations d'API spécifiques au champ, remplaçant les mappages d'opérateurs globaux. Les touches d'opérateur prises en charge sont les suivantes : `EQUAL_TO` `NOT_EQUAL_TO` `LESS_THAN` `GREATER_THAN` `LESS_THAN_OR_EQUAL_TO``GREATER_THAN_OR_EQUAL_TO`,`CONTAINS`,,`BETWEEN`,`AND`, et`OR`.
+ `BetweenConfiguration` – Un objet [BetweenConfiguration](#aws-glue-api-catalog-connections-connections-type-BetweenConfiguration).

  Field-specific configuration pour gérer les opérations de filtrage de plage BETWEEN.
+ `DateTimeFormat`— UTF-8 ficelle.

  Format de date et d'heure pour les expressions de filtre de ce champ, qui remplace le format global`DateTimeFormat`. Accepte `DateTimeFormatter` les modèles Java (par exemple`EEE, d MMM yyyy HH:mm:ss Z`), `EPOCH_SECONDS` pour les secondes d'époque Unix ou `EPOCH_MILLIS` pour les millisecondes d'époque Unix.

## BetweenConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-BetweenConfiguration"></a>

Configuration qui définit la manière dont les opérations de filtrage de plage BETWEEN sont traduites en paramètres de demande d'API REST.

**Champs**
+ `LowBoundKey`— UTF-8 ficelle.

  Nom du paramètre utilisé pour la valeur de la limite inférieure dans une opération de filtre BETWEEN.
+ `HighBoundKey`— UTF-8 ficelle.

  Le nom du paramètre utilisé pour la valeur de la limite supérieure dans une opération de filtre BETWEEN.
+ `Template`— UTF-8 ficelle.

  Chaîne modèle pour créer l'expression de filtre BETWEEN.

## FilterStringConfiguration structure
<a name="aws-glue-api-catalog-connections-connections-type-FilterStringConfiguration"></a>

Configuration pour créer des chaînes d'expression de filtre lors de l'utilisation du mode `FILTER_STRING` filtre.

**Champs**
+ `QueryParameterName`— * Obligatoire : * UTF-8 chaîne.

  Le nom du paramètre de requête utilisé pour envoyer la chaîne d'expression de filtre construite dans les requêtes d'API.
+ `QuoteStringValues` : booléen.

  Indique si les valeurs de chaîne et de date doivent être entourées d'un guillemet dans l'expression du filtre.
+ `QuoteCharacter`— UTF-8 ficelle.

  Le caractère utilisé pour citer les valeurs lorsqu'il `QuoteStringValues` est vrai. Par défaut, les guillemets doubles sont utilisés si ce n'est pas spécifié.