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 des objets du catalogue
L'API des objets du catalogue décrit les types de données et l'API liés à l'utilisation des catalogues dans AWS Glue.
**Topics**
+ [API de catalogues](aws-glue-api-catalog-catalogs.md)
+ [API d'une base de données](aws-glue-api-catalog-databases.md)
+ [API de table](aws-glue-api-catalog-tables.md)
+ [API de partition](aws-glue-api-catalog-partitions.md)
+ [API de connexions](aws-glue-api-catalog-connections.md)
+ [API de fonction définie par l'utilisateur](aws-glue-api-catalog-functions.md)
+ [Importation d'un Athena catalogue dans AWS Glue](aws-glue-api-catalog-migration.md)
# API de catalogues
L'API Catalogs décrit comment créer, supprimer, localiser, mettre à jour et répertorier les catalogues. APIs
## Types de données
+ [Structure du catalogue](#aws-glue-api-catalog-catalogs-Catalog)
+ [CatalogInput structure](#aws-glue-api-catalog-catalogs-CatalogInput)
+ [TargetRedshiftCatalog structure](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog)
+ [CatalogProperties structure](#aws-glue-api-catalog-catalogs-CatalogProperties)
+ [CatalogPropertiesOutput structure](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput)
+ [DataLakeAccessProperties structure](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties)
+ [IcebergOptimizationProperties structure](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties)
+ [DataLakeAccessPropertiesOutput structure](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput)
+ [IcebergOptimizationPropertiesOutput structure](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput)
+ [FederatedCatalog structure](#aws-glue-api-catalog-catalogs-FederatedCatalog)
## Structure du catalogue
L'objet de catalogue représente un regroupement logique de bases de données dans le catalogue de AWS Glue données ou dans une source fédérée. Vous pouvez désormais créer un catalogue fédéré Redshift ou un catalogue contenant des liens de ressources vers des bases de données Redshift d’un autre compte ou d’une autre région.
**Champs**
+ `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).
L’ID du catalogue. Pour autoriser l’accès au catalogue par défaut, ce champ ne doit pas être fourni.
+ `Name` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 64 octets, correspondant au [Custom string pattern #25](aws-glue-api-common.md#regex_25).
Le nom du catalogue. Il ne peut pas être identique à l’identifiant du compte.
+ `ResourceArn` – Chaîne UTF-8.
Amazon Resource Name (ARN) affecté à la ressource du catalogue.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au modèle de chaîne à plusieurs lignes d’adresse URI. Une description du catalogue de données.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Un tableau de mappage de paires clé-valeur qui définissent les paramètres et les propriétés du catalogue.
+ `CreateTime` – Horodatage.
Heure à laquelle le catalogue a été créé.
+ `UpdateTime` – Horodatage.
Heure de dernière mise à jour du catalogue.
+ `TargetRedshiftCatalog` – Un objet [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog).
Objet `TargetRedshiftCatalog` qui décrit un catalogue cible pour la liaison de ressources de la base de données.
+ `FederatedCatalog` – Un objet [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog).
Un `FederatedCatalog` objet qui pointe vers une entité en dehors du catalogue de AWS Glue données.
+ `CatalogProperties` – Un objet [CatalogPropertiesOutput](#aws-glue-api-catalog-catalogs-CatalogPropertiesOutput).
Objet `CatalogProperties` qui spécifie les propriétés d’accès au lac de données et d’autres propriétés personnalisées.
+ `CreateTableDefaultPermissions` : un tableau d’objets [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Tableau d’objets `PrincipalPermissions`. Crée un ensemble d’autorisations par défaut sur la/les table(s) pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.
+ `CreateDatabaseDefaultPermissions` : un tableau d’objets [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Tableau d’objets `PrincipalPermissions`. Crée un ensemble d’autorisations par défaut sur la/les base(s) de données pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.
+ `AllowFullTableExternalDataAccess` – Chaîne UTF-8 (valeurs valides : `True` \$1 `False`).
Permet à des moteurs tiers d'accéder aux données Amazon S3 situées dans des emplacements enregistrés auprès de Lake Formation.
## CatalogInput structure
Structure qui décrit les propriétés du catalogue.
**Champs**
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au modèle de chaîne à plusieurs lignes d’adresse URI. Une description du catalogue de données.
+ `FederatedCatalog` – Un objet [FederatedCatalog](#aws-glue-api-catalog-catalogs-FederatedCatalog).
Un objet `FederatedCatalog`. `FederatedCatalog`Structure qui fait référence à une entité extérieure au catalogue de AWS Glue données, par exemple une base de données Redshift.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Un tableau de mappage de paires clé-valeur qui définissent les paramètres et les propriétés du catalogue.
+ `TargetRedshiftCatalog` – Un objet [TargetRedshiftCatalog](#aws-glue-api-catalog-catalogs-TargetRedshiftCatalog).
Objet `TargetRedshiftCatalog` qui décrit un catalogue cible pour la liaison de ressources.
+ `CatalogProperties` – Un objet [CatalogProperties](#aws-glue-api-catalog-catalogs-CatalogProperties).
Objet `CatalogProperties` qui spécifie les propriétés d’accès au lac de données et d’autres propriétés personnalisées.
+ `CreateTableDefaultPermissions` : un tableau d’objets [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Tableau d’objets `PrincipalPermissions`. Crée un ensemble d’autorisations par défaut sur la/les table(s) pour les principaux. Utilisé par AWS Lake Formation. Il doit généralement être défini explicitement sous forme de liste vide.
+ `CreateDatabaseDefaultPermissions` : un tableau d’objets [PrincipalPermissions](aws-glue-api-catalog-databases.md#aws-glue-api-catalog-databases-PrincipalPermissions).
Tableau d’objets `PrincipalPermissions`. Crée un ensemble d’autorisations par défaut sur la/les base(s) de données pour les principaux. Utilisé par AWS Lake Formation. Il doit généralement être défini explicitement sous forme de liste vide.
+ `AllowFullTableExternalDataAccess` – Chaîne UTF-8 (valeurs valides : `True` \$1 `False`).
Permet à des moteurs tiers d'accéder aux données Amazon S3 situées dans des emplacements enregistrés auprès de Lake Formation.
## TargetRedshiftCatalog structure
Structure qui décrit un catalogue cible pour la liaison de ressources.
**Champs**
+ `CatalogArn` – *Obligatoire :* chaîne UTF-8.
Amazon Resource Name (ARN) de la ressource de catalogue.
## CatalogProperties structure
Structure qui spécifie les propriétés d’accès au lac de données et d’autres propriétés personnalisées.
**Champs**
+ `DataLakeAccessProperties` – Un objet [DataLakeAccessProperties](#aws-glue-api-catalog-catalogs-DataLakeAccessProperties).
`DataLakeAccessProperties`Objet qui spécifie les propriétés permettant de configurer l'accès au lac de données pour la ressource de votre catalogue dans le catalogue de AWS Glue données.
+ `IcebergOptimizationProperties` : un objet [IcebergOptimizationProperties](#aws-glue-api-catalog-catalogs-IcebergOptimizationProperties).
Structure qui spécifie les propriétés d’optimisation de table Iceberg pour le catalogue. Cela inclut la configuration des opérations de compactage, de conservation et de suppression de fichiers orphelins qui peuvent être appliquées aux tables Iceberg de ce catalogue.
+ `CustomProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Propriétés clé-valeur supplémentaires pour le catalogue, telles que les optimisations des statistiques de colonne.
## CatalogPropertiesOutput structure
Attributs de propriété qui incluent les propriétés de configuration pour la ressource du catalogue.
**Champs**
+ `DataLakeAccessProperties` – Un objet [DataLakeAccessPropertiesOutput](#aws-glue-api-catalog-catalogs-DataLakeAccessPropertiesOutput).
`DataLakeAccessProperties`Objet doté de propriétés d'entrée permettant de configurer l'accès au lac de données pour les ressources de votre catalogue dans le catalogue de AWS Glue données.
+ `IcebergOptimizationProperties` : un objet [IcebergOptimizationPropertiesOutput](#aws-glue-api-catalog-catalogs-IcebergOptimizationPropertiesOutput).
Objet `IcebergOptimizationPropertiesOutput` qui spécifie les paramètres d’optimisation des tables Iceberg pour le catalogue, notamment les configurations pour les opérations de compactage, de conservation et de suppression de fichiers orphelins.
+ `CustomProperties` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Propriétés clé-valeur supplémentaires pour le catalogue, telles que les optimisations des statistiques de colonne.
## DataLakeAccessProperties structure
Entrez des propriétés pour configurer l'accès au lac de données pour la ressource de votre catalogue dans le catalogue de AWS Glue données.
**Champs**
+ `DataLakeAccess` : booléen.
Active ou désactive l'accès aux lacs de données pour les applications Apache Spark qui accèdent aux bases de données Amazon Redshift dans le catalogue de données à partir d'un moteur autre que Redshift, tel qu'Amazon Athena, Amazon EMR ou ETL. AWS Glue
+ `DataTransferRole` – Chaîne UTF-8, correspondant au [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Rôle qui sera assumé par le transfert AWS Glue des données into/out du bucket intermédiaire lors d'une requête.
+ `KmsKey` – Chaîne UTF-8.
Clé de chiffrement qui sera utilisée pour le compartiment intermédiaire qui sera créé avec le catalogue.
+ `CatalogType` – 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).
Spécifie un type de catalogue fédéré pour la ressource de catalogue native. Le type `aws:redshift` est actuellement pris en charge.
## IcebergOptimizationProperties structure
Structure qui spécifie les propriétés d’optimisation des tables Iceberg pour le catalogue, y compris les configurations pour les opérations de compactage, de conservation et de suppression de fichiers orphelins.
**Champs**
+ `RoleArn` – Chaîne UTF-8, correspondant au [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Amazon Resource Name (ARN) du rôle IAM qui sera endossé pour effectuer les opérations d’optimisation des tables Iceberg.
+ `Compaction` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de compactage des tables Iceberg, qui optimisent la disposition des fichiers de données afin d’améliorer les performances des requêtes.
+ `Retention` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de conservation des tables Iceberg, qui gèrent le cycle de vie des instantanés de tables afin de contrôler les coûts de stockage.
+ `OrphanFileDeletion` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de suppression de fichiers orphelins Iceberg, qui identifient et suppriment les fichiers qui ne sont plus référencés par les métadonnées de table.
## DataLakeAccessPropertiesOutput structure
Les propriétés de sortie de la configuration d'accès au lac de données pour votre ressource de catalogue dans le catalogue de AWS Glue données.
**Champs**
+ `DataLakeAccess` : booléen.
Active ou désactive l’accès au lac de données pour les applications Apache Spark qui accèdent aux bases de données Amazon Redshift dans le catalogue de données.
+ `DataTransferRole` – Chaîne UTF-8, correspondant au [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Rôle qui sera assumé par le transfert AWS Glue des données into/out du bucket intermédiaire lors d'une requête.
+ `KmsKey` – Chaîne UTF-8.
Clé de chiffrement qui sera utilisée pour le compartiment intermédiaire qui sera créé avec le catalogue.
+ `ManagedWorkgroupName` – 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 du calcul Redshift sans serveur géré qui est créé pour votre ressource de catalogue.
+ `ManagedWorkgroupStatus` – 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).
État du calcul Redshift sans serveur géré.
+ `RedshiftDatabaseName` – 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 ressource de base de données Redshift par défaut dans le calcul géré.
+ `StatusMessage` – 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).
Message qui fournit des informations plus détaillées sur l’état du groupe de travail géré.
+ `CatalogType` – 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).
Spécifie un type de catalogue fédéré pour la ressource de catalogue native. Le type `aws:redshift` est actuellement pris en charge.
## IcebergOptimizationPropertiesOutput structure
Structure qui contient les propriétés de sortie de la configuration d'optimisation des tables Iceberg pour votre ressource de catalogue dans le catalogue de AWS Glue données.
**Champs**
+ `RoleArn` – Chaîne UTF-8, correspondant au [Custom string pattern #53](aws-glue-api-common.md#regex_53).
Amazon Resource Name (ARN) du rôle IAM qui est utilisé pour effectuer les opérations d’optimisation des tables Iceberg.
+ `Compaction` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de compactage des tables Iceberg, qui optimisent la disposition des fichiers de données afin d’améliorer les performances des requêtes.
+ `Retention` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de conservation des tables Iceberg, qui gèrent le cycle de vie des instantanés de tables afin de contrôler les coûts de stockage.
+ `OrphanFileDeletion` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Carte de paires clé-valeur qui spécifient les paramètres de configuration pour les opérations de suppression de fichiers orphelins Iceberg, qui identifient et suppriment les fichiers qui ne sont plus référencés par les métadonnées de table.
+ `LastUpdatedTime` – Horodatage.
Horodatage de la dernière mise à jour des propriétés d’optimisation Iceberg.
## FederatedCatalog structure
Catalogue qui pointe vers une entité extérieure au catalogue AWS Glue de données.
**Champs**
+ `Identifier` – Chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Identifiant unique pour le catalogue fédéré.
+ `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 à une source de données externe, par exemple un catalogue fédéré par Redshift.
+ `ConnectionType` – 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).
Type de connexion utilisé pour accéder au catalogue fédéré, spécifiant le protocole ou la méthode de connexion à la source de données externe.
## Opérations
+ [CreateCatalog action (Python : create\$1catalog)](#aws-glue-api-catalog-catalogs-CreateCatalog)
+ [UpdateCatalog action (Python : update\$1catalog)](#aws-glue-api-catalog-catalogs-UpdateCatalog)
+ [DeleteCatalog action (Python : supprimer\$1catalogue)](#aws-glue-api-catalog-catalogs-DeleteCatalog)
+ [GetCatalog action (Python : get\$1catalog)](#aws-glue-api-catalog-catalogs-GetCatalog)
+ [GetCatalogs action (Python : get\$1catalogs)](#aws-glue-api-catalog-catalogs-GetCatalogs)
## CreateCatalog action (Python : create\$1catalog)
Crée un nouveau catalogue dans le catalogue AWS Glue de données.
**Demande**
+ `Name` – *Obligatoire :* Chaîne UTF-8, d’une longueur comprise entre 1 et 64 octets, correspondant au [Custom string pattern #25](aws-glue-api-common.md#regex_25).
Nom du catalogue à créer.
+ `CatalogInput` – *Obligatoire :* un objet [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput).
Objet `CatalogInput` qui définit les métadonnées du catalogue.
+ `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.
Tableau de mappage de paires valeur-clé, 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 balises que vous attribuez au catalogue.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
## UpdateCatalog action (Python : update\$1catalog)
Met à jour les propriétés d'un catalogue existant dans le catalogue de AWS Glue données.
**Demande**
+ `CatalogId` – *Obligatoire :* 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).
L’ID du catalogue.
+ `CatalogInput` – *Obligatoire :* un objet [CatalogInput](#aws-glue-api-catalog-catalogs-CatalogInput).
Objet `CatalogInput` spécifiant les nouvelles propriétés d’un catalogue existant.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## DeleteCatalog action (Python : supprimer\$1catalogue)
Supprime le catalogue spécifié du catalogue de AWS Glue données.
Une fois cette opération terminée, vous n'avez plus accès aux bases de données, aux tables (ni à toutes les versions de tables et partitions susceptibles d'appartenir aux tables) ni aux fonctions définies par l'utilisateur dans le catalogue supprimé. AWS Glue supprime ces ressources « orphelines » de manière asynchrone en temps opportun, à la discrétion du service.
Pour garantir la suppression immédiate de toutes les ressources connexes, avant d’appeler l’opération `DeleteCatalog`, utilisez `DeleteTableVersion` (ou `BatchDeleteTableVersion`), `DeletePartition` (ou `BatchDeletePartition`), `DeleteTable` (ou `BatchDeleteTable`) `DeleteUserDefinedFunction` et `DeleteDatabase` pour supprimer les ressources appartenant au catalogue.
**Demande**
+ `CatalogId` – *Obligatoire :* 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).
L’ID du catalogue.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `AccessDeniedException`
+ `FederationSourceException`
## GetCatalog action (Python : get\$1catalog)
Nom du catalogue à extraire. Il doit être entièrement en minuscules.
**Demande**
+ `CatalogId` – *Obligatoire :* 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 parent dans lequel réside le catalogue. Si aucun numéro n'est fourni, le numéro de AWS compte est utilisé par défaut.
**Réponse**
+ `Catalog` – Un objet [Catalogue](#aws-glue-api-catalog-catalogs-Catalog).
Un objet `Catalog`. Définition du catalogue spécifié dans le catalogue de AWS Glue données.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetCatalogs action (Python : get\$1catalogs)
Récupère tous les catalogues définis dans un catalogue dans le catalogue de données AWS Glue . Pour un cas d’utilisation de catalogue fédéré par Redshift, cette opération renvoie la liste des catalogues mappés aux bases de données Redshift dans le catalogue d’espace de noms Redshift.
**Demande**
+ `ParentCatalogId` – 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 parent dans lequel réside le catalogue. Si aucun numéro n'est fourni, le numéro de AWS compte est utilisé par défaut.
+ `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 maximum de catalogues renvoyés par réponse.
+ `Recursive` : booléen.
Indique s’il faut répertorier tous les catalogues de la hiérarchie des catalogues, en commençant par la valeur `ParentCatalogId`. La valeur par défaut est `false` . Lorsque `true`, tous les objets du catalogue de la hiérarchie `ParentCatalogID` sont énumérés dans la réponse.
+ `IncludeRoot` : booléen.
Indique s’il faut répertorier le catalogue par défaut dans le compte et la région dans la réponse. La valeur par défaut est `false` . Quand `true` et `ParentCatalogId = NULL | AWS Account ID`, tous les catalogues et le catalogue par défaut sont énumérés dans la réponse.
Lorsque la valeur `ParentCatalogId` n’est pas égal à null et que cet attribut est transmis en tant que `false` ou `true`, une `InvalidInputException` est émise.
**Réponse**
+ `CatalogList` – *Obligatoire :* un tableau d’objets [Catalogue](#aws-glue-api-catalog-catalogs-Catalog).
Tableau d’objets `Catalog`. Liste d’objets `Catalog` à partir du catalogue parent spécifié.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n’est pas le dernier.
**Erreurs**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# API d'une base de données
L'API de base de données décrit les types de données d'une base de données et comprend l'API permettant de créer, supprimer, localiser, mettre à jour et répertorier des bases de données.
## Types de données
+ [Structure Database](#aws-glue-api-catalog-databases-Database)
+ [DatabaseInput structure](#aws-glue-api-catalog-databases-DatabaseInput)
+ [PrincipalPermissions structure](#aws-glue-api-catalog-databases-PrincipalPermissions)
+ [DataLakePrincipal structure](#aws-glue-api-catalog-databases-DataLakePrincipal)
+ [DatabaseIdentifier structure](#aws-glue-api-catalog-databases-DatabaseIdentifier)
+ [FederatedDatabase structure](#aws-glue-api-catalog-databases-FederatedDatabase)
## Structure Database
L'objet `Database` représente un groupement logique de tables pouvant résider dans un metastore Hive ou un SGBDR.
**Champs**
+ `Name` – *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 base de données. Pour des raisons de compatibilité avec Hive, ce nom est converti en minuscules lors de son stockage.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la base de données.
+ `LocationUri` – Identificateur de ressource uniforme (URI), d'une longueur comprise entre 1 et 1024 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Emplacement de la base de données (par exemple, un chemin HDFS).
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.
+ `CreateTime` – Horodatage.
Heure à laquelle la base de données de métadonnées a été créée dans le catalogue.
+ `CreateTableDefaultPermissions` : un tableau d’objets [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions).
Crée un ensemble d'autorisations par défaut sur le tableau pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.
+ `TargetDatabase` – Un objet [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier).
Structure `DatabaseIdentifier` qui décrit une base de données cible pour la liaison de ressources.
+ `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 de données dans lequel réside la base de données.
+ `FederatedDatabase` – Un objet [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase).
Une structure `FederatedDatabase` qui fait référence à une entité extérieure à AWS Glue Data Catalog.
## DatabaseInput structure
Structure utilisée pour créer ou mettre à jour une base de données.
**Champs**
+ `Name` – *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 base de données. Pour des raisons de compatibilité avec Hive, ce nom est converti en minuscules lors de son stockage.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la base de données.
+ `LocationUri` – Identificateur de ressource uniforme (URI), d'une longueur comprise entre 1 et 1024 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Emplacement de la base de données (par exemple, un chemin HDFS).
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.
Ces paires clé-valeur définissent les paramètres et les propriétés de la base de données.
+ `CreateTableDefaultPermissions` : un tableau d’objets [PrincipalPermissions](#aws-glue-api-catalog-databases-PrincipalPermissions).
Crée un ensemble d'autorisations par défaut sur le tableau pour les principaux. Utilisé par AWS Lake Formation. Non utilisé dans le cours normal des AWS Glue opérations.
+ `TargetDatabase` – Un objet [DatabaseIdentifier](#aws-glue-api-catalog-databases-DatabaseIdentifier).
Structure `DatabaseIdentifier` qui décrit une base de données cible pour la liaison de ressources.
+ `FederatedDatabase` – Un objet [FederatedDatabase](#aws-glue-api-catalog-databases-FederatedDatabase).
Une structure `FederatedDatabase` qui fait référence à une entité extérieure à AWS Glue Data Catalog.
## PrincipalPermissions structure
Autorisations accordées à un principal.
**Champs**
+ `Principal` – Un objet [DataLakePrincipal](#aws-glue-api-catalog-databases-DataLakePrincipal).
Principal à qui les autorisations sont accordées.
+ `Permissions` – Tableau de chaînes UTF-8.
Autorisations accordées au principal.
## DataLakePrincipal structure
Le AWS Lake Formation directeur.
**Champs**
+ `DataLakePrincipalIdentifier` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets.
Un identifiant pour le AWS Lake Formation principal.
## DatabaseIdentifier structure
Structure qui décrit une base de données cible pour la liaison de ressources.
**Champs**
+ `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 de données dans lequel réside la base de données.
+ `DatabaseName` – 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 base de données du catalogue.
+ `Region` – 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).
Région de la base de données cible.
## FederatedDatabase structure
Une base de données qui pointe vers une entité extérieure à AWS Glue Data Catalog.
**Champs**
+ `Identifier` – Chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Un identifiant unique pour la base de données fédérée.
+ `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).
Le nom de la connexion au métastore externe.
+ `ConnectionType` – 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).
Type de connexion utilisé pour accéder à la base de données fédérée, tel que JDBC, ODBC ou d’autres protocoles de connexion pris en charge.
## Opérations
+ [CreateDatabase action (Python : créer\$1base de données)](#aws-glue-api-catalog-databases-CreateDatabase)
+ [UpdateDatabase action (Python : update\$1database)](#aws-glue-api-catalog-databases-UpdateDatabase)
+ [DeleteDatabase action (Python : supprimer\$1base de données)](#aws-glue-api-catalog-databases-DeleteDatabase)
+ [GetDatabase action (Python : get\$1database)](#aws-glue-api-catalog-databases-GetDatabase)
+ [GetDatabases action (Python : get\$1databases)](#aws-glue-api-catalog-databases-GetDatabases)
## CreateDatabase action (Python : créer\$1base de données)
Crée une nouvelle base de données dans un 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel créer la base de données. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseInput` – *Obligatoire :* un objet [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput).
Métadonnées pour la base de données.
+ `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 balises que vous attribuez à la base de données.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederatedResourceAlreadyExistsException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## UpdateDatabase action (Python : update\$1database)
Met à jour une définition de base de données existante dans un 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel réside la base de données de métadonnées. 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la base de données à mettre à jour dans le catalogue. Pour la compatibilité Hive, ce nom est converti en minuscules.
+ `DatabaseInput` – *Obligatoire :* un objet [DatabaseInput](#aws-glue-api-catalog-databases-DatabaseInput).
Objet `DatabaseInput` spécifiant la nouvelle définition de la base de données de métadonnées dans le catalogue.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## DeleteDatabase action (Python : supprimer\$1base de données)
Supprime une base de données spécifiée d'un catalogue de données.
**Note**
Une fois cette opération terminée, vous n'avez plus accès aux tables (ni à toutes les versions de tables et partitions susceptibles d'appartenir aux tables) ni aux fonctions définies par l'utilisateur dans la base de données supprimée. AWS Glue supprime ces ressources « orphelines » de manière asynchrone en temps opportun, à la discrétion du service.
Pour garantir la suppression immédiate de toutes les ressources connexes, avant d'appeler `DeleteDatabase`, utilisez `DeleteTableVersion` ou `BatchDeleteTableVersion`, `DeletePartition` ou `BatchDeletePartition`, `DeleteUserDefinedFunction`, et `DeleteTable` ou `BatchDeleteTable` pour supprimer les ressources appartenant à la base 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel réside la base de données. 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la base de données à supprimer. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetDatabase action (Python : get\$1database)
Extrait la définition d'une base de données spécifiée.
**Demande**
+ `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 de données dans lequel réside la base de données. 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom la base de données à extraire. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
**Réponse**
+ `Database` – Un objet [Base de données](#aws-glue-api-catalog-databases-Database).
Définition de la base de données spécifiée dans le catalogue de données.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetDatabases action (Python : get\$1databases)
Extrait toutes les bases de données définies dans un catalogue de données donnée.
**Demande**
+ `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 de données à partir duquel extraire `Databases`. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, s’il s’agit d’un appel de continuation.
+ `MaxResults` – Nombre (entier), compris entre 1 et 100.
Nombre maximum de bases de données renvoyées par réponse.
+ `ResourceShareType` – Chaîne UTF-8 (valeurs valides : `FOREIGN` \$1 `ALL` \$1 `FEDERATED`).
Permet de spécifier que vous souhaitez répertorier les bases de données partagées avec votre compte. Les valeurs autorisées sont `FEDERATED`, `FOREIGN` ou `ALL`.
+ Si la valeur est définie sur `FEDERATED`, la liste des bases de données fédérées (référençant une entité externe) partagées avec votre compte sera affichée.
+ Si défini sur `FOREIGN`, répertorie les bases de données partagées avec votre compte.
+ Si défini sur `ALL`, répertorie les bases de données partagées avec votre compte, ainsi que les bases de données dans votre compte local.
+ `AttributesToGet` – Tableau de chaînes UTF-8.
Spécifie les champs de base de données renvoyés par l’appel `GetDatabases`. Ce paramètre n’accepte pas une liste vide. La demande doit inclure le `NAME`.
**Réponse**
+ `DatabaseList` – *Obligatoire :* un tableau d’objets [Base de données](#aws-glue-api-catalog-databases-Database).
Liste d'objets `Database` à partir du catalogue spécifié.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation pour la pagination de la liste des jetons renvoyés, renvoyé si le segment actuel de la liste n’est pas le dernier.
**Erreurs**
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `EntityNotFoundException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
# API de table
L'API de tableau décrit les types de données et les opérations associés aux tableaux.
## Types de données
+ [Structure de table](#aws-glue-api-catalog-tables-Table)
+ [TableInput structure](#aws-glue-api-catalog-tables-TableInput)
+ [FederatedTable structure](#aws-glue-api-catalog-tables-FederatedTable)
+ [Structure de colonne](#aws-glue-api-catalog-tables-Column)
+ [StorageDescriptor structure](#aws-glue-api-catalog-tables-StorageDescriptor)
+ [SchemaReference structure](#aws-glue-api-catalog-tables-SchemaReference)
+ [SerDeInfo structure](#aws-glue-api-catalog-tables-SerDeInfo)
+ [Structure de tri](#aws-glue-api-catalog-tables-Order)
+ [SkewedInfo structure](#aws-glue-api-catalog-tables-SkewedInfo)
+ [TableVersion structure](#aws-glue-api-catalog-tables-TableVersion)
+ [TableError structure](#aws-glue-api-catalog-tables-TableError)
+ [TableVersionError structure](#aws-glue-api-catalog-tables-TableVersionError)
+ [SortCriterion structure](#aws-glue-api-catalog-tables-SortCriterion)
+ [TableIdentifier structure](#aws-glue-api-catalog-tables-TableIdentifier)
+ [KeySchemaElement structure](#aws-glue-api-catalog-tables-KeySchemaElement)
+ [PartitionIndex structure](#aws-glue-api-catalog-tables-PartitionIndex)
+ [PartitionIndexDescriptor structure](#aws-glue-api-catalog-tables-PartitionIndexDescriptor)
+ [BackfillError structure](#aws-glue-api-catalog-tables-BackfillError)
+ [IcebergInput structure](#aws-glue-api-catalog-tables-IcebergInput)
+ [OpenTableFormatInput structure](#aws-glue-api-catalog-tables-OpenTableFormatInput)
+ [ViewDefinition structure](#aws-glue-api-catalog-tables-ViewDefinition)
+ [ViewDefinitionInput structure](#aws-glue-api-catalog-tables-ViewDefinitionInput)
+ [ViewRepresentation structure](#aws-glue-api-catalog-tables-ViewRepresentation)
+ [ViewRepresentationInput structure](#aws-glue-api-catalog-tables-ViewRepresentationInput)
+ [UpdateOpenTableFormatInput structure](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput)
+ [UpdateIcebergInput structure](#aws-glue-api-catalog-tables-UpdateIcebergInput)
+ [CreateIcebergTableInput structure](#aws-glue-api-catalog-tables-CreateIcebergTableInput)
+ [UpdateIcebergTableInput structure](#aws-glue-api-catalog-tables-UpdateIcebergTableInput)
+ [IcebergSortOrder structure](#aws-glue-api-catalog-tables-IcebergSortOrder)
+ [IcebergSortField structure](#aws-glue-api-catalog-tables-IcebergSortField)
+ [IcebergPartitionSpec structure](#aws-glue-api-catalog-tables-IcebergPartitionSpec)
+ [IcebergPartitionField structure](#aws-glue-api-catalog-tables-IcebergPartitionField)
+ [IcebergSchema structure](#aws-glue-api-catalog-tables-IcebergSchema)
+ [IcebergStructField structure](#aws-glue-api-catalog-tables-IcebergStructField)
+ [IcebergTableUpdate structure](#aws-glue-api-catalog-tables-IcebergTableUpdate)
+ [AuditContext structure](#aws-glue-api-catalog-tables-AuditContext)
## Structure de table
Représente un ensemble de données connexes organisées en colonnes et en lignes.
**Champs**
+ `Name` – *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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `DatabaseName` – 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 base de données où résident les métadonnées de table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la table.
+ `Owner` – 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).
Propriétaire de la table.
+ `CreateTime` – Horodatage.
Date de création de la définition de table dans le catalogue de données.
+ `UpdateTime` – Horodatage.
Date de la dernière mise à jour de la table.
+ `LastAccessTime` – Horodatage.
Date du dernier accès à la table. Cette information est généralement extraite de HDFS et peut ne pas être fiable.
+ `LastAnalyzedTime` – Horodatage.
Dernière date de calcul des statistiques de colonne pour cette table.
+ `Retention` – Nombre (entier), pas plus qu'Aucun.
Durée de conservation de la table.
+ `StorageDescriptor` – Un Objet [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor).
Descripteur de stockage contenant des informations sur le stockage physique de la table.
+ `PartitionKeys` : un tableau d’objets [Colonne](#aws-glue-api-catalog-tables-Column).
Liste de colonnes par laquelle la table est partitionnée. Seuls les types primitifs sont pris en charge en tant que clés de partition.
Lorsque vous créez un tableau utilisé par Amazon Athena et que vous ne spécifiez pas de `partitionKeys`, vous devez au moins régler la valeur de `partitionKeys` à une liste vide. Par exemple :
`"PartitionKeys": []`
+ `ViewOriginalText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Inclus pour la compatibilité avec Apache Hive. Non utilisé dans le cours normal des AWS Glue opérations. Si la table est une`VIRTUAL_VIEW`, une certaine Athena configuration codée en base64.
+ `ViewExpandedText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Inclus pour la compatibilité avec Apache Hive. Non utilisé dans le cours normal des AWS Glue opérations.
+ `TableType` – Chaîne UTF-8, d'une longueur maximale de 255 octets.
Type de cette table. AWS Glue créera des tables avec le `EXTERNAL_TABLE` type. D'autres services, tels que Athena, peuvent créer des tables avec des types de tables supplémentaires.
AWS Glue types de tables associés :
EXTERNAL\$1TABLE
Attribut compatible avec Hive : indique une table non gérée par Hive.
GOVERNED
Utilisé par AWS Lake Formation. Le catalogue AWS Glue de données comprend`GOVERNED`.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les propriétés associées à la table.
+ `CreatedBy` – 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).
Personne ou entité qui a créé la table.
+ `IsRegisteredWithLakeFormation` : booléen.
Indique si la table a été enregistrée auprès de AWS Lake Formation.
+ `TargetTable` – Un objet [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier).
Structure `TableIdentifier` qui décrit une table cible pour la liaison de ressources.
+ `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 de données dans lequel réside la table.
+ `VersionId` – 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).
ID de la version de tableau.
+ `FederatedTable` – Un objet [FederatedTable](#aws-glue-api-catalog-tables-FederatedTable).
Une structure `FederatedTable` qui fait référence à une entité extérieure à AWS Glue Data Catalog.
+ `ViewDefinition` – Un objet [ViewDefinition](#aws-glue-api-catalog-tables-ViewDefinition).
Structure contenant toutes les informations qui définissent la vue, y compris le ou les dialectes de la vue, et la requête.
+ `IsMultiDialectView` : booléen.
Spécifie si la vue prend en charge les dialectes SQL d’un ou de plusieurs différents moteurs de requête et peut donc être lue par ces moteurs.
## TableInput structure
Structure utilisé pour définir une table.
**Champs**
+ `Name` – *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 table. Pour des raisons de compatibilité avec Hive, ce nom est converti en minuscules lors de son stockage.
+ `Description` – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la table.
+ `Owner` – 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).
Propriétaire de la table. Inclus pour la compatibilité avec Apache Hive. Non utilisé dans le cours normal des AWS Glue opérations.
+ `LastAccessTime` – Horodatage.
Date du dernier accès à la table.
+ `LastAnalyzedTime` – Horodatage.
Dernière date de calcul des statistiques de colonne pour cette table.
+ `Retention` – Nombre (entier), pas plus qu'Aucun.
Durée de conservation de la table.
+ `StorageDescriptor` – Un Objet [StorageDescriptor](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-StorageDescriptor).
Descripteur de stockage contenant des informations sur le stockage physique de la table.
+ `PartitionKeys` : un tableau d’objets [Colonne](#aws-glue-api-catalog-tables-Column).
Liste de colonnes par laquelle la table est partitionnée. Seuls les types primitifs sont pris en charge en tant que clés de partition.
Lorsque vous créez un tableau utilisé par Amazon Athena et que vous ne spécifiez pas de `partitionKeys`, vous devez au moins régler la valeur de `partitionKeys` à une liste vide. Par exemple :
`"PartitionKeys": []`
+ `ViewOriginalText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Inclus pour la compatibilité avec Apache Hive. Non utilisé dans le cours normal des AWS Glue opérations. Si la table est une`VIRTUAL_VIEW`, une certaine Athena configuration codée en base64.
+ `ViewExpandedText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Inclus pour la compatibilité avec Apache Hive. Non utilisé dans le cours normal des AWS Glue opérations.
+ `TableType` – Chaîne UTF-8, d'une longueur maximale de 255 octets.
Type de cette table. AWS Glue créera des tables avec le `EXTERNAL_TABLE` type. D'autres services, tels que Athena, peuvent créer des tables avec des types de tables supplémentaires.
AWS Glue types de tables associés :
EXTERNAL\$1TABLE
Attribut compatible avec Hive : indique une table non gérée par Hive.
GOVERNED
Utilisé par AWS Lake Formation. Le catalogue AWS Glue de données comprend`GOVERNED`.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les propriétés associées à la table.
+ `TargetTable` – Un objet [TableIdentifier](#aws-glue-api-catalog-tables-TableIdentifier).
Structure `TableIdentifier` qui décrit une table cible pour la liaison de ressources.
+ `ViewDefinition` – Un objet [ViewDefinitionInput](#aws-glue-api-catalog-tables-ViewDefinitionInput).
Structure contenant toutes les informations qui définissent la vue, y compris le ou les dialectes de la vue, et la requête.
## FederatedTable structure
Une table qui pointe vers une entité extérieure à AWS Glue Data Catalog.
**Champs**
+ `Identifier` – Chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Un identifiant unique pour la table fédérée.
+ `DatabaseIdentifier` – Chaîne UTF-8, d’une longueur comprise entre 1 et 512 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Un identifiant unique pour la base de données fédérée.
+ `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).
Le nom de la connexion au métastore externe.
+ `ConnectionType` – 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).
Type de connexion utilisé pour accéder à la table fédérée, spécifiant le protocole ou la méthode de connexion à la source de données externe.
## Structure de colonne
Colonne d'une `Table`.
**Champs**
+ `Name` – *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).
Le nom de l'`Column`.
+ `Type` – Chaîne UTF-8, d’une longueur maximale de 131 072 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Le type de données de `Column`.
+ `Comment` – Chaîne de commentaire, d’une longueur maximale de 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Commentaire au format de texte libre.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les propriétés associées à la colonne.
## StorageDescriptor structure
Décrit le stockage physique des données de table.
**Champs**
+ `Columns` : un tableau d’objets [Colonne](#aws-glue-api-catalog-tables-Column).
Liste des `Columns` de la table.
+ `Location` – Chaîne de localisation, d'une longueur maximale de 2 056 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Emplacement physique de la table. Par défaut, il prend la forme de l'emplacement de entrepôt, suivie de l'emplacement de la base de données dans l'entrepôt, suivi du nom de la table.
+ `AdditionalLocations` – Tableau de chaînes UTF-8.
Liste des emplacements pointant vers le chemin d'accès où se trouve une table Delta.
+ `InputFormat` – Chaîne de format, d'une longueur maximale de 128 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Format d'entrée : `SequenceFileInputFormat` (binaire) ou `TextInputFormat` ou format personnalisé.
+ `OutputFormat` – Chaîne de format, d'une longueur maximale de 128 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Format de sortie : `SequenceFileOutputFormat` (binaire) ou `IgnoreKeyTextOutputFormat` ou format personnalisé.
+ `Compressed` : booléen.
`True` si les données de la table sont compressées ou `False` si elles ne le sont pas.
+ `NumberOfBuckets` : nombre (entier).
Doit être spécifié si la table contient des colonnes de dimension.
+ `SerdeInfo` – Un objet [SerDeInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SerDeInfo).
Les serialization/deserialization (SerDe) informations.
+ `BucketColumns` – Tableau de chaînes UTF-8.
Liste de colonnes de regroupement de réducteur, de colonnes de clustérisation et de colonnes de mise en compartiment de la table.
+ `SortColumns` : un tableau d’objets [Ordre](#aws-glue-api-catalog-tables-Order).
Liste spécifiant l'ordre de tri de chaque compartiment de la table.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Propriétés fournies par l'utilisateur sous la forme clé-valeur.
+ `SkewedInfo` – Un objet [SkewedInfo](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SkewedInfo).
Informations concernant les valeurs qui apparaissent fréquemment dans une colonne (valeurs asymétriques).
+ `StoredAsSubDirectories` : booléen.
`True` si les données de la table sont stockées dans les sous-répertoires ou `False` dans le cas contraire.
+ `SchemaReference` – Un objet [SchemaReference](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-SchemaReference).
Objet qui fait référence à un schéma stocké dans le registre des AWS Glue schémas.
Lors de la création d'une table, vous pouvez transmettre une liste vide de colonnes pour le schéma et plutôt utiliser une référence de schéma.
## SchemaReference structure
Objet qui fait référence à un schéma stocké dans le registre des AWS Glue schémas.
**Champs**
+ `SchemaId` – Un objet [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId).
Structure qui contient des champs d'identité de schéma. Ceci ou `SchemaVersionId` doit être fourni.
+ `SchemaVersionId` – Obligatoire : chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au [Custom string pattern #45](aws-glue-api-common.md#regex_45).
ID unique affecté à une version du schéma. Ceci ou `SchemaId` doit être fourni.
+ `SchemaVersionNumber` – Nombre (long), compris entre 1 et 100 000.
Numéro de version du schéma.
## SerDeInfo structure
Informations sur un serialization/deserialization programme (SerDe) qui sert d'extracteur et de chargeur.
**Champs**
+ `Name` – 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 du SerDe.
+ `SerializationLibrary` – 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).
Généralement, la classe qui implémente le SerDe. Par exemple : `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètres d'initialisation pour. SerDe
## Structure de tri
Indique l'ordre de tri d'une colonne triée.
**Champs**
+ `Column` – *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).
Le nom de la colonne.
+ `SortOrder` – *Obligatoire :* Nombre (entier), inférieur ou égal à 1.
Indique que la colonne est triée en ordre croissant (`== 1`) ou en ordre décroissant(`==0`).
## SkewedInfo structure
Spécifie les valeurs biaisées d'une table. Les valeurs biaisées sont celles qui se produisent à très haute fréquence.
**Champs**
+ `SkewedColumnNames` – Tableau de chaînes UTF-8.
Liste des noms de colonnes qui contiennent des valeurs biaisées.
+ `SkewedColumnValues` – Tableau de chaînes UTF-8.
Liste des valeurs qui apparaissent si fréquemment qu'elles sont considérées comme biaisées.
+ `SkewedColumnValueLocationMaps` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8.
Chaque valeur est une chaîne UTF-8.
Mappage de valeurs biaisées avec les colonnes qui les contiennent.
## TableVersion structure
Spécifie une version d'une table.
**Champs**
+ `Table` – Un objet [Table](#aws-glue-api-catalog-tables-Table).
Table en question
+ `VersionId` – 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).
Valeur d'ID qui identifie cette version de table. Un `VersionId` est une représentation de chaîne d'un nombre entier. Chaque version est incrémentée par 1.
## TableError structure
Enregistrement d'erreur pour les opérations de table.
**Champs**
+ `TableName` – 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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `ErrorDetail` – Un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Détails relatifs à l'erreur.
## TableVersionError structure
Enregistrement d'erreur pour les opérations de version table.
**Champs**
+ `TableName` – 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 table en question.
+ `VersionId` – 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).
Valeur d'ID de la version en question. Un `VersionID` est une représentation de chaîne d'un nombre entier. Chaque version est incrémentée par 1.
+ `ErrorDetail` – Un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Détails relatifs à l'erreur.
## SortCriterion structure
Spécifie un champ selon lequel trier et un ordre de tri.
**Champs**
+ `FieldName` : chaîne de valeurs, d’une longueur comprise entre 1 et 1 024 octets.
Nom du champ sur lequel trier.
+ `Sort` – Chaîne UTF-8 (valeurs valides : `ASC="ASCENDING"` \$1 `DESC="DESCENDING"`).
Tri croissant ou décroissant.
## TableIdentifier structure
Structure qui décrit une table cible pour la liaison de ressources.
**Champs**
+ `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 de données dans lequel réside la table.
+ `DatabaseName` – 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 base de données du catalogue qui contient la table cible.
+ `Name` – 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 table cible.
+ `Region` – 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).
Région de la table cible.
## KeySchemaElement structure
Une paire de clés de partition composée d'un nom et d'un type.
**Champs**
+ `Name` – *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 d'une clé de partition.
+ `Type` – *Obligatoire :* chaîne UTF-8, d'une longueur comprise entre 1 et 131 072 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Type d'une clé de partition.
## PartitionIndex structure
Structure pour un index de partition.
**Champs**
+ `Keys` – *Obligatoire :* Tableau de chaînes UTF-8, au moins 1 chaîne.
Les clés de l'index de partition.
+ `IndexName` – *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 l'index de partition.
## PartitionIndexDescriptor structure
Descripteur d'un index de partition dans une table.
**Champs**
+ `IndexName` – *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 l'index de partition.
+ `Keys` – *Obligatoire :* Tableau d'objets [KeySchemaElement](#aws-glue-api-catalog-tables-KeySchemaElement), au moins 1 structure.
Liste d'une ou plusieurs clés, sous forme de structures `KeySchemaElement`, pour l'index de partition.
+ `IndexStatus` – *Obligatoire* :Chaîne UTF-8 (valeurs valides : `CREATING` \$1 `ACTIVE` \$1 `DELETING` \$1 `FAILED`).
Statut de l'index de partition.
Les statuts possibles sont les suivants :
+ CRÉATION : l'index est en cours de création. Lorsqu'un index est dans un état CRÉATION, l'index ou sa table ne peut pas être supprimé.
+ ACTIVE : la création de l'index a réussi.
+ ÉCHEC : la création de l'index a échoué.
+ SUPPRESSION : l'index est supprimé de la liste des index.
+ `BackfillErrors` : un tableau d’objets [BackfillError](#aws-glue-api-catalog-tables-BackfillError).
Liste d'erreurs qui peuvent se produire lors de l'enregistrement d'index de partition pour une table existante.
## BackfillError structure
Liste d'erreurs qui peuvent se produire lors de l'enregistrement d'index de partition pour une table existante.
Ces erreurs donnent les détails sur la raison pour laquelle un enregistrement d'index a échoué et fournissent un nombre limité de partitions dans la réponse, de sorte que vous pouvez corriger les partitions défaillantes et essayer d'enregistrer à nouveau l'index. Les erreurs les plus courantes pouvant se produire sont classées comme suit :
+ EncryptedPartitionError: Les partitions sont cryptées.
+ InvalidPartitionTypeDataError: La valeur de la partition ne correspond pas au type de données de cette colonne de partition.
+ MissingPartitionValueError: Les partitions sont cryptées.
+ UnsupportedPartitionCharacterError: Les caractères contenus dans la valeur de partition ne sont pas pris en charge. Par exemple : U\$10000, U\$10001, U\$10002.
+ InternalError: Toute erreur qui n'appartient pas à d'autres codes d'erreur.
**Champs**
+ `Code` – Chaîne UTF-8 (valeurs valides : `ENCRYPTED_PARTITION_ERROR` \$1 `INTERNAL_ERROR` \$1 `INVALID_PARTITION_TYPE_DATA_ERROR` \$1 `MISSING_PARTITION_VALUE_ERROR` \$1 `UNSUPPORTED_PARTITION_CHARACTER_ERROR`).
Code d'erreur correspondant à une erreur survenue lors de l'enregistrement d'index de partition pour une table existante.
+ `Partitions` : un tableau d’objets [PartitionValueList](aws-glue-api-catalog-partitions.md#aws-glue-api-catalog-partitions-PartitionValueList).
Liste d'un nombre limité de partitions dans la réponse.
## IcebergInput structure
Une structure qui définit une table de métadonnées Apache Iceberg à créer dans le catalogue.
**Champs**
+ `MetadataOperation` – *Obligatoire* : Chaîne UTF-8 (valeurs valides : `CREATE`).
Une opération de métadonnées obligatoire. Ne peut être défini que sur `CREATE`.
+ `Version` – 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).
La version de table pour la table Iceberg. La valeur par défaut est 2.
+ `CreateIcebergTableInput` – Un objet [CreateIcebergTableInput](#aws-glue-api-catalog-tables-CreateIcebergTableInput).
Les paramètres de configuration requis pour créer une nouvelle table Iceberg dans le catalogue de AWS Glue données, y compris les propriétés de la table et les spécifications des métadonnées.
## OpenTableFormatInput structure
Une structure représentant un tableau au format ouvert.
**Champs**
+ `IcebergInput` : un objet [IcebergInput](#aws-glue-api-catalog-tables-IcebergInput).
Spécifie une structure `IcebergInput` qui définit une table de métadonnées Apache Iceberg.
## ViewDefinition structure
Structure contenant les détails des représentations.
**Champs**
+ `IsProtected` : booléen.
Vous pouvez définir cet indicateur sur true pour indiquer au moteur de ne pas transférer les opérations fournies par l’utilisateur dans le plan logique de la vue lors de la planification des requêtes. Cependant, le réglage de cet indicateur ne garantit pas que le moteur sera conforme. Reportez-vous à la documentation du moteur pour comprendre les garanties fournies, le cas échéant.
+ `Definer` – chaîne UTF-8, d’une longueur comprise entre 20 et 2048 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Définisseur d’une vue dans SQL.
+ `SubObjects` : tableau de chaînes UTF-8, avec 10 chaînes maximum.
Liste des tables Amazon Resource Names (ARNs).
+ `Representations` – tableau d’objets [ViewRepresentation](#aws-glue-api-catalog-tables-ViewRepresentation), avec 1 structure minimum et 1 000 structures maximum.
Liste de représentations.
## ViewDefinitionInput structure
Structure contenant les détails relatifs à la création ou à la mise à jour d'une AWS Glue vue.
**Champs**
+ `IsProtected` : booléen.
Vous pouvez définir cet indicateur sur true pour indiquer au moteur de ne pas transférer les opérations fournies par l’utilisateur dans le plan logique de la vue lors de la planification des requêtes. Cependant, le réglage de cet indicateur ne garantit pas que le moteur sera conforme. Reportez-vous à la documentation du moteur pour comprendre les garanties fournies, le cas échéant.
+ `Definer` – chaîne UTF-8, d’une longueur comprise entre 20 et 2048 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Définisseur d’une vue dans SQL.
+ `Representations` – Tableau d’objets [ViewRepresentationInput](#aws-glue-api-catalog-tables-ViewRepresentationInput), avec 1 structure minimum et 10 structures maximum.
Liste de structures contenant le dialecte de la vue et la requête qui définit la vue.
+ `SubObjects` : tableau de chaînes UTF-8, avec 10 chaînes maximum.
Liste des tables de base ARNs qui constituent la vue.
## ViewRepresentation structure
Structure contenant le dialecte de la vue et la requête qui définit la vue.
**Champs**
+ `Dialect` – Chaîne UTF-8 (valeurs valides : `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`).
Dialecte du moteur de requête.
+ `DialectVersion` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets.
Version du dialecte du moteur de requête. Par exemple, 3.0.0.
+ `ViewOriginalText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Requête `SELECT` fournie par le client pendant `CREATE VIEW DDL`. Ce code SQL n’est pas utilisé lors d’une requête sur une vue (`ViewExpandedText` est utilisé à la place). `ViewOriginalText` est utilisé dans les cas comme `SHOW CREATE VIEW` où les utilisateurs souhaitent voir la commande DDL d’origine qui a créé la vue.
+ `ViewExpandedText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Code SQL étendu pour la vue. Ce code SQL est utilisé par les moteurs lors du traitement d’une requête sur une vue. Les moteurs peuvent effectuer des opérations lors de la création de la vue pour transformer `ViewOriginalText` en `ViewExpandedText`. Par exemple :
+ Identifiants entièrement qualifiés : `SELECT * from table1 -> SELECT * from db1.table1`
+ `ValidationConnection` – 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 à utiliser pour valider la représentation spécifique de la vue.
+ `IsStale` : booléen.
Les dialectes marqués comme périmés ne sont plus valides et doivent être mis à jour avant de pouvoir être interrogés dans leurs moteurs de requêtes respectifs.
## ViewRepresentationInput structure
Structure contenant les détails d’une représentation pour mettre à jour ou créer une vue Lake Formation.
**Champs**
+ `Dialect` – Chaîne UTF-8 (valeurs valides : `REDSHIFT` \$1 `ATHENA` \$1 `SPARK`).
Paramètre qui indique le type de moteur d’une représentation spécifique.
+ `DialectVersion` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets.
Paramètre qui indique la version du moteur d’une représentation spécifique.
+ `ViewOriginalText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Chaîne qui représente la requête SQL d’origine qui décrit la vue.
+ `ValidationConnection` – 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 à utiliser pour valider la représentation spécifique de la vue.
+ `ViewExpandedText` – Chaîne UTF-8, d’une longueur maximale de 409 600 octets.
Chaîne qui représente la requête SQL qui décrit la vue avec une ressource étendue ARNs
## UpdateOpenTableFormatInput structure
Paramètres d'entrée pour la mise à jour des tables au format de table ouvertes dans AWS Glue Data Catalog, servant de wrapper pour les opérations de mise à jour spécifiques au format, telles qu'Apache Iceberg.
**Champs**
+ `UpdateIcebergInput` : un objet [UpdateIcebergInput](#aws-glue-api-catalog-tables-UpdateIcebergInput).
Paramètres de mise à jour propres à Apache Iceberg qui définissent les modifications de table à appliquer, notamment les modifications de schéma, les spécifications de partition et les propriétés de table.
## UpdateIcebergInput structure
Paramètres d'entrée spécifiques à la mise à jour des tables Apache Iceberg dans le catalogue de AWS Glue données, contenant les opérations de mise à jour à appliquer à une table Iceberg existante.
**Champs**
+ `UpdateIcebergTableInput` – *Obligatoire :* un objet [UpdateIcebergTableInput](#aws-glue-api-catalog-tables-UpdateIcebergTableInput).
Opérations de mise à jour spécifiques à appliquer à la table Iceberg, contenant une liste de mises à jour qui définissent le nouvel état de la table, y compris le schéma, les partitions et les propriétés.
## CreateIcebergTableInput structure
Les paramètres de configuration requis pour créer une nouvelle table Iceberg dans le catalogue de AWS Glue données, y compris les propriétés de la table et les spécifications des métadonnées.
**Champs**
+ `Location` – *Obligatoire :* chaîne de localisation, d’une longueur maximale de 2 056 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
L’emplacement S3 dans lequel les données de la table Iceberg seront stockées.
+ `Schema` – *Obligatoire :* un objet [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema).
Définition du schéma qui spécifie la structure, les types de champs et les métadonnées de la table Iceberg.
+ `PartitionSpec` : un objet [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec).
Spécification de partitionnement qui définit la manière dont les données de la table Iceberg seront organisées et partitionnées pour des performances de requête optimales.
+ `WriteOrder` : un objet [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder).
Spécification de l’ordre de tri qui définit la manière dont les données doivent être ordonnées au sein de chaque partition afin d’optimiser les performances des requêtes.
+ `Properties` –
Paires clé-valeur contenant des propriétés de table supplémentaires et des paramètres de configuration pour la table Iceberg.
## UpdateIcebergTableInput structure
Contient les opérations de mise à jour à appliquer à une table Iceberg existante dans le catalogue de AWS Glue données, définissant le nouvel état des métadonnées de la table.
**Champs**
+ `Updates` – *Obligatoire :* un tableau d’objets [IcebergTableUpdate](#aws-glue-api-catalog-tables-IcebergTableUpdate).
Liste des opérations de mise à jour de la table qui spécifient les modifications à apporter à la table Iceberg, notamment les modifications du schéma, les spécifications de partition et les propriétés de la table.
## IcebergSortOrder structure
Définit la spécification de l’ordre de tri pour une table Iceberg, déterminant comment les données doivent être classées dans les partitions afin d’optimiser les performances des requêtes.
**Champs**
+ `OrderId` – *Obligatoire :* nombre (entier).
Identifiant unique pour cette spécification d’ordre de tri dans les métadonnées de la table Iceberg.
+ `Fields` – *Obligatoire :* un tableau d’objets [IcebergSortField](#aws-glue-api-catalog-tables-IcebergSortField).
La liste des champs et leurs directions de tri qui définissent les critères d’ordre des données de la table Iceberg.
## IcebergSortField structure
Définit un champ unique dans une spécification d’ordre de tri Iceberg, y compris le champ source, la transformation, la direction du tri et l’ordre des valeurs nulles.
**Champs**
+ `SourceId` – *Obligatoire :* nombre (entier).
Identifiant du champ source issu du schéma de table sur lequel ce champ de tri est basé.
+ `Transform` – *Obligatoire :* chaîne UTF-8.
Fonction de transformation appliquée au champ source avant le tri, telle que identity, bucket ou truncate.
+ `Direction` – *Obligatoire :* Chaîne UTF-8 (valeurs valides : `asc="ASC"` \$1 `desc="DESC"`).
La direction du tri pour ce champ, soit croissant, soit décroissant.
+ `NullOrder` – *Obligatoire :* Chaîne UTF-8 (valeurs valides : `nulls-first="NULLS_FIRST"` \$1 `nulls-last="NULLS_LAST"`).
Comportement d’ordre des valeurs nulles dans ce champ, spécifiant si les valeurs nulles doivent apparaître en premier ou en dernier dans l’ordre de tri.
## IcebergPartitionSpec structure
Définit les spécifications de partitionnement d’une table Iceberg, déterminant comment les données de la table seront organisées et partitionnées pour des performances de requête optimales.
**Champs**
+ `Fields` – *Obligatoire :* un tableau d’objets [IcebergPartitionField](#aws-glue-api-catalog-tables-IcebergPartitionField).
Liste des champs de partition qui définissent la manière dont les données de la table doivent être partitionnées, y compris les champs source et leurs transformations.
+ `SpecId` : nombre (entier).
Identifiant unique de cette spécification de partition dans l’historique des métadonnées de la table Iceberg.
## IcebergPartitionField structure
Définit un champ de partition unique dans une spécification de partition Iceberg, y compris le champ source, la fonction de transformation, le nom de la partition et l’identifiant unique.
**Champs**
+ `SourceId` – *Obligatoire :* nombre (entier).
Identifiant du champ source issu du schéma de table sur lequel ce champ de partition est basé.
+ `Transform` – *Obligatoire :* chaîne UTF-8.
Fonction de transformation appliquée au champ source pour créer la partition, telle que identity, bucket, truncate, year, month, day ou hour.
+ `Name` – *Obligatoire :* chaîne UTF-8, d’une longueur comprise entre 1 et 1024 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom du champ de partition tel qu’il apparaîtra dans la structure de la table partitionnée.
+ `FieldId` : nombre (entier).
Identifiant unique attribué à ce champ de partition dans la spécification de partition de la table Iceberg.
## IcebergSchema structure
Définit la structure du schéma d’une table Iceberg, y compris les définitions de champs, les types de données et les métadonnées du schéma.
**Champs**
+ `SchemaId` : nombre (entier).
Identifiant unique de cette version de schéma dans l’historique d’évolution du schéma de la table Iceberg.
+ `IdentifierFieldIds` : un tableau d’entiers 32 bits signés.
Liste des identifiants de champs qui identifient de manière unique les enregistrements de la table, utilisés pour les opérations au niveau des lignes et la déduplication.
+ `Type` – Chaîne UTF-8 (valeurs valides : `struct="STRUCT"`).
Type de racine de la structure du schéma, généralement « struct » pour les schémas de table Iceberg.
+ `Fields` – *Obligatoire :* un tableau d’objets [IcebergStructField](#aws-glue-api-catalog-tables-IcebergStructField).
Liste des définitions de champs qui constituent le schéma de table, y compris les noms, les types et les métadonnées des champs.
## IcebergStructField structure
Définit un champ unique dans un schéma de table Iceberg, y compris son identifiant, son nom, son type de données, son caractère nul et sa documentation.
**Champs**
+ `Id` – *Obligatoire :* nombre (entier).
Identifiant unique attribué à ce champ dans le schéma de table Iceberg, utilisé pour l’évolution du schéma et le suivi des champs.
+ `Name` – *Obligatoire :* chaîne UTF-8, d’une longueur comprise entre 1 et 1024 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom du champ tel qu’il apparaît dans le schéma de table et dans les opérations de requête.
+ `Type`— *Obligatoire :* une structure vide nommée `IcebergDocument`.
Définition du type de données pour ce champ, spécifiant la structure et le format des données qu’il contient.
+ `Required` – *obligatoire :* booléen.
Indique si ce champ est obligatoire (n’autorisant pas les valeurs nulles) ou facultatif (autorisant les valeurs nulles) dans le schéma de table.
+ `Doc` – Chaîne de commentaire, d’une longueur maximale de 255 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Documentation facultative ou texte de description fournissant un contexte supplémentaire sur l’objectif et l’utilisation de ce champ.
## IcebergTableUpdate structure
Définit un ensemble complet de mises à jour à appliquer à une table Iceberg, y compris les modifications de schéma, les modifications de partitionnement, les ajustements d’ordre de tri, les mises à jour de localisation et les modifications de propriétés.
**Champs**
+ `Schema` – *Obligatoire :* un objet [IcebergSchema](#aws-glue-api-catalog-tables-IcebergSchema).
Définition de schéma mise à jour pour la table Iceberg, spécifiant les modifications apportées à la structure des champs, aux types de données ou aux métadonnées du schéma.
+ `PartitionSpec` : un objet [IcebergPartitionSpec](#aws-glue-api-catalog-tables-IcebergPartitionSpec).
Spécification de partitionnement mise à jour qui définit la manière dont les données de la table doivent être réorganisées et partitionnées.
+ `SortOrder` : un objet [IcebergSortOrder](#aws-glue-api-catalog-tables-IcebergSortOrder).
Spécification de l’ordre de tri mise à jour qui définit la manière dont les données doivent être ordonnées au sein des partitions afin d’optimiser les performances des requêtes.
+ `Location` – *Obligatoire :* chaîne de localisation, d’une longueur maximale de 2 056 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
L’emplacement S3 mis à jour dans lequel les données de la table Iceberg seront stockées.
+ `Properties` –
Paires clé-valeur mises à jour des propriétés de table et des paramètres de configuration pour la table Iceberg.
## AuditContext structure
Structure contenant le contexte de l' Lake Formation audit.
**Champs**
+ `AdditionalAuditContext`— Chaîne UTF-8 d'une longueur maximale de 2 048 octets.
Chaîne contenant les informations contextuelles d'audit supplémentaires.
+ `RequestedColumns` – Tableau de chaînes UTF-8.
Les colonnes demandées pour l'audit.
+ `AllColumnsRequested` : booléen.
Toutes les colonnes font l'objet d'une demande d'audit.
## Opérations
+ [CreateTable action (Python : créer\$1table)](#aws-glue-api-catalog-tables-CreateTable)
+ [UpdateTable action (Python : update\$1table)](#aws-glue-api-catalog-tables-UpdateTable)
+ [DeleteTable action (Python : supprimer\$1table)](#aws-glue-api-catalog-tables-DeleteTable)
+ [BatchDeleteTable action (Python : batch\$1delete\$1table)](#aws-glue-api-catalog-tables-BatchDeleteTable)
+ [GetTable action (Python : get\$1table)](#aws-glue-api-catalog-tables-GetTable)
+ [GetTables action (Python : get\$1tables)](#aws-glue-api-catalog-tables-GetTables)
+ [GetTableVersion action (Python : get\$1table\$1version)](#aws-glue-api-catalog-tables-GetTableVersion)
+ [GetTableVersions action (Python : get\$1table\$1versions)](#aws-glue-api-catalog-tables-GetTableVersions)
+ [DeleteTableVersion action (Python : supprimer\$1table\$1version)](#aws-glue-api-catalog-tables-DeleteTableVersion)
+ [BatchDeleteTableVersion action (Python : batch\$1delete\$1table\$1version)](#aws-glue-api-catalog-tables-BatchDeleteTableVersion)
+ [SearchTables action (Python : tables de recherche)](#aws-glue-api-catalog-tables-SearchTables)
+ [GetPartitionIndexes action (Python : get\$1partition\$1indexes)](#aws-glue-api-catalog-tables-GetPartitionIndexes)
+ [CreatePartitionIndex action (Python : create\$1partition\$1index)](#aws-glue-api-catalog-tables-CreatePartitionIndex)
+ [DeletePartitionIndex action (Python : delete\$1partition\$1index)](#aws-glue-api-catalog-tables-DeletePartitionIndex)
+ [GetColumnStatisticsForTable action (Python : get\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-GetColumnStatisticsForTable)
+ [UpdateColumnStatisticsForTable action (Python : update\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-UpdateColumnStatisticsForTable)
+ [DeleteColumnStatisticsForTable action (Python : delete\$1column\$1statistics\$1for\$1table)](#aws-glue-api-catalog-tables-DeleteColumnStatisticsForTable)
## CreateTable action (Python : créer\$1table)
Crée une nouvelle définition de table 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel créer la `Table`. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue dans laquelle créer la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Name` – 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).
Identifiant unique de la table de la base de données spécifiée qui sera créée dans le catalogue de AWS Glue données.
+ `TableInput` – Un objet [TableInput](#aws-glue-api-catalog-tables-TableInput).
Objet `TableInput` qui définit la table de métadonnées à créer dans le catalogue.
+ `PartitionIndexes` – Un tableau d'objets [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex), 3 structures au maximum.
Liste d'index de partition, structures de type `PartitionIndex`, à créer dans la table.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
ID de la transaction.
+ `OpenTableFormatInput` : un objet [OpenTableFormatInput](#aws-glue-api-catalog-tables-OpenTableFormatInput).
Spécifie une structure `OpenTableFormatInput` lors de la création d'un tableau au format ouvert.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## UpdateTable action (Python : update\$1table)
Met à jour une table de métadonnées 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données où réside la table. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Name` – 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).
Identifiant unique de la table de la base de données spécifiée qui sera créée dans le catalogue de AWS Glue données.
+ `TableInput` – Un objet [TableInput](#aws-glue-api-catalog-tables-TableInput).
Objet `TableInput` mis à jour qui définit la table de métadonnées du catalogue.
+ `SkipArchive` : booléen.
Par défaut, `UpdateTable` crée toujours une version archivée de la table avant de la mettre à jour. Toutefois, si `skipArchive` a la valeur true, `UpdateTable` ne crée pas la version archivée.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction auquel le contenu de la table doit être mis à jour.
+ `VersionId` – 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).
L'ID de la version selon laquelle le contenu du tableau doit être mis à jour.
+ `ViewUpdateAction` – Chaîne UTF-8 (valeurs valides : `ADD` \$1 `REPLACE` \$1 `ADD_OR_REPLACE` \$1 `DROP`).
Opération à effectuer lors de la mise à jour de la vue.
+ `Force` : booléen.
Indicateur qui peut être défini sur true pour ignorer les exigences de correspondance entre le descripteur de stockage et le sous-objet.
+ `UpdateOpenTableFormatInput` : un objet [UpdateOpenTableFormatInput](#aws-glue-api-catalog-tables-UpdateOpenTableFormatInput).
Paramètres d'entrée pour la mise à jour des tables au format de table ouvertes dans AWS Glue Data Catalog, servant de wrapper pour les opérations de mise à jour spécifiques au format, telles qu'Apache Iceberg.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
+ `AlreadyExistsException`
## DeleteTable action (Python : supprimer\$1table)
Supprime une définition de table du catalogue de données.
**Note**
Après avoir effectué cette opération, vous n'avez plus accès aux versions et partitions de table appartenant à la table supprimée. AWS Glue supprime ces ressources « orphelines » de manière asynchrone en temps opportun, à la discrétion du service.
Pour garantir la suppression immédiate de toutes les ressources connexes, avant d'appeler `DeleteTable`, utilisez `DeleteTableVersion` ou `BatchDeleteTableVersion`, et `DeletePartition` ou `BatchDeletePartition`, pour supprimer les ressources appartenant à la table.
**Demande**
+ `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 de données où réside la table. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Name` – *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 table à supprimer. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction pour laquelle supprimer le contenu de la table.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `ConcurrentModificationException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchDeleteTable action (Python : batch\$1delete\$1table)
Supprime plusieurs tables à la fois.
**Note**
Après avoir effectué cette opération, vous n'avez plus accès aux versions et partitions de table appartenant à la table supprimée. AWS Glue supprime ces ressources « orphelines » de manière asynchrone en temps opportun, à la discrétion du service.
Pour garantir la suppression immédiate de toutes les ressources connexes, avant d'appeler `BatchDeleteTable`, utilisez `DeleteTableVersion` ou `BatchDeleteTableVersion`, et `DeletePartition` ou `BatchDeletePartition`, pour supprimer les ressources appartenant à la table.
**Demande**
+ `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 de données où réside la table. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les tables à supprimer. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TablesToDelete` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Liste des tables à supprimer.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction pour laquelle supprimer le contenu de la table.
**Réponse**
+ `Errors` : un tableau d’objets [TableError](#aws-glue-api-catalog-tables-TableError).
Liste des erreurs survenues dans la tentative de supprimer les tables spécifiées.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
## GetTable action (Python : get\$1table)
Extrait la définition de `Table` d'un catalogue de données pour une table spécifiée.
**Demande**
+ `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 de données où réside la table. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Name` – *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 table pour laquelle récupérer la définition. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction pour laquelle lire le contenu de la table.
+ `QueryAsOfTime` – Horodatage.
L'Heure à laquelle lire le contenu de la table. S'il n'est pas défini, l'heure de validation de transaction la plus récente sera utilisée. Ne peut pas être spécifié avec `TransactionId`.
+ `AuditContext` : un objet [AuditContext](#aws-glue-api-catalog-tables-AuditContext).
Structure contenant le [contexte de l' Lake Formation audit](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html).
+ `IncludeStatusDetails` : booléen.
Spécifie s'il faut inclure les détails du statut relatifs à une demande de création ou de mise à jour d'une vue du catalogue de AWS Glue données.
**Réponse**
+ `Table` – Un Objet [Table](#aws-glue-api-catalog-tables-Table).
Objet `Table` qui définit la table spécifiée.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetTables action (Python : get\$1tables)
Récupère les définitions de tout ou partie des tables dans une `Database` donnée.
**Demande**
+ `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).
L'ID du catalogue de données où résident les tables. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue dont les tables doivent être affichées. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `Expression` – Chaîne UTF-8, d'une longueur maximale de 2 048 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Modèle d'expression régulière. S'il est présent, seules les tables dont les noms correspondent au modèle sont renvoyées.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
+ `MaxResults` – Nombre (entier), compris entre 1 et 100.
Nombre maximal de tables à renvoyer dans une seule réponse.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction pour laquelle lire le contenu de la table.
+ `QueryAsOfTime` – Horodatage.
L'Heure à laquelle lire le contenu de la table. S'il n'est pas défini, l'heure de validation de transaction la plus récente sera utilisée. Ne peut pas être spécifié avec `TransactionId`.
+ `AuditContext` : un objet [AuditContext](#aws-glue-api-catalog-tables-AuditContext).
Structure contenant le [contexte de l' Lake Formation audit](https://docs.aws.amazon.com/glue/latest/webapi/API_AuditContext.html).
+ `IncludeStatusDetails` : booléen.
Spécifie s'il faut inclure les détails du statut relatifs à une demande de création ou de mise à jour d'une vue du catalogue de AWS Glue données.
+ `AttributesToGet` – Tableau de chaînes UTF-8.
Indique les champs de table renvoyés par l’appel `GetTables`. Ce paramètre n’accepte pas une liste vide. La demande doit inclure `NAME`.
Les combinaisons de valeurs valides sont les suivantes :
+ `NAME` : nom de toutes les tables de la base de données.
+ `NAME`, `TABLE_TYPE` : noms de toutes les tables et des types de table.
**Réponse**
+ `TableList` : un tableau d’objets [Table](#aws-glue-api-catalog-tables-Table).
Liste des objets `Table` demandés.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, présent si le segment de liste actuel n'est pas le dernier.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetTableVersion action (Python : get\$1table\$1version)
Extrait une version spécifiée d'une table.
**Demande**
+ `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).
L'ID du catalogue de données où résident les tables. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TableName` – *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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `VersionId` – 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).
Valeur d'ID de la version de table à récupérer. Un `VersionID` est une représentation de chaîne d'un nombre entier. Chaque version est incrémentée par 1.
**Réponse**
+ `TableVersion` – Un objet [TableVersion](#aws-glue-api-catalog-tables-TableVersion).
Version de table demandée.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## GetTableVersions action (Python : get\$1table\$1versions)
Extrait une liste de chaînes qui identifient les versions disponibles d'une table spécifiée.
**Demande**
+ `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).
L'ID du catalogue de données où résident les tables. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TableName` – *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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, s'il ne s'agit pas du premier appel.
+ `MaxResults` – Nombre (entier), compris entre 1 et 100.
Nombre maximal de versions de table à renvoyer dans une réponse.
**Réponse**
+ `TableVersions` : un tableau d’objets [TableVersion](#aws-glue-api-catalog-tables-TableVersion).
Liste de chaînes qui identifient les versions disponibles de la table spécifiée.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, si la liste des version disponibles n'inclut pas la dernière version.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteTableVersion action (Python : supprimer\$1table\$1version)
Supprime une version spécifiée d'une table.
**Demande**
+ `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).
L'ID du catalogue de données où résident les tables. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TableName` – *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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `VersionId` – *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).
ID de la version de table à supprimer. Un `VersionID` est une représentation de chaîne d'un nombre entier. Chaque version est incrémentée par 1.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchDeleteTableVersion action (Python : batch\$1delete\$1table\$1version)
Supprime un lot spécifié de versions d'une table.
**Demande**
+ `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).
L'ID du catalogue de données où résident les tables. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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).
Base de données du catalogue où se trouve la table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `TableName` – *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 table. Pour la compatibilité Hive, ce nom doit être entièrement en minuscules.
+ `VersionIds` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Liste IDs des versions à supprimer. Un `VersionId` est une représentation de chaîne d'un nombre entier. Chaque version est incrémentée par 1.
**Réponse**
+ `Errors` : un tableau d’objets [TableVersionError](#aws-glue-api-catalog-tables-TableVersionError).
Liste des erreurs survenues lors de la tentative de suppression des versions de table spécifiées.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## SearchTables action (Python : tables de recherche)
Recherche un ensemble de tables en fonction des propriétés figurant dans les métadonnées de table, ainsi que dans la base de données parent. Vous pouvez effectuer une recherche sur des conditions de texte ou de filtre.
Vous pouvez uniquement obtenir les tables auxquelles vous avez accès en fonction des stratégies de sécurité définies dans Lake Formation. Vous avez besoin d'au moins un accès en lecture seule à la table pour qu'elle soit renvoyée. Si vous n'avez pas accès à toutes les colonnes de la table, ces colonnes ne feront pas l'objet d'une recherche lorsque la liste des tables vous sera renvoyée. Si vous avez accès aux colonnes, mais pas aux données des colonnes, ces colonnes et les métadonnées associées pour ces colonnes seront incluses dans la recherche.
**Demande**
+ `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).
Identifiant unique, composé de `account_id`.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
+ `Filters` : un tableau d’objets [PropertyPredicate](aws-glue-api-common.md#aws-glue-api-common-PropertyPredicate).
Liste de paires clé-valeur et comparateur utilisé pour filtrer les résultats de recherche. Renvoie toutes les entités correspondant au prédicat.
Le membre `Comparator` du struct `PropertyPredicate` est utilisé uniquement pour les champs temporels et peut être omis pour d'autres types de champs. En outre, lors de la comparaison de valeurs de chaîne, par exemple lorsque `Key=Name`, un algorithme de correspondance floue (fuzzy match) est utilisé. Le champ `Key` (par exemple, la valeur du champ `Name`) est divisé en jetons sur certains caractères de ponctuation, par exemple -, :, \$1, etc.. Ensuite, chaque jeton est comparé de manière exacte à un membre `Value` de `PropertyPredicate`. Par exemple, si `Key=Name` et `Value=link`, les tables nommées `customer-link` et `xx-link-yy` sont retournés, mais `xxlinkyy` ne l'est pas.
+ `SearchText` : chaîne de valeurs, d’une longueur comprise entre 1 et 1 024 octets.
Chaîne utilisée pour une recherche de texte.
La spécification d'une valeur entre guillemets filtre en fonction d'une correspondance exacte avec cette valeur.
+ `SortCriteria` – Un tableau d'objets [SortCriterion](#aws-glue-api-catalog-tables-SortCriterion), pas plus d'une structure.
Liste de critères de tri des résultats par un nom de champ, dans un ordre croissant ou décroissant.
+ `MaxResults` – Nombre (entier), compris entre 1 et 1 000.
Nombre maximal de tables à renvoyer dans une seule réponse.
+ `ResourceShareType` – Chaîne UTF-8 (valeurs valides : `FOREIGN` \$1 `ALL` \$1 `FEDERATED`).
Permet de spécifier que vous souhaitez rechercher les tables partagées avec votre compte. Les valeurs autorisées sont `FOREIGN` ou `ALL`.
+ Si défini sur `FOREIGN`, effectuera une recherche dans les tables partagées avec votre compte.
+ Si défini sur `ALL`, effectuera une recherche dans les tables partagées avec votre compte, ainsi que les tables dans votre compte local.
+ `IncludeStatusDetails` : booléen.
Spécifie s'il faut inclure les détails du statut relatifs à une demande de création ou de mise à jour d'une vue du catalogue de AWS Glue données.
**Réponse**
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, présent si le segment de liste actuel n'est pas le dernier.
+ `TableList` : un tableau d’objets [Table](#aws-glue-api-catalog-tables-Table).
Liste des objets `Table` demandés. La réponse `SearchTables` renvoie uniquement les tables auxquelles vous avez accès.
**Erreurs**
+ `InternalServiceException`
+ `InvalidInputException`
+ `OperationTimeoutException`
## GetPartitionIndexes action (Python : get\$1partition\$1indexes)
Récupère les index de partition associés à une table.
**Demande**
+ `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 où réside la table.
+ `DatabaseName` – *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).
Spécifie le nom d'une base de données à partir de laquelle vous souhaitez extraire des index de partition.
+ `TableName` – *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).
Spécifie le nom d'une table à partir de laquelle vous souhaitez extraire les index de partition.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, inclus s’il s’agit d’un appel de continuation.
**Réponse**
+ `PartitionIndexDescriptorList` : un tableau d’objets [PartitionIndexDescriptor](#aws-glue-api-catalog-tables-PartitionIndexDescriptor).
Liste des descripteurs d'index.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, présent si le segment de liste actuel n'est pas le dernier.
**Erreurs**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
## CreatePartitionIndex action (Python : create\$1partition\$1index)
Crée un index de partition spécifié dans une table existante.
**Demande**
+ `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 où réside la table.
+ `DatabaseName` – *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).
Spécifie le nom d'une base de données dans laquelle vous souhaitez créer un index de partition.
+ `TableName` – *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).
Spécifie le nom d'une table dans laquelle vous souhaitez créer un index de partition.
+ `PartitionIndex` – *Obligatoire :* un objet [PartitionIndex](#aws-glue-api-catalog-tables-PartitionIndex).
Spécifie une structure `PartitionIndex` pour créer un index de partition dans une table existante.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeletePartitionIndex action (Python : delete\$1partition\$1index)
Supprime un index de partition spécifié d'une table existante.
**Demande**
+ `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 où réside la table.
+ `DatabaseName` – *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).
Spécifie le nom d'une base de données dont vous souhaitez supprimer un index de partition.
+ `TableName` – *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).
Spécifie le nom d'une table dont vous souhaitez supprimer un index de partition.
+ `IndexName` – *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 l'index de partition à supprimer.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `GlueEncryptionException`
## GetColumnStatisticsForTable action (Python : get\$1column\$1statistics\$1for\$1table)
Récupère les statistiques de table des colonnes.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `GetTable`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `ColumnNames` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Une liste des noms de colonnes.
**Réponse**
+ `ColumnStatisticsList` : un tableau d’objets [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics).
Liste des ColumnStatistics.
+ `Errors` : un tableau d’objets [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError).
La liste de ces ColumnStatistics informations n'a pas pu être récupérée.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdateColumnStatisticsForTable action (Python : update\$1column\$1statistics\$1for\$1table)
Crée ou met à jour les statistiques de table des colonnes.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `UpdateTable`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `ColumnStatisticsList` – *Obligatoire :* Un tableau d'objets [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), 25 structures maximum.
Liste des statistiques de la colonne.
**Réponse**
+ `Errors` : un tableau d’objets [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError).
Liste des ColumnStatisticsErrors.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteColumnStatisticsForTable action (Python : delete\$1column\$1statistics\$1for\$1table)
Récupère les statistiques de table des colonnes.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `DeleteTable`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `ColumnName` – *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).
Le nom de la colonne.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# API de partition
L'API de partition décrit les types de données et les opérations qui permettent de travailler avec les partitions.
## Types de données
+ [Structure de partition](#aws-glue-api-catalog-partitions-Partition)
+ [PartitionInput structure](#aws-glue-api-catalog-partitions-PartitionInput)
+ [PartitionSpecWithSharedStorageDescriptor structure](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor)
+ [PartitionListComposingSpec structure](#aws-glue-api-catalog-partitions-PartitionListComposingSpec)
+ [PartitionSpecProxy structure](#aws-glue-api-catalog-partitions-PartitionSpecProxy)
+ [PartitionValueList structure](#aws-glue-api-catalog-partitions-PartitionValueList)
+ [Structure d'un segment](#aws-glue-api-catalog-partitions-Segment)
+ [PartitionError structure](#aws-glue-api-catalog-partitions-PartitionError)
+ [BatchUpdatePartitionFailureEntry structure](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry)
+ [BatchUpdatePartitionRequestEntry structure](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry)
+ [StorageDescriptor structure](#aws-glue-api-catalog-partitions-StorageDescriptor)
+ [SchemaReference structure](#aws-glue-api-catalog-partitions-SchemaReference)
+ [SerDeInfo structure](#aws-glue-api-catalog-partitions-SerDeInfo)
+ [SkewedInfo structure](#aws-glue-api-catalog-partitions-SkewedInfo)
## Structure de partition
Représente une tranche de données d'une table.
**Champs**
+ `Values` – Tableau de chaînes UTF-8.
Valeurs de la partition.
+ `DatabaseName` – 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 base de données du catalogue dans laquelle créer la partition.
+ `TableName` – 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 table de base de données dans laquelle créer la partition.
+ `CreationTime` – Horodatage.
Heure à laquelle la partition a été créée.
+ `LastAccessTime` – Horodatage.
Dernière date d'accès à la partition.
+ `StorageDescriptor` – Un objet [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
Fournit des informations sur l'emplacement physique où la partition est stockée.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètre de partition.
+ `LastAnalyzedTime` – Horodatage.
Dernière heure à laquelle les statistiques de colonne ont été calculées pour cette partition.
+ `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 de données dans lequel réside la partition.
## PartitionInput structure
Structure utilisée pour créer et mettre à jour une partition.
**Champs**
+ `Values` – Tableau de chaînes UTF-8.
Valeurs de la partition. Bien que ce paramètre ne soit pas requis par le SDK, vous devez spécifier ce paramètre pour une entrée valide.
Les valeurs des clés de la nouvelle partition doivent être transmises sous la forme d'un tableau d'objets String qui doivent être classés dans le même ordre que les clés de partition qui apparaissent dans le préfixe Amazon S3. Sinon, les valeurs AWS Glue seront ajoutées aux mauvaises clés.
+ `LastAccessTime` – Horodatage.
Dernière date d'accès à la partition.
+ `StorageDescriptor` – Un objet [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
Fournit des informations sur l'emplacement physique où la partition est stockée.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètre de partition.
+ `LastAnalyzedTime` – Horodatage.
Dernière heure à laquelle les statistiques de colonne ont été calculées pour cette partition.
## PartitionSpecWithSharedStorageDescriptor structure
Spécification de partition pour les partitions qui partagent un emplacement physique.
**Champs**
+ `StorageDescriptor` – Un objet [StorageDescriptor](#aws-glue-api-catalog-partitions-StorageDescriptor).
Informations sur le partage du stockage physique.
+ `Partitions` : un tableau d’objets [Partition](#aws-glue-api-catalog-partitions-Partition).
Liste des partitions qui partagent cet emplacement physique.
## PartitionListComposingSpec structure
Répertorie les partitions connexes.
**Champs**
+ `Partitions` : un tableau d’objets [Partition](#aws-glue-api-catalog-partitions-Partition).
Liste des partitions dans la spécification de composition.
## PartitionSpecProxy structure
Fournit un chemin d'accès racine aux partitions spécifiées.
**Champs**
+ `DatabaseName` – 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).
Base de données du catalogue dans laquelle résident les partitions.
+ `TableName` – 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 table contenant les partitions.
+ `RootPath` – 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).
Chemin d'accès racine du proxy pour l'adressage des partitions.
+ `PartitionSpecWithSharedSD` – Un objet [PartitionSpecWithSharedStorageDescriptor](#aws-glue-api-catalog-partitions-PartitionSpecWithSharedStorageDescriptor).
Spécification des partitions qui partagent le même emplacement de stockage physique.
+ `PartitionListComposingSpec` – Un objet [PartitionListComposingSpec](#aws-glue-api-catalog-partitions-PartitionListComposingSpec).
Spécifie une liste de partitions.
## PartitionValueList structure
Contient une liste de valeurs définissant les partitions.
**Champs**
+ `Values` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste de valeurs.
## Structure d'un segment
Définit une région sans chevauchement des partitions d'une table, ce qui permet l'exécution en parallèle de plusieurs requêtes.
**Champs**
+ `SegmentNumber` – *Obligatoire :* Nombre (entier), pas plus qu'Aucun.
Numéro d'index de base zéro du segment. Par exemple, si le nombre total de segments est 4, les valeurs `SegmentNumber` vont de 0 à 3.
+ `TotalSegments` – *Obligatoire :* Nombre (entier), compris entre 1 et 10.
Nombre total de segments.
## PartitionError structure
Contient les informations sur une erreur de partition.
**Champs**
+ `PartitionValues` – Tableau de chaînes UTF-8.
Valeurs qui définissent la partition.
+ `ErrorDetail` – Un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Détails sur l'erreur de partition.
## BatchUpdatePartitionFailureEntry structure
Contient des informations sur une erreur de partition de mise à jour par lots.
**Champs**
+ `PartitionValueList` – Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Liste des valeurs définissant la partition.
+ `ErrorDetail` – Un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-ErrorDetail).
Détails sur l'erreur de partition de mise à jour par lots.
## BatchUpdatePartitionRequestEntry structure
Structure contenant les valeurs et la structure utilisées pour mettre à jour une partition.
**Champs**
+ `PartitionValueList` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Liste des valeurs définissant la partition.
+ `PartitionInput` – *Obligatoire :* un objet [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
Structure utilisée pour mettre à jour une partition.
## StorageDescriptor structure
Décrit le stockage physique des données de table.
**Champs**
+ `Columns` : un tableau d’objets [Colonne](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Column).
Liste des `Columns` de la table.
+ `Location` – Chaîne de localisation, d'une longueur maximale de 2 056 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Emplacement physique de la table. Par défaut, il prend la forme de l'emplacement de entrepôt, suivie de l'emplacement de la base de données dans l'entrepôt, suivi du nom de la table.
+ `AdditionalLocations` – Tableau de chaînes UTF-8.
Liste des emplacements pointant vers le chemin d'accès où se trouve une table Delta.
+ `InputFormat` – Chaîne de format, d'une longueur maximale de 128 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Format d'entrée : `SequenceFileInputFormat` (binaire) ou `TextInputFormat` ou format personnalisé.
+ `OutputFormat` – Chaîne de format, d'une longueur maximale de 128 octets, correspondant au [Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Format de sortie : `SequenceFileOutputFormat` (binaire) ou `IgnoreKeyTextOutputFormat` ou format personnalisé.
+ `Compressed` : booléen.
`True` si les données de la table sont compressées ou `False` si elles ne le sont pas.
+ `NumberOfBuckets` : nombre (entier).
Doit être spécifié si la table contient des colonnes de dimension.
+ `SerdeInfo` – Un objet [SerDeInfo](#aws-glue-api-catalog-partitions-SerDeInfo).
Les serialization/deserialization (SerDe) informations.
+ `BucketColumns` – Tableau de chaînes UTF-8.
Liste de colonnes de regroupement de réducteur, de colonnes de clustérisation et de colonnes de mise en compartiment de la table.
+ `SortColumns` : un tableau d’objets [Ordre](aws-glue-api-catalog-tables.md#aws-glue-api-catalog-tables-Order).
Liste spécifiant l'ordre de tri de chaque compartiment de la table.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Propriétés fournies par l'utilisateur sous la forme clé-valeur.
+ `SkewedInfo` – Un objet [SkewedInfo](#aws-glue-api-catalog-partitions-SkewedInfo).
Informations concernant les valeurs qui apparaissent fréquemment dans une colonne (valeurs asymétriques).
+ `StoredAsSubDirectories` : booléen.
`True` si les données de la table sont stockées dans les sous-répertoires ou `False` dans le cas contraire.
+ `SchemaReference` – Un objet [SchemaReference](#aws-glue-api-catalog-partitions-SchemaReference).
Objet qui fait référence à un schéma stocké dans le registre des AWS Glue schémas.
Lors de la création d'une table, vous pouvez transmettre une liste vide de colonnes pour le schéma et plutôt utiliser une référence de schéma.
## SchemaReference structure
Objet qui fait référence à un schéma stocké dans le registre des AWS Glue schémas.
**Champs**
+ `SchemaId` – Un objet [SchemaId](aws-glue-api-schema-registry-api.md#aws-glue-api-schema-registry-api-SchemaId).
Structure qui contient des champs d'identité de schéma. Ceci ou `SchemaVersionId` doit être fourni.
+ `SchemaVersionId` – Obligatoire : chaîne UTF-8, d'une longueur exacte de 36 octets, correspondant au [Custom string pattern #45](aws-glue-api-common.md#regex_45).
ID unique affecté à une version du schéma. Ceci ou `SchemaId` doit être fourni.
+ `SchemaVersionNumber` – Nombre (long), compris entre 1 et 100 000.
Numéro de version du schéma.
## SerDeInfo structure
Informations sur un serialization/deserialization programme (SerDe) qui sert d'extracteur et de chargeur.
**Champs**
+ `Name` – 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 du SerDe.
+ `SerializationLibrary` – 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).
Généralement, la classe qui implémente le SerDe. Par exemple : `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe`.
+ `Parameters` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne de clé, 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).
Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 512 000 octets.
Ces paires clé-valeur définissent les paramètres d'initialisation pour. SerDe
## SkewedInfo structure
Spécifie les valeurs biaisées d'une table. Les valeurs biaisées sont celles qui se produisent à très haute fréquence.
**Champs**
+ `SkewedColumnNames` – Tableau de chaînes UTF-8.
Liste des noms de colonnes qui contiennent des valeurs biaisées.
+ `SkewedColumnValues` – Tableau de chaînes UTF-8.
Liste des valeurs qui apparaissent si fréquemment qu'elles sont considérées comme biaisées.
+ `SkewedColumnValueLocationMaps` – Tableau de mappage de paires valeur-clé.
Chaque clé est une chaîne UTF-8.
Chaque valeur est une chaîne UTF-8.
Mappage de valeurs biaisées avec les colonnes qui les contiennent.
## Opérations
+ [CreatePartition action (Python : créer\$1partition)](#aws-glue-api-catalog-partitions-CreatePartition)
+ [BatchCreatePartition action (Python : batch\$1create\$1partition)](#aws-glue-api-catalog-partitions-BatchCreatePartition)
+ [UpdatePartition action (Python : update\$1partition)](#aws-glue-api-catalog-partitions-UpdatePartition)
+ [DeletePartition action (Python : supprimer\$1partition)](#aws-glue-api-catalog-partitions-DeletePartition)
+ [BatchDeletePartition action (Python : batch\$1supprimer\$1partition)](#aws-glue-api-catalog-partitions-BatchDeletePartition)
+ [GetPartition action (Python : get\$1partition)](#aws-glue-api-catalog-partitions-GetPartition)
+ [GetPartitions action (Python : get\$1partitions)](#aws-glue-api-catalog-partitions-GetPartitions)
+ [BatchGetPartition action (Python : batch\$1get\$1partition)](#aws-glue-api-catalog-partitions-BatchGetPartition)
+ [BatchUpdatePartition action (Python : batch\$1update\$1partition)](#aws-glue-api-catalog-partitions-BatchUpdatePartition)
+ [GetColumnStatisticsForPartition action (Python : get\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-GetColumnStatisticsForPartition)
+ [UpdateColumnStatisticsForPartition action (Python : update\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-UpdateColumnStatisticsForPartition)
+ [DeleteColumnStatisticsForPartition action (Python : supprimer\$1column\$1statistics\$1for\$1partition)](#aws-glue-api-catalog-partitions-DeleteColumnStatisticsForPartition)
## CreatePartition action (Python : créer\$1partition)
Crée une partition.
**Demande**
+ `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 de AWS compte du catalogue dans lequel la partition doit être créée.
+ `DatabaseName` – *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 base de données de métadonnées dans laquelle la partition doit être créée.
+ `TableName` – *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 table de métadonnées dans laquelle la partition doit être créée.
+ `PartitionInput` – *Obligatoire :* un objet [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
Structure `PartitionInput`définissant la partition à créer.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## BatchCreatePartition action (Python : batch\$1create\$1partition)
Crée une ou plusieurs partitions dans une opération par lot.
**Demande**
+ `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 dans lequel la partition doit être créée. Actuellement, il devrait s'agir de l'identifiant du AWS compte.
+ `DatabaseName` – *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 base de données de métadonnées dans laquelle la partition doit être créée.
+ `TableName` – *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 table de métadonnées dans laquelle la partition doit être créée.
+ `PartitionInputList` – *Obligatoire :* Un tableau d'objets [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput), 100 structures maximum.
Liste de structures `PartitionInput` qui définissent les partitions à créer.
**Réponse**
+ `Errors` : un tableau d’objets [PartitionError](#aws-glue-api-catalog-partitions-PartitionError).
Erreurs survenues pendant la tentative de création des partitions demandées.
**Erreurs**
+ `InvalidInputException`
+ `AlreadyExistsException`
+ `ResourceNumberLimitExceededException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdatePartition action (Python : update\$1partition)
Met à jour une partition.
**Demande**
+ `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 de données où réside la partition à mettre à jour. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table en question.
+ `TableName` – *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 table où se trouve la partition à mettre à jour.
+ `PartitionValueList` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Liste des valeurs de clé de partition qui définissent la partition à mettre à jour.
+ `PartitionInput` – *Obligatoire :* un objet [PartitionInput](#aws-glue-api-catalog-partitions-PartitionInput).
Nouvel objet de partition où mettre à jour la partition.
Cette propriété `Values` ne peut pas être modifiée. Si vous souhaitez modifier les valeurs de clé de partition d'une partition, supprimez et recréez la partition.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeletePartition action (Python : supprimer\$1partition)
Supprime une partition spécifiée.
**Demande**
+ `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 de données où réside la partition à supprimer. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table en question.
+ `TableName` – *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 table qui contient la partition à supprimer.
+ `PartitionValues` – *Obligatoire :* Tableau de chaînes UTF-8.
Valeurs qui définissent la partition.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## BatchDeletePartition action (Python : batch\$1supprimer\$1partition)
Supprime une ou plusieurs partitions dans une opération par lot.
**Demande**
+ `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 de données où réside la partition à supprimer. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue où se trouve la table en question.
+ `TableName` – *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 table contenant les partitions à supprimer.
+ `PartitionsToDelete` – *Obligatoire :* Un tableau d'objets [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), 25 structures maximum.
Liste de structures `PartitionInput` qui définissent les partitions à supprimer.
**Réponse**
+ `Errors` : un tableau d’objets [PartitionError](#aws-glue-api-catalog-partitions-PartitionError).
Erreurs survenues pendant la tentative de suppression des partitions demandées.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetPartition action (Python : get\$1partition)
Extrait les informations sur une partition spécifiée.
**Demande**
+ `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 de données où réside la partition en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où réside la partition.
+ `TableName` – *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 table des partitions.
+ `PartitionValues` – *Obligatoire :* Tableau de chaînes UTF-8.
Valeurs qui définissent la partition.
**Réponse**
+ `Partition` – Un objet [Partition](#aws-glue-api-catalog-partitions-Partition).
Informations demandées, sous la forme d'un objet `Partition`.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## GetPartitions action (Python : get\$1partitions)
Extrait les informations sur les partitions d'une table.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `Expression` – Chaîne de prédicat, d'une longueur maximale de 2 048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri).
Expression qui filtre les partitions à renvoyer.
L'expression utilise une syntaxe SQL similaire à la clause de filtre `WHERE` SQL. L'analyseur d'instructions SQL [JSQLParser](http://jsqlparser.sourceforge.net/home.php)analyse l'expression.
*Opérateurs* : voici les opérateurs que vous pouvez utiliser dans l'appel d'API `Expression` :
=
Vérifie si les valeurs des deux opérandes sont égales ; si c'est le cas, la condition est vraie.
Exemple : supposons que la « variable a » et la « variable b » sont de 20.
(a = b) n'est pas vrai.
< >
Vérifie si les valeurs des deux opérandes sont égales ; si ce n'est pas le cas, la condition est vraie.
Exemple : (a < > b) est vrai.
>
Vérifie si la valeur de l'opérande gauche est supérieure à la valeur de l'opérande droite ; si c'est le cas, la condition est vraie.
Exemple : (a > b) n'est pas vrai.
<
Vérifie si la valeur de l'opérande gauche est inférieure à la valeur de l'opérande droite ; si c'est le cas, la condition est vraie.
Exemple : (a < b) est vrai.
>=
Vérifie si la valeur de l'opérande gauche est supérieure ou égale à la valeur de l'opérande droite ; si c'est le cas, la condition est vraie.
Exemple : (a >= b) n'est pas vrai.
<=
Vérifie si la valeur de l'opérande gauche est inférieure ou égale à la valeur de l'opérande droite ; si c'est le cas, la condition est vraie.
Exemple : (a <= b) est vrai.
AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
Opérateurs logiques.
*Types de clés de partition prises en charge* : les clés de partition prises en charge sont énoncées ci-dessous.
+ `string`
+ `date`
+ `timestamp`
+ `int`
+ `bigint`
+ `long`
+ `tinyint`
+ `smallint`
+ `decimal`
Si un type non valide est rencontré, une exception est levée.
La liste suivante présente les opérateurs valides sur chaque type. Lorsque vous définissez un crawler, le type `partitionKey` est créé en tant que `STRING`, pour être compatible avec le catalogue de partitions.
*Exemple d'appel d'API* :
**Example**
La table `twitter_partition` comprend trois partitions :
```
year = 2015
year = 2016
year = 2017
```
**Example**
Obtenir la partition `year` équivalant à 2015
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year*=*'2015'"
```
**Example**
Obtenir la partition `year` entre 2016 et 2018 (exclusif)
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>'2016' AND year<'2018'"
```
**Example**
Obtenir la partition `year` entre 2015 et 2018 (inclusif). Les appels d'API suivants sont équivalents :
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year>='2015' AND year<='2018'"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year BETWEEN 2015 AND 2018"
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year IN (2015,2016,2017,2018)"
```
**Example**
Une partition à caractère générique où la sortie d'appel suivante est la partition année = 2017. Une expression régulière n'est pas prise en charge dans `LIKE`.
```
aws glue get-partitions --database-name dbname --table-name twitter_partition
--expression "year LIKE '%7'"
```
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, si ce n'est pas le premier appel pour récupérer ces partitions.
+ `Segment` – Un objet [Segment](#aws-glue-api-catalog-partitions-Segment).
Segment des partitions de la table à analyser dans cette demande.
+ `MaxResults` – Nombre (entier), compris entre 1 et 1 000.
Nombre maximal de partitions à renvoyer dans une seule réponse.
+ `ExcludeColumnSchema` : booléen.
Lorsque la valeur est « true (VRAI) », indique de ne pas renvoyer le schéma de la colonne de partition. Utile lorsque vous êtes intéressé uniquement par d'autres attributs de partition tels que les valeurs de partition ou l'emplacement. En ne renvoyant pas de données en double, cette approche évite le problème d'une grande réponse.
+ `TransactionId` – Chaîne UTF-8, d’une longueur comprise entre 1 et 255 octets, correspondant au [Custom string pattern #44](aws-glue-api-common.md#regex_44).
L'ID de transaction auquel lire le contenu de la partition.
+ `QueryAsOfTime` – Horodatage.
L'Heure à laquelle lire le contenu de la partition. S'il n'est pas défini, l'heure de validation de transaction la plus récente sera utilisée. Ne peut pas être spécifié avec `TransactionId`.
**Réponse**
+ `Partitions` : un tableau d’objets [Partition](#aws-glue-api-catalog-partitions-Partition).
Liste des partitions demandées.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, si la liste de partitions renvoyée n'inclut pas la dernière partition.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `ResourceNotReadyException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchGetPartition action (Python : batch\$1get\$1partition)
Extrait les partitions d'une demande par lot.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `PartitionsToGet` – *Obligatoire :* Un tableau d'objets [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), 1000 structures maximum.
Liste des valeurs de partition qui identifie les partitions à récupérer.
**Réponse**
+ `Partitions` : un tableau d’objets [Partition](#aws-glue-api-catalog-partitions-Partition).
Liste des partitions demandées.
+ `UnprocessedKeys` – Un tableau d'objets [PartitionValueList](#aws-glue-api-catalog-partitions-PartitionValueList), 1000 structures maximum.
Liste des valeurs de partition de la demande pour laquelle les partitions n'ont pas été retournées.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
+ `InvalidStateException`
+ `FederationSourceException`
+ `FederationSourceRetryableException`
## BatchUpdatePartition action (Python : batch\$1update\$1partition)
Met à jour une ou plusieurs partitions dans une opération par lot.
**Demande**
+ `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 dans lequel la partition doit être mise à jour. Actuellement, il devrait s'agir de l'identifiant du AWS compte.
+ `DatabaseName` – *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 base de données de métadonnées dans laquelle la partition doit être mise à jour.
+ `TableName` – *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 table de métadonnées dans laquelle la partition doit être mise à jour.
+ `Entries` – *Obligatoire :* Tableau d'objets [BatchUpdatePartitionRequestEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionRequestEntry), 1 structure minimum et 100 structures maximum.
Une liste de jusqu'à 100 objets `BatchUpdatePartitionRequestEntry` à mettre à jour.
**Réponse**
+ `Errors` : un tableau d’objets [BatchUpdatePartitionFailureEntry](#aws-glue-api-catalog-partitions-BatchUpdatePartitionFailureEntry).
Erreurs survenues pendant la tentative de mise à jour des partitions demandées. Liste d’objets `BatchUpdatePartitionFailureEntry`.
**Erreurs**
+ `InvalidInputException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
## GetColumnStatisticsForPartition action (Python : get\$1column\$1statistics\$1for\$1partition)
Récupère les statistiques de partition des colonnes.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `GetPartition`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `PartitionValues` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des valeurs de partition qui identifie la partition.
+ `ColumnNames` – *Obligatoire :* Tableau de chaînes UTF-8, avec 100 chaînes maximum.
Une liste des noms de colonnes.
**Réponse**
+ `ColumnStatisticsList` : un tableau d’objets [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics).
La liste n' ColumnStatistics a pas pu être récupérée.
+ `Errors` : un tableau d’objets [ColumnError](aws-glue-api-common.md#aws-glue-api-common-ColumnError).
Une erreur s'est produite lors de la récupération des données statistiques de colonne.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## UpdateColumnStatisticsForPartition action (Python : update\$1column\$1statistics\$1for\$1partition)
Crée ou met à jour les statistiques de partition des colonnes.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `UpdatePartition`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `PartitionValues` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des valeurs de partition qui identifie la partition.
+ `ColumnStatisticsList` – *Obligatoire :* Un tableau d'objets [ColumnStatistics](aws-glue-api-common.md#aws-glue-api-common-ColumnStatistics), 25 structures maximum.
Liste des statistiques de la colonne.
**Réponse**
+ `Errors` : un tableau d’objets [ColumnStatisticsError](aws-glue-api-common.md#aws-glue-api-common-ColumnStatisticsError).
Une erreur s'est produite lors de la mise à jour des données statistiques.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteColumnStatisticsForPartition action (Python : supprimer\$1column\$1statistics\$1for\$1partition)
Supprime les statistiques de colonne de partition d'une colonne.
L'autorisation Identity and Access Management (IAM) requise pour cette opération est `DeletePartition`.
**Demande**
+ `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 de données où résident les partitions en question. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données de catalogue où résident les partitions.
+ `TableName` – *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 table des partitions.
+ `PartitionValues` – *Obligatoire :* Tableau de chaînes UTF-8.
Liste des valeurs de partition qui identifie la partition.
+ `ColumnName` – *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 colonne.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
# API de connexions
L'API Connections décrit les types de données et l'API liés à l'utilisation des connexions dans AWS Glue.
**Topics**
+ [API de connexion](aws-glue-api-catalog-connections-connections.md)
+ [API de types de connexion](aws-glue-api-catalog-connections-connections-type.md)
+ [Métadonnées de connexion et API de prévisualisation](aws-glue-api-catalog-connections-connections-metadata.md)
# 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](#aws-glue-api-catalog-connections-connections-Connection)
+ [ConnectionInput structure](#aws-glue-api-catalog-connections-connections-ConnectionInput)
+ [TestConnectionInput structure](#aws-glue-api-catalog-connections-connections-TestConnectionInput)
+ [PhysicalConnectionRequirements structure](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements)
+ [GetConnectionsFilter structure](#aws-glue-api-catalog-connections-connections-GetConnectionsFilter)
+ [AuthenticationConfiguration structure](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration)
+ [AuthenticationConfigurationInput structure](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput)
+ [OAuth2Structure des propriétés](#aws-glue-api-catalog-connections-connections-OAuth2Properties)
+ [OAuth2PropertiesInput structure](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput)
+ [OAuth2ClientApplication structure](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication)
+ [AuthorizationCodeProperties structure](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties)
+ [BasicAuthenticationCredentials structure](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials)
+ [OAuth2Structure des informations d'identification](#aws-glue-api-catalog-connections-connections-OAuth2Credentials)
## 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la connexion.
+ `ConnectionType`— Chaîne UTF-8 (valeurs valides : `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` `TPCDS` \$1`VERTICA`).
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` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Ces paires clé-valeur définissent les paramètres pour la connexion lors de l’utilisation du schéma de connexion de la version 1 :
+ `HOST`- L'URI de l'hôte : soit le nom de domaine complet (FQDN), soit l' IPv4 adresse 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` - 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 insensible à la casse (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 cas`false`. 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 SHA256with RSA, RSA ou SHA384with SHA512with RSA. 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 : SHA256with RSA, RSA et SHA384with RSA. SHA512with 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 [mécanismes SASL](https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml) pris en charge.
+ `KAFKA_SASL_PLAIN_USERNAME` : nom d’utilisateur en texte clair utilisé pour s’authentifier avec le mécanisme « PLAIN ».
+ `KAFKA_SASL_PLAIN_PASSWORD` : 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](https://web.mit.edu/kerberos/krb5-latest/doc/basic/keytab_def.html).
+ `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](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html).
+ `KAFKA_SASL_GSSAPI_SERVICE` - Le nom du service Kerberos, tel que défini avec `sasl.kerberos.service.name` dans votre [Configuration Kafka](https://kafka.apache.org/documentation/#brokerconfigs_sasl.kerberos.service.name).
+ `KAFKA_SASL_GSSAPI_PRINCIPAL`- Le nom du principal Kerberos utilisé par. AWS Glue Pour plus d’informations, consultez [Documentation Kafka : configuration des courtiers Kafka](https://kafka.apache.org/documentation/#security_sasl_kerberos_clientconfig).
+ `ROLE_ARN` : 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` : nom d’un groupe de travail Amazon Redshift sans serveur ou d’un groupe de travail Amazon Athena dans lequel les requêtes seront exécutées.
+ `CLUSTER_IDENTIFIER` : identifiant de cluster d’un cluster Amazon Redshift dans lequel les requêtes seront exécutées.
+ `DATABASE` : base de données Amazon Redshift à laquelle vous vous connectez.
+ `SparkProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Spark.
+ `AthenaProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Athena.
+ `PythonProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Python.
+ `PhysicalConnectionRequirements` – Un objet [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Les exigences de connexion physique, comme un cloud privé virtuel (VPC) et `SecurityGroup`, qui sont nécessaires pour établir la connexion.
+ `CreationTime` – Horodatage.
Horodatage de l’heure à laquelle la définition de connexion a été créée.
+ `LastUpdatedTime` – Horodatage.
Horodatage de la dernière date à laquelle la définition de connexion a été mise à jour.
+ `LastUpdatedBy` – 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).
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` \$1 `IN_PROGRESS` \$1 `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 comprise entre 1 et 16 384 octets.
Motif de l’état de la connexion.
+ `LastConnectionValidationTime` – Horodatage.
Horodatage de la dernière date de validation de cette connexion.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfiguration](#aws-glue-api-catalog-connections-connections-AuthenticationConfiguration).
Les propriétés d’authentification de la connexion.
+ `ConnectionSchemaVersion`— Nombre (entier), pas moins de 1 ou plus de 2.
Version du schéma de connexion pour cette connexion. La version 2 prend en charge les propriétés pour des environnements de calcul spécifiques.
+ `CompatibleComputeEnvironments` – Tableau de chaînes UTF-8.
Liste des environnements de calcul compatibles avec 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-uri).
Description de la connexion.
+ `ConnectionType`— *Obligatoire :* chaîne UTF-8 (valeurs valides : `JDBC` `SFTP` `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO`\$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
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).
`JDBC`Les 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.
`KAFKA`Les 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 SASL/GSSAPI l'authentification avec`KAFKA`.
+ `MONGODB` - Désigne une connexion à une base de données de documents MongoDB.
`MONGODB`Les connexions utilisent les méthodes suivantes ConnectionParameters.
+ Obligatoire : `CONNECTION_URL`.
+ Obligatoire : toutes les valeurs (`USERNAME`, `PASSWORD`) ou `SECRET_ID`.
+ `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 dans un environnement Amazon Virtual Private Cloud (Amazon VPC).
`NETWORK`Les 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.
`MARKETPLACE`Les 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.
Pour plus d'informations sur les paramètres de connexion nécessaires pour un connecteur particulier, consultez la documentation du connecteur dans la section [Ajout d'une AWS Glue connexion](https://docs.aws.amazon.com/glue/latest/dg/console-connections.html) dans le guide de AWS Glue l'utilisateur.
`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](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html).
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](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html).
+ `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` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Ces paires clé-valeur définissent les paramètres pour la connexion.
+ `SparkProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Spark.
+ `AthenaProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Athena.
+ `PythonProperties` – 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 comprise entre 1 et 2 048 octets.
Propriétés de connexion propres à l’environnement de calcul Python.
+ `PhysicalConnectionRequirements` – Un objet [PhysicalConnectionRequirements](#aws-glue-api-catalog-connections-connections-PhysicalConnectionRequirements).
Les exigences de connexion physique, comme un cloud privé virtuel (VPC) et `SecurityGroup`, qui sont nécessaires pour bien établir cette connexion.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
Les propriétés d’authentification de la connexion.
+ `ValidateCredentials` : booléen.
Un indicateur pour valider les informations d’identification lors de la création de la connexion. La valeur par défaut est true.
+ `ValidateForComputeEnvironments` – Tableau de chaînes UTF-8.
Environnements de calcul par rapport auxquels les propriétés de connexion spécifiées sont validées.
## TestConnectionInput structure
Structure utilisée pour spécifier le test d’une connexion à un service.
**Champs**
+ `ConnectionType`— *Obligatoire :* chaîne UTF-8 (valeurs valides : `JDBC` `SFTP` `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` `DATADOG` `WOOCOMMERCE`\$1 `INTERCOM` \$1 `SNAPCHATADS` \$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` `FRESHSALES` \$1 `ZOOM` \$1 `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` `BLACKBAUD` \$1 `CLOUDERAHIVE` \$1 `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO`\$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE` `HBASE` \$1 `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
Le type de connexion à tester. Cette opération n’est disponible que pour les types de connexion `JDBC` ou `SALESFORCE`.
+ `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` \$1 `PORT` \$1 `USERNAME="USER_NAME"` \$1 `PASSWORD` \$1 `ENCRYPTED_PASSWORD` \$1 `JDBC_DRIVER_JAR_URI` \$1 `JDBC_DRIVER_CLASS_NAME` \$1 `JDBC_ENGINE` \$1 `JDBC_ENGINE_VERSION` \$1 `CONFIG_FILES` \$1 `INSTANCE_ID` \$1 `JDBC_CONNECTION_URL` \$1 `JDBC_ENFORCE_SSL` \$1 `CUSTOM_JDBC_CERT` \$1 `SKIP_CUSTOM_JDBC_CERT_VALIDATION` \$1 `CUSTOM_JDBC_CERT_STRING` \$1 `CONNECTION_URL` \$1 `KAFKA_BOOTSTRAP_SERVERS` \$1 `KAFKA_SSL_ENABLED` \$1 `KAFKA_CUSTOM_CERT` \$1 `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` \$1 `KAFKA_CLIENT_KEYSTORE` \$1 `KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `KAFKA_CLIENT_KEY_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` \$1 `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` \$1 `KAFKA_SASL_MECHANISM` \$1 `KAFKA_SASL_PLAIN_USERNAME` \$1 `KAFKA_SASL_PLAIN_PASSWORD` \$1 `ENCRYPTED_KAFKA_SASL_PLAIN_PASSWORD` \$1 `KAFKA_SASL_SCRAM_USERNAME` \$1 `KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_SCRAM_SECRETS_ARN` \$1 `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` \$1 `KAFKA_SASL_GSSAPI_KEYTAB` \$1 `KAFKA_SASL_GSSAPI_KRB5_CONF` \$1 `KAFKA_SASL_GSSAPI_SERVICE` \$1 `KAFKA_SASL_GSSAPI_PRINCIPAL` \$1 `SECRET_ID` \$1 `CONNECTOR_URL` \$1 `CONNECTOR_TYPE` \$1 `CONNECTOR_CLASS_NAME` \$1 `ENDPOINT` \$1 `ENDPOINT_TYPE` \$1 `ROLE_ARN` \$1 `REGION` \$1 `WORKGROUP_NAME` \$1 `CLUSTER_IDENTIFIER` \$1 `DATABASE`).
Chaque valeur est une chaîne Valeur, d’une longueur comprise entre 1 et 1 024 octets.
Les paires clé-valeur qui définissent les paramètres pour la connexion.
Les connexions JDBC utilisent les propriétés de connexion suivantes :
+ 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.
Les connexions SALESFORCE nécessitent que le membre `AuthenticationConfiguration` soit configuré.
+ `AuthenticationConfiguration` : un objet [AuthenticationConfigurationInput](#aws-glue-api-catalog-connections-connections-AuthenticationConfigurationInput).
Structure contenant la configuration d'authentification dans la TestConnection demande. Nécessaire pour une connexion à Salesforce à l'aide de OAuth l'authentification.
## PhysicalConnectionRequirements structure
L'application OAuth cliente en GetConnection réponse.
**Champs**
+ `SubnetId` – 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).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` `KUSTOMER` \$1 `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` `OPENSEARCH` \$1 `ORACLE` \$1 `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` \$1 `TIMESTREAM` `TPCDS` \$1`VERTICA`).
Type de connexions à renvoyer. Actuellement, SFTP n'est pas pris en charge.
+ `ConnectionSchemaVersion`— Nombre (entier), pas moins de 1 ou plus de 2.
Indique si la connexion a été créée avec la version 1 ou 2 du schéma.
## AuthenticationConfiguration structure
Une structure contenant la configuration d’authentification.
**Champs**
+ `AuthenticationType` – Chaîne UTF-8 (valeurs valides : `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Une structure contenant la configuration d’authentification.
+ `SecretArn` – Chaîne UTF-8, correspondant au [Custom string pattern #36](aws-glue-api-common.md#regex_36).
ARN de Secrets Manager pour stocker les informations d’identification.
+ `KmsKeyArn` – Chaîne UTF-8, correspondant au [Custom string pattern #42](aws-glue-api-common.md#regex_42).
Amazon Resource Name (ARN) de la clé KMS à utiliser pour chiffrer les informations d’authentification sensibles. Cette clé est utilisée pour protéger les informations d’identification et autres données sensibles stockées dans la configuration d’authentification.
+ `OAuth2Properties` : un objet [OAuth2Propriétés](#aws-glue-api-catalog-connections-connections-OAuth2Properties).
Les propriétés de l' OAuth2 authentification.
## AuthenticationConfigurationInput structure
Structure contenant la configuration d'authentification dans la CreateConnection demande.
**Champs**
+ `AuthenticationType` – Chaîne UTF-8 (valeurs valides : `BASIC` \$1 `OAUTH2` \$1 `CUSTOM` \$1 `IAM`).
Structure contenant la configuration d'authentification dans la CreateConnection demande.
+ `OAuth2Properties` : un objet [OAuth2PropertiesInput](#aws-glue-api-catalog-connections-connections-OAuth2PropertiesInput).
Les propriétés d' OAuth2 authentification dans la CreateConnection demande.
+ `SecretArn` – Chaîne UTF-8, correspondant au [Custom string pattern #36](aws-glue-api-common.md#regex_36).
L'ARN du gestionnaire secret pour stocker les informations d'identification dans la CreateConnection demande.
+ `KmsKeyArn` – Chaîne UTF-8, correspondant au [Custom string pattern #42](aws-glue-api-common.md#regex_42).
ARN de la clé KMS utilisée pour chiffrer la connexion. Utilisé uniquement comme entrée dans la demande et stocké dans Secrets Manager.
+ `BasicAuthenticationCredentials` – Un objet [BasicAuthenticationCredentials](#aws-glue-api-catalog-connections-connections-BasicAuthenticationCredentials).
Informations d’identification utilisées lorsque le type d’authentification est une authentification de base.
+ `CustomAuthenticationCredentials` – 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 comprise entre 1 et 2 048 octets.
Informations d’identification utilisées lorsque le type d’authentification est une authentification personnalisée.
## OAuth2Structure des propriétés
Structure contenant les propriétés d' OAuth2 authentification.
**Champs**
+ `OAuth2GrantType` – Chaîne UTF-8 (valeurs valides : `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
Le type de OAuth2 subvention. Par exemple, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` : un objet [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
Type d’application client. Par exemple, AWS\$1MANAGED ou USER\$1MANAGED.
+ `TokenUrl` – chaîne UTF-8, d'une longueur ne dépassant pas 256 octets, correspondant au [Custom string pattern #40](aws-glue-api-common.md#regex_40).
URL du serveur d’authentification du fournisseur, pour échanger un code d’autorisation en vue d’obtenir 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 comprise entre 1 et 512 octets.
Carte des paramètres ajoutés à la demande de jeton `GET`.
## OAuth2PropertiesInput structure
Structure contenant les propriétés OAuth2 de la CreateConnection demande.
**Champs**
+ `OAuth2GrantType` – Chaîne UTF-8 (valeurs valides : `AUTHORIZATION_CODE` \$1 `CLIENT_CREDENTIALS` \$1 `JWT_BEARER`).
Type de OAuth2 subvention indiqué dans la CreateConnection demande. Par exemple, `AUTHORIZATION_CODE`, `JWT_BEARER` ou `CLIENT_CREDENTIALS`.
+ `OAuth2ClientApplication` : un objet [OAuth2ClientApplication](#aws-glue-api-catalog-connections-connections-OAuth2ClientApplication).
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 #40](aws-glue-api-common.md#regex_40).
URL du serveur d’authentification du fournisseur, pour échanger un code d’autorisation en vue d’obtenir 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 comprise entre 1 et 512 octets.
Carte des paramètres ajoutés à la demande de jeton `GET`.
+ `AuthorizationCodeProperties` : un objet [AuthorizationCodeProperties](#aws-glue-api-catalog-connections-connections-AuthorizationCodeProperties).
Ensemble de propriétés requis pour le type de OAuth2 `AUTHORIZATION_CODE` subvention.
+ `OAuth2Credentials` : un objet [OAuth2Informations d'identification](#aws-glue-api-catalog-connections-connections-OAuth2Credentials).
Les informations d'identification utilisées lorsque le type d'authentification est OAuth2 l'authentification.
## OAuth2ClientApplication structure
L'application OAuth2 cliente utilisée pour la connexion.
**Champs**
+ `UserManagedClientApplicationClientId` – Chaîne UTF-8, d'une longueur maximale de 2 048 octets, correspondant au [Custom string pattern #37](aws-glue-api-common.md#regex_37).
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 #37](aws-glue-api-common.md#regex_37).
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 du type de OAuth2 `AUTHORIZATION_CODE` subvention.
**Champs**
+ `AuthorizationCode`— Chaîne UTF-8, d'une longueur d'au moins 1 ou supérieure à 4 096 octets, correspondant au. [Custom string pattern #37](aws-glue-api-common.md#regex_37)
Code d’autorisation à utiliser dans la troisième étape du flux de travail d’autorisation `AUTHORIZATION_CODE`. 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 #41](aws-glue-api-common.md#regex_41)
URI de redirection vers lequel 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é pour obtenir un jeton d’accès.
## BasicAuthenticationCredentials structure
Pour fournir des informations d’authentification de base lorsque vous ne fournissez pas de valeur `SecretArn`.
**Champs**
+ `Username`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #37](aws-glue-api-common.md#regex_37)
Nom d’utilisateur pour se connecter à la source de données.
+ `Password`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #33](aws-glue-api-common.md#regex_33)
Mot de passe pour se connecter à la source de données.
## OAuth2Structure des informations d'identification
Les informations d'identification utilisées lorsque le type d'authentification est OAuth2 l'authentification.
**Champs**
+ `UserManagedClientApplicationClientSecret`— Chaîne UTF-8, d'une longueur maximale de 512 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Secret client de l’application client si l’application client est gérée par l’utilisateur.
+ `AccessToken`— Chaîne UTF-8, d'une longueur maximale de 4096 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Le jeton d'accès utilisé lorsque le type d'authentification est OAuth2.
+ `RefreshToken`— Chaîne UTF-8, d'une longueur maximale de 4096 octets, correspondant au. [Custom string pattern #38](aws-glue-api-common.md#regex_38)
Le jeton d'actualisation utilisé lorsque le type d'authentification est OAuth2.
+ `JwtToken`— Chaîne UTF-8, d'une longueur maximale de 8 000 octets, correspondant au. [Custom string pattern #39](aws-glue-api-common.md#regex_39)
Le jeton Web JSON (JWT) utilisé lorsque le type d'authentification est OAuth2.
## Opérations
+ [CreateConnection action (Python : créer\$1connexion)](#aws-glue-api-catalog-connections-connections-CreateConnection)
+ [DeleteConnection action (Python : supprimer\$1connexion)](#aws-glue-api-catalog-connections-connections-DeleteConnection)
+ [GetConnection action (Python : get\$1connection)](#aws-glue-api-catalog-connections-connections-GetConnection)
+ [GetConnections action (Python : get\$1connections)](#aws-glue-api-catalog-connections-connections-GetConnections)
+ [UpdateConnection action (Python : update\$1connection)](#aws-glue-api-catalog-connections-connections-UpdateConnection)
+ [TestConnection action (Python : test\$1connection)](#aws-glue-api-catalog-connections-connections-TestConnection)
+ [BatchDeleteConnection action (Python : batch\$1delete\$1connection)](#aws-glue-api-catalog-connections-connections-BatchDeleteConnection)
## CreateConnection action (Python : créer\$1connexion)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](#aws-glue-api-catalog-connections-connections-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` \$1 `IN_PROGRESS` \$1 `FAILED`).
Statut 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 jetons via VPC.
**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## DeleteConnection action (Python : supprimer\$1connexion)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la connexion à supprimer.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
## GetConnection action (Python : get\$1connection)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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.
+ `ApplyOverrideForComputeEnvironment` – Chaîne UTF-8 (valeurs valides : `SPARK` \$1 `ATHENA` \$1 `PYTHON`).
Pour les connexions qui peuvent être utilisées dans plusieurs services, spécifie les propriétés de renvoi pour l’environnement de calcul spécifié.
**Réponse**
+ `Connection` – Un objet [Connexion](#aws-glue-api-catalog-connections-connections-Connection).
Définition de connexion demandée.
**Erreurs**
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `InvalidInputException`
+ `GlueEncryptionException`
## GetConnections action (Python : get\$1connections)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](#aws-glue-api-catalog-connections-connections-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` – 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](#aws-glue-api-catalog-connections-connections-Connection).
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\$1connection)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Nom de la définition de connexion à mettre à jour.
+ `ConnectionInput` – *Obligatoire :* un objet [ConnectionInput](#aws-glue-api-catalog-connections-connections-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`
## TestConnection action (Python : test\$1connection)
Teste une connexion à un service pour valider les informations d’identification du service que vous indiquez.
Vous pouvez indiquer un nom de connexion existant ou une `TestConnectionInput` pour tester une entrée de connexion inexistante. Fournir les deux en même temps entraînera une erreur.
Si l’action aboutit, le service renvoie une réponse HTTP 200.
**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).
Facultatif. Nom de la connexion à tester. Si seul le nom est fourni, l’opération obtiendra la connexion et l’utilisera pour les tests.
+ `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 où réside la connexion.
+ `TestConnectionInput` – Un objet [TestConnectionInput](#aws-glue-api-catalog-connections-connections-TestConnectionInput).
Structure utilisée pour spécifier le test d’une connexion à un service.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
+ `FederationSourceException`
+ `AccessDeniedException`
+ `EntityNotFoundException`
+ `ConflictException`
+ `InternalServiceException`
## BatchDeleteConnection action (Python : batch\$1delete\$1connection)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
Chaque valeur est un objet [ErrorDetail](aws-glue-api-common.md#aws-glue-api-common-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`
# API de types de connexion
L'API Connection Type décrit AWS Glue APIs les types de connexion.
## Gestion des connexions APIs
+ [DescribeConnectionType action (Python : describe\$1connection\$1type)](#aws-glue-api-catalog-connections-connections-type-DescribeConnectionType)
+ [ListConnectionTypes action (Python : list\$1connection\$1types)](#aws-glue-api-catalog-connections-connections-type-ListConnectionTypes)
+ [ConnectionTypeBrief structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeBrief)
+ [ConnectionTypeVariant structure](#aws-glue-api-catalog-connections-connections-type-ConnectionTypeVariant)
## DescribeConnectionType action (Python : describe\$1connection\$1type)
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
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](#aws-glue-api-catalog-connections-connections-type-Capabilities).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
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](#aws-glue-api-catalog-connections-connections-type-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](#aws-glue-api-catalog-connections-connections-type-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é](#aws-glue-api-catalog-connections-connections-type-Property).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
Propriétés de connexion propres à l’environnement de calcul Spark.
**Erreurs**
+ `ValidationException`
+ `InvalidInputException`
+ `InternalServiceException`
## ListConnectionTypes action (Python : list\$1connection\$1types)
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](aws-glue-api-common.md#regex_11).
Jeton de continuation, s’il s’agit d’un appel de continuation.
**Réponse**
+ `ConnectionTypes` : un tableau d’objets [ConnectionTypeBrief](#aws-glue-api-catalog-connections-connections-type-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](aws-glue-api-common.md#regex_11).
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’API `ListConnectionTypes`.
**Champs**
+ `ConnectionType`— Chaîne UTF-8 (valeurs valides : `JDBC` \$1 `SFTP` \$1 `MONGODB` \$1 `KAFKA` \$1 `NETWORK` \$1 `MARKETPLACE` \$1 `CUSTOM` \$1 `SALESFORCE` \$1 `VIEW_VALIDATION_REDSHIFT` \$1 `VIEW_VALIDATION_ATHENA` \$1 `GOOGLEADS` \$1 `GOOGLESHEETS` \$1 \$1 `GOOGLEANALYTICS4` \$1 `SERVICENOW` \$1 `MARKETO` \$1 `SAPODATA` \$1 `ZENDESK` \$1 `JIRACLOUD` \$1 `NETSUITEERP` \$1 `HUBSPOT` \$1 `FACEBOOKADS` \$1 `INSTAGRAMADS` \$1 `ZOHOCRM` \$1 `SALESFORCEPARDOT` \$1 `SALESFORCEMARKETINGCLOUD` \$1 `ADOBEANALYTICS` \$1 `SLACK` \$1 `LINKEDIN` \$1 `MIXPANEL` \$1 `ASANA` \$1 `STRIPE` \$1 `SMARTSHEET` \$1 `DATADOG` \$1 `WOOCOMMERCE` `INTERCOM` `SNAPCHATADS`\$1 `PAYPAL` \$1 `QUICKBOOKS` \$1 `FACEBOOKPAGEINSIGHTS` \$1 `FRESHDESK` \$1 `TWILIO` \$1 `DOCUSIGNMONITOR` \$1 `FRESHSALES` \$1 `ZOOM` `GOOGLESEARCHCONSOLE` \$1 `SALESFORCECOMMERCECLOUD` \$1 `SAPCONCUR` \$1 `DYNATRACE` \$1 `MICROSOFTDYNAMIC365FINANCEANDOPS` \$1 `MICROSOFTTEAMS` \$1 `BLACKBAUDRAISEREDGENXT` \$1 `MAILCHIMP` \$1 `GITLAB` \$1 `PENDO` \$1 `PRODUCTBOARD` \$1 `CIRCLECI` \$1 `PIPEDIVE` \$1 `SENDGRID` \$1 `AZURECOSMOS` \$1 `AZURESQL` \$1 `BIGQUERY` \$1 `BLACKBAUD` \$1 `CLOUDERAHIVE` `CLOUDERAIMPALA` \$1 `CLOUDWATCH` \$1 `CLOUDWATCHMETRICS` \$1 `CMDB` \$1 `DATALAKEGEN2` \$1 `DB2` \$1 `DB2AS400` \$1 `DOCUMENTDB` \$1 `DOMO` \$1 `DYNAMODB` \$1 `GOOGLECLOUDSTORAGE`\$1 `HBASE` \$1 `KUSTOMER` `MICROSOFTDYNAMICS365CRM` \$1 `MONDAY` \$1 `MYSQL` \$1 `OKTA` \$1 `OPENSEARCH` \$1 `ORACLE` `PIPEDRIVE` \$1 `POSTGRESQL` \$1 `SAPHANA` \$1 `SQLSERVER` \$1 `SYNAPSE` \$1 `TERADATA` \$1 `TERADATANOS` `TIMESTREAM` \$1 `TPCDS` \$1`VERTICA`).
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` – .
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](#aws-glue-api-catalog-connections-connections-type-Capabilities).
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](#aws-glue-api-catalog-connections-connections-type-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.
## ConnectionTypeVariant structure
Représente une variante d'un type de connexion dans le catalogue de AWS Glue données. 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'homme de la variante de type de connexion affichée dans la AWS Glue console.
+ `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](#aws-glue-api-catalog-connections-connections-type-Validation)
+ [AuthConfiguration structure](#aws-glue-api-catalog-connections-connections-type-AuthConfiguration)
+ [Structure des fonctionnalités](#aws-glue-api-catalog-connections-connections-type-Capabilities)
+ [Structure de la propriété](#aws-glue-api-catalog-connections-connections-type-Property)
+ [AllowedValue structure](#aws-glue-api-catalog-connections-connections-type-AllowedValue)
+ [ComputeEnvironmentConfiguration structure](#aws-glue-api-catalog-connections-connections-type-ComputeEnvironmentConfiguration)
## 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` \$1 `RANGE`).
Type de validation à effectuer, tel que `REGEX`.
+ `Patterns` – .
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.
## AuthConfiguration structure
Configuration d’authentification pour une connexion renvoyée par l’API `DescribeConnectionType`.
**Champs**
+ `AuthenticationType` – *Obligatoire :* un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).
Type d’autorisation pour une connexion.
+ `SecretArn` – Un objet [Propriété](#aws-glue-api-catalog-connections-connections-type-Property).
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é](#aws-glue-api-catalog-connections-connections-type-Property).
Carte des paires clé-valeur pour les OAuth2 propriétés. 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é](#aws-glue-api-catalog-connections-connections-type-Property).
Carte des paires clé-valeur pour les OAuth2 propriétés. 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é](#aws-glue-api-catalog-connections-connections-type-Property).
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 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 ne dépassant pas 1 024 octets.
Description de la propriété.
+ `Required` – *obligatoire :* booléen.
Indique si la propriété est obligatoire.
+ `PropertyTypes` – *Obligatoire :* Tableau de chaînes UTF-8.
Décrit le type de propriété.
+ `AllowedValues` : un tableau d’objets [AllowedValue](#aws-glue-api-catalog-connections-connections-type-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é.
## AllowedValue structure
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 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 de calcul (tel que Spark, Python ou Athena) renvoyé par l’API `DescribeConnectionType`.
**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 ne dépassant pas 1 024 octets.
Description de l’environnement de calcul.
+ `ComputeEnvironment` – *Obligatoire :* Chaîne UTF-8 (valeurs valides : `SPARK` \$1 `ATHENA` \$1 `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é](#aws-glue-api-catalog-connections-connections-type-Property).
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 :*.
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.
# 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`
# API de fonction définie par l'utilisateur
L'API des fonctions définies par l'utilisateur décrit les types de AWS Glue données et les opérations utilisés lors de l'utilisation des fonctions.
## Types de données
+ [UserDefinedFunction structure](#aws-glue-api-catalog-functions-UserDefinedFunction)
+ [UserDefinedFunctionInput structure](#aws-glue-api-catalog-functions-UserDefinedFunctionInput)
## UserDefinedFunction structure
Représente l'équivalent d'une définition de fonction Hive définie par l'utilisateur (`UDF`).
**Champs**
+ `FunctionName` – 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 fonction.
+ `DatabaseName` – 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 base de données du catalogue qui contient la fonction.
+ `ClassName` – 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).
Classe Java qui contient le code de fonction.
+ `OwnerName` – 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).
Propriétaire de la fonction.
+ `OwnerType` – Chaîne UTF-8 (valeurs valides : `USER` \$1 `ROLE` \$1 `GROUP`).
Type de propriétaire.
+ `CreateTime` – Horodatage.
Heure à laquelle la fonction a été créée.
+ `ResourceUris` – Un tableau d'objets [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), 1000 structures maximum.
La ressource URIs associée à la fonction.
+ `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 de données dans lequel réside la fonction.
## UserDefinedFunctionInput structure
Structure utilisée pour créer ou mettre à jour une fonction définie par l'utilisateur.
**Champs**
+ `FunctionName` – 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 fonction.
+ `ClassName` – 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).
Classe Java qui contient le code de fonction.
+ `OwnerName` – 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).
Propriétaire de la fonction.
+ `OwnerType` – Chaîne UTF-8 (valeurs valides : `USER` \$1 `ROLE` \$1 `GROUP`).
Type de propriétaire.
+ `ResourceUris` – Un tableau d'objets [ResourceUri](aws-glue-api-common.md#aws-glue-api-common-ResourceUri), 1000 structures maximum.
La ressource URIs associée à la fonction.
## Opérations
+ [CreateUserDefinedFunction action (Python : create\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-CreateUserDefinedFunction)
+ [UpdateUserDefinedFunction action (Python : update\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-UpdateUserDefinedFunction)
+ [DeleteUserDefinedFunction action (Python : delete\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-DeleteUserDefinedFunction)
+ [GetUserDefinedFunction action (Python : get\$1user\$1defined\$1function)](#aws-glue-api-catalog-functions-GetUserDefinedFunction)
+ [GetUserDefinedFunctions action (Python : get\$1user\$1defined\$1functions)](#aws-glue-api-catalog-functions-GetUserDefinedFunctions)
## CreateUserDefinedFunction action (Python : create\$1user\$1defined\$1function)
Crée une nouvelle définition de fonction 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données dans lequel créer la fonction. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue dans laquelle créer la fonction.
+ `FunctionInput` – *Obligatoire :* un objet [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput).
Objet `FunctionInput` qui définit la fonction à créer dans le catalogue de données.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `AlreadyExistsException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `EntityNotFoundException`
+ `OperationTimeoutException`
+ `ResourceNumberLimitExceededException`
+ `GlueEncryptionException`
## UpdateUserDefinedFunction action (Python : update\$1user\$1defined\$1function)
Met à jour une définition de fonction existante 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données contenant la fonction à mettre à jour. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue contenant la fonction à mettre à jour.
+ `FunctionName` – *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 fonction.
+ `FunctionInput` – *Obligatoire :* un objet [UserDefinedFunctionInput](#aws-glue-api-catalog-functions-UserDefinedFunctionInput).
Objet `FunctionInput` qui redéfinit la fonction à créer dans le catalogue de données.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## DeleteUserDefinedFunction action (Python : delete\$1user\$1defined\$1function)
Supprime une définition de fonction existante 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données contenant la fonction à supprimer. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue contenant la fonction.
+ `FunctionName` – *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 définition de fonction à supprimer.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetUserDefinedFunction action (Python : get\$1user\$1defined\$1function)
Extrait une définition de fonction spécifiée 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données contenant la fonction à extraire. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – *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 base de données du catalogue contenant la fonction.
+ `FunctionName` – *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 fonction.
**Réponse**
+ `UserDefinedFunction` – Un objet [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction).
Définition de la fonction demandée.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `InternalServiceException`
+ `OperationTimeoutException`
+ `GlueEncryptionException`
## GetUserDefinedFunctions action (Python : get\$1user\$1defined\$1functions)
Extrait plusieurs définitions de fonction 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](aws-glue-api-common.md#aws-glue-api-regex-oneLine).
ID du catalogue de données contenant les fonction à extraire. Si aucun identifiant n'est fourni, l'identifiant du AWS compte est utilisé par défaut.
+ `DatabaseName` – 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 base de données du catalogue contenant les fonctions. Si aucune n'est fournie, des fonctions de toutes les bases de données du catalogue seront renvoyées.
+ `Pattern` – *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).
Chaîne de modèle nom-fonction facultative qui filtre les définitions de fonction renvoyées.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, s’il s’agit d’un appel de continuation.
+ `MaxResults` – Nombre (entier), compris entre 1 et 100.
Nombre maximum de fonctions renvoyées par réponse.
**Réponse**
+ `UserDefinedFunctions` : un tableau d’objets [UserDefinedFunction](#aws-glue-api-catalog-functions-UserDefinedFunction).
Liste des définitions de fonction demandées.
+ `NextToken` – Chaîne UTF-8.
Jeton de continuation, si la liste de fonctions renvoyée n'inclut pas la dernière fonction demandée.
**Erreurs**
+ `EntityNotFoundException`
+ `InvalidInputException`
+ `OperationTimeoutException`
+ `InternalServiceException`
+ `GlueEncryptionException`
# Importation d'un Athena catalogue dans AWS Glue
L'API de migration décrit AWS Glue les types de données et les opérations liées à la migration d'un catalogue de Athena données vers AWS Glue.
## Types de données
+ [CatalogImportStatus structure](#aws-glue-api-catalog-migration-CatalogImportStatus)
## CatalogImportStatus structure
Structure contenant les informations sur le statut de la migration.
**Champs**
+ `ImportCompleted` : booléen.
`True` si la migration est terminée ou `False` dans le cas contraire.
+ `ImportTime` – Horodatage.
Heure à laquelle la migration a été démarrée.
+ `ImportedBy` – 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 personne ayant lancé la migration.
## Opérations
+ [ImportCatalogToGlue action (Python : import\$1catalog\$1to\$1glue)](#aws-glue-api-catalog-migration-ImportCatalogToGlue)
+ [GetCatalogImportStatus action (Python : get\$1catalog\$1import\$1status)](#aws-glue-api-catalog-migration-GetCatalogImportStatus)
## ImportCatalogToGlue action (Python : import\$1catalog\$1to\$1glue)
Importe un catalogue de données Amazon Athena existant dans. AWS Glue
**Demande**
+ `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 à importer. Actuellement, il devrait s'agir de l'identifiant du AWS compte.
**Réponse**
+ *Paramètres d’absence de réponse.*
**Erreurs**
+ `InternalServiceException`
+ `OperationTimeoutException`
## GetCatalogImportStatus action (Python : get\$1catalog\$1import\$1status)
Extrait le statut d'une opération de migration.
**Demande**
+ `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 à migrer. Actuellement, il devrait s'agir de l'identifiant du AWS compte.
**Réponse**
+ `ImportStatus` – Un objet [CatalogImportStatus](#aws-glue-api-catalog-migration-CatalogImportStatus).
Statut de la migration du catalogue spécifié.
**Erreurs**
+ `InternalServiceException`
+ `OperationTimeoutException`