View a markdown version of this page

API de statistiques de colonne - AWS Glue

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 de statistiques de colonne

L'API de statistiques de colonne décrit les AWS Glue API permettant de renvoyer des statistiques sur les colonnes d'un tableau.

Types de données

ColumnStatisticsTaskRun structure

L'objet qui affiche les détails de l'exécution des statistiques de colonne.

Champs
  • CustomerId— UTF-8 chaîne ne dépassant pas 12 octets.

    L'identifiant AWS du compte.

  • ColumnStatisticsTaskRunId— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    L'identifiant d'exécution de la tâche de statistiques de colonne particulière.

  • DatabaseName— UTF-8 ficelle.

    La base de données où réside la table.

  • TableName— UTF-8 ficelle.

    Le nom de la table pour laquelle les statistiques de colonne sont générées.

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

    Une liste des noms de colonnes. Si aucun nom n'est fourni, tous les noms de colonnes de la table seront utilisés par défaut.

  • CatalogID – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données où réside la table. Si aucun élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

  • Role— UTF-8 ficelle.

    Le rôle IAM que le service assume pour générer des statistiques.

  • SampleSize – Nombre (double), 100 au maximum.

    Pourcentage de lignes utilisées pour générer des statistiques. Si aucun nom n'est fourni, la table entière sera utilisée pour générer des statistiques.

  • SecurityConfiguration— UTF-8 chaîne ne dépassant pas 128 octets.

    Nom de la configuration de sécurité utilisée pour chiffrer les CloudWatch journaux pour la tâche de statistiques de colonne exécutée.

  • NumberOfWorkers – Nombre (entier), au moins égal à 1.

    Le nombre d'employés utilisés pour générer les statistiques de colonne. La tâche est préconfigurée pour effectuer une mise à l'échelle automatique jusqu'à 25 instances.

  • WorkerType— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Type de travailleurs utilisés pour générer des statistiques. La valeur par défaut est g.1x.

  • ComputationType— UTF-8 chaîne (valeurs valides : FULL |INCREMENTAL).

    Type de calcul de statistiques de colonne.

  • Status— UTF-8 chaîne (valeurs valides : STARTING | RUNNING | SUCCEEDED | FAILED |STOPPED).

    L'état d'exécution de la tâche.

  • CreationTime – Horodatage.

    Heure à laquelle cette tâche a été créée.

  • LastUpdated – Horodatage.

    Dernier moment où cette tâche a été modifiée.

  • StartTime – Horodatage.

    L'heure de début de la tâche.

  • EndTime – Horodatage.

    L'heure de fin de la tâche.

  • ErrorMessage – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

    Le message d'erreur pour la tâche.

  • DPUSeconds – Nombre (double).

    L'utilisation de la DPU calculée en secondes pour tous les travailleurs mis à l'échelle automatique.

ColumnStatisticsTaskSettings structure

Paramètres d’une tâche de statistiques de colonne.

Champs
  • DatabaseName— UTF-8 ficelle.

    Le nom de la base de données où réside la table.

  • TableName— UTF-8 ficelle.

    Nom de la table pour laquelle les statistiques de colonne sont générées.

  • Schedule – Un objet Planificateur.

    Calendrier d’exécution des statistiques de colonne, spécifié dans la syntaxe CRON.

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

    Liste des noms de colonnes pour lesquelles les statistiques doivent être exécutées.

  • CatalogID – Chaîne d’ID de catalogue, d’une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la base de données.

  • Role— UTF-8 ficelle.

    Rôle utilisé pour l’exécution des statistiques de colonne.

  • SampleSize – Nombre (double), 100 au maximum.

    Pourcentage de données à échantillonner.

  • SecurityConfiguration— UTF-8 chaîne ne dépassant pas 128 octets.

    Nom de la configuration de sécurité utilisée pour chiffrer les CloudWatch journaux.

  • ScheduleType— UTF-8 chaîne (valeurs valides : CRON |AUTO).

    Type de planification pour une tâche de statistiques de colonne. Les valeurs possibles peuvent être CRON ou AUTO.

  • SettingSource— UTF-8 chaîne (valeurs valides : CATALOG |TABLE).

    Source de définition de la tâche de statistiques de colonne. Les valeurs possibles peuvent être CATALOG ou TABLE.

  • LastExecutionAttempt : un objet ExecutionAttempt.

    Dernière ExecutionAttempt pour l’exécution de la tâche de statistiques de colonne.

