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.
# API de connexions
L'API Connections décrit les types de données et l'API liés à l'utilisation des connexions dans AWS Glue.
**Topics**
+ [API de connexion](aws-glue-api-catalog-connections-connections.md)
+ [API de types de connexion](aws-glue-api-catalog-connections-connections-type.md)
+ [Métadonnées de connexion et API de prévisualisation](aws-glue-api-catalog-connections-connections-metadata.md)
# API de connexion
L'API de connexion décrit les types de données de AWS Glue connexion, ainsi que l'API permettant de créer, de supprimer, de mettre à jour et de répertorier les connexions.
## Types de données
+ [Structure de connexion](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput structure](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput structure](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements structure](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter structure](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration structure](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput structure](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Structure des propriétés](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput structure](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication structure](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties structure](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials structure](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Structure des informations d'identification](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
## Structure de connexion
Définit une connexion à une source de données.
**Champs**
+ `Name` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la définition de connexion.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la connexion.
+ `ConnectionType`— Chaîne UTF-8 (valeurs valides : `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 \$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` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `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` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` `TPCDS` \$1`VERTICA`).
Type de connexion. Actuellement, SFTP n'est pas pris en charge.
+ `MatchCriteria` : tableau de chaînes UTF-8, avec 10 chaînes maximum.
Liste des critères qui peuvent être utilisés dans la sélection de cette connexion.
+ `ConnectionProperties` – Tableau de mappage de paires clé-valeur, 100 paires au maximum.
Chaque clé est une chaîne UTF-8 (valeurs valides : `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Ces paires clé-valeur définissent les paramètres pour la connexion lors de l’utilisation du schéma de connexion de la version 1 :
+ `HOST`- L'URI de l'hôte : soit le nom de domaine complet (FQDN), soit l' IPv4 adresse de l'hôte de la base de données.
+ `PORT` - Numéro du port, compris entre 1 024 et 65 535, sur lequel l'hôte de base de données écoute les connexions de la base de données.
+ `USER_NAME` - Nom sous lequel vous vous connectez à la base de données. La valeur de chaîne pour `USER_NAME` est « `USERNAME` ».
+ `PASSWORD` - Mot de passe, le cas échéant, pour le nom d'utilisateur.
+ `ENCRYPTED_PASSWORD` - Lorsque vous activez la protection de mot de passe en réglant `ConnectionPasswordEncryption` dans les paramètres de chiffrage de Catalogue de données, ce champ stocke le mot de passe chiffré.
+ `JDBC_DRIVER_JAR_URI` - Chemin d’accès Amazon Simple Storage Service (Amazon S3) du fichier JAR qui contient le pilote JDBC à utiliser.
+ `JDBC_DRIVER_CLASS_NAME` - Nom de classe du pilote JDBC à utiliser.
+ `JDBC_ENGINE` – Nom du moteur JDBC à utiliser.
+ `JDBC_ENGINE_VERSION` - Version du moteur JDBC à utiliser.
+ `CONFIG_FILES` - (Réservé pour une utilisation ultérieure.)
+ `INSTANCE_ID` - ID d'instance à utiliser.
+ `JDBC_CONNECTION_URL` - URL de connexion à une source de données JDBC.
+ `JDBC_ENFORCE_SSL` : chaîne booléenne insensible à la casse (true, false) spécifiant si Secure Sockets Layer (SSL) avec le nom d’hôte correspondant est appliqué pour la connexion JDBC sur le client. La valeur par défaut est false.
+ `CUSTOM_JDBC_CERT`- Un emplacement Amazon S3 spécifiant le certificat racine du client. AWS Glue utilise ce certificat racine pour valider le certificat du client lors de la connexion à la base de données clients. AWS Glue gère uniquement les certificats X.509. Le certificat fourni doit être codé DER et fourni au format PEM d'encodage Base64.
+ `SKIP_CUSTOM_JDBC_CERT_VALIDATION`- Par défaut, c'est le cas`false`. AWS Glue valide l'algorithme de signature et l'algorithme de clé publique du sujet pour le certificat client. Les seuls algorithmes autorisés pour l'algorithme de signature sont SHA256with RSA, RSA ou SHA384with SHA512with RSA. Pour l'algorithme de clé publique d'objet, la longueur de clé doit être d'au moins 2048. Vous pouvez mettre la valeur de cette propriété à `true` pour ignorer la validation par AWS Glue du certificat du client.
+ `CUSTOM_JDBC_CERT_STRING`- Une chaîne de certificat JDBC personnalisée qui est utilisée pour la correspondance de domaine ou de nom distinctif afin de prévenir une man-in-the-middle attaque. Dans Oracle Database, elle est utilisée comme `SSL_SERVER_CERT_DN`. Dans Microsoft SQL Server, elle est utilisée comme `hostNameInCertificate`.
+ `CONNECTION_URL` - URL de connexion à une source de données générale (non JDBC).
+ `SECRET_ID` - L'ID secret utilisé pour le gestionnaire secret des informations d'identification.
+ `CONNECTOR_URL` - L'URL du connecteur pour une connexion MARKETPLACE ou CUSTOM.
+ `CONNECTOR_TYPE` - Le type du connecteur pour une connexion MARKETPLACE ou CUSTOM.
+ `CONNECTOR_CLASS_NAME` - Le nom de la classe de connecteur pour une connexion MARKETPLACE ou CUSTOM.
+ `KAFKA_BOOTSTRAP_SERVERS` - Liste séparée par des virgules composée de paires hôte et port qui sont les adresses des courtiers Apache Kafka dans un cluster Kafka auquel un client Kafka se connecte pour démarrer lui-même.
+ `KAFKA_SSL_ENABLED` - Indique s'il convient d'activer ou de désactiver SSL sur une connexion Apache Kafka. La valeur par défaut est « true » (vrai).
+ `KAFKA_CUSTOM_CERT` - L'URL d'Amazon S3 pour le fichier de certificat de l'autorité de certification privée (format .pem). La valeur par défaut est une chaîne vide.
+ `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`- S'il faut ou non ignorer la validation du fichier de certification CA. AWS Glue valide pour trois algorithmes : SHA256with RSA, RSA et SHA384with RSA. SHA512with La valeur par défaut est « false » (faux).
+ `KAFKA_CLIENT_KEYSTORE` - Emplacement Amazon S3 du fichier de magasin de clés client pour l'authentification côté client Kafka (facultatif).
+ `KAFKA_CLIENT_KEYSTORE_PASSWORD` - Le mot de passe pour accéder au magasin de clés fourni (facultatif).
+ `KAFKA_CLIENT_KEY_PASSWORD` - Un magasin de clés peut être composé de plusieurs clés, il s'agit donc du mot de passe pour accéder à la clé client à utiliser avec la clé côté serveur Kafka (facultatif).
+ `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`- La version cryptée du mot de passe du keystore du client Kafka (si l'utilisateur a sélectionné le paramètre de AWS Glue chiffrement des mots de passe).
+ `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`- La version cryptée du mot de passe clé du client Kafka (si l'utilisateur a sélectionné le paramètre de AWS Glue cryptage des mots de passe).
+ `KAFKA_SASL_MECHANISM`- `"SCRAM-SHA-512"``"GSSAPI"`,`"AWS_MSK_IAM"`, ou`"PLAIN"`. Ce sont les [mécanismes SASL](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) pris en charge.
+ `KAFKA_SASL_PLAIN_USERNAME` : nom d’utilisateur en texte clair utilisé pour s’authentifier avec le mécanisme « PLAIN ».
+ `KAFKA_SASL_PLAIN_PASSWORD` : mot de passe en texte clair utilisé pour s’authentifier avec le mécanisme « PLAIN ».
+ `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD`- La version cryptée du mot de passe Kafka SASL PLAIN (si l'utilisateur a sélectionné le paramètre de AWS Glue cryptage des mots de passe).
+ `KAFKA_SASL_SCRAM_USERNAME` - Un nom d'utilisateur en texte clair utilisé pour s'authentifier avec le mécanisme « SCRAM-SHA-512 ».
+ `KAFKA_SASL_SCRAM_PASSWORD` - Un mot de passe en texte clair utilisé pour s'authentifier avec le mécanisme « SCRAM-SHA-512 ».
+ `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`- La version cryptée du mot de passe Kafka SASL SCRAM (si l'utilisateur a sélectionné le paramètre de AWS Glue cryptage des mots de passe).
+ `KAFKA_SASL_SCRAM_SECRETS_ARN`- Le nom de ressource Amazon d'un secret dans AWS Secrets Manager.
+ `KAFKA_SASL_GSSAPI_KEYTAB` - Emplacement S3 d'un fichier Kerberos `keytab`. Un keytab stocke les clés à long terme pour un ou plusieurs principaux. Pour en savoir plus, consultez [Documentation du MIT Kerberos : Keytab](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html).
+ `KAFKA_SASL_GSSAPI_KRB5_CONF` - Emplacement S3 d'un fichier Kerberos `krb5.conf`. Un fichier krb5.conf stocke les informations de configuration Kerberos, telles que l'emplacement du serveur KDC. Pour en savoir plus, consultez [Documentation MIT Kerberos : krb5.conf](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html).
+ `KAFKA_SASL_GSSAPI_SERVICE` - Le nom du service Kerberos, tel que défini avec `sasl.kerberos.service.name` dans votre [Configuration Kafka](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name).
+ `KAFKA_SASL_GSSAPI_PRINCIPAL`- Le nom du principal Kerberos utilisé par. AWS Glue Pour plus d’informations, consultez [Documentation Kafka : configuration des courtiers Kafka](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig).
+ `ROLE_ARN` : rôle à utiliser pour exécuter des requêtes.
+ `REGION`- La AWS région dans laquelle les requêtes seront exécutées.
+ `WORKGROUP_NAME` : nom d’un groupe de travail Amazon Redshift sans serveur ou d’un groupe de travail Amazon Athena dans lequel les requêtes seront exécutées.
+ `CLUSTER_IDENTIFIER` : identifiant de cluster d’un cluster Amazon Redshift dans lequel les requêtes seront exécutées.
+ `DATABASE` : base de données Amazon Redshift à laquelle vous vous connectez.
+ `SparkProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Spark.
+ `AthenaProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Athena.
+ `PythonProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Python.
+ `PhysicalConnectionRequirements` – Un objet [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Les exigences de connexion physique, comme un cloud privé virtuel (VPC) et `SecurityGroup`, qui sont nécessaires pour établir la connexion.
+ `CreationTime` – Horodatage.
Horodatage de l’heure à laquelle la définition de connexion a été créée.
+ `LastUpdatedTime` – Horodatage.
Horodatage de la dernière date à laquelle la définition de connexion a été mise à jour.
+ `LastUpdatedBy` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
L'utilisateur, groupe ou rôle qui a mis à jour la définition de connexion pour la dernière fois.
+ `Status` – Chaîne UTF-8 (valeurs valides : `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).
État de la connexion. Peut avoir l'une des valeurs suivantes : `READY`, `IN_PROGRESS` ou `FAILED`.
+ `StatusReason` – Chaîne UTF-8, d’une longueur comprise entre 1 et 16 384 octets.
Motif de l’état de la connexion.
+ `LastConnectionValidationTime` – Horodatage.
Horodatage de la dernière date de validation de cette connexion.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration).
Les propriétés d’authentification de la connexion.
+ `ConnectionSchemaVersion`— Nombre (entier), pas moins de 1 ou plus de 2.
Version du schéma de connexion pour cette connexion. La version 2 prend en charge les propriétés pour des environnements de calcul spécifiques.
+ `CompatibleComputeEnvironments` – Tableau de chaînes UTF-8.
Liste des environnements de calcul compatibles avec la connexion.
## ConnectionInput structure
Une structure utilisée pour spécifier la connexion à créer ou à mettre à jour.
**Champs**
+ `Name` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la connexion.
+ `ConnectionType`— *Obligatoire :* chaîne UTF-8 (valeurs valides : `JDBC` `SFTP` `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$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` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `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` `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` `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
Type de connexion. Actuellement, ces types sont pris en charge :
+ `JDBC` - Désigne une connexion à une base de données via Java Database Connectivity (JDBC).
`JDBC`Les connexions utilisent les méthodes suivantes ConnectionParameters.
+ Obligatoire : toutes les valeurs (`HOST`, `PORT`, `JDBC_ENGINE`) ou `JDBC_CONNECTION_URL`.
+ Obligatoire : toutes les valeurs (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ Facultatif : `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Ces paramètres sont utilisés pour configurer le SSL avec JDBC.
+ `KAFKA` - Désigne une connexion à une plateforme de streaming Apache Kafka.
`KAFKA`Les connexions utilisent les méthodes suivantes ConnectionParameters.
+ Obligatoire : `KAFKA_BOOTSTRAP_SERVERS`.
+ Facultatif : `KAFKA_SSL_ENABLED`, `KAFKA_CUSTOM_CERT`, `KAFKA_SKIP_CUSTOM_CERT_VALIDATION`. Ces paramètres sont utilisés pour configurer le SSL avec `KAFKA`.
+ Facultatif : `KAFKA_CLIENT_KEYSTORE`, `KAFKA_CLIENT_KEYSTORE_PASSWORD`, `KAFKA_CLIENT_KEY_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD`, `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD`. Ces paramètres sont utilisés pour configurer la configuration client TLS avec SSL dans `KAFKA`.
+ Facultatif : `KAFKA_SASL_MECHANISM`. Peut être spécifié comme suit : `SCRAM-SHA-512`, `GSSAPI` ou `AWS_MSK_IAM`.
+ Facultatif : `KAFKA_SASL_SCRAM_USERNAME`, `KAFKA_SASL_SCRAM_PASSWORD`, `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD`. Ces paramètres sont utilisés pour configurer l'authentification SASL/SCRAMSHA-512 avec `KAFKA`.
+ Facultatif : `KAFKA_SASL_GSSAPI_KEYTAB`, `KAFKA_SASL_GSSAPI_KRB5_CONF`, `KAFKA_SASL_GSSAPI_SERVICE`, `KAFKA_SASL_GSSAPI_PRINCIPAL`. Ces paramètres sont utilisés pour configurer SASL/GSSAPI l'authentification avec`KAFKA`.
+ `MONGODB` - Désigne une connexion à une base de données de documents MongoDB.
`MONGODB`Les connexions utilisent les méthodes suivantes ConnectionParameters.
+ Obligatoire : `CONNECTION_URL`.
+ Obligatoire : toutes les valeurs (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ `VIEW_VALIDATION_REDSHIFT` : désigne une connexion utilisée pour la validation des vues par Amazon Redshift.
+ `VIEW_VALIDATION_ATHENA` : désigne une connexion utilisée pour la validation des vues par Amazon Athena.
+ `NETWORK` - Désigne une connexion réseau à une source de données dans un environnement Amazon Virtual Private Cloud (Amazon VPC).
`NETWORK`Les connexions ne sont pas nécessaires ConnectionParameters. Fournissez plutôt un PhysicalConnectionRequirements.
+ `MARKETPLACE`- Utilise les paramètres de configuration contenus dans un connecteur acheté AWS Marketplace pour lire et écrire dans des magasins de données qui ne sont pas pris en charge de manière native par AWS Glue.
`MARKETPLACE`Les connexions utilisent les méthodes suivantes ConnectionParameters.
+ Obligatoire : `CONNECTOR_TYPE`, `CONNECTOR_URL`, `CONNECTOR_CLASS_NAME`, `CONNECTION_URL`.
+ Obligatoire pour les connexions `JDBC` `CONNECTOR_TYPE` : toutes les valeurs (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ `CUSTOM` - Utilise les paramètres de configuration contenus dans un connecteur personnalisé pour lire et écrire dans des magasins de données qui ne sont pas pris en charge en mode natif par AWS Glue.
Pour plus d'informations sur les paramètres de connexion nécessaires pour un connecteur particulier, consultez la documentation du connecteur dans la section [Ajout d'une AWS Glue connexion](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) dans le guide de AWS Glue l'utilisateur.
`SFTP` n’est pas pris en charge.
Pour plus d'informations sur la manière dont les fonctionnalités facultatives ConnectionProperties sont utilisées pour configurer les fonctionnalités dans AWS Glue, consultez les [propriétés de AWS Glue connexion](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html).
Pour plus d'informations sur la manière dont ConnectionProperties les options sont utilisées pour configurer les fonctionnalités dans AWS Glue Studio, consultez [Utilisation de connecteurs et de connexions](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html).
+ `MatchCriteria` : tableau de chaînes UTF-8, avec 10 chaînes maximum.
Liste des critères qui peuvent être utilisés dans la sélection de cette connexion.
+ `ConnectionProperties` – *Obligatoire :* Tableau de mappage de paires clé-valeur, avec 100 paires au maximum.
Chaque clé est une chaîne UTF-8 (valeurs valides : `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Ces paires clé-valeur définissent les paramètres pour la connexion.
+ `SparkProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Spark.
+ `AthenaProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Athena.
+ `PythonProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Python.
+ `PhysicalConnectionRequirements` – Un objet [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Les exigences de connexion physique, comme un cloud privé virtuel (VPC) et `SecurityGroup`, qui sont nécessaires pour bien établir cette connexion.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
Les propriétés d’authentification de la connexion.
+ `ValidateCredentials` : booléen.
Un indicateur pour valider les informations d’identification lors de la création de la connexion. La valeur par défaut est true.
+ `ValidateForComputeEnvironments` – Tableau de chaînes UTF-8.
Environnements de calcul par rapport auxquels les propriétés de connexion spécifiées sont validées.
## TestConnectionInput structure
Structure utilisée pour spécifier le test d’une connexion à un service.
**Champs**
+ `ConnectionType`— *Obligatoire :* chaîne UTF-8 (valeurs valides : `JDBC` `SFTP` `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$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` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `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` `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` `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
Le type de connexion à tester. Cette opération n’est disponible que pour les types de connexion `JDBC` ou `SALESFORCE`.
+ `ConnectionProperties` – *Obligatoire :* Tableau de mappage de paires clé-valeur, avec 100 paires au maximum.
Chaque clé est une chaîne UTF-8 (valeurs valides : `HOST` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Les paires clé-valeur qui définissent les paramètres pour la connexion.
Les connexions JDBC utilisent les propriétés de connexion suivantes :
+ Obligatoire : toutes les valeurs (`HOST`, `PORT`, `JDBC_ENGINE`) ou `JDBC_CONNECTION_URL`.
+ Obligatoire : toutes les valeurs (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ Facultatif : `JDBC_ENFORCE_SSL`, `CUSTOM_JDBC_CERT`, `CUSTOM_JDBC_CERT_STRING`, `SKIP_CUSTOM_JDBC_CERT_VALIDATION`. Ces paramètres sont utilisés pour configurer le SSL avec JDBC.
Les connexions SALESFORCE nécessitent que le membre `AuthenticationConfiguration` soit configuré.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
Structure contenant la configuration d'authentification dans la TestConnection demande. Nécessaire pour une connexion à Salesforce à l'aide de OAuth l'authentification.
## PhysicalConnectionRequirements structure
L'application OAuth cliente en GetConnection réponse.
**Champs**
+ `SubnetId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID de sous-réseau utilisé par la connexion.
+ `SecurityGroupIdList` – Tableau de chaînes UTF-8, avec 50 chaînes maximum.
Liste des ID de groupe de sécurité utilisée par la connexion.
+ `AvailabilityZone` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Connexion de la zone de disponibilité.
## GetConnectionsFilter structure
Filtre les définitions de connexion retournées par l'opération d'API `GetConnections`.
**Champs**
+ `MatchCriteria` : tableau de chaînes UTF-8, avec 10 chaînes maximum.
Chaîne des critères qui doivent répondre aux critères enregistrés dans la définition de connexion pour que cette définition soit renvoyée.
+ `ConnectionType`— Chaîne UTF-8 (valeurs valides : `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 \$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` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `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` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` `TPCDS` \$1`VERTICA`).
Type de connexions à renvoyer. Actuellement, SFTP n'est pas pris en charge.
+ `ConnectionSchemaVersion`— Nombre (entier), pas moins de 1 ou plus de 2.
Indique si la connexion a été créée avec la version 1 ou 2 du schéma.
## AuthenticationConfiguration structure
Une structure contenant la configuration d’authentification.
**Champs**
+ `AuthenticationType` – Chaîne UTF-8 (valeurs valides : `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Une structure contenant la configuration d’authentification.
+ `SecretArn` – Chaîne UTF-8, correspondant au [Custom string pattern #36](aws-glue-api-common.md#regex_36).
ARN de Secrets Manager pour stocker les informations d’identification.
+ `KmsKeyArn` – Chaîne UTF-8, correspondant au [Custom string pattern #42](aws-glue-api-common.md#regex_42).
Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les informations d’authentification sensibles. Cette clé est utilisée pour protéger les informations d’identification et autres données sensibles stockées dans la configuration d’authentification.
+ `OAuth2Properties` : un objet [OAuth2Propriétés](#aws-glue-api-catalog-connections-connections-OAuth2Properties).
Les propriétés de l' OAuth2 authentification.
## AuthenticationConfigurationInput structure
Structure contenant la configuration d'authentification dans la CreateConnection demande.
**Champs**
+ `AuthenticationType` – Chaîne UTF-8 (valeurs valides : `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Structure contenant la configuration d'authentification dans la CreateConnection demande.
+ `OAuth2Properties` : un objet [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput).
Les propriétés d' OAuth2 authentification dans la CreateConnection demande.
+ `SecretArn` – Chaîne UTF-8, correspondant au [Custom string pattern #36](aws-glue-api-common.md#regex_36).
L'ARN du gestionnaire secret pour stocker les informations d'identification dans la CreateConnection demande.
+ `KmsKeyArn` – Chaîne UTF-8, correspondant au [Custom string pattern #42](aws-glue-api-common.md#regex_42).
ARN de la clé KMS utilisée pour chiffrer la connexion. Utilisé uniquement comme entrée dans la demande et stocké dans Secrets Manager.
+ `BasicAuthenticationCredentials` – Un objet [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials).
Informations d’identification utilisées lorsque le type d’authentification est une authentification de base.
+ `CustomAuthenticationCredentials` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 2 048 octets.
Informations d’identification utilisées lorsque le type d’authentification est une authentification personnalisée.
## OAuth2Structure des propriétés
Structure contenant les propriétés d' OAuth2 authentification.
**Champs**
+ `OAuth2GrantType` – Chaîne UTF-8 (valeurs valides : `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
Le type de OAuth2 subvention. Par exemple, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` : un objet [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
Type d’application client. Par exemple, AWS\$1MANAGED ou USER\$1MANAGED.
+ `TokenUrl` – chaîne UTF-8, d'une longueur ne dépassant pas 256 octets, correspondant au [Custom string pattern #40](aws-glue-api-common.md#regex_40).
URL du serveur d’authentification du fournisseur, pour échanger un code d’autorisation en vue d’obtenir un jeton d’accès.
+ `TokenUrlParametersMap` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets.
Carte des paramètres ajoutés à la demande de jeton `GET`.
## OAuth2PropertiesInput structure
Structure contenant les propriétés OAuth2 de la CreateConnection demande.
**Champs**
+ `OAuth2GrantType` – Chaîne UTF-8 (valeurs valides : `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
Type de OAuth2 subvention indiqué dans la CreateConnection demande. Par exemple, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` : un objet [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
Type d'application client dans la CreateConnection demande. Par exemple, `AWS_MANAGED` ou `USER_MANAGED`.
+ `TokenUrl` – chaîne UTF-8, d'une longueur ne dépassant pas 256 octets, correspondant au [Custom string pattern #40](aws-glue-api-common.md#regex_40).
URL du serveur d’authentification du fournisseur, pour échanger un code d’autorisation en vue d’obtenir un jeton d’accès.
+ `TokenUrlParametersMap` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets.
Carte des paramètres ajoutés à la demande de jeton `GET`.
+ `AuthorizationCodeProperties` : un objet [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties).
Ensemble de propriétés requis pour le type de OAuth2 `AUTHORIZATION_CODE` subvention.
+ `OAuth2Credentials` : un objet [OAuth2Informations d'identification](#aws-glue-api-catalog-connections-connections-OAuth2Credentials).
Les informations d'identification utilisées lorsque le type d'authentification est OAuth2 l'authentification.
## OAuth2ClientApplication structure
L'application OAuth2 cliente utilisée pour la connexion.
**Champs**
+ `UserManagedClientApplicationClientId` – Chaîne UTF-8, d'une longueur maximale de 2 048 octets, correspondant au [Custom string pattern #37](aws-glue-api-common.md#regex_37).
ClientiD de l'application clientId si c'est le cas. ClientAppType `USER_MANAGED`
+ `AWSManagedClientApplicationReference` – Chaîne UTF-8, d'une longueur maximale de 2 048 octets, correspondant au [Custom string pattern #37](aws-glue-api-common.md#regex_37).
La référence à l'application cliente côté SaaS qui est AWS gérée.
## AuthorizationCodeProperties structure
Ensemble de propriétés requis pour le flux de travail du type de OAuth2 `AUTHORIZATION_CODE` subvention.
**Champs**
+ `AuthorizationCode`— Chaîne UTF-8, d'une longueur d'au moins 1 ou supérieure à 4 096 octets, correspondant au. [Custom string pattern #37](aws-glue-api-common.md#regex_37)
Code d’autorisation à utiliser dans la troisième étape du flux de travail d’autorisation `AUTHORIZATION_CODE`. Il s’agit d’un code à usage unique qui devient invalide une fois échangé contre un jeton d’accès. Il est donc acceptable d’avoir cette valeur comme paramètre de demande.
+ `RedirectUri`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #41](aws-glue-api-common.md#regex_41)
URI de redirection vers lequel l’utilisateur est redirigé par le serveur d’autorisation lors de l’émission d’un code d’autorisation. L’URI est ensuite utilisé lorsque le code d’autorisation est échangé pour obtenir un jeton d’accès.
## BasicAuthenticationCredentials structure
Pour fournir des informations d’authentification de base lorsque vous ne fournissez pas de valeur `SecretArn`.
**Champs**
+ `Username`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #37](aws-glue-api-common.md#regex_37)
Nom d’utilisateur pour se connecter à la source de données.
+ `Password`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #33](aws-glue-api-common.md#regex_33)
Mot de passe pour se connecter à la source de données.
## OAuth2Structure des informations d'identification
Les informations d'identification utilisées lorsque le type d'authentification est OAuth2 l'authentification.
**Champs**
+ `UserManagedClientApplicationClientSecret`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Secret client de l’application client si l’application client est gérée par l’utilisateur.
+ `AccessToken`— Chaîne UTF-8, d'une longueur maximale de 4096 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Le jeton d'accès utilisé lorsque le type d'authentification est OAuth2.
+ `RefreshToken`— Chaîne UTF-8, d'une longueur maximale de 4096 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Le jeton d'actualisation utilisé lorsque le type d'authentification est OAuth2.
+ `JwtToken`— Chaîne UTF-8, d'une longueur maximale de 8 000 octets, correspondant au. [Custom string pattern #39](aws-glue-api-common.md#regex_39)
Le jeton Web JSON (JWT) utilisé lorsque le type d'authentification est OAuth2.
## Opérations
+ [CreateConnection action (Python : créer\$1connexion)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection action (Python : supprimer\$1connexion)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection action (Python : get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections action (Python : get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection action (Python : update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection action (Python : test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection action (Python : batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
## CreateConnection action (Python : créer\$1connexion)
Crée une définition de connexion dans le catalogue de données.
Les connexions utilisées pour créer des ressources fédérées nécessitent l’autorisation IAM `glue:PassConnection`.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel créer la connexion. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `ConnectionInput` – *Obligatoire :* un objet [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).
Objet `ConnectionInput` définissant la connexion à créer.
+ `Tags` – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 256 octets.
Les identifications que vous attribuez à la connexion.
**Réponse**
+ `CreateConnectionStatus` – Chaîne UTF-8 (valeurs valides : `READY` \$1 `IN_PROGRESS` \$1 `FAILED`).
Statut de la demande de création de connexion. La demande peut prendre un certain temps pour certains types d'authentification, par exemple lors de la création d'une OAuth connexion avec échange de jetons via VPC.
**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## DeleteConnection action (Python : supprimer\$1connexion)
Supprime une connexion du catalogue de données.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel réside la connexion. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `ConnectionName` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion à supprimer.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
## GetConnection action (Python : get\$1connection)
Extrait une définition de connexion du catalogue de données.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel réside la connexion. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `Name` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la définition de connexion à extraire.
+ `HidePassword` : booléen.
Vous permet de récupérer les métadonnées de connexion sans renvoyer le mot de passe. Par exemple, la AWS Glue console utilise cet indicateur pour récupérer la connexion et n'affiche pas le mot de passe. Définissez ce paramètre lorsque l'appelant n'est peut-être pas autorisé à utiliser la AWS KMS clé pour déchiffrer le mot de passe, mais qu'il est autorisé à accéder au reste des propriétés de connexion.
+ `ApplyOverrideForComputeEnvironment` – Chaîne UTF-8 (valeurs valides : `SPARK` \$1 `ATHENA` \$1 `PYTHON`).
Pour les connexions qui peuvent être utilisées dans plusieurs services, spécifie les propriétés de renvoi pour l’environnement de calcul spécifié.
**Réponse**
+ `Connection` – Un objet [Connexion](#aws-glue-api-catalog-connections-connections-Connection).
Définition de connexion demandée.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## GetConnections action (Python : get\$1connections)
Extrait une liste de définitions de connexion du catalogue de données.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel résident les connexions. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `Filter` – Un objet [GetConnectionsFilter](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter).
Filtre qui contrôle les connexions à renvoyer.
+ `HidePassword` : booléen.
Vous permet de récupérer les métadonnées de connexion sans renvoyer le mot de passe. Par exemple, la AWS Glue console utilise cet indicateur pour récupérer la connexion et n'affiche pas le mot de passe. Définissez ce paramètre lorsque l'appelant n'est peut-être pas autorisé à utiliser la AWS KMS clé pour déchiffrer le mot de passe, mais qu'il est autorisé à accéder au reste des propriétés de connexion.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, s’il s’agit d’un appel de continuation.
+ `MaxResults` – Nombre (entier), compris entre 1 et 1 000.
Nombre maximal de connexions à renvoyer dans une réponse.
**Réponse**
+ `ConnectionList` : un tableau d’objets [Connexion](#aws-glue-api-catalog-connections-connections-Connection).
Liste des définitions de connexion demandées.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, si la liste des connexions renvoyées n'inclut pas la dernière connexion filtrée.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## UpdateConnection action (Python : update\$1connection)
Met à jour une définition de connexion dans le catalogue de données.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel réside la connexion. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `Name` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la définition de connexion à mettre à jour.
+ `ConnectionInput` – *Obligatoire :* un objet [ConnectionInput](#aws-glue-api-catalog-connections-connections-ConnectionInput).
Objet `ConnectionInput` qui redéfinit la connexion en question.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## TestConnection action (Python : test\$1connection)
Teste une connexion à un service pour valider les informations d’identification du service que vous indiquez.
Vous pouvez indiquer un nom de connexion existant ou une `TestConnectionInput` pour tester une entrée de connexion inexistante. Fournir les deux en même temps entraînera une erreur.
Si l’action aboutit, le service renvoie une réponse HTTP 200.
**Demande**
+ `ConnectionName` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Facultatif. Nom de la connexion à tester. Si seul le nom est fourni, l’opération obtiendra la connexion et l’utilisera pour les tests.
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue où réside la connexion.
+ `TestConnectionInput` – Un objet [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput).
Structure utilisée pour spécifier le test d’une connexion à un service.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`
## BatchDeleteConnection action (Python : batch\$1delete\$1connection)
Supprime une liste de définitions de connexion du catalogue de données.
**Demande**
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel résident les connexions. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `ConnectionNameList` – *Obligatoire :* Tableau de chaînes UTF-8, avec 25 chaînes maximum.
Liste des noms des connexions à supprimer.
**Réponse**
+ `Succeeded` – Tableau de chaînes UTF-8.
Liste des noms des définitions de connexion qui ont été supprimées avec succès.
+ `Errors` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Chaque valeur est un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Carte des noms des connexions qui n'ont pas été supprimées avec succès pour les détails d'erreur.
**Erreurs**
+ `InternalServiceException`
+ `OperationTimeoutException`
# API de types de connexion
L'API Connection Type décrit AWS Glue APIs les types de connexion.
## Gestion des connexions APIs
+ [DescribeConnectionType action (Python : describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes action (Python : list\$1connection\$1types)](#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)
## DescribeConnectionType action (Python : describe\$1connection\$1type)
L’API `DescribeConnectionType` fournit des informations complètes sur les options prises en charge pour un type de connexion donné dans AWS Glue.
**Demande**
+ `ConnectionType` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom du type de connexion à décrire.
**Réponse**
+ `ConnectionType` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom du type de connexion.
+ `Description` – Chaîne UTF-8, d’une longueur maximale de 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’interface de données (environnements de calcul) et les opérations de données pris en charge par le connecteur.
+ `ConnectionProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 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 Athena.
+ `PythonConnectionProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 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.
**Erreurs**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## ListConnectionTypes action (Python : list\$1connection\$1types)
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. Les types de connexion répertoriés sont l’ensemble des options prises en charge pour la valeur `ConnectionType` dans l’API `CreateConnection`.
**Demande**
+ `MaxResults` – Nombre (entier), compris entre 1 et 1 000.
Nombre maximal de résultats à renvoyer.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [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` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [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
Brèves informations sur un type de connexion pris en charge renvoyées par l’API `ListConnectionTypes`.
**Champs**
+ `ConnectionType`— Chaîne UTF-8 (valeurs valides : `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 \$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` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `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` `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` `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
Nom du type de connexion.
+ `DisplayName` – Chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Nom lisible par l’utilisateur du type de connexion affiché dans la console AWS Glue .
+ `Vendor` – Chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Nom du fournisseur qui a créé ou qui gère ce type de connexion.
+ `Description` – Chaîne UTF-8, d’une longueur maximale de 1 024 octets.
Description du type de connexion.
+ `Categories` – .
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’interface de données (environnements de calcul) et les opérations de données pris en charge par le connecteur.
+ `LogoUrl` – Chaîne UTF-8.
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
Représente une variante d'un type de connexion dans le catalogue de AWS Glue données. 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` – Chaîne UTF-8, d’une longueur comprise entre 1 et 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` – Chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Nom lisible par l'homme de la variante de type de connexion affichée dans la AWS Glue console.
+ `Description` – Chaîne UTF-8, d’une longueur maximale de 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` – Chaîne UTF-8.
URL du logo associé à une variante du type de connexion.
## types de données
+ [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
Définit la manière dont une validation est effectuée sur une propriété de connexion.
**Champs**
+ `ValidationType` – *Obligatoire :* Chaîne UTF-8 (valeurs valides : `REGEX` \$1 `RANGE`).
Type de validation à effectuer, tel que `REGEX`.
+ `Patterns` – .
Liste des modèles qui s’appliquent à la validation.
+ `Description` – *Obligatoire :* chaîne UTF-8, d’une longueur comprise entre 1 et 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
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 chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).
Carte des paires clé-valeur pour les OAuth2 propriétés. Chaque valeur est un objet `Property`.
+ `BasicAuthenticationProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).
Carte des paires clé-valeur pour les OAuth2 propriétés. Chaque valeur est un objet `Property`.
+ `CustomAuthenticationProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 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
Spécifie les types d’authentification pris en charge renvoyés par l’API `DescribeConnectionType`.
**Champs**
+ `SupportedAuthenticationTypes` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des types d’authentification pris en charge.
+ `SupportedDataOperations` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des opérations de données prises en charge.
+ `SupportedComputeEnvironments` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des environnements de calcul pris en charge.
## Structure de la propriété
Objet qui définit un type de connexion pour un environnement de calcul.
**Champs**
+ `Name`— *Obligatoire :* chaîne UTF-8 d'une longueur d'au moins 1 ou de plus de 128 octets.
Le nom de la propriété.
+ `Description` – *Obligatoire :* Chaîne UTF-8, d’une longueur ne dépassant pas 1 024 octets.
Description de la propriété.
+ `Required` – *obligatoire :* booléen.
Indique si la propriété est obligatoire.
+ `PropertyTypes` – *Obligatoire :* Tableau de chaînes UTF-8.
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` – Tableau de chaînes UTF-8.
Indique les opérations de données applicables à la propriété.
## AllowedValue structure
Objet représentant une valeur autorisée pour une propriété.
**Champs**
+ `Description` – Chaîne UTF-8, d’une longueur maximale de 1 024 octets.
Description de la valeur autorisée.
+ `Value`— *Obligatoire :* chaîne UTF-8 d'une longueur d'au moins 1 ou de plus de 128 octets.
Valeur autorisée pour la propriété.
## ComputeEnvironmentConfiguration structure
Objet contenant la configuration d’un environnement de calcul (tel que Spark, Python ou Athena) renvoyé par l’API `DescribeConnectionType`.
**Champs**
+ `Name`— *Obligatoire :* chaîne UTF-8 d'une longueur d'au moins 1 ou de plus de 128 octets.
Nom de la configuration de l’environnement de calcul.
+ `Description` – *Obligatoire :* Chaîne UTF-8, d’une longueur ne dépassant pas 1 024 octets.
Description de l’environnement de calcul.
+ `ComputeEnvironment` – *Obligatoire :* Chaîne UTF-8 (valeurs valides : `SPARK` \$1 `ATHENA` \$1 `PYTHON`).
Type d'environnement de calcul.
+ `SupportedAuthenticationTypes` – *Obligatoire :* Tableau de chaînes UTF-8.
Types d’authentification pris en charge pour l’environnement de calcul.
+ `ConnectionOptions` – *obligatoire :* tableau de mappage de paires clé-valeur.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 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 chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.
Le nom d’option de connexion est remplacé pour l’environnement de calcul.
+ `ConnectionPropertiesRequiredOverrides`— *Obligatoire :*.
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.
# Métadonnées de connexion et API de prévisualisation
La connexion suivante APIs décrit les opérations permettant de décrire les métadonnées de connexion.
## Types de données
+ [Structure de l’entité](#aws-glue-api-catalog-connections-connections-metadata-Entity)
+ [Structure de champ](#aws-glue-api-catalog-connections-connections-metadata-Field)
## Structure de l’entité
Entité prise en charge par un `ConnectionType` donné.
**Champs**
+ `EntityName` – Chaîne UTF-8.
Le nom de l’entité.
+ `Label` – Chaîne UTF-8.
Étiquette utilisée pour l’entité.
+ `IsParentEntity` : booléen.
Valeur booléenne qui permet de déterminer si des sous-objets peuvent être répertoriés.
+ `Description` – Chaîne UTF-8.
Une description de l’entité.
+ `Category` – Chaîne UTF-8.
Type d’entités présentes dans la réponse. Cette valeur dépend de la connexion source. Par exemple, il s’agit de `SObjects` pour Salesforce et de `databases`, `schemas` ou `tables` pour des sources telles qu’Amazon Redshift.
+ `CustomProperties` –
Carte facultative de clés qui peuvent être renvoyées pour une entité par un connecteur.
## Structure de champ
L’objet `Field` contient des informations sur les différentes propriétés associées à un champ dans le connecteur.
**Champs**
+ `FieldName` – Chaîne UTF-8.
Un identifiant unique du champ.
+ `Label` – Chaîne UTF-8.
Une étiquette lisible pour le champ.
+ `Description` – Chaîne UTF-8.
Une description du champ.
+ `FieldType`— Chaîne UTF-8 (valeurs valides : `INT` \$1 \$1 `SMALLINT` \$1 `BIGINT` \$1 \$1 `FLOAT` \$1 `LONG` \$1 `DATE` \$1 `BOOLEAN` \$1 `MAP` \$1 `ARRAY` \$1 `STRING` \$1 `TIMESTAMP` \$1 \$1 `DECIMAL` \$1 `BYTE` `SHORT` `DOUBLE` \$1`STRUCT`).
Type de données dans le champ.
+ `IsPrimaryKey` : booléen.
Indique si ce champ peut être utilisé comme clé primaire pour l’entité donnée.
+ `IsNullable` : booléen.
Indique si ce champ peut autoriser les valeurs nulles ou non.
+ `IsRetrievable` : booléen.
Indique si ce champ peut être ajouté dans la clause Select de la requête SQL ou s’il peut être extrait ou non.
+ `IsFilterable` : booléen.
Indique si ce champ peut être utilisé dans une clause de filtre (clause `WHERE`) d’une instruction SQL lors de l’interrogation de données.
+ `IsPartitionable` : booléen.
Indique si un champ donné peut être utilisé pour partitionner la requête envoyée à SaaS.
+ `IsCreateable` : booléen.
Indique si ce champ peut être créé dans le cadre d’une écriture de destination.
+ `IsUpdateable` : booléen.
Indique si ce champ peut être mis à jour dans le cadre d’une écriture de destination.
+ `IsUpsertable` : booléen.
Indique si ce champ peut faire l’objet d’un upsert dans le cadre d’une écriture de destination.
+ `IsDefaultOnCreate` : booléen.
Indique si ce champ est automatiquement renseigné lors de la création de l’objet, par exemple s’il est créé au niveau de l’horodatage.
+ `SupportedValues` – .
Liste des valeurs prises en charge pour le champ.
+ `SupportedFilterOperators` – Tableau de chaînes UTF-8.
Indique les opérateurs de filtre de prise en charge pour ce champ.
+ `CustomProperties` –
Carte facultative des clés qui peuvent être renvoyées.
## Opérations
+ [ListEntities action (Python : list\$1entities)](#aws-glue-api-catalog-connections-connections-metadata-ListEntities)
+ [DescribeEntity action (Python : describe\$1entity)](#aws-glue-api-catalog-connections-connections-metadata-DescribeEntity)
+ [GetEntityRecords action (Python : get\$1entity\$1records)](#aws-glue-api-catalog-connections-connections-metadata-GetEntityRecords)
## ListEntities action (Python : list\$1entities)
Renvoie les entités disponibles prises en charge par le type de connexion.
**Demande**
+ `ConnectionName` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion dont les informations d’identification sont requises pour interroger n’importe quel type de connexion.
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue contenant la connexion. Cela peut être nul. Par défaut, l'ID de AWS compte est l'ID du catalogue.
+ `ParentEntityName` – Chaîne UTF-8.
Nom de l’entité parent pour laquelle vous souhaitez répertorier les enfants. Ce paramètre utilise un chemin entièrement qualifié de l’entité afin de répertorier les entités enfant.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
+ `DataStoreApiVersion` – Chaîne UTF-8, d’une longueur comprise entre 1 et 256 octets, correspondant au [Custom string pattern #23](aws-glue-api-common.md#regex_23).
Version d’API du connecteur SaaS.
**Réponse**
+ `Entities` : un tableau d’objets [Entité](#aws-glue-api-catalog-connections-connections-metadata-Entity).
Liste d’objets `Entity`.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Un jeton de continuation, présent si le segment actuel n’est pas le dernier.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## DescribeEntity action (Python : describe\$1entity)
Fournit des détails concernant l’entité utilisée avec le type de connexion, avec une description du modèle de données pour chaque champ de l’entité sélectionnée.
La réponse inclut tous les champs qui constituent l’entité.
**Demande**
+ `ConnectionName` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion qui contient les informations d’identification du type de connexion.
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue contenant la connexion. Cela peut être nul. Par défaut, l'ID de AWS compte est l'ID du catalogue.
+ `EntityName` – *Obligatoire :* chaîne UTF-8.
Nom de l’entité que vous souhaitez décrire à partir du type de connexion.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
+ `DataStoreApiVersion` – Chaîne UTF-8, d’une longueur comprise entre 1 et 256 octets, correspondant au [Custom string pattern #23](aws-glue-api-common.md#regex_23).
Version de l’API utilisée pour l’entrepôt de données.
**Réponse**
+ `Fields` : un tableau d’objets [Champ](#aws-glue-api-catalog-connections-connections-metadata-Field).
Décrit les champs de cette entité de connecteur. Il s’agit de la liste des objets `Field`. `Field` est très similaire à une colonne dans une base de données. L’objet `Field` contient des informations sur les différentes propriétés associées aux champs dans le connecteur.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Un jeton de continuation, présent si le segment actuel n’est pas le dernier.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`
## GetEntityRecords action (Python : get\$1entity\$1records)
Cette API est utilisée pour interroger les données d'aperçu à partir d'un type de connexion donné ou d'un catalogue de AWS Glue données natif basé sur Amazon S3.
Renvoie les enregistrements sous forme de tableau de blobs JSON. Chaque enregistrement est formaté à l'aide de Jackson en JsonNode fonction du type de champ défini par l'`DescribeEntity`API.
Les connecteurs Spark génèrent des schémas selon le même mappage de type de données que dans l’API `DescribeEntity`. Les connecteurs Spark convertissent les données en types de données appropriés correspondant au schéma lors du renvoi de lignes.
**Demande**
+ `ConnectionName` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion qui contient les informations d’identification du type de connexion.
+ `CatalogId` – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue contenant la connexion. Cela peut être nul. Par défaut, l'ID de AWS compte est l'ID du catalogue.
+ `EntityName` – *Obligatoire :* chaîne UTF-8.
Nom de l’entité pour laquelle nous souhaitons interroger les données de prévisualisation à partir du type de connexion donné.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
+ `DataStoreApiVersion` – Chaîne UTF-8, d’une longueur comprise entre 1 et 256 octets, correspondant au [Custom string pattern #23](aws-glue-api-common.md#regex_23).
Version d’API du connecteur SaaS.
+ `ConnectionOptions` – Tableau de mappage de paires clé-valeur, 100 paires au maximum.
Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 256 octets, correspondant au [Custom string pattern #18](aws-glue-api-common.md#regex_18).
Chaque valeur est une chaîne UTF-8, d’une longueur comprise entre 1 et 256 octets, correspondant au [Custom string pattern #17](aws-glue-api-common.md#regex_17).
Options de connecteur requises pour interroger les données.
+ `FilterPredicate` – Chaîne UTF-8, d’une longueur comprise entre 1 et 100000 octets.
Un prédicat de filtre que vous pouvez appliquer dans la demande de requête.
+ `Limit` – *Obligatoire :* nombre (long), compris entre 1 et 1 000.
Limite le nombre d’enregistrements récupérés avec la demande.
+ `SelectedFields` – Tableau de chaînes UTF-8, avec 1 chaîne minimum et 1 000 chaînes maximum.
Liste des champs que nous souhaitons récupérer dans le cadre des données de prévisualisation.
**Réponse**
+ `Records` : tableau d’une structure.
Liste des objets demandés.
+ `NextToken` – Chaîne UTF-8, d’une longueur comprise entre 1 et 2048 octets, correspondant au [Custom string pattern #11](aws-glue-api-common.md#regex_11).
Un jeton de continuation, présent si le segment actuel n’est pas le dernier.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
+ `ValidationException`
+ `FederationSourceException`
+ `AccessDeniedException`