Déclencheurs - AWS Glue
 –  types de données  –DéclencheurTriggerUpdatePrédicatConditionActionEventBatchingCondition  —  operations  —CreateTrigger (create_trigger)StartTrigger (start_trigger)GetTrigger (get_trigger)GetTriggers (get_triggers)UpdateTrigger (update_trigger)StopTrigger (stop_trigger)DeleteTrigger (delete_trigger)ListTriggers (list_triggers)BatchGetTriggers (batch_get_triggers)

Déclencheurs

L'API de déclencheurs décrit les types de données et l'API liés à la création, la mise à jour ou la suppression, et le lancement et l'arrêt de déclencheurs de tâches dans AWS Glue.

Types de données

Structure Trigger

Informations concernant un déclencheur spécifique.

Champs

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

    Le nom du déclencheur.

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

    Nom du flux de travail associé au déclencheur.

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

    Réservé pour un usage futur.

  • Type – Chaîne UTF-8 (valeurs valides : SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

    Type de déclencheur.

  • State – Chaîne UTF-8 (valeurs valides : CREATING | CREATED | ACTIVATING | ACTIVATED | DEACTIVATING | DEACTIVATED | DELETING | UPDATING).

    État actuel du déclencheur.

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

    Description de ce déclencheur.

  • Schedule – Chaîne UTF-8.

    Une expression cron utilisée pour spécifier la planification (consultez Time-Based Schedules for Jobs and Crawlers (Planifications temporelles pour les tâches et les crawlers)). Par exemple, pour exécuter un élément tous les jours à 12h15 UTC, vous devez spécifier : cron(15 12 * * ? *).

  • Actions : un tableau d’objets Action.

    Actions initiées par ce déclencheur.

  • Predicate – Un objet Prédicat.

    Prédicat de ce déclencheur, qui définit le moment du déclenchement.

  • EventBatchingCondition : un objet EventBatchingCondition.

    Condition de lot qui doit être remplie (nombre spécifié d'événements reçus ou fenêtre temporelle de lot expirée) avant que le déclencheur d'événement EventBridge ne se déclenche.

Structure TriggerUpdate

Structure utilisée pour fournir des informations utilisées pour mettre à jour un déclencheur. Cet objet met à jour la définition précédente du déclencheur en la remplaçant complètement.

Champs

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

    Réservé pour un usage futur.

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

    Description de ce déclencheur.

  • Schedule – Chaîne UTF-8.

    Une expression cron utilisée pour spécifier la planification (consultez Time-Based Schedules for Jobs and Crawlers (Planifications temporelles pour les tâches et les crawlers)). Par exemple, pour exécuter un élément tous les jours à 12h15 UTC, vous devez spécifier : cron(15 12 * * ? *).

  • Actions : un tableau d’objets Action.

    Actions initiées par ce déclencheur.

  • Predicate – Un objet Prédicat.

    Prédicat de ce déclencheur, qui définit le moment du déclenchement.

  • EventBatchingCondition : un objet EventBatchingCondition.

    Condition de lot qui doit être remplie (nombre spécifié d'événements reçus ou fenêtre temporelle de lot expirée) avant que le déclencheur d'événement EventBridge ne se déclenche.

Structure Predicate

Définit le prédicat du déclencheur, qui détermine le moment du déclenchement.

Champs

  • Logical – Chaîne UTF-8 (valeurs valides : AND | ANY).

    Champ facultatif si une seule condition est répertoriée. Si plusieurs conditions sont répertoriées, ce champ est obligatoire.

  • Conditions – Un tableau d'objets Condition, 500 structures au maximum.

    Liste des conditions qui déterminent le moment du déclenchement.

Structure Condition

Définit une condition selon laquelle un déclencheur s'exécute.

Champs

  • LogicalOperator – Chaîne UTF-8 (valeurs valides : EQUALS).

    Opérateur logique.

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

    Nom de la tâche pour laquelle cette condition s'applique à JobRuns et sur laquelle ce déclencheur attend.

  • State – Chaîne UTF-8 (valeurs valides: STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT | ERROR | WAITING | EXPIRED).

    État de la condition. Actuellement, les seuls états de tâche qu'un déclencheur peut écouter sont SUCCEEDED, STOPPED, FAILED et TIMEOUT. Les seuls états d'crawler qu'un déclencheur peut écouter sont SUCCEEDED, FAILED et CANCELLED.

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

    Nom de l'crawler à laquelle cette condition s'applique.

  • CrawlState – Chaîne UTF-8 (valeurs valides : RUNNING | CANCELLING | CANCELLED | SUCCEEDED | FAILED | ERROR).

    Nom de l'crawler à laquelle cette condition s'applique.

Structure Action

Définit une action qui doit être initiée par un déclencheur.

Champs

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

    Nom de la tâche à exécuter.

  • Arguments – Tableau de mappage de paires valeur-clé.

    Chaque clé est une chaîne UTF-8.

    Chaque valeur est une chaîne UTF-8.

    Arguments de tâche utilisés lorsque ce déclencheur s'exécute. Pour cette exécution de tâche, ils remplacent les arguments par défaut définis pour la tâche elle-même.

    Ici, vous pouvez spécifier des arguments que votre propre script tâche-exécution consomme, ainsi que des arguments que AWS Glue consomme lui-même.

    Pour plus d'informations sur la façon de spécifier et d'utiliser vos propres arguments de Job, consultez la rubrique Appel d'API AWS Glue en Python dans le Guide du développeur.

    Pour plus d'informations sur les paires clé-valeur que AWS Glue utilise pour configurer votre tâche, consultez la rubrique Paramètres spéciaux utilisés par AWS Glue dans le Guide du développeur.

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

    Délai d'expiration de JobRun en minutes. Durée maximale durant laquelle une tâche exécutée peut consommer des ressources avant qu'elle ne se termine et n'entre dans l'état TIMEOUT. Cette valeur remplace la valeur définie dans la tâche parent.

    Les tâches doivent avoir des valeurs de délai d’expiration inférieures à 7 jours ou 10 080 minutes. Dans le cas contraire, les tâches déclencheront une exception.

    Lorsque la valeur est laissée vide, le délai d’expiration est défini par défaut sur 2 880 minutes.

    Toutes les tâches AWS Glue existantes dont la valeur du délai d’expiration est supérieure à sept jours seront définies par défaut sur sept jours. Par exemple, si vous avez spécifié un délai d’expiration de 20 jours pour un traitement par lots, celui-ci sera arrêté le 7e jour.

    Pour les tâches de streaming, si vous avez défini une fenêtre de maintenance, elles seront redémarrées au cours de celle-ci au bout de sept jours.

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

    Nom de la structure SecurityConfiguration à utiliser avec cette action.

  • NotificationProperty – Un objet NotificationProperty.

    Spécifie les propriétés de configuration d'une notification d'exécution de tâche.

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

    Nom de l'crawler à utiliser avec cette action.

Structure EventBatchingCondition

Condition de lot qui doit être remplie (nombre spécifié d'événements reçus ou fenêtre temporelle de lot expirée) avant que le déclencheur d'événement EventBridge ne se déclenche.

Champs

  • BatchSize – obligatoire : nombre (entier), compris entre 1 et 100.

    Nombre d'événements qui doivent être reçus d'Amazon EventBridge avant que le déclencheur d'événement EventBridge ne se déclenche.

  • BatchWindow – nombre (entier), compris entre 1 et 900.

    Fenêtre temporelle en secondes après laquelle le déclencheur d'événement EventBridge se déclenche. La fenêtre démarre dès la réception du premier événement.

Opérations

Action CreateTrigger (Python : create_trigger)

Crée un nouveau déclencheur.

Les arguments de la tâche peuvent être consignés. Ne transmettez pas de secrets en texte clair comme arguments. Récupérez des secrets à partir d’une connexion AWS Glue, d’AWS Secrets Manager ou de tout autre mécanisme de gestion de secrets si vous avez l’intention de les conserver dans la tâche.

Demande

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

    Le nom du déclencheur.

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

    Nom du flux de travail associé au déclencheur.

  • Type – obligatoire : chaîne UTF-8 (valeurs valides : SCHEDULED | CONDITIONAL | ON_DEMAND | EVENT).

    Type du nouveau déclencheur.

  • Schedule – Chaîne UTF-8.

    Une expression cron utilisée pour spécifier la planification (consultez Time-Based Schedules for Jobs and Crawlers (Planifications temporelles pour les tâches et les crawlers)). Par exemple, pour exécuter un élément tous les jours à 12h15 UTC, vous devez spécifier : cron(15 12 * * ? *).

    Ce champ est obligatoire lorsque le type de déclencheur est SCHEDULED.

  • Predicate – Un objet Prédicat.

    Prédicat pour spécifier le moment du déclenchement.

    Ce champ est obligatoire lorsque le type de déclencheur est CONDITIONAL.

  • Actions – Obligatoire : un tableau d’objets Action.

    Actions initiées par ce déclencheur lorsqu'il s'exécute.

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

    Description du nouveau déclencheur.

  • StartOnCreation : booléen.

    Définissez ce paramètre sur true pour démarrer les déclencheurs SCHEDULED et CONDITIONAL lorsqu'ils sont créés. True n'est pas pris en charge pour les déclencheurs ON_DEMAND.

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

    Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.

    Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 256 octets.

    Balises à utiliser avec ce déclencheur. Vous pouvez utiliser des balises pour limiter l'accès au déclencheur. Pour plus d'informations sur les balises dans AWS Glue Glue, consultez Balises AWS dans AWS Glue dans le Guide du développeur.

  • EventBatchingCondition : un objet EventBatchingCondition.

    Condition de lot qui doit être remplie (nombre spécifié d'événements reçus ou fenêtre temporelle de lot expirée) avant que le déclencheur d'événement EventBridge ne se déclenche.

Réponse

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

    Le nom du déclencheur.

Erreurs

  • AlreadyExistsException

  • EntityNotFoundException

  • InvalidInputException

  • IdempotentParameterMismatchException

  • InternalServiceException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentModificationException

Action StartTrigger (Python : start_trigger)

Lance un déclencheur existant. Consultez Déclenchement de tâches pour obtenir des informations sur la manière dont différents types de déclencheurs sont lancés.

Demande

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

    Nom du déclencheur à lancer.

Réponse

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

    Nom du déclencheur qui a été lancé.

Erreurs

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • ConcurrentRunsExceededException

Action GetTrigger (Python : get_trigger)

Extrait la définition d'un déclencheur.

Demande

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

    Nom du déclencheur à extraire.

Réponse

  • Trigger – Un objet Déclencheur.

    Définition du déclencheur demandé.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

Action GetTriggers (Python : get_triggers)

Permet d'obtenir tous les déclencheurs associés à une tâche.

Demande

  • NextToken – Chaîne UTF-8.

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

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

    Nom de la tâche pour laquelle récupérer des déclencheurs. Le déclencheur qui peut lancer cette tâche est renvoyé. Si aucun déclencheur de ce type n'existe, tous les déclencheurs sont renvoyés.

  • MaxResults – nombre (entier), compris entre 1 et 200.

    Taille maximale de la réponse.

Réponse

  • Triggers : un tableau d’objets Déclencheur.

    Liste des déclencheurs pour la tâche spécifiée.

  • NextToken – Chaîne UTF-8.

    Jeton de continuation, si tous les déclencheurs demandés ne sont pas encore renvoyés.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

Action UpdateTrigger (Python : update_trigger)

Met à jour la définition d'un déclencheur.

Les arguments de la tâche peuvent être consignés. Ne transmettez pas de secrets en texte clair comme arguments. Récupérez des secrets à partir d’une connexion AWS Glue, d’AWS Secrets Manager ou de tout autre mécanisme de gestion de secrets si vous avez l’intention de les conserver dans la tâche.

Demande

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

    Nom du déclencheur à mettre à jour.

  • TriggerUpdate – Obligatoire : un objet TriggerUpdate.

    Nouvelles valeurs pour mettre à jour le déclencheur.

Réponse

  • Trigger – Un objet Déclencheur.

    Définition du déclencheur obtenu.

Erreurs

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ConcurrentModificationException

Action StopTrigger (Python : stop_trigger)

Arrête un déclencheur spécifié.

Demande

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

    Nom du déclencheur à arrêter.

Réponse

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

    Nom du déclencheur qui a été arrêté.

Erreurs

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ConcurrentModificationException

Action DeleteTrigger (Python : delete_trigger)

Supprime un déclencheur spécifié. Si le déclencheur est introuvable, aucune exception n'est levée.

Demande

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

    Nom du déclencheur à supprimer.

Réponse

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

    Nom du déclencheur qui a été supprimé.

Erreurs

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • ConcurrentModificationException

Action ListTriggers (Python : list_triggers)

Récupère les noms de toutes les ressources de déclencheur dans ce compte AWS, ou des ressources avec la balise spécifiée. Cette opération vous permet de voir quelles ressources sont disponibles dans votre compte, et leurs noms.

Cette opération accepte le champ Tags facultatif que vous pouvez utiliser comme filtre sur la réponse, afin que les ressources balisées puissent être récupérées en tant que groupe. Si vous choisissez d'utiliser le filtrage des balises, seules les ressources avec la balise sont récupérées.

Demande

  • NextToken – Chaîne UTF-8.

    Jeton de continuation, s’il s’agit d’une requête de continuation.

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

    Nom de la tâche pour laquelle récupérer les déclencheurs. Le déclencheur qui peut lancer cette tâche est renvoyé. Si aucun déclencheur de ce type n'existe, tous les déclencheurs sont renvoyés.

  • MaxResults – nombre (entier), compris entre 1 et 200.

    La taille maximale d’une liste à renvoyer.

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

    Chaque clé est une chaîne UTF-8, d’une longueur comprise entre 1 et 128 octets.

    Chaque valeur est une chaîne UTF-8, d’une longueur maximale de 256 octets.

    Spécifie de renvoyer uniquement les ressources balisées.

Réponse

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

    Noms de tous les déclencheurs dans le compte ou des déclencheurs avec les balises spécifiées.

  • NextToken – Chaîne UTF-8.

    Jeton continuation, si la liste renvoyée ne contient pas la dernière métrique disponible.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

Action BatchGetTriggers (Python : batch_get_triggers)

Renvoie la liste des métadonnées de ressource pour une liste donnée de noms de déclencheur. Après avoir appelé l’opération ListTriggers, vous pouvez appeler cette opération pour accéder aux données sur lesquelles des autorisations vous ont été octroyées. Cette opération prend en charge toutes les autorisations IAM, y compris les conditions d’autorisation qui utilisent des balises.

Demande

  • TriggerNames – obligatoire : tableau de chaînes UTF-8.

    Liste des noms de déclencheur, qui peuvent être les noms renvoyés à partir de l'opération ListTriggers.

Réponse

  • Triggers : un tableau d’objets Déclencheur.

    Liste des définitions de déclencheur.

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

    Liste des noms des déclencheurs introuvables.

Erreurs

  • InternalServiceException

  • OperationTimeoutException

  • InvalidInputException