ExecutionAttempt structure

Tentative d’exécution d’une tâche de statistiques de colonne.

Champs
  • Status— UTF-8 chaîne (valeurs valides : FAILED |STARTED).

    Statut d’exécution de la dernière tâche de statistiques de colonne.

  • ColumnStatisticsTaskRunId— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Identifiant d’exécution de tâche de la dernière exécution de tâche de statistiques de colonne.

  • ExecutionTimestamp – Horodatage.

    Horodatage de la dernière exécution de tâche de statistiques de colonne.

  • ErrorMessage – Chaîne de description, d’une longueur maximale de 2 048 octets, correspondant au URI address multi-line string pattern.

    Message d’erreur associé à la dernière exécution de tâche de statistiques de colonne.

Opérations

StartColumnStatisticsTaskRun action (Python : start_column_statistics_task_run)

Démarre une exécution de tâche de statistiques de colonne pour une table et des colonnes spécifiées.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la table pour générer des statistiques.

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

    Une liste des noms de colonnes pour générer des statistiques. Si aucun nom n'est fourni, tous les noms de colonnes de la table seront utilisés par défaut.

  • Role Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le rôle IAM que le service assume pour générer des statistiques.

  • SampleSize – Nombre (double), 100 au maximum.

    Pourcentage de lignes utilisées pour générer des statistiques. Si aucun nom n'est fourni, la table entière sera utilisée pour générer des statistiques.

  • CatalogID— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    L'ID du catalogue de données où réside la table. Si aucun nom n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • SecurityConfiguration— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la configuration de sécurité utilisée pour chiffrer les CloudWatch journaux pour la tâche de statistiques de colonne exécutée.

Réponse
  • ColumnStatisticsTaskRunId— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    L'identifiant d'exécution de la tâche de statistiques de colonne.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • ColumnStatisticsTaskRunningException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • InvalidInputException

GetColumnStatisticsTaskRun action (Python : get_column_statistics_task_run)

Obtenez les informations associées à metadata/information l'exécution d'une tâche, en fonction de l'ID d'exécution de la tâche.

Demande
  • ColumnStatisticsTaskRunId Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    L'identifiant d'exécution de la tâche de statistiques de colonne particulière.

Réponse
  • ColumnStatisticsTaskRun – Un objet ColumnStatisticsTaskRun.

    Un objet ColumnStatisticsTaskRun représentant les détails de l'exécution des statistiques de colonne.

Erreurs
  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

GetColumnStatisticsTaskRuns action (Python : get_column_statistics_task_runs)

Récupère des informations sur toutes les exécutions associées à la table spécifiée.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table.

  • MaxResults – Nombre (entier), compris entre 1 et 1 000.

    Taille maximale de la réponse.

  • NextToken— UTF-8 ficelle.

    Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse
  • ColumnStatisticsTaskRuns : un tableau d’objets ColumnStatisticsTaskRun.

    Une liste des exécutions de tâches de statistiques de colonne.

  • NextToken— UTF-8 ficelle.

    Un jeton de continuation, si toutes les exécutions de tâches n'ont pas encore été renvoyées.

Erreurs
  • OperationTimeoutException

ListColumnStatisticsTaskRuns action (Python : list_column_statistics_task_runs)

Répertoriez toutes les exécutions de tâches pour un compte spécifique.

Demande
  • MaxResults – Nombre (entier), compris entre 1 et 1 000.

    Taille maximale de la réponse.

  • NextToken— UTF-8 ficelle.

    Jeton de continuation, s’il s’agit d’un appel de continuation.

Réponse
  • ColumnStatisticsTaskRunIds— Tableau de UTF-8 chaînes, pas plus de 100 chaînes.

    Une liste d'ID d'exécution de tâches de statistiques de colonne.

  • NextToken— UTF-8 ficelle.

    Un jeton de continuation, si toutes les ID d'exécution de tâches n'ont pas encore été renvoyées.

Erreurs
  • OperationTimeoutException

StopColumnStatisticsTaskRun action (Python : stop_column_statistics_task_run)

Arrête l'exécution d'une tâche pour la table spécifiée.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • EntityNotFoundException

  • ColumnStatisticsTaskNotRunningException

  • ColumnStatisticsTaskStoppingException

  • OperationTimeoutException

CreateColumnStatisticsTaskSettings action (Python : create_column_statistics_task_settings)

