API de connexion - AWS Glue
  —  types de données  —ConnexionConnectionInputPhysicalConnectionExigencesGetConnectionsFiltre  —  operations  —CreateConnection (créer_connexion)DeleteConnection (supprimer_connexion)GetConnection (get_connection)GetConnections (get_connections)UpdateConnection (mise à jour de la connexion)BatchDeleteConnection (supprime_connexion par lots) — configuration de l'authentification —AuthenticationConfigurationAuthenticationConfigurationEntréeOAuth2PropertiesOAuth 2 PropertiesInputOAuth 2 ClientApplicationAuthorizationCodePropriétés

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 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

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.

    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.

    Description de la connexion.

  • ConnectionType – Chaîne UTF-8 (valeurs valides : JDBC | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE).

    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 | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL |ROLE_ARN).

    Chaque valeur est une chaîne Valeur, d'une longueur maximale de 1024 octets.

    Ces paires clé-valeur définissent les paramètre pour la connexion :

    • HOST - URI de l'hôte : nom de domaine complet (FQDN) ou adresse IPv4 de l'hôte de 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 (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 casfalse. 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 SHA256withRSA, SHA384withRSA et SHA512withRSA. 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 : SHA256WithRSA, SHA384WithRSA et SHA512WithRSA. 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 le paramètre de AWS Glue cryptage des mots de passe est sélectionné par l'utilisateur).

    • 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 pris en charge.

    • KAFKA_SASL_PLAIN_USERNAME- Un nom d'utilisateur en texte clair utilisé pour s'authentifier avec le mécanisme « PLAIN ».

    • KAFKA_SASL_PLAIN_PASSWORD- Un 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.

    • 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.

    • KAFKA_SASL_GSSAPI_SERVICE - Le nom du service Kerberos, tel que défini avec sasl.kerberos.service.name dans votre Configuration Kafka.

    • KAFKA_SASL_GSSAPI_PRINCIPAL- Le nom du principal Kerberos utilisé par. AWS Glue Pour plus d’informations, consultez Documentation Kafka : configuration des courtiers Kafka.

  • PhysicalConnectionRequirements – Un objet PhysicalConnectionExigences.

    Les exigences de connexion physique, telles que le cloud privé virtuel (VPC) etSecurityGroup, qui sont nécessaires pour établir cette connexion avec succès.

  • CreationTime – Horodatage.

    Horodatage de l'heure à laquelle cette définition de connexion a été créée.

  • LastUpdatedTime – Horodatage.

    Horodatage de la dernière mise à jour de la définition de connexion.

  • LastUpdatedBy – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    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 | IN_PROGRESS | 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 d'au moins 1 ou de plus de 16 384 octets.

    Raison de l'état de la connexion.

  • LastConnectionValidationTime – Horodatage.

    Horodatage de la dernière validation de cette connexion.

  • AuthenticationConfiguration – Un objet AuthenticationConfiguration.

    Les propriétés d'authentification de 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.

    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.

    Description de la connexion.

  • ConnectionType— Obligatoire : chaîne UTF-8 (valeurs valides : JDBC | SFTP | MONGODB | KAFKA | | NETWORK MARKETPLACE CUSTOM |SALESFORCE).

    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).

      JDBCLes 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.

      KAFKALes 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 l'authentification SASL/GSSAPI avec KAFKA.

    • MONGODB - Désigne une connexion à une base de données de documents MongoDB.

      MONGODBLes connexions utilisent les méthodes suivantes ConnectionParameters.

      • Obligatoire : CONNECTION_URL.

      • Obligatoire : toutes les valeurs (USERNAME, PASSWORD) ou SECRET_ID.

    • SALESFORCE- Désigne une connexion à Salesforce à l'aide de l'authentification OAuth.

      • Nécessite que le AuthenticationConfiguration membre soit configuré.

    • NETWORK - Désigne une connexion réseau à une source de données dans un environnement Amazon Virtual Private Cloud (Amazon VPC).

      NETWORKLes 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.

      MARKETPLACELes 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.

    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.

    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.

  • 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 | PORT | USERNAME="USER_NAME" | PASSWORD | ENCRYPTED_PASSWORD | JDBC_DRIVER_JAR_URI | JDBC_DRIVER_CLASS_NAME | JDBC_ENGINE | JDBC_ENGINE_VERSION | CONFIG_FILES INSTANCE_ID | JDBC_CONNECTION_URL | JDBC_ENFORCE_SSL | CUSTOM_JDBC_CERT | SKIP_CUSTOM_JDBC_CERT_VALIDATION | CUSTOM_JDBC_CERT_STRING | CONNECTION_URL | KAFKA_BOOTSTRAP_SERVERS | KAFKA_SSL_ENABLED | KAFKA_CUSTOM_CERT | KAFKA_SKIP_CUSTOM_CERT_VALIDATION | KAFKA_CLIENT_KEYSTORE | KAFKA_CLIENT_KEYSTORE_PASSWORD | KAFKA_CLIENT_KEY_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD | ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD | SECRET_ID | CONNECTOR_URL | CONNECTOR_TYPE | CONNECTOR_CLASS_NAME | KAFKA_SASL_MECHANISM | KAFKA_SASL_PLAIN_USERNAME | KAFKA_SASL_PLAIN_PASSWORD | ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD KAFKA_SASL_SCRAM_USERNAME KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_SCRAM_SECRETS_ARN | ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD | KAFKA_SASL_GSSAPI_KEYTAB KAFKA_SASL_GSSAPI_KRB5_CONF | KAFKA_SASL_GSSAPI_SERVICE | KAFKA_SASL_GSSAPI_PRINCIPAL |ROLE_ARN).

    Chaque valeur est une chaîne Valeur, d'une longueur maximale de 1024 octets.

    Ces paires clé-valeur définissent les paramètres pour la connexion.

  • PhysicalConnectionRequirements – Un objet PhysicalConnectionExigences.

    Les exigences de connexion physique, telles que le cloud privé virtuel (VPC) etSecurityGroup, qui sont nécessaires pour établir correctement cette connexion.

  • AuthenticationConfiguration – Un objet AuthenticationConfigurationEntrée.

    Les propriétés d'authentification de la connexion. Utilisé pour une connexion Salesforce.

  • ValidateCredentials – Booléen.

    Un drapeau pour valider les informations d'identification lors de la création de la connexion. Utilisé pour une connexion Salesforce. La valeur par défaut est true.

