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 API AWS Glue permettant de renvoyer des statistiques sur des colonnes dans une table.

Types de données

Structure ColumnStatisticsTaskRun

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

Champs
  • CustomerId – Chaîne UTF-8, d'une longueur maximale de 12 octets.

    L'ID de compte AWS.

  • ColumnStatisticsTaskRunId – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

  • DatabaseName – Chaîne UTF-8.

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

  • TableName – Chaîne UTF-8.

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

  • ColumnNameList – Tableau de chaînes UTF-8.

    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 nom n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • Role – Chaîne UTF-8.

    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 – Chaîne UTF-8, d'une longueur maximale de 128 octets.

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

  • 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 – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

  • Status – Chaîne UTF-8 (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), pas plus qu'Aucun.

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

Structure ColumnStatisticsTaskRunningException

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 – Chaîne UTF-8.

    Un message décrivant le problème.

Structure ColumnStatisticsTaskNotRunningException

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 – Chaîne UTF-8.

    Un message décrivant le problème.

Structure ColumnStatisticsTaskStoppingException

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

Champs
  • Message – Chaîne UTF-8.

    Un message décrivant le problème.

Opérations

Action StartColumnStatisticsTaskRun (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.

Requête
  • DatabaseNameObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

  • TableNameObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

  • ColumnNameList – Tableau de chaînes UTF-8.

    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.

  • RoleObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au 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 – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au 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 – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

Réponse
  • ColumnStatisticsTaskRunId – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

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

Erreurs
  • AccessDeniedException

  • EntityNotFoundException

  • ColumnStatisticsTaskRunningException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • InvalidInputException

Action GetColumnStatisticsTaskRun (Python : get_column_statistics_task_run)

Obtenez les métadonnées/informations associées à une exécution de tâche, en fonction d'un ID d'exécution de tâche.

Requête
  • ColumnStatisticsTaskRunIdObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au 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

Action GetColumnStatisticsTaskRuns (Python : get_column_statistics_task_runs)

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

Requête
  • DatabaseNameObligatoire : chaîne UTF-8.

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

  • TableNameObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la table.

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

    Taille maximale de la réponse.

  • NextToken – Chaîne UTF-8.

    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 – Chaîne UTF-8.

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

Erreurs
  • OperationTimeoutException

Action ListColumnStatisticsTaskRuns (Python : list_column_statistics_task_runs)

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

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

    Taille maximale de la réponse.

  • NextToken – Chaîne UTF-8.

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

Réponse
  • ColumnStatisticsTaskRunIds – Tableau de chaînes UTF-8, avec 100 chaînes maximum.

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

  • NextToken – Chaîne UTF-8.

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

Erreurs
  • OperationTimeoutException

Action StopColumnStatisticsTaskRun (Python : stop_column_statistics_task_run)

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

Requête
  • DatabaseNameObligatoire : chaîne UTF-8.

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

  • TableNameObligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la table.

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

Erreurs
  • EntityNotFoundException

  • ColumnStatisticsTaskNotRunningException

  • ColumnStatisticsTaskStoppingException

  • OperationTimeoutException