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 Qualité des données L'API Qualité des données décrit les types de données de qualité et inclut l'API permettant de créer, supprimer ou de mettre à jour des ensembles de règles, exécutions et évaluations. ## Types de données + [DataSource structure](#aws-glue-api-data-quality-api-DataSource) + [DataQualityRulesetListDetails structure](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails) + [DataQualityTargetTable structure](#aws-glue-api-data-quality-api-DataQualityTargetTable) + [DataQualityRulesetEvaluationRunDescription structure](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription) + [DataQualityRulesetEvaluationRunFilter structure](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter) + [DataQualityEvaluationRunAdditionalRunOptions structure](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions) + [DataQualityRuleRecommendationRunDescription structure](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription) + [DataQualityRuleRecommendationRunFilter structure](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter) + [DataQualityResult structure](#aws-glue-api-data-quality-api-DataQualityResult) + [DataQualityAnalyzerResult structure](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult) + [DataQualityObservation structure](#aws-glue-api-data-quality-api-DataQualityObservation) + [MetricBasedObservation structure](#aws-glue-api-data-quality-api-MetricBasedObservation) + [DataQualityMetricValues structure](#aws-glue-api-data-quality-api-DataQualityMetricValues) + [DataQualityRuleResult structure](#aws-glue-api-data-quality-api-DataQualityRuleResult) + [DataQualityResultDescription structure](#aws-glue-api-data-quality-api-DataQualityResultDescription) + [DataQualityResultFilterCriteria structure](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria) + [DataQualityRulesetFilterCriteria structure](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria) + [DataQualityAggregatedMetrics structure](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics) + [StatisticAnnotation structure](#aws-glue-api-data-quality-api-StatisticAnnotation) + [TimestampedInclusionAnnotation structure](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation) + [AnnotationError structure](#aws-glue-api-data-quality-api-AnnotationError) + [DatapointInclusionAnnotation structure](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation) + [StatisticSummaryList liste](#aws-glue-api-data-quality-api-StatisticSummaryList) + [StatisticSummary structure](#aws-glue-api-data-quality-api-StatisticSummary) + [RunIdentifier structure](#aws-glue-api-data-quality-api-RunIdentifier) + [StatisticModelResult structure](#aws-glue-api-data-quality-api-StatisticModelResult) + [DataQualityGlueTable structure](#aws-glue-api-data-quality-api-DataQualityGlueTable) ## DataSource structure Source de données ( AWS Glue table) pour laquelle vous souhaitez obtenir des résultats de qualité. **Champs** + `GlueTable` – Un objet [GlueTable](aws-glue-api-machine-learning-api.md#aws-glue-api-machine-learning-api-GlueTable). Et une AWS Glue table. + `DataQualityGlueTable` – Un objet [DataQualityGlueTable](#aws-glue-api-data-quality-api-DataQualityGlueTable). Un AWS Glue tableau pour les opérations relatives à la qualité des données. ## DataQualityRulesetListDetails structure Décrit un ensemble de règles de qualité des données renvoyé par `GetDataQualityRuleset`. **Champs** + `Name`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles de qualité des données. + `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 l'ensemble de règles de qualité des données. + `CreatedOn` – Horodatage. Date et heure de création de l'ensemble de règles de qualité des données. + `LastModifiedOn` – Horodatage. Date et heure de la dernière modification de l'ensemble de règles de qualité des données. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Objet représentant une AWS Glue table. + `RecommendationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Lors de la création d'un ensemble de règles à partir d'une exécution de recommandation, cet ID d'exécution est généré pour relier les deux. + `RuleCount` : nombre (entier). Nombre de règles dans l'ensemble de règles. ## DataQualityTargetTable structure Objet représentant une AWS Glue table. **Champs** + `TableName`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la AWS Glue table. + `DatabaseName`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 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 dans laquelle se trouve la AWS Glue table. + `CatalogId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L'identifiant du catalogue où se trouve la AWS Glue table. ## DataQualityRulesetEvaluationRunDescription structure Décrit le résultat d'une exécution d'évaluation d'un ensemble de règles de qualité des données. **Champs** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `FINISHED` \| `FAILED` \| `PENDING_EXECUTION` \| `TIMED_OUT` \| `CANCELING` \| `CANCELED` \|`RECEIVED_BY_TASKRUNNER`). Statut de cette exécution. + `StartedOn` – Horodatage. Date et heure de lancement de l'exécution. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (une AWS Glue table) associée à l'exécution. ## DataQualityRulesetEvaluationRunFilter structure Critères de filtrage. **Champs** + `DataSource` – *Obligatoire :* un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Filtrez en fonction d'une source de données (une AWS Glue table) associée à l'exécution. + `StartedBefore` – Horodatage. Filtrez les résultats en fonction des exécutions qui ont débuté avant cette heure. + `StartedAfter` – Horodatage. Filtrez les résultats en fonction des exécutions qui ont débuté après cette heure. + `RulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Filtrez les résultats en fonction des exécutions associées à un nom d'ensemble de règles spécifique. ## DataQualityEvaluationRunAdditionalRunOptions structure Options d'exécution supplémentaires que vous pouvez spécifier pour une exécution d'évaluation. **Champs** + `CloudWatchMetricsEnabled` : booléen. Activer ou non les CloudWatch métriques. + `ResultsS3Prefix`— UTF-8 chaîne. Préfixe permettant à Amazon S3 de stocker les résultats. + `CompositeRuleEvaluationMethod`— UTF-8 chaîne (valeurs valides : `COLUMN` \|`ROW`). Définissez la méthode d'évaluation des règles composites du jeu de règles sur ROW/COLUMN + `CustomLogGroupPrefix`— UTF-8 chaîne. Un préfixe personnalisé pour les noms des groupes de CloudWatch journaux. Lorsque cela est spécifié, les journaux d'exécution des évaluations sont écrits dans `/error` et à la `/output` place des groupes de `/aws-glue/data-quality/output` journaux `/aws-glue/data-quality/error` et des groupes de journaux par défaut. Le nom total du groupe de journaux, y compris le suffixe (`/error`ou`/output`), ne doit pas dépasser 512 caractères. ## DataQualityRuleRecommendationRunDescription structure Décrit le résultat de l'exécution d'une recommandation de règle de qualité des données. **Champs** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `FINISHED` \| `FAILED` \| `PENDING_EXECUTION` \| `TIMED_OUT` \| `CANCELING` \| `CANCELED` \|`RECEIVED_BY_TASKRUNNER`). Statut de cette exécution. + `StartedOn` – Horodatage. Date et heure de lancement de cette exécution. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Source de données (AWS Glue table) associée à l'exécution de la recommandation. ## DataQualityRuleRecommendationRunFilter structure Filtre permettant de répertorier les exécutions de recommandations relatives à la qualité des données. **Champs** + `DataSource` – *Obligatoire :* un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Filtrez en fonction d'une source de données spécifiée (AWS Glue table). + `StartedBefore` – Horodatage. Filtrez en fonction de l'heure de début des résultats avant l'heure indiquée. + `StartedAfter` – Horodatage. Filtrez en fonction de l'heure de début des résultats après l'heure indiquée. ## DataQualityResult structure Décrit un résultat sur la qualité des données. **Champs** + `ResultId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de résultat unique pour le résultat en matière de qualité des données. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil pour le résultat en matière de qualité des données. + `Score` – Nombre (double), au plus égal à 1,0. Score de qualité des données agrégées. Représente le rapport entre le nombre de règles transmises et le nombre total de règles. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Table associée au résultat sur la qualité des données, le cas échéant. + `RulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles associé au résultat sur la qualité des données. + `EvaluationContext`— UTF-8 chaîne. Dans le contexte d'une tâche dans AWS Glue Studio, chaque nœud du canevas se voit généralement attribuer un nom et les nœuds de qualité des données porteront un nom. Dans le cas de plusieurs nœuds, `evaluationContext` peut distinguer les nœuds. + `StartedOn` – Horodatage. Date et heure du début de cette exécution de l'évaluation de la qualité des données. + `CompletedOn` – Horodatage. Date et heure de fin de la dernière exécution de cette évaluation de la qualité des données. + `JobName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de tâche associé au résultat sur la qualité des données, le cas échéant. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution de la tâche associé au résultat sur la qualité des données, le cas échéant. + `RulesetEvaluationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution unique de l'évaluation de l'ensemble de règles pour ce résultat sur la qualité des données. + `RuleResults` – Un tableau d’objets [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), 2 000 structures au maximum. Liste d'objets `DataQualityRuleResult` représentant les résultats de chaque règle. + `AnalyzerResults` – Un tableau d’objets [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), 2 000 structures au maximum. Liste d’objets `DataQualityAnalyzerResult` représentant les résultats de chaque analyseur. + `Observations` – Un tableau d'objets [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation), 50 structures maximum. Liste d’objets `DataQualityObservation` représentant les observations générées après évaluation des règles et des analyseurs. + `AggregatedMetrics` – Un objet [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics). Récapitulatif des `DataQualityAggregatedMetrics` objets indiquant le nombre total de lignes et de règles traitées, y compris leurs pass/fail statistiques basées sur les résultats au niveau des lignes. ## DataQualityAnalyzerResult structure Décrit le résultat de l’évaluation d’un analyseur de qualité des données. **Champs** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l’analyseur de qualité des données. + `Description`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Description de l’analyseur de qualité des données. + `EvaluationMessage`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Message d'évaluation. + `EvaluatedMetrics` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est un nombre (double). Carte des métriques associées à l’évaluation de l’analyseur. ## DataQualityObservation structure Décrit l’observation générée après l’évaluation des règles et des analyseurs. **Champs** + `Description`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Description de l’observation de la qualité des données. + `MetricBasedObservation` – Un objet [MetricBasedObservation](#aws-glue-api-data-quality-api-MetricBasedObservation). Objet de type `MetricBasedObservation` représentant l’observation basée sur des métriques de qualité des données évaluées. ## MetricBasedObservation structure Décrit l’observation basée sur les métriques générée sur la base des métriques de qualité des données évaluées. **Champs** + `MetricName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la métrique de qualité des données utilisée pour générer l’observation. + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `MetricValues` – Un objet [DataQualityMetricValues](#aws-glue-api-data-quality-api-DataQualityMetricValues). Objet de type `DataQualityMetricValues` représentant l’analyse de la valeur de métrique de qualité des données. + `NewRules`— Un tableau de UTF-8 chaînes. Liste des nouvelles règles de qualité des données générées dans le cadre de l’observation basée sur la valeur de métrique de qualité des données. ## DataQualityMetricValues structure Décrit la valeur de la métrique de qualité des données en fonction de l’analyse des données historiques. **Champs** + `ActualValue` – Nombre (double). Valeur réelle de la métrique de qualité des données. + `ExpectedValue` – Nombre (double). Valeur attendue de la métrique de qualité des données selon l’analyse des données historiques. + `LowerLimit` – Nombre (double). Limite inférieure de la valeur de métrique de qualité des données selon l’analyse des données historiques. + `UpperLimit` – Nombre (double). Limite supérieure de la valeur de métrique de qualité des données selon l’analyse des données historiques. ## DataQualityRuleResult structure Décrit le résultat de l'évaluation d'une règle de qualité des données. **Champs** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la règle de qualité des données. + `Description`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Description de la règle de qualité des données. + `EvaluationMessage`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Message d'évaluation. + `Result`— UTF-8 chaîne (valeurs valides : `PASS` \| `FAIL` \|`ERROR`). État de réussite ou d'échec de la règle. + `EvaluatedMetrics` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est un nombre (double). Une carte des métriques associées à l'évaluation de la règle. + `EvaluatedRule`— UTF-8 chaîne, d'une longueur maximale de 2048 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Règle évaluée. + `RuleMetrics` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est un nombre (double). Carte contenant les métriques associées à l’évaluation de la règle en fonction des résultats au niveau des lignes. ## DataQualityResultDescription structure Décrit un résultat sur la qualité des données. **Champs** + `ResultId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de résultat unique pour ce résultat sur la qualité des données. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Nom de la table associée au résultat sur la qualité des données. + `JobName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la tâche associée au résultat en matière de qualité des données. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution de la tâche associé au résultat en matière de qualité des données. + `StartedOn` – Horodatage. Heure du début de l'exécution pour ce résultat en matière de qualité des données. ## DataQualityResultFilterCriteria structure Critères permettant de renvoyer des résultats en matière de qualité des données. **Champs** + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Filtrez les résultats en fonction de la source de données spécifiée. Par exemple, récupérer tous les résultats d'une AWS Glue table. + `JobName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Filtrez les résultats en fonction du nom de la tâche spécifiée. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Filtrez les résultats en fonction de l'ID d'exécution de la tâche spécifiée. + `StartedAfter` – Horodatage. Filtrez les résultats en fonction des exécutions qui ont débuté après cette heure. + `StartedBefore` – Horodatage. Filtrez les résultats en fonction des exécutions qui ont débuté avant cette heure. ## DataQualityRulesetFilterCriteria structure Critères permettant de filtrer les ensembles de règles de qualité des données. **Champs** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom des critères de filtrage de l'ensemble de règles. + `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 des critères de filtrage de l'ensemble de règles. + `CreatedBefore` – Horodatage. Filtre sur les ensembles de règles créés avant cette date. + `CreatedAfter` – Horodatage. Filtre sur les ensembles de règles créés après cette date. + `LastModifiedBefore` – Horodatage. Filtre sur les derniers ensembles de règles modifiés avant cette date. + `LastModifiedAfter` – Horodatage. Filtre sur les derniers ensembles de règles modifiés après cette date. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Nom et nom de la base de données de la table cible. ## DataQualityAggregatedMetrics structure Résumé des mesures indiquant le nombre total de lignes et de règles traitées, y compris leurs pass/fail statistiques basées sur les résultats au niveau des lignes. **Champs** + `TotalRowsProcessed` – Nombre (double). Nombre total de lignes traitées lors de l’évaluation de la qualité des données. + `TotalRowsPassed` – Nombre (double). Nombre total de lignes ayant satisfait à toutes les règles de qualité des données applicables. + `TotalRowsFailed` – Nombre (double). Nombre total de lignes n’ayant pas respecté une ou plusieurs règles de qualité des données. + `TotalRulesProcessed` – Nombre (double). Nombre total de règles de qualité des données qui ont été évaluées. + `TotalRulesPassed` – Nombre (double). Nombre total de règles de qualité des données qui ont satisfait à leurs critères d’évaluation. + `TotalRulesFailed` – Nombre (double). Nombre total de règles de qualité des données qui n’ont pas satisfait à leurs critères d’évaluation. ## StatisticAnnotation structure Annotation statistique. **Champs** + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `StatisticRecordedOn` – Horodatage. Horodatage de l’enregistrement de la statistique annotée. + `InclusionAnnotation` – Un objet [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation). Annotation d’inclusion appliquée à la statistique. ## TimestampedInclusionAnnotation structure Annotation d’inclusion horodatée. **Champs** + `Value`— UTF-8 chaîne (valeurs valides : `INCLUDE` \|`EXCLUDE`). Valeur de l’annotation d’inclusion. + `LastModifiedOn` – Horodatage. Horodatage de la dernière modification de l’annotation d’inclusion. ## AnnotationError structure Annotation qui a échoué. **Champs** + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de profil de l’annotation qui a échoué. + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de statistique de l’annotation qui a échoué. + `FailureReason` – 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). Raison pour laquelle l’annotation a échoué. ## DatapointInclusionAnnotation structure Annotation d’inclusion. **Champs** + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID du profil de qualité des données auquel appartient la statistique. + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `InclusionAnnotation`— UTF-8 chaîne (valeurs valides : `INCLUDE` \|`EXCLUDE`). Valeur d’annotation d’inclusion à appliquer à la statistique. ## StatisticSummaryList liste Une liste de `StatisticSummary`. Tableau d’objets [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary). Une liste de `StatisticSummary`. ## StatisticSummary structure Informations récapitulatives relatives à une statistique. **Champs** + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. + `RunIdentifier` – Un objet [RunIdentifier](#aws-glue-api-data-quality-api-RunIdentifier). Identifiant de l’exécution. + `StatisticName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Custom string pattern #16](aws-glue-api-common.md#regex_16). Nom de la statistique. + `DoubleValue` – Nombre (double). Valeur de la statistique. + `EvaluationLevel`— UTF-8 chaîne (valeurs valides : `Dataset="DATASET"` \| `Column="COLUMN"` \|`Multicolumn="MULTICOLUMN"`). Niveau d’évaluation de la statistique. Valeurs possibles :`Dataset`,`Column`,`Multicolumn`. + `ColumnsReferenced`— Un tableau de UTF-8 chaînes. Liste des colonnes référencées par la statistique. + `ReferencedDatasets`— Un tableau de UTF-8 chaînes. Liste des jeux de données référencés par la statistique. + `StatisticProperties` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est une chaîne Description, d’une longueur ne dépassant pas 2048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). `StatisticPropertiesMap`, qui contient des valeurs `NameString` et `DescriptionString`. + `RecordedOn` – Horodatage. Horodatage de l’enregistrement de la statistique. + `InclusionAnnotation` – Un objet [TimestampedInclusionAnnotation](#aws-glue-api-data-quality-api-TimestampedInclusionAnnotation). Annotation d’inclusion pour la statistique. ## RunIdentifier structure Identifiant d’exécution. **Champs** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de l’exécution. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de l’exécution de la tâche. ## StatisticModelResult structure Résultat du modèle statistique. **Champs** + `LowerBound` – Nombre (double). Limite inférieure. + `UpperBound` – Nombre (double). Limite supérieure. + `PredictedValue` – Nombre (double). Valeur prédite. + `ActualValue` – Nombre (double). Valeur réelle. + `Date` – Horodatage. Date. + `InclusionAnnotation`— UTF-8 chaîne (valeurs valides : `INCLUDE` \|`EXCLUDE`). Annotation d’inclusion. ## DataQualityGlueTable structure Base de données et table utilisées pour AWS Glue Data Catalog les données d'entrée ou de sortie pour les opérations de qualité des données. **Champs** + `DatabaseName`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 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 dans le AWS Glue Data Catalog. + `TableName`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la table dans AWS Glue Data Catalog. + `CatalogId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant unique pour AWS Glue Data Catalog. + `ConnectionName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la connexion à AWS Glue Data Catalog. + `AdditionalOptions` – Tableau de mappage de paires valeur-clé, pas moins de 1 ou plus de 10 paires.. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est une chaîne Description, d’une longueur ne dépassant pas 2048 octets, correspondant au [URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Options supplémentaires pour la table. Actuellement, deux clés sont prises en charge : + `pushDownPredicate` : pour filtrer les partitions sans avoir à répertorier ni lire tous les fichiers de votre jeu de données. + `catalogPartitionPredicate` : pour utiliser le nettoyage de partition côté serveur à l’aide des index de partition du AWS Glue Data Catalog. + `PreProcessingQuery`— UTF-8 chaîne, d'une longueur maximale de 51 200 octets, correspondant au[URI address multi-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-uri). Requête SQL au format SparkSQL qui peut être utilisée pour prétraiter les données de la table AWS Glue Data Catalog dans, avant d'exécuter l'opération de qualité des données. ## Opérations + [StartDataQualityRulesetEvaluationRun action (Python : start\_data\_quality\_ruleset\_evaluation\_run)](#aws-glue-api-data-quality-api-StartDataQualityRulesetEvaluationRun) + [CancelDataQualityRulesetEvaluationRun action (Python : cancel\_data\_quality\_ruleset\_evaluation\_run)](#aws-glue-api-data-quality-api-CancelDataQualityRulesetEvaluationRun) + [GetDataQualityRulesetEvaluationRun action (Python : get\_data\_quality\_ruleset\_evaluation\_run)](#aws-glue-api-data-quality-api-GetDataQualityRulesetEvaluationRun) + [ListDataQualityRulesetEvaluationRuns action (Python : list\_data\_quality\_ruleset\_evaluation\_runs)](#aws-glue-api-data-quality-api-ListDataQualityRulesetEvaluationRuns) + [StartDataQualityRuleRecommendationRun action (Python : start\_data\_quality\_rule\_recommendation\_run)](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRun) + [CancelDataQualityRuleRecommendationRun action (Python : cancel\_data\_quality\_rule\_recommendation\_run)](#aws-glue-api-data-quality-api-CancelDataQualityRuleRecommendationRun) + [GetDataQualityRuleRecommendationRun action (Python : get\_data\_quality\_rule\_recommendation\_run)](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRun) + [ListDataQualityRuleRecommendationRuns action (Python : list\_data\_quality\_rule\_recommendation\_runs)](#aws-glue-api-data-quality-api-ListDataQualityRuleRecommendationRuns) + [GetDataQualityResult action (Python : get\_data\_quality\_result)](#aws-glue-api-data-quality-api-GetDataQualityResult) + [BatchGetDataQualityResult action (Python : batch\_get\_data\_quality\_result)](#aws-glue-api-data-quality-api-BatchGetDataQualityResult) + [ListDataQualityResults action (Python : list\_data\_quality\_results)](#aws-glue-api-data-quality-api-ListDataQualityResults) + [CreateDataQualityRuleset action (Python : create\_data\_quality\_ruleset)](#aws-glue-api-data-quality-api-CreateDataQualityRuleset) + [DeleteDataQualityRuleset action (Python : delete\_data\_quality\_ruleset)](#aws-glue-api-data-quality-api-DeleteDataQualityRuleset) + [GetDataQualityRuleset action (Python : get\_data\_quality\_ruleset)](#aws-glue-api-data-quality-api-GetDataQualityRuleset) + [ListDataQualityRulesets action (Python : list\_data\_quality\_rulesets)](#aws-glue-api-data-quality-api-ListDataQualityRulesets) + [UpdateDataQualityRuleset action (Python : update\_data\_quality\_ruleset)](#aws-glue-api-data-quality-api-UpdateDataQualityRuleset) + [ListDataQualityStatistics action (Python : list\_data\_quality\_statistics)](#aws-glue-api-data-quality-api-ListDataQualityStatistics) + [TimestampFilter structure](#aws-glue-api-data-quality-api-TimestampFilter) + [CreateDataQualityRulesetRequest structure](#aws-glue-api-data-quality-api-CreateDataQualityRulesetRequest) + [GetDataQualityRulesetResponse structure](#aws-glue-api-data-quality-api-GetDataQualityRulesetResponse) + [GetDataQualityResultResponse structure](#aws-glue-api-data-quality-api-GetDataQualityResultResponse) + [StartDataQualityRuleRecommendationRunRequest structure](#aws-glue-api-data-quality-api-StartDataQualityRuleRecommendationRunRequest) + [GetDataQualityRuleRecommendationRunResponse structure](#aws-glue-api-data-quality-api-GetDataQualityRuleRecommendationRunResponse) + [BatchPutDataQualityStatisticAnnotation action (Python : batch\_put\_data\_quality\_statistic\_annotation)](#aws-glue-api-data-quality-api-BatchPutDataQualityStatisticAnnotation) + [GetDataQualityModel action (Python : get\_data\_quality\_model)](#aws-glue-api-data-quality-api-GetDataQualityModel) + [GetDataQualityModelResult action (Python : get\_data\_quality\_model\_result)](#aws-glue-api-data-quality-api-GetDataQualityModelResult) + [ListDataQualityStatisticAnnotations action (Python : list\_data\_quality\_statistic\_annotations)](#aws-glue-api-data-quality-api-ListDataQualityStatisticAnnotations) + [PutDataQualityProfileAnnotation action (Python : put\_data\_quality\_profile\_annotation)](#aws-glue-api-data-quality-api-PutDataQualityProfileAnnotation) ## StartDataQualityRulesetEvaluationRun action (Python : start\_data\_quality\_ruleset\_evaluation\_run) Une fois que vous avez une définition d'ensemble de règles (recommandée ou la vôtre), vous appelez cette opération pour évaluer l'ensemble de règles par rapport à une source de données (AWS Glue table). L'évaluation calcule les résultats que vous pouvez récupérer à l'aide de l'API `GetDataQualityResult`. **Demande** + `DataSource` – *Obligatoire :* un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (AWS Glue table) associée à cette exécution. + `Role`— *Obligatoire :* UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Utilisée pour l'idempotence  ; il est recommandé de la définir sur un ID aléatoire (tel qu'un UUID) afin d'éviter de créer ou de démarrer plusieurs instances de la même ressource. + `AdditionalRunOptions` – Un objet [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions). Options d'exécution supplémentaires que vous pouvez spécifier pour une exécution d'évaluation. + `RulesetNames`— *Obligatoire :* un tableau de UTF-8 chaînes, pas moins d'une ou plus de 10 chaînes. Liste de noms d'ensembles de règles. + `AdditionalDataSources` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Une carte de chaînes de référence vers des sources de données supplémentaires que vous pouvez spécifier pour une exécution d'évaluation. **Réponse** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Erreurs** + `InvalidInputException` + `EntityNotFoundException` + `OperationTimeoutException` + `InternalServiceException` + `ConflictException` ## CancelDataQualityRulesetEvaluationRun action (Python : cancel\_data\_quality\_ruleset\_evaluation\_run) Annule une exécution au cours de laquelle un ensemble de règles est évalué par rapport à une source de données. **Demande** + `RunId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Réponse** + *Paramètres d’absence de réponse.* **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## GetDataQualityRulesetEvaluationRun action (Python : get\_data\_quality\_ruleset\_evaluation\_run) Récupère une exécution spécifique au cours de laquelle un ensemble de règles est évalué par rapport à une source de données. **Demande** + `RunId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Réponse** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (une AWS Glue table) associée à cette exécution d'évaluation. + `Role`— UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `AdditionalRunOptions` – Un objet [DataQualityEvaluationRunAdditionalRunOptions](#aws-glue-api-data-quality-api-DataQualityEvaluationRunAdditionalRunOptions). Options d'exécution supplémentaires que vous pouvez spécifier pour une exécution d'évaluation. + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `FINISHED` \| `FAILED` \| `PENDING_EXECUTION` \| `TIMED_OUT` \| `CANCELING` \| `CANCELED` \|`RECEIVED_BY_TASKRUNNER`). Statut de cette exécution. + `ErrorString`— UTF-8 chaîne. Chaînes d'erreur associées à l'exécution. + `StartedOn` – Horodatage. Date et heure de lancement de cette exécution. + `LastModifiedOn` – Horodatage. Horodatage. Dernier moment où cette exécution de recommandation de règle de qualité des données a été modifiée. + `CompletedOn` – Horodatage. Date et heure de fin de cette exécution. + `ExecutionTime` : nombre (entier). Durée (en secondes) pendant laquelle l'exécution a consommé des ressources. + `RulesetNames`— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes. Liste des noms des ensembles de règles utilisés pour l'exécution. Actuellement, ce paramètre ne peut avoir qu’un seul nom d’ensemble de règles. + `ResultIds`— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 10 chaînes. Liste des ID des résultats en matière de qualité des données pour l'exécution. + `AdditionalDataSources` – Tableau de mappage de paires valeur-clé. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets correspondant à[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Chaque valeur est un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Une carte de chaînes de référence vers des sources de données supplémentaires que vous pouvez spécifier pour une exécution d'évaluation. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## ListDataQualityRulesetEvaluationRuns action (Python : list\_data\_quality\_ruleset\_evaluation\_runs) Répertorie l'ensemble des exécutions répondant aux critères de filtrage, lorsqu'un ensemble de règles est évalué par rapport à une source de données. **Demande** + `Filter` – Un objet [DataQualityRulesetEvaluationRunFilter](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunFilter). Critères de filtrage. + `NextToken`— UTF-8 chaîne. Jeton de pagination pour décaler les résultats. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer. **Réponse** + `Runs` : un tableau d’objets [DataQualityRulesetEvaluationRunDescription](#aws-glue-api-data-quality-api-DataQualityRulesetEvaluationRunDescription). Liste d'objets `DataQualityRulesetEvaluationRunDescription` représentant les exécutions d'un ensemble de règles en matière de qualité des données. + `NextToken`— UTF-8 chaîne. Un jeton de pagination, si d'autres résultats sont disponibles. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## StartDataQualityRuleRecommendationRun action (Python : start\_data\_quality\_rule\_recommendation\_run) Lance une série de recommandations qui est utilisée pour générer des règles lorsque vous ne savez pas quelles règles écrire. AWS Glue Data Quality analyse les données et formule des recommandations pour un ensemble de règles potentiel. Vous pouvez ensuite trier l'ensemble de règles et modifier l'ensemble de règles généré selon votre convenance. Les exécutions de recommandations sont automatiquement supprimées après 90 jours. **Demande** La demande de recommandation d’une règle de qualité des données. + `DataSource` – *Obligatoire :* un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (AWS Glue table) associée à cette exécution. + `Role`— *Obligatoire :* UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `CreatedRulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Utilisée pour l'idempotence  ; il est recommandé de la définir sur un ID aléatoire (tel qu'un UUID) afin d'éviter de créer ou de démarrer plusieurs instances de la même ressource. **Réponse** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `ConflictException` ## CancelDataQualityRuleRecommendationRun action (Python : cancel\_data\_quality\_rule\_recommendation\_run) Annule l'exécution de recommandation spécifiée qui était utilisée pour générer des règles. **Demande** + `RunId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Réponse** + *Paramètres d’absence de réponse.* **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## GetDataQualityRuleRecommendationRun action (Python : get\_data\_quality\_rule\_recommendation\_run) Obtient l'exécution de recommandation spécifiée qui a été utilisée pour générer des règles. **Demande** + `RunId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. **Réponse** La réponse à l’exécution de la recommandation d’une règle de qualité des données. + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (une AWS Glue table) associée à cette exécution. + `Role`— UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `FINISHED` \| `FAILED` \| `PENDING_EXECUTION` \| `TIMED_OUT` \| `CANCELING` \| `CANCELED` \|`RECEIVED_BY_TASKRUNNER`). Statut de cette exécution. + `ErrorString`— UTF-8 chaîne. Chaînes d'erreur associées à l'exécution. + `StartedOn` – Horodatage. Date et heure de lancement de cette exécution. + `LastModifiedOn` – Horodatage. Horodatage. Dernier moment où cette exécution de recommandation de règle de qualité des données a été modifiée. + `CompletedOn` – Horodatage. Date et heure de fin de cette exécution. + `ExecutionTime` : nombre (entier). Durée (en secondes) pendant laquelle l'exécution a consommé des ressources. + `RecommendedRuleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. À la fin de l'exécution d'une recommandation de règle de démarrage, un ensemble de règles recommandé est créé. Ce membre dispose de ces règles au format DQDL (Data Quality Definition Language). + `CreatedRulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles créé par l'exécution. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## ListDataQualityRuleRecommendationRuns action (Python : list\_data\_quality\_rule\_recommendation\_runs) Répertorie les exécutions de recommandation répondant aux critères de filtrage. **Demande** + `Filter` – Un objet [DataQualityRuleRecommendationRunFilter](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunFilter). Critères de filtrage. + `NextToken`— UTF-8 chaîne. Jeton de pagination pour décaler les résultats. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer. **Réponse** + `Runs` : un tableau d’objets [DataQualityRuleRecommendationRunDescription](#aws-glue-api-data-quality-api-DataQualityRuleRecommendationRunDescription). Liste d’objets `DataQualityRuleRecommendationRunDescription`. + `NextToken`— UTF-8 chaîne. Un jeton de pagination, si d'autres résultats sont disponibles. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## GetDataQualityResult action (Python : get\_data\_quality\_result) Récupère le résultat d'une évaluation des règles de qualité des données. **Demande** + `ResultId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de résultat unique pour le résultat en matière de qualité des données. **Réponse** La réponse pour le résultat en matière de qualité des données. + `ResultId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de résultat unique pour le résultat en matière de qualité des données. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil pour le résultat en matière de qualité des données. + `Score` – Nombre (double), au plus égal à 1,0. Score de qualité des données agrégées. Représente le rapport entre le nombre de règles transmises et le nombre total de règles. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Table associée au résultat sur la qualité des données, le cas échéant. + `RulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles associé au résultat sur la qualité des données. + `EvaluationContext`— UTF-8 chaîne. Dans le contexte d'une tâche dans AWS Glue Studio, chaque nœud du canevas se voit généralement attribuer un nom et les nœuds de qualité des données porteront un nom. Dans le cas de plusieurs nœuds, `evaluationContext` peut distinguer les nœuds. + `StartedOn` – Horodatage. Date et heure du début de l'exécution de ce résultat en matière de qualité des données. + `CompletedOn` – Horodatage. Date et heure de fin de l'exécution de ce résultat en matière de qualité des données. + `JobName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de tâche associé au résultat sur la qualité des données, le cas échéant. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution de la tâche associé au résultat sur la qualité des données, le cas échéant. + `RulesetEvaluationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution unique associé à l'évaluation de l'ensemble de règles. + `RuleResults` – Un tableau d’objets [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), 2 000 structures au maximum. Liste d'objets `DataQualityRuleResult` représentant les résultats de chaque règle. + `AnalyzerResults` – Un tableau d’objets [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), 2 000 structures au maximum. Liste d’objets `DataQualityAnalyzerResult` représentant les résultats de chaque analyseur. + `Observations` – Un tableau d'objets [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation), 50 structures maximum. Liste d’objets `DataQualityObservation` représentant les observations générées après évaluation des règles et des analyseurs. + `AggregatedMetrics` – Un objet [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics). Récapitulatif des `DataQualityAggregatedMetrics` objets indiquant le nombre total de lignes et de règles traitées, y compris leurs pass/fail statistiques basées sur les résultats au niveau des lignes. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `EntityNotFoundException` ## BatchGetDataQualityResult action (Python : batch\_get\_data\_quality\_result) Récupère la liste des résultats en matière de qualité des données pour les ID de résultat spécifiés. **Demande** + `ResultIds`— *Obligatoire :* un tableau de UTF-8 chaînes, pas moins d'une ou plus de 100 chaînes. Liste d'ID de résultat uniques pour les résultats en matière de qualité des données. **Réponse** + `Results` – *Obligatoire :* un tableau d’objets [DataQualityResult](#aws-glue-api-data-quality-api-DataQualityResult). Liste d'objets `DataQualityResult` représentant les résultats en matière de qualité des données. + `ResultsNotFound`— Un tableau de UTF-8 chaînes comprenant au moins 1 ou au plus 100 chaînes. Liste d'ID de résultats pour lesquels aucun résultat n'a été trouvé. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## ListDataQualityResults action (Python : list\_data\_quality\_results) Renvoie tous les résultats d'exécution en matière de qualité des données pour votre compte. **Demande** + `Filter` – Un objet [DataQualityResultFilterCriteria](#aws-glue-api-data-quality-api-DataQualityResultFilterCriteria). Critères de filtrage. + `NextToken`— UTF-8 chaîne. Jeton de pagination pour décaler les résultats. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer. **Réponse** + `Results` – *Obligatoire :* un tableau d’objets [DataQualityResultDescription](#aws-glue-api-data-quality-api-DataQualityResultDescription). Liste d’objets `DataQualityResultDescription`. + `NextToken`— UTF-8 chaîne. Un jeton de pagination, si d'autres résultats sont disponibles. **Erreurs** + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## CreateDataQualityRuleset action (Python : create\_data\_quality\_ruleset) Crée un ensemble de règles de qualité des données avec des règles DQDL appliquées à une table spécifiée AWS Glue . Vous créez l'ensemble de règles au format DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. **Demande** Demande de création d’un ensemble de règles de qualité des données. + `Name`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom unique de l'ensemble de règles de qualité des données. + `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 l'ensemble de règles de qualité des données. + `Ruleset`— *Obligatoire :* UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 65 536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. + `Tags` – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets. Chaque valeur est une UTF-8 chaîne dont la longueur ne dépasse pas 256 octets. Liste de balises appliquées à l'ensemble de règles de qualité des données. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Table cible associée à l'ensemble de règles de qualité des données. + `RecommendationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution unique pour l'exécution recommandée. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Utilisée pour l'idempotence  ; il est recommandé de la définir sur un ID aléatoire (tel qu'un UUID) afin d'éviter de créer ou de démarrer plusieurs instances de la même ressource. **Réponse** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom unique de l'ensemble de règles de qualité des données. **Erreurs** + `InvalidInputException` + `AlreadyExistsException` + `OperationTimeoutException` + `InternalServiceException` + `ResourceNumberLimitExceededException` ## DeleteDataQualityRuleset action (Python : delete\_data\_quality\_ruleset) Supprime un ensemble de règles de qualité des données. **Demande** + `Name`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles de qualité des données. **Réponse** + *Paramètres d’absence de réponse.* **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## GetDataQualityRuleset action (Python : get\_data\_quality\_ruleset) Renvoie un ensemble de règles existant par identifiant ou nom. **Demande** + `Name`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de l'ensemble de règles. **Réponse** Renvoie la réponse de l’ensemble de règles de qualité des données. + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de l'ensemble de règles. + `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 l'ensemble de règles. + `Ruleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Nom et nom de la base de données de la table cible. + `CreatedOn` – Horodatage. Horodatage. Date et heure de création de cet ensemble de règles de qualité des données. + `LastModifiedOn` – Horodatage. Horodatage. Dernier moment où cet ensemble de règles de qualité des données a été modifié. + `RecommendationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Lors de la création d'un ensemble de règles à partir d'une exécution de recommandation, cet ID d'exécution est généré pour relier les deux. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## ListDataQualityRulesets action (Python : list\_data\_quality\_rulesets) Renvoie une liste paginée d'ensembles de règles pour la liste de tables spécifiée. AWS Glue **Demande** + `NextToken`— UTF-8 chaîne. Jeton de pagination pour décaler les résultats. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer. + `Filter` – Un objet [DataQualityRulesetFilterCriteria](#aws-glue-api-data-quality-api-DataQualityRulesetFilterCriteria). Critères de filtrage. + `Tags` – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets. Chaque valeur est une UTF-8 chaîne dont la longueur ne dépasse pas 256 octets. Liste de balises de paire clé-valeur. **Réponse** + `Rulesets` : un tableau d’objets [DataQualityRulesetListDetails](#aws-glue-api-data-quality-api-DataQualityRulesetListDetails). Liste paginée d'ensembles de règles pour la liste de tables spécifiée. AWS Glue + `NextToken`— UTF-8 chaîne. Un jeton de pagination, si d'autres résultats sont disponibles. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## UpdateDataQualityRuleset action (Python : update\_data\_quality\_ruleset) Met à jour l'ensemble de règles de qualité des données spécifié. **Demande** + `Name`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles de qualité des données. + `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 l'ensemble de règles. + `Ruleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. **Réponse** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles de qualité des données. + `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 l'ensemble de règles. + `Ruleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. **Erreurs** + `EntityNotFoundException` + `AlreadyExistsException` + `IdempotentParameterMismatchException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` + `ResourceNumberLimitExceededException` ## ListDataQualityStatistics action (Python : list\_data\_quality\_statistics) Récupère la liste des statistiques de qualité des données. **Demande** + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. + `TimestampFilter` – Un objet [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter). Un filtre d’horodatage. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer dans cette demande. + `NextToken`— UTF-8 chaîne. Un jeton de pagination pour demander la page de résultats suivante. **Réponse** + `Statistics` : un tableau d’objets [StatisticSummary](#aws-glue-api-data-quality-api-StatisticSummary). Une `StatisticSummaryList`. + `NextToken`— UTF-8 chaîne. Un jeton de pagination pour demander la page de résultats suivante. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` ## TimestampFilter structure Un filtre d’horodatage. **Champs** + `RecordedBefore` – Horodatage. Horodatage avant lequel les statistiques doivent être incluses dans les résultats. + `RecordedAfter` – Horodatage. Horodatage après lequel les statistiques doivent être incluses dans les résultats. ## CreateDataQualityRulesetRequest structure Demande de création d’un ensemble de règles de qualité des données. **Champs** + `Name`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom unique de l'ensemble de règles de qualité des données. + `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 l'ensemble de règles de qualité des données. + `Ruleset`— *Obligatoire :* UTF-8 chaîne d'une longueur d'au moins 1 octet ou supérieure à 65 536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. + `Tags` – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum. Chaque clé est une UTF-8 chaîne d'au moins 1 octet ou d'au plus 128 octets. Chaque valeur est une UTF-8 chaîne dont la longueur ne dépasse pas 256 octets. Liste de balises appliquées à l'ensemble de règles de qualité des données. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Table cible associée à l'ensemble de règles de qualité des données. + `RecommendationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution unique pour l'exécution recommandée. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Utilisée pour l'idempotence  ; il est recommandé de la définir sur un ID aléatoire (tel qu'un UUID) afin d'éviter de créer ou de démarrer plusieurs instances de la même ressource. ## GetDataQualityRulesetResponse structure Renvoie la réponse de l’ensemble de règles de qualité des données. **Champs** + `Name`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de l'ensemble de règles. + `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 l'ensemble de règles. + `Ruleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. Ensemble de règles DQDL (Data Quality Definition Language). Pour plus d'informations, consultez le guide du AWS Glue développeur. + `TargetTable` – Un objet [DataQualityTargetTable](#aws-glue-api-data-quality-api-DataQualityTargetTable). Nom et nom de la base de données de la table cible. + `CreatedOn` – Horodatage. Horodatage. Date et heure de création de cet ensemble de règles de qualité des données. + `LastModifiedOn` – Horodatage. Horodatage. Dernier moment où cet ensemble de règles de qualité des données a été modifié. + `RecommendationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Lors de la création d'un ensemble de règles à partir d'une exécution de recommandation, cet ID d'exécution est généré pour relier les deux. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. ## GetDataQualityResultResponse structure La réponse pour le résultat en matière de qualité des données. **Champs** + `ResultId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID de résultat unique pour le résultat en matière de qualité des données. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil pour le résultat en matière de qualité des données. + `Score` – Nombre (double), au plus égal à 1,0. Score de qualité des données agrégées. Représente le rapport entre le nombre de règles transmises et le nombre total de règles. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). Table associée au résultat sur la qualité des données, le cas échéant. + `RulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles associé au résultat sur la qualité des données. + `EvaluationContext`— UTF-8 chaîne. Dans le contexte d'une tâche dans AWS Glue Studio, chaque nœud du canevas se voit généralement attribuer un nom et les nœuds de qualité des données porteront un nom. Dans le cas de plusieurs nœuds, `evaluationContext` peut distinguer les nœuds. + `StartedOn` – Horodatage. Date et heure du début de l'exécution de ce résultat en matière de qualité des données. + `CompletedOn` – Horodatage. Date et heure de fin de l'exécution de ce résultat en matière de qualité des données. + `JobName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Le nom de tâche associé au résultat sur la qualité des données, le cas échéant. + `JobRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution de la tâche associé au résultat sur la qualité des données, le cas échéant. + `RulesetEvaluationRunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID d'exécution unique associé à l'évaluation de l'ensemble de règles. + `RuleResults` – Un tableau d’objets [DataQualityRuleResult](#aws-glue-api-data-quality-api-DataQualityRuleResult), 2 000 structures au maximum. Liste d'objets `DataQualityRuleResult` représentant les résultats de chaque règle. + `AnalyzerResults` – Un tableau d’objets [DataQualityAnalyzerResult](#aws-glue-api-data-quality-api-DataQualityAnalyzerResult), 2 000 structures au maximum. Liste d’objets `DataQualityAnalyzerResult` représentant les résultats de chaque analyseur. + `Observations` – Un tableau d'objets [DataQualityObservation](#aws-glue-api-data-quality-api-DataQualityObservation), 50 structures maximum. Liste d’objets `DataQualityObservation` représentant les observations générées après évaluation des règles et des analyseurs. + `AggregatedMetrics` – Un objet [DataQualityAggregatedMetrics](#aws-glue-api-data-quality-api-DataQualityAggregatedMetrics). Récapitulatif des `DataQualityAggregatedMetrics` objets indiquant le nombre total de lignes et de règles traitées, y compris leurs pass/fail statistiques basées sur les résultats au niveau des lignes. ## StartDataQualityRuleRecommendationRunRequest structure La demande de recommandation d’une règle de qualité des données. **Champs** + `DataSource` – *Obligatoire :* un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (AWS Glue table) associée à cette exécution. + `Role`— *Obligatoire :* UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `CreatedRulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Utilisée pour l'idempotence  ; il est recommandé de la définir sur un ID aléatoire (tel qu'un UUID) afin d'éviter de créer ou de démarrer plusieurs instances de la même ressource. ## GetDataQualityRuleRecommendationRunResponse structure La réponse à l’exécution de la recommandation d’une règle de qualité des données. **Champs** + `RunId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Identifiant d’exécution unique associé à cette exécution. + `DataSource` – Un objet [DataSource](#aws-glue-api-data-quality-api-DataSource). La source de données (une AWS Glue table) associée à cette exécution. + `Role`— UTF-8 chaîne. IAM Rôle fourni pour chiffrer les résultats de l'exécution. + `NumberOfWorkers` : nombre (entier). Nombre d'employés `G.1X` à utiliser dans l'exécution. La valeur par défaut est 5. + `Timeout` – Nombre (entier), au moins égal à 1. Délai d'expiration d'une exécution en minutes. Durée maximale pendant laquelle une exécution peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état `TIMEOUT`. La valeur par défaut est de 2 880 minutes (48 heures). + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `FINISHED` \| `FAILED` \| `PENDING_EXECUTION` \| `TIMED_OUT` \| `CANCELING` \| `CANCELED` \|`RECEIVED_BY_TASKRUNNER`). Statut de cette exécution. + `ErrorString`— UTF-8 chaîne. Chaînes d'erreur associées à l'exécution. + `StartedOn` – Horodatage. Date et heure de lancement de cette exécution. + `LastModifiedOn` – Horodatage. Horodatage. Dernier moment où cette exécution de recommandation de règle de qualité des données a été modifiée. + `CompletedOn` – Horodatage. Date et heure de fin de cette exécution. + `ExecutionTime` : nombre (entier). Durée (en secondes) pendant laquelle l'exécution a consommé des ressources. + `RecommendedRuleset`— UTF-8 chaîne d'au moins 1 octet ou supérieure à 65536 octets. À la fin de l'exécution d'une recommandation de règle de démarrage, un ensemble de règles recommandé est créé. Ce membre dispose de ces règles au format DQDL (Data Quality Definition Language). + `CreatedRulesetName`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de l'ensemble de règles créé par l'exécution. + `DataQualitySecurityConfiguration`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Nom de la configuration de sécurité créée avec l’option de chiffrement de la qualité des données. ## BatchPutDataQualityStatisticAnnotation action (Python : batch\_put\_data\_quality\_statistic\_annotation) Annotez les points de données au fil du temps pour une statistique de qualité des données spécifique. L'API nécessite à la fois ProfileID et StatisticID dans le cadre de l'entrée. InclusionAnnotation L’API ne fonctionne que pour un seul élément statisticId sur plusieurs profils. **Demande** + `InclusionAnnotations` – *Obligatoire :* un tableau d’objets [DatapointInclusionAnnotation](#aws-glue-api-data-quality-api-DatapointInclusionAnnotation). Une liste de `DatapointInclusionAnnotation`. Ils InclusionAnnotations doivent contenir un ProfileID et un StatisticID. S'il y en a plusieurs InclusionAnnotations, la liste doit faire référence à un seul StatisticID pour plusieurs ProfileID. + `ClientToken`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Jeton client. **Réponse** + `FailedInclusionAnnotations` : un tableau d’objets [AnnotationError](#aws-glue-api-data-quality-api-AnnotationError). Une liste de `AnnotationError`. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException` + `ResourceNumberLimitExceededException` ## GetDataQualityModel action (Python : get\_data\_quality\_model) Récupérez l'état d'entraînement du modèle ainsi que des informations supplémentaires (CompletedOn, StartedOn, FailureReason). **Demande** + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `ProfileId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. **Réponse** + `Status`— UTF-8 chaîne (valeurs valides : `RUNNING` \| `SUCCEEDED` \|`FAILED`). Statut d’entraînement du modèle de qualité des données. + `StartedOn` – Horodatage. Horodatage du début de l’entraînement des modèles de qualité des données. + `CompletedOn` – Horodatage. Horodatage de l’achèvement de l’entraînement des modèles de qualité des données. + `FailureReason`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). Motif de l’échec de l’entraînement. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## GetDataQualityModelResult action (Python : get\_data\_quality\_model\_result) Récupérez les prédictions d’une statistique pour un ID de profil donné. **Demande** + `StatisticId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `ProfileId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. **Réponse** + `CompletedOn` – Horodatage. Horodatage de l’achèvement de l’entraînement des modèles de qualité des données. + `Model` : un tableau d’objets [StatisticModelResult](#aws-glue-api-data-quality-api-StatisticModelResult). Liste de `StatisticModelResult`. **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `OperationTimeoutException` + `InternalServiceException` ## ListDataQualityStatisticAnnotations action (Python : list\_data\_quality\_statistic\_annotations) Récupérez les annotations d’une statistique de qualité des données. **Demande** + `StatisticId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de statistique. + `ProfileId`— UTF-8 chaîne, d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). L’ID de profil. + `TimestampFilter` – Un objet [TimestampFilter](#aws-glue-api-data-quality-api-TimestampFilter). Un filtre d’horodatage. + `MaxResults` – Nombre (entier), compris entre 1 et 1 000. Nombre maximal de résultats à renvoyer dans cette demande. + `NextToken`— UTF-8 chaîne. Jeton de pagination permettant de récupérer l’ensemble suivant de résultats. **Réponse** + `Annotations` : un tableau d’objets [StatisticAnnotation](#aws-glue-api-data-quality-api-StatisticAnnotation). Liste de `StatisticAnnotation` appliquées à la statistique + `NextToken`— UTF-8 chaîne. Jeton de pagination permettant de récupérer l’ensemble suivant de résultats. **Erreurs** + `InvalidInputException` + `InternalServiceException` ## PutDataQualityProfileAnnotation action (Python : put\_data\_quality\_profile\_annotation) Annotez tous les points de données d’un profil. **Demande** + `ProfileId`— *Obligatoire :* UTF-8 chaîne d'au moins 1 octet ou d'au plus 255 octets, correspondant au[Single-line string pattern](aws-glue-api-common.md#aws-glue-api-regex-oneLine). ID du profil de surveillance de la qualité des données à annoter. + `InclusionAnnotation`— *Obligatoire :* UTF-8 chaîne (valeurs valides : `INCLUDE` \|`EXCLUDE`). Valeur d’annotation d’inclusion à appliquer au profil. **Réponse** + *Paramètres d’absence de réponse.* **Erreurs** + `EntityNotFoundException` + `InvalidInputException` + `InternalServiceException`