PhysicalConnectionRequirements structure

L'application client OAuth en réponse. GetConnection

Champs

  • SubnetId – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    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.

    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 | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE).

    Type de connexions à renvoyer. Actuellement, SFTP n'est pas pris en charge.

Opérations

CreateConnection action (Python : créer_connexion)

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.

    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.

    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 | IN_PROGRESS | FAILED).

    État 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 connexion OAuth avec échange de jetons via VPC.

Erreurs

  • AlreadyExistsException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

DeleteConnection action (Python : supprimer_connexion)

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.

    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.

    Nom de la connexion à supprimer.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • EntityNotFoundException

  • OperationTimeoutException

GetConnection action (Python : get_connection)

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.

    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.

    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.

Réponse

  • Connection – Un objet Connexion.

    Définition de connexion demandée.

Erreurs

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

GetConnections action (Python : get_connections)

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.

    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 GetConnectionsFiltre.

    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.

    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_connection)

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.

    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.

    Nom de la définition de connexion à mettre à jour.

  • ConnectionInput – Obligatoire : un objet 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

BatchDeleteConnection action (Python : batch_delete_connection)

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.

    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.

    Chaque valeur est un objet 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

Configuration de l'authentification

AuthenticationConfiguration structure

Structure contenant la configuration d'authentification.

Champs

  • AuthenticationType – Chaîne UTF-8 (valeurs valides : BASIC | OAUTH2 | CUSTOM).

    Structure contenant la configuration d'authentification.

  • SecretArn – Chaîne UTF-8, correspondant au Custom string pattern #11.

    L'ARN du gestionnaire secret pour stocker les informations d'identification.

  • OAuth2Properties – Un objet OAuth2Properties.

    Les propriétés de l'authentification OAuth2.

AuthenticationConfigurationInput structure

Structure contenant la configuration d'authentification dans la CreateConnection demande.

Champs

  • AuthenticationType – Chaîne UTF-8 (valeurs valides : BASIC | OAUTH2 | CUSTOM).

    Structure contenant la configuration d'authentification dans la CreateConnection demande.

  • SecretArn – Chaîne UTF-8, correspondant au Custom string pattern #11.

    L'ARN du gestionnaire secret pour stocker les informations d'identification dans la CreateConnection demande.

  • OAuth2Properties – Un objet OAuth 2 PropertiesInput.

    Les propriétés de l'authentification OAuth2 dans la CreateConnection demande.

Structure OAuth2Properties

Structure contenant des propriétés pour l'authentification OAuth2.

Champs

  • OAuth2GrantType – Chaîne UTF-8 (valeurs valides : AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER).

    Type de subvention OAuth2. Par exemple, AUTHORIZATION_CODE, JWT_BEARER ou CLIENT_CREDENTIALS.

  • OAuth2ClientApplication – Un objet OAuth 2 ClientApplication.

    Type d'application client. 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 #12.

    URL du serveur d'authentification du fournisseur, pour échanger un code d'autorisation contre 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 d'au moins 1 octet ou supérieure à 512 octets.

    Carte des paramètres ajoutés à la GET demande de jeton.

Structure OAuth2 PropertiesInput

Structure contenant les propriétés d'OAuth2 dans la CreateConnection demande.

Champs

  • OAuth2GrantType – Chaîne UTF-8 (valeurs valides : AUTHORIZATION_CODE | CLIENT_CREDENTIALS | JWT_BEARER).

    Type de subvention OAuth2 indiqué dans la CreateConnection demande. Par exemple, AUTHORIZATION_CODE, JWT_BEARER ou CLIENT_CREDENTIALS.

  • OAuth2ClientApplication – Un objet OAuth 2 ClientApplication.

    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 #12.

    URL du serveur d'authentification du fournisseur, pour échanger un code d'autorisation contre 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 d'au moins 1 octet ou supérieure à 512 octets.

    Carte des paramètres ajoutés à la GET demande de jeton.

  • AuthorizationCodeProperties – Un objet AuthorizationCodePropriétés.

    Ensemble de propriétés requis pour le type de AUTHORIZATION_CODE subvention OAuth2.

Structure OAuth2 ClientApplication

L'application cliente OAuth2 utilisée pour la connexion.

Champs

  • UserManagedClientApplicationClientId – Chaîne UTF-8, d'une longueur maximale de 2 048 octets, correspondant au Custom string pattern #13.

    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 #13.

    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 de type de AUTHORIZATION_CODE subvention OAuth2.

Champs

  • AuthorizationCode— Chaîne UTF-8, d'une longueur d'au moins 1 ou supérieure à 4 096 octets, correspondant au. Custom string pattern #13

    Code d'autorisation à utiliser dans la troisième étape du processus de AUTHORIZATION_CODE subvention. 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 #14

    L'URI de redirection vers laquelle 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é contre un jeton d'accès.