Raccordement API

• Structure de connexion

• ConnectionInput structure

• PhysicalConnectionRequirements structure

• GetConnectionsFilter structure

Champs

• Name— Chaîne UTF -8, d'une longueur d'au moins 1 ou supérieure à 255 octets, correspondant auSingle-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 VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  Type de connexion. Actuellement, SFTP n'est pas pris en charge.

• MatchCriteria— Un tableau de UTF -8 chaînes, pas plus de 10 chaînes.

  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 | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE).

  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- L'hôte URI : soit le nom de domaine complet (FQDN), soit l'IPv4adresse 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- Le chemin Amazon Simple Storage Service (Amazon S3) du fichier contenant JAR JDBC le pilote à utiliser.

  • JDBC_DRIVER_CLASS_NAME- Le nom de classe du JDBC pilote à utiliser.

  • JDBC_ENGINE- Le nom du JDBC moteur à utiliser.

  • JDBC_ENGINE_VERSION- La version du JDBC moteur à utiliser.

  • CONFIG_FILES - (Réservé pour une utilisation ultérieure.)

  • INSTANCE_ID - ID d'instance à utiliser.

  • JDBC_CONNECTION_URL- Le URL pour se connecter à une source JDBC de données.

  • JDBC_ENFORCE_SSL- Une chaîne booléenne (true, false) spécifiant si le protocole Secure Sockets Layer (SSL) avec correspondance de nom d'hôte est appliqué pour la JDBC connexion 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 DER codé et fourni au format de codage PEM 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 sontSHA256withRSA, SHA384withRSA ouSHA512withRSA. 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 JDBC certificat 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 la base de données Oracle, il est utilisé en tant que. Dans Microsoft SQL Server, il est utilisé en tant quehostNameInCertificate. SSL_SERVER_CERT_DN

  • CONNECTION_URL- Le URL pour se connecter à une (nonJDBC) source de données générale.

  • SECRET_ID - L'ID secret utilisé pour le gestionnaire secret des informations d'identification.

  • CONNECTOR_URL- Le connecteur URL pour une CUSTOM connexion MARKETPLACE ou.

  • CONNECTOR_TYPE- Le type de connecteur pour une CUSTOM connexion MARKETPLACE ou.

  • CONNECTOR_CLASS_NAME- Le nom de classe de connecteur pour une CUSTOM connexion MARKETPLACE or.

  • 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- S'il faut activer ou désactiver SSL sur une connexion Apache Kafka. La valeur par défaut est « true » (vrai).

  • KAFKA_CUSTOM_CERT- L'Amazon S3 URL pour le fichier de certificat CA privé (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 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 SASLmécanismes 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 à l'aide du mécanisme « PLAIN ».

  • ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD- La version cryptée du mot de SASL PLAIN passe Kafka (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 SASL SCRAM passe Kafka (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 plus d'informations, consultez la documentation 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 de Kerberos, telles que l'emplacement du serveur. KDC Pour plus d'informations, consultez la 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.

  • ROLE_ARN- Le 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- Le nom d'un groupe de travail sans serveur Amazon Redshift ou d'un groupe de travail Amazon Athena dans lequel les requêtes seront exécutées.

  • CLUSTER_IDENTIFIER- L'identifiant de cluster d'un cluster Amazon Redshift dans lequel les requêtes seront exécutées.

  • DATABASE- La base de données Amazon Redshift à laquelle vous vous connectez.

• PhysicalConnectionRequirements – Un objet PhysicalConnectionRequirements.

  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 d'au moins 1 ou supérieure à 255 octets, correspondant auSingle-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— UTF -8 chaînes, d'une longueur d'au moins 1 ou supérieure à 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.

Champs

• Name— Obligatoire : UTF -8 chaînes, d'au moins 1 ou plus de 255 octets de long, correspondant auSingle-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 VIEW_VALIDATION_REDSHIFT |VIEW_VALIDATION_ATHENA).

  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 SSL avecJDBC.

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

    • 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 TLS du client avec SSL inKAFKA.

    • 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'authentificationSASL/SCRAM- SHA -512 avecKAFKA.

    • 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 GSSAPI l'authentificationSASL/avecKAFKA.

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

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

  • 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 au sein d'un environnement Amazon Virtual Private Cloud (AmazonVPC).

    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— Un tableau de UTF -8 chaînes, pas plus de 10 chaînes.

  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 | REGION | WORKGROUP_NAME | CLUSTER_IDENTIFIER |DATABASE).

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

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

  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.

Champs

• SubnetId— Chaîne UTF -8, d'une longueur d'au moins 1 ou supérieure à 255 octets, correspondant auSingle-line string pattern.

  ID de sous-réseau utilisé par la connexion.

• SecurityGroupIdList— Un tableau de UTF -8 chaînes, pas plus de 50 chaînes.

  Liste des ID de groupe de sécurité utilisée par la connexion.

• AvailabilityZone— Chaîne UTF -8, d'une longueur d'au moins 1 ou supérieure à 255 octets, correspondant auSingle-line string pattern.

  Connexion de la zone de disponibilité.

Champs

• MatchCriteria— Un tableau de UTF -8 chaînes, pas plus de 10 chaînes.

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

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

• CreateConnection action (Python : créer_connexion)

• DeleteConnection action (Python : supprimer_connexion)

• GetConnection action (Python : get_connection)

• GetConnections action (Python : get_connections)

• UpdateConnection action (Python : update_connection)

• BatchDeleteConnection action (Python : batch_delete_connection)

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

  Chaque valeur est une chaîne de 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 OAuth connexion avec échange de jetonsVPC.

Erreurs

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

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 : UTF -8 chaînes, d'au moins 1 ou plus de 255 octets de long, correspondant auSingle-line string pattern.

  Nom de la connexion à supprimer.

Réponse

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

Erreurs

• EntityNotFoundException

• OperationTimeoutException

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 : UTF -8 chaînes, d'au moins 1 ou plus de 255 octets de long, correspondant auSingle-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

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 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— UTF -8 chaînes.

  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— UTF -8 chaînes.

  Jeton de continuation, si la liste des connexions renvoyées n'inclut pas la dernière connexion filtrée.

Erreurs

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

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 : UTF -8 chaînes, d'au moins 1 ou plus de 255 octets de long, correspondant auSingle-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

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 : un tableau de UTF -8 chaînes, pas plus de 25 chaînes.

  Liste des noms des connexions à supprimer.

Réponse

• Succeeded— Un tableau de UTF -8 chaînes.

  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 d'au moins 1 octet ou supérieure à 255 octets, correspondant auSingle-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

• AuthenticationConfiguration structure

• AuthenticationConfigurationInput structure

• OAuth2Propertiesstructure

• OAuth2PropertiesInputstructure

• OAuth2ClientApplicationstructure

• AuthorizationCodeProperties structure

Champs

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

  Structure contenant la configuration d'authentification.

• SecretArn— Chaîne UTF -8, correspondant auCustom string pattern #11.

  Le gestionnaire secret ARN pour stocker les informations d'identification.

• OAuth2Properties – Un objet OAuth2Properties.

  Les propriétés de l'OAuth2authentification.

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 auCustom string pattern #11.

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

• OAuth2Properties – Un objet OAuth2PropertiesInput.

  Les propriétés d'OAuth2authentification dans la CreateConnection demande.

Champs

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

  Le type de OAuth2 subvention. Par exemple, AUTHORIZATION_CODE, JWT_BEARER ou CLIENT_CREDENTIALS.

• OAuth2ClientApplication – Un objet OAuth2ClientApplication.

  Type d'application client. Par exemple, AWS _ MANAGED ou USER _MANAGED.

• TokenUrl— Chaîne UTF -8, d'une longueur maximale de 256 octets, correspondant auCustom string pattern #12.

  Le serveur URL 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 d'au moins 1 ou d'au plus 128 octets.

  Chaque valeur est une chaîne de UTF -8, d'une longueur d'au moins 1 ou supérieure à 512 octets.

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

Champs

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

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

• OAuth2ClientApplication – Un objet OAuth2ClientApplication.

  Type d'application client dans la CreateConnection demande. Par exemple, AWS_MANAGED ou USER_MANAGED.

• TokenUrl— Chaîne UTF -8, d'une longueur maximale de 256 octets, correspondant auCustom string pattern #12.

  Le serveur URL 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 d'au moins 1 ou d'au plus 128 octets.

  Chaque valeur est une chaîne de UTF -8, d'une longueur d'au moins 1 ou supérieure à 512 octets.

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

• AuthorizationCodeProperties – Un objet AuthorizationCodeProperties.

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

Champs

• UserManagedClientApplicationClientId— Chaîne UTF -8, d'une longueur maximale de 2048 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 2048 octets, correspondant au. Custom string pattern #13

  La référence à l'application cliente côté SaaS qui est AWS gérée.

Champs

• AuthorizationCode— Chaîne UTF -8, d'une longueur d'au moins 1 ou supérieure à 4096 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 auCustom string pattern #14.

  La redirection vers URI laquelle l'utilisateur est redirigé par le serveur d'autorisation lors de l'émission d'un code d'autorisation. Le URI est ensuite utilisé lorsque le code d'autorisation est échangé contre un jeton d'accès.