Crée les paramètres d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle les statistiques de colonne sont générées.

  • Role Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Rôle utilisé pour l’exécution des statistiques de colonne.

  • Schedule— UTF-8 ficelle.

    Calendrier d’exécution des statistiques de colonne, spécifié dans la syntaxe CRON.

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

    Liste des noms de colonnes pour lesquelles les statistiques doivent être exécutées.

  • SampleSize – Nombre (double), 100 au maximum.

    Pourcentage de données à échantillonner.

  • CatalogID— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    ID du catalogue de données dans lequel réside la base de données.

  • SecurityConfiguration— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la configuration de sécurité utilisée pour chiffrer les CloudWatch journaux.

  • Tags – Tableau de mappage de paires clé-valeur, avec 50 paires au maximum.

    Chaque clé est une UTF-8 chaîne d'une longueur d'au moins 1 et d'au plus 128 octets.

    Chaque valeur est une UTF-8 chaîne ne dépassant pas 256 octets.

    Carte de balises.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • AlreadyExistsException

  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ColumnStatisticsTaskRunningException

UpdateColumnStatisticsTaskSettings action (Python : update_column_statistics_task_settings)

Met à jour les paramètres d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle les statistiques de colonne sont générées.

  • Role— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Rôle utilisé pour l’exécution des statistiques de colonne.

  • Schedule— UTF-8 ficelle.

    Calendrier d’exécution des statistiques de colonne, spécifié dans la syntaxe CRON.

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

    Liste des noms de colonnes pour lesquelles les statistiques doivent être exécutées.

  • SampleSize – Nombre (double), 100 au maximum.

    Pourcentage de données à échantillonner.

  • CatalogID— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    ID du catalogue de données dans lequel réside la base de données.

  • SecurityConfiguration— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la configuration de sécurité utilisée pour chiffrer les CloudWatch journaux.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • VersionMismatchException

  • OperationTimeoutException

GetColumnStatisticsTaskSettings action (Python : get_column_statistics_task_settings)

Obtient les paramètres d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle les statistiques de colonne sont extraites.

Réponse
  • ColumnStatisticsTaskSettings – Un objet ColumnStatisticsTaskSettings.

    Objet ColumnStatisticsTaskSettings représentant les paramètres de la tâche de statistiques de colonne.

Erreurs
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

DeleteColumnStatisticsTaskSettings action (Python : delete_column_statistics_task_settings)

Supprime les paramètres d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle les statistiques de colonne sont supprimées.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

StartColumnStatisticsTaskRunSchedule action (Python : start_column_statistics_task_run_schedule)

Démarre la planification d’exécution d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle un calendrier d’exécution des tâches de statistiques de colonne doit être lancé.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

StopColumnStatisticsTaskRunSchedule action (Python : stop_column_statistics_task_run_schedule)

Arrête un calendrier d’exécution d’une tâche de statistiques de colonne.

Demande
  • DatabaseName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Le nom de la base de données où réside la table.

  • TableName Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

    Nom de la table pour laquelle un calendrier d’exécution des tâches de statistiques de colonne doit être arrêté.

Réponse
  • Paramètres d’absence de réponse.

Erreurs
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

Exceptions

ColumnStatisticsTaskRunningException structure

Exception renvoyée lorsque vous essayez de démarrer une autre tâche lors de l'exécution d'une tâche de génération de statistiques de colonne.

Champs
  • Message— UTF-8 ficelle.

    Un message décrivant le problème.

ColumnStatisticsTaskNotRunningException structure

Exception renvoyée lorsque vous essayez d'arrêter l'exécution d'une tâche alors qu'aucune tâche n'est en cours d'exécution.

Champs
  • Message— UTF-8 ficelle.

    Un message décrivant le problème.

ColumnStatisticsTaskStoppingException structure

Exception renvoyée lorsque vous essayez d'arrêter l'exécution d'une tâche.

Champs
  • Message— UTF-8 ficelle.

    Un message décrivant le problème.

ColumnStatisticsTaskAutoConcurrencyLimitException structure

Une exception est déclenchée lorsque vous avez déjà atteint la limite des tâches de statistiques automatiques simultanées.

Champs
  • Message— UTF-8 ficelle.

    Un message décrivant le problème.

InvalidCatalogSettingException structure

Une exception déclenchée en cas de problème avec les paramètres du catalogue.

Champs
  • Message— UTF-8 ficelle.

    Un message décrivant le problème.