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