API des types de connexion

L'API Connection Type décrit AWS Glue APIs la description des types de connexion.

Gestion des connexions APIs

• DescribeConnectionType action (Python : describe_connection_type)

• ListConnectionTypes action (Python : list_connection_types)

• ConnectionTypeBrief structure

DescribeConnectionType action (Python : describe_connection_type)

L'DescribeConnectionTypeAPI 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 1024 octets.

  Description du type de connexion.

• Capabilities – Un objet Fonctionnalités.

  Les types d'authentification, les types d'interface de données (environnements informatiques) 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 informatiques.

• 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 leConnectionInput.ConnectionProperties. ConnectionOptionsdéfinit les paramètres qui peuvent être définis dans un script Spark ETL dans la carte des options de connexion transmise à une trame de données.

• AuthenticationConfiguration – Un objet AuthConfiguration.

  Type d'authentification 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 informatiques 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 du VPC, du sous-réseau et du 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 spécifiques à l'environnement informatique 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 spécifiques à 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 spécifiques à l'environnement informatique Spark.

Erreurs

• ValidationException

• InvalidInputException

• InternalServiceException

ListConnectionTypes action (Python : list_connection_types)

L'ListConnectionTypesAPI 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 ConnectionType valeur dans l'CreateConnectionAPI.

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.

  Liste d'ConnectionTypeBriefobjets 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.

  Un 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'ListConnectionTypesAPI.

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.

• Description— Chaîne UTF-8 d'une longueur maximale de 1024 octets.

  Description du type de connexion.

• Capabilities – Un objet Fonctionnalités.

  Les types d'authentification, les types d'interface de données (environnements informatiques) et les opérations de données pris en charge par le connecteur.

types de données

• Structure de validation

• AuthConfiguration structure

• Structure des capacités

• Structure de la propriété

• AllowedValue structure

• ComputeEnvironmentConfiguration structure

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

  Le type de validation à effectuer, tel queREGEX.

• 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 d'au moins 1 ou de 1 024 octets.

  Description de la validation.

• MaxLength – Nombre (entier).

  Longueur maximale d'une propriété de connexion sous forme de chaîne.

• Maximum – Nombre (entier).

  Valeur maximale lors de la spécification d'un RANGE type de validation.

• Minimum – Nombre (entier).

  Une valeur minimale lors de la spécification d'un RANGE type de validation.

AuthConfiguration structure

Configuration d'authentification pour une connexion renvoyée par l'DescribeConnectionTypeAPI.

Champs

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

  Type d'authentification pour une connexion.

• SecretArn – Un objet Propriété.

  Le nom de ressource Amazon (ARN) pour le 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é.

  Carte des paires clé-valeur pour les OAuth2 propriétés. Chaque valeur est un Property objet.

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

  Carte des paires clé-valeur pour les OAuth2 propriétés. Chaque valeur est un Property objet.

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

  Carte des paires clé-valeur pour les propriétés d'authentification personnalisées. Chaque valeur est un Property objet.

Structure des capacités

Spécifie les types d'authentification pris en charge renvoyés par l'DescribeConnectionTypeAPI.

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

Structure de la propriété

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

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 maximale de 1024 octets.

  Description de la propriété.

• DataType – Obligatoire :Chaîne UTF-8 (valeurs valides : STRING | INTEGER | BOOLEAN | STRING_LIST).

  Type de données de la propriété.

• Required – obligatoire : booléen.

  Indique si la propriété est obligatoire.

• DefaultValue – Chaîne UTF-8.

  La 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'AllowedValueobjets 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 1024 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 informatique (tel que Spark, Python ou Athena) renvoyé par l'DescribeConnectionTypeAPI.

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 maximale de 1024 octets.

  Description de l'environnement informatique.

• ComputeEnvironment – Obligatoire : Chaîne UTF-8 (valeurs valides : SPARK | ATHENA | PYTHON).

  Type d'environnement de calcul.

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

  Les types d'authentification pris en charge pour l'environnement informatique.

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

  Les 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 d'au moins 1 ou de plus de 128 octets.

  Le nom de la 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 d'au moins 1 ou de plus de 128 octets.

  Le nom de l'option de connexion remplace celui de l'environnement informatique.

• 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 PhysicalConnectionProperties elles sont requises pour l'environnement de calcul.