API de types de connexion - AWS Glue
 —  API de gestion des connexions  —DescribeConnectionType (describe_connection_type)ListConnectionTypes (list_connection_types)ConnectionTypeBriefConnectionTypeVariant —  types de données  —ValidationAuthConfigurationFonctionnalitésPropriétéAllowedValueComputeEnvironmentConfiguration

API de types de connexion

L’API Connection Type décrit les API AWS Glue associées à la description des types de connexion.

API de gestion des connexions

Action DescribeConnectionType (Python : describe_connection_type)

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.

    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.

    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.

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

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

    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.

    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.

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

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

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

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

    Propriétés de connexion propres à l’environnement de calcul Spark.

Erreurs

  • ValidationException

  • InvalidInputException

  • InternalServiceException

Action ListConnectionTypes (Python : list_connection_types)

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.

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

Réponse

  • ConnectionTypes : un tableau d’objets 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.

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

Erreurs

  • InternalServiceException

Structure ConnectionTypeBrief

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 | SFTP | MONGODB | KAFKA | NETWORK | MARKETPLACE | CUSTOM | SALESFORCE | VIEW_VALIDATION_REDSHIFT | VIEW_VALIDATION_ATHENA | GOOGLEADS | GOOGLESHEETS | GOOGLEANALYTICS4 | SERVICENOW | MARKETO | SAPODATA | ZENDESK | JIRACLOUD | NETSUITEERP | HUBSPOT | FACEBOOKADS | INSTAGRAMADS | ZOHOCRM | SALESFORCEPARDOT | SALESFORCEMARKETINGCLOUD | SLACK | STRIPE | INTERCOM | SNAPCHATADS).

    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 – Tableau de chaînes UTF-8.

    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.

    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.

    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.

Structure ConnectionTypeVariant

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

Champs

  • ConnectionTypeVariantName – 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’utilisateur de la variante du type de connexion affichée dans la console AWS Glue.

  • 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

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

    Type de validation à effectuer, tel que REGEX.

  • Patterns – Tableau de chaînes UTF-8.

    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.

Structure AuthConfiguration

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

Champs

  • AuthenticationType – Obligatoire : un objet Propriété.

    Type d’autorisation pour une connexion.

  • SecretArn – Un objet Propriété.

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

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

  • BasicAuthenticationProperties – Tableau de mappage de paires valeur-clé.

    Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.

    Chaque valeur est un objet Propriété.

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

  • CustomAuthenticationProperties – Tableau de mappage de paires valeur-clé.

    Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.

    Chaque valeur est un objet Propriété.

    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 comprise entre 1 et 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.

  • DefaultValue – Chaîne UTF-8.

    Valeur par défaut de la propriété.

  • PropertyTypes – Obligatoire : Tableau de chaînes UTF-8.

    Décrit le type de propriété.

  • AllowedValues : un tableau d’objets 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é.

Structure AllowedValue

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 comprise entre 1 et 128 octets.

    Valeur autorisée pour la propriété.

Structure ComputeEnvironmentConfiguration

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 comprise entre 1 et 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 | ATHENA | 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é.

    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 : Tableau de chaînes UTF-8.

    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.