Flux de travail

L'API Workflows décrit les types de données et l'API liés à la création, à la mise à jour ou à l'affichage des flux de travail dans AWS Glue.

Types de données

• JobNodeDetails structure

• CrawlerNodeDetails structure

• TriggerNodeDetails structure

• Structure Crawl

• Structure de nœud

• Structure Edge

• Structure de flux de travail

• WorkflowGraph structure

• WorkflowRun structure

• WorkflowRunStatistics structure

• StartingEventBatchCondition structure

• Structure du plan

• BlueprintDetails structure

• LastActiveDefinition structure

• BlueprintRun structure

JobNodeDetails structure

Détails d'un nœud de tâches présent dans le flux de travail.

Champs

• JobRuns – Un tableau d'objets JobRun.

  Informations relatives aux exécutions de tâches représentées par le nœud de tâches.

CrawlerNodeDetails structure

Détails d'un nœud d'crawler présent dans le flux de travail.

Champs

• Crawls – Un tableau d'objets Crawl.

  Liste de crawlers représentés par le nœud de crawler.

TriggerNodeDetails structure

Détails d'un nœud Trigger présent dans le flux de travail.

Champs

• Trigger – Un objet Déclencheur.

  Informations relatives au déclencheur représenté par le nœud de déclencheur.

Structure Crawl

Détails d'un crawler dans le flux de travail.

Champs

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

  État de l'crawler.

• StartedOn – Horodatage.

  Date et heure auxquelles le crawler a démarré.

• CompletedOn – Horodatage.

  Date et heure auxquelles l'analyse a terminé.

• 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é au crawler

• LogGroup – Chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets, correspondant au Log group string pattern.

  Groupe de journaux associés au crawler.

• LogStream – Chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets, correspondant au Log-stream string pattern.

  Flux de journaux associé au crawler.

Structure de nœud

Un nœud représente un AWS Glue composant (déclencheur, robot ou tâche) sur un graphe de flux de travail.

Champs

• Type – Chaîne UTF-8 (valeurs valides : CRAWLER | JOB | TRIGGER).

  Type de AWS Glue composant représenté par le nœud.

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

  Nom du AWS Glue composant représenté par le nœud.

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

  ID unique affecté au nœud au sein du flux de travail.

• TriggerDetails – Un objet TriggerNodeDetails.

  Détails du déclencheur lorsque le nœud représente un déclencheur.

• JobDetails – Un objet JobNodeDetails.

  Détails de la tâche lorsque le nœud représente une tâche.

• CrawlerDetails – Un objet CrawlerNodeDetails.

  Détails de l'crawler lorsque le nœud représente un crawler.

Structure Edge

Un arête représente une connexion dirigée entre deux AWS Glue composants qui font partie du flux de travail auquel appartient l'arête.

Champs

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

  Chaîne unique du nœud au sein du flux de travail où démarre la périphérie.

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

  Chaîne unique du nœud au sein du flux de travail où la périphérie se termine.

Structure de flux de travail

Un flux de travail est un ensemble de plusieurs AWS Glue tâches dépendantes et de robots d'exploration exécutés pour effectuer une tâche ETL complexe. Un flux de travail gère l'exécution et le suivi de tous ses jobs et crawlers.

Champs

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

  Nom du flux de travail.

• Description – Chaîne UTF-8.

  Description du flux de travail.

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Collection de propriétés à utiliser dans le cadre de chaque exécution du flux de travail. Les propriétés d'exécution sont mises à la disposition de chaque tâche du flux de travail. Une tâche peut modifier les propriétés des tâches suivants dans le flux de travail.

• CreatedOn – Horodatage.

  Date et heure auxquelles le flux de travail a été créé.

• LastModifiedOn – Horodatage.

  Date et heure auxquelles le flux de travail a été modifié pour la dernière fois.

• LastRun – Un objet WorkflowRun.

  Informations relatives à la dernière exécution du flux de travail.

• Graph – Un objet WorkflowGraph.

  Le graphique représente tous les AWS Glue composants appartenant au flux de travail sous forme de nœuds et les connexions dirigées entre eux sous forme d'arêtes.

• CreationStatus – Chaîne UTF-8 (valeurs valides : CREATING | CREATED | CREATION_FAILED).

  État de création du flux de travail.

• MaxConcurrentRuns – Nombre (entier).

  Vous pouvez utiliser ce paramètre pour empêcher plusieurs mises à jour indésirables des données, pour contrôler les coûts ou, dans certains cas, pour empêcher le dépassement du nombre maximal d'exécutions simultanées de l'un des travaux de composant. Si vous laissez ce paramètre vide, le nombre d'exécutions de flux de travail simultanées est illimité.

• BlueprintDetails – Un objet BlueprintDetails.

  Cette structure indique les détails du plan à partir duquel ce flux de travail particulier est créé.

WorkflowGraph structure

Un graphique de flux de travail représente le flux de travail complet contenant tous les composants AWS Glue présents dans le flux de travail et toutes les connexions dirigées entre eux.

Champs

• Nodes – Un tableau d'objets Nœud.

  Une liste des AWS Glue composants appartenant au flux de travail représentés sous forme de nœuds.

• Edges – Un tableau d'objets Edge.

  Liste de toutes les connexions dirigées entre les nœuds appartenant au flux de travail.

WorkflowRun structure

Une exécution de flux de travail est une exécution de flux de travail qui fournit toutes les informations d'exécution.

Champs

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

  Nom du flux de travail qui a été exécuté.

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

  ID de cette exécution de flux de travail.

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

  ID de la précédente exécution de flux de travail.

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Propriétés d'exécution de flux de travail qui ont été définies au cours de l'exécution.

• StartedOn – Horodatage.

  Date et heure auxquelles l'exécution de flux de travail a démarré.

• CompletedOn – Horodatage.

  Date et heure auxquelles l'exécution de flux de travail a s'est terminée.

• Status – Chaîne UTF-8 (valeurs valides : RUNNING | COMPLETED | STOPPING | STOPPED | ERROR).

  État de l'exécution de flux de travail.

• ErrorMessage – Chaîne UTF-8.

  Ce message d'erreur décrit toute erreur qui peut s'être produite lors du démarrage de l'exécution du flux de travail. Actuellement, le seul message d'erreur est « Concurrent runs exceeded for workflow: foo » (Exécutions simultanées dépassées pour le flux de travail : foo).

• Statistics – Un objet WorkflowRunStatistics.

  Statistiques de l'exécution.

• Graph – Un objet WorkflowGraph.

  Le graphique représente tous les AWS Glue composants appartenant au flux de travail sous forme de nœuds et les connexions dirigées entre eux sous forme d'arêtes.

• StartingEventBatchCondition – Un objet StartingEventBatchCondition.

  Condition de lot qui a démarré l'exécution du flux de travail.

WorkflowRunStatistics structure

Le flux de travail exécutent des statistiques et fournit des statistiques sur l'exécution du flux de travail.

Champs

• TotalActions – Nombre (entier).

  Nombre total d'actions dans l'exécution du flux de travail.

• TimeoutActions – Nombre (entier).

  Nombre total d'actions qui ont expiré.

• FailedActions – Nombre (entier).

  Nombre total d'actions qui ont échoué.

• StoppedActions – Nombre (entier).

  Nombre total d'actions qui sont arrêtées.

• SucceededActions – Nombre (entier).

  Nombre total d'actions qui ont réussi.

• RunningActions – Nombre (entier).

  Nombre total d'actions en cours d'exécution.

• ErroredActions – Nombre (entier).

  Indique le nombre d'exécutions de tâches dans l'état ERROR dans l'exécution du flux de travail.

• WaitingActions – Nombre (entier).

  Indique le nombre d'exécutions de tâches en état WAITING dans l'exécution du flux de travail.

StartingEventBatchCondition structure

Condition de lot qui a démarré l'exécution du flux de travail. Soit le nombre d'événements de la taille du lot est arrivé, auquel cas le BatchSize membre est différent de zéro, soit la fenêtre du lot a expiré, auquel cas le BatchWindow membre est différent de zéro.

Champs

• BatchSize – Nombre (entier).

  Nombre d'événements dans le lot.

• BatchWindow – Nombre (entier).

  Durée de la fenêtre de traitement par lots en secondes.

Structure du plan

Détails d'un plan.

Champs

• Name – chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

• Description – chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets.

  Description du plan.

• CreatedOn – Horodatage.

  Date et heure d'enregistrement du plan.

• LastModifiedOn – Horodatage.

  Date et heure auxquelles le plan a été modifié pour la dernière fois.

• ParameterSpec – chaîne UTF-8, d'une longueur comprise entre 1 et 131 072 octets.

  Chaîne JSON qui indique la liste des spécifications de paramètres pour le plan.

• BlueprintLocation – Chaîne UTF-8.

  Spécifie le chemin dans Amazon S3 où le plan est publié.

• BlueprintServiceLocation – Chaîne UTF-8.

  Spécifie un chemin dans Amazon S3 où le plan est copié lorsque vous appelez CreateBlueprint/UpdateBlueprint pour enregistrer le plan dans AWS Glue.

• Status – Chaîne UTF-8 (valeurs valides : CREATING | ACTIVE | UPDATING | FAILED).

  Statut de l'enregistrement du plan.

  • Création : l'enregistrement du plan est en cours.

  • Actif : le plan a été enregistré avec succès.

  • Mise à jour : une mise à jour de l'enregistrement du plan est en cours.

  • Échec : l'enregistrement du plan a échoué.

• ErrorMessage – Chaîne UTF-8.

  Message d'erreur.

• LastActiveDefinition – Un objet LastActiveDefinition.

  Lorsqu'il existe plusieurs versions d'un plan et que la dernière version contient des erreurs, cet attribut indique la dernière définition de plan réussie qui est disponible avec le service.

BlueprintDetails structure

Détails d'un plan.

Champs

• BlueprintName – chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

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

  ID d'exécution de ce plan.

LastActiveDefinition structure

Lorsqu'il existe plusieurs versions d'un plan et que la dernière version contient des erreurs, cet attribut indique la dernière définition de plan réussie qui est disponible avec le service.

Champs

• Description – chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets.

  Description du plan.

• LastModifiedOn – Horodatage.

  Date et heure auxquelles le plan a été modifié pour la dernière fois.

• ParameterSpec – chaîne UTF-8, d'une longueur comprise entre 1 et 131 072 octets.

  Chaîne JSON spécifiant les paramètres du plan.

• BlueprintLocation – Chaîne UTF-8.

  Spécifie un chemin dans Amazon S3 où le plan est publié par le AWS Glue développeur.

• BlueprintServiceLocation – Chaîne UTF-8.

  Spécifie un chemin dans Amazon S3 où le plan est copié lorsque vous créez ou mettez à jour ce dernier.

BlueprintRun structure

Détails d'une exécution de plan.

Champs

• BlueprintName – chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

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

  ID d'exécution de cette exécution de plan.

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

  Nom d'un flux de travail créé à la suite d'une exécution réussie du plan. Si une exécution de plan comporte une erreur, aucun flux de travail ne sera créé.

• State – Chaîne UTF-8 (valeurs valides : RUNNING | SUCCEEDED | FAILED | ROLLING_BACK).

  État de l'exécution du plan. Les valeurs possibles sont :

  • En cours d'exécution : l'exécution du plan est en cours.

  • Réussi : l'exécution du plan s'est terminée.

  • Échec : l'exécution du plan a échoué et la restauration est terminée.

  • Annuler : l'exécution du plan a échoué et la restauration est en cours.

• StartedOn – Horodatage.

  Date et heure auxquelles l'exécution du plan a démarré.

• CompletedOn – Horodatage.

  Date et heure auxquelles le modèle a été exécuté.

• ErrorMessage – Chaîne UTF-8.

  Indique les erreurs détectées lors de l'exécution du plan.

• RollbackErrorMessage – Chaîne UTF-8.

  S'il y a des erreurs lors de la création des entités d'un flux de travail, nous essayons de restaurer les entités créées jusqu'à ce point et de les supprimer. Cet attribut indique les erreurs rencontrées lors de la tentative de suppression des entités créées.

• Parameters – chaîne UTF-8, d'une longueur comprise entre 1 et 131 072 octets.

  Paramètres du plan sous la forme d'une chaîne. Vous devrez fournir une valeur pour chaque clé requise à partir de la spécification de paramètre définie dans Blueprint$ParameterSpec.

• RoleArn – Chaîne UTF-8, d'une longueur comprise entre 1 et 1024 octets, correspondant au Custom string pattern #21.

  ARN du rôle. Ce rôle sera assumé par le AWS Glue service et sera utilisé pour créer le flux de travail et les autres entités d'un flux de travail.

Opérations

• CreateWorkflow action (Python : create_workflow)

• UpdateWorkflow action (Python : update_workflow)

• DeleteWorkflow action (Python : delete_workflow)

• GetWorkflow action (Python : get_workflow)

• ListWorkflows action (Python : list_workflows)

• BatchGetWorkflows action (Python : batch_get_workflows)

• GetWorkflowRun action (Python : get_workflow_run)

• GetWorkflowRuns action (Python : get_workflow_runs)

• GetWorkflowRunProperties action (Python : get_workflow_run_properties)

• PutWorkflowRunProperties action (Python : put_workflow_run_properties)

• CreateBlueprint action (Python : créer_blueprint)

• UpdateBlueprint action (Python : update_blueprint)

• DeleteBlueprint action (Python : delete_blueprint)

• ListBlueprints action (Python : list_blueprints)

• BatchGetBlueprints action (Python : batch_get_blueprints)

• StartBlueprintRun action (Python : start_blueprint_run)

• GetBlueprintRun action (Python : get_blueprint_run)

• GetBlueprintRuns action (Python : get_blueprint_runs)

• StartWorkflowRun action (Python : start_workflow_run)

• StopWorkflowRun action (Python : stop_workflow_run)

• ResumeWorkflowRun action (Python : resume_workflow_run)

CreateWorkflow action (Python : create_workflow)

Crée un nouveau flux de travail.

Demande

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

  Nom à affecter ai flux de travail. Il doit être unique au sein de votre compte.

• Description – Chaîne UTF-8.

  Description du flux de travail.

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Collection de propriétés à utiliser dans le cadre de chaque exécution du flux de travail.

• 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 flux de travail.

• MaxConcurrentRuns – Nombre (entier).

  Vous pouvez utiliser ce paramètre pour empêcher plusieurs mises à jour indésirables des données, pour contrôler les coûts ou, dans certains cas, pour empêcher le dépassement du nombre maximal d'exécutions simultanées de l'un des travaux de composant. Si vous laissez ce paramètre vide, le nombre d'exécutions de flux de travail simultanées est illimité.

Réponse

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

  Nom du flux de travail qui a été fourni dans le cadre de la requête.

Erreurs

• AlreadyExistsException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

UpdateWorkflow action (Python : update_workflow)

Met à jour un flux de travail existant.

Demande

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

  Nom du flux de travail à mettre à jour.

• Description – Chaîne UTF-8.

  Description du flux de travail.

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Collection de propriétés à utiliser dans le cadre de chaque exécution du flux de travail.

• MaxConcurrentRuns – Nombre (entier).

  Vous pouvez utiliser ce paramètre pour empêcher plusieurs mises à jour indésirables des données, pour contrôler les coûts ou, dans certains cas, pour empêcher le dépassement du nombre maximal d'exécutions simultanées de l'un des travaux de composant. Si vous laissez ce paramètre vide, le nombre d'exécutions de flux de travail simultanées est illimité.

Réponse

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

  Nom du flux de travail qui a été spécifié dans l'entrée.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

DeleteWorkflow action (Python : delete_workflow)

Supprime un flux de travail.

Demande

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

  Nom du flux de travail à 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 flux de travail spécifié dans l'entrée.

Erreurs

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ConcurrentModificationException

GetWorkflow action (Python : get_workflow)

Récupère les métadonnées de ressource pour un flux de travail.

Demande

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

  Nom du flux de travail à récupérer.

• IncludeGraph – Booléen.

  Indique si un graphique doit être inclus lors du renvoi de métadonnées de ressource de flux de travail.

Réponse

• Workflow – Un objet Flux de travail.

  Métadonnées de ressource du flux de travail.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

ListWorkflows action (Python : list_workflows)

Affiche les noms des flux de travail créés dans le compte.

Demande

• NextToken – Chaîne UTF-8.

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

• MaxResults— Nombre (entier), pas moins de 1 ou plus de 25.

  La taille maximale d'une liste à renvoyer.

Réponse

• Workflows – tableau de chaînes UTF-8, avec 1 chaîne minimum et 25 chaînes maximum.

  Liste des noms des flux de travail dans le compte.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, si tous les noms de flux de travail n'ont pas été retournés.

Erreurs

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

BatchGetWorkflows action (Python : batch_get_workflows)

Retourne la liste des métadonnées de ressource pour une liste donnée de noms de flux de travail. Après avoir appelé l'opération ListWorkflows, 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

• Names – Obligatoire : Tableau de chaînes UTF-8, avec 1 chaîne minimum et 25 chaînes maximum.

  Liste des noms de flux de travail, qui peuvent être les noms renvoyés à partir de l'opération ListWorkflows.

• IncludeGraph – Booléen.

  Indique si un graphique doit être inclus lors du renvoi de métadonnées de ressource de flux de travail.

Réponse

• Workflows – tableau d'objets Flux de travail, avec 1 structure minimum et 25 structures maximum.

  Liste de métadonnées de ressource de flux de travail.

• MissingWorkflows – tableau de chaînes UTF-8, avec 1 chaîne minimum et 25 chaînes maximum.

  Liste des noms de flux de travail non trouvés.

Erreurs

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

GetWorkflowRun action (Python : get_workflow_run)

Extrait les métadonnées pour une exécution de flux de travail donné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 flux de travail en cours d'exécution.

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

  ID de l'exécution de flux de travail.

• IncludeGraph – Booléen.

  Indique si le graphique de flux de travail doit être inclus en réponse ou non.

Réponse

• Run – Un objet WorkflowRun.

  Métadonnées d'exécution de flux de travail demandées.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetWorkflowRuns action (Python : get_workflow_runs)

Extrait les métadonnées de toutes les exécutions d'un flux de travail donné.

Demande

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

  Nom du flux de travail dont les métadonnées des exécutions doivent être renvoyées.

• IncludeGraph – Booléen.

  Indique si le graphique de flux de travail doit être inclus en réponse ou non.

• NextToken – Chaîne UTF-8.

  Taille maximale de la réponse.

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

  Nombre maximal d'exécutions de flux de travail à inclure dans la réponse.

Réponse

• Runs – tableau d'objets WorkflowRun, avec 1 structure minimum et 1 000 structures maximum.

  Liste d'objets des métadonnées d'exécution de flux de travail.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, si toutes les exécutions de tâche demandées ne sont pas renvoyées.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetWorkflowRunProperties action (Python : get_workflow_run_properties)

Extrait les propriétés d'exécution de flux de travail qui ont été définies au cours de l'exécution.

Demande

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

  Nom du flux de travail qui a été exécuté.

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

  ID de l'exécution de flux de travail dont les propriétés d'exécution doivent être renvoyées.

Réponse

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Propriétés d'exécution de flux de travail qui ont été définies au cours de l'exécution spécifiée.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

PutWorkflowRunProperties action (Python : put_workflow_run_properties)

Place les propriétés d'exécution de flux de travail spécifiées pour l'exécution de flux de travail donnée. Si une propriété existe déjà pour l'exécution spécifiée, elle remplace la valeur et ajoute la propriété aux propriétés existantes.

Demande

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

  Nom du flux de travail qui a été exécuté.

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

  ID de l'exécution de flux de travail pour laquelle les propriétés d'exécution doivent être mises à jour.

• RunProperties – obligatoire : tableau de mappage de paires clé-valeur.

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Propriétés à placer pour l'exécution spécifiée.

Réponse

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

Erreurs

• AlreadyExistsException

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentModificationException

CreateBlueprint action (Python : créer_blueprint)

Enregistre un plan avec AWS Glue.

Demande

• Name – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

• Description – chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets.

  Description du plan.

• BlueprintLocation – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 8 192 octets, correspondant au Custom string pattern #23.

  Spécifie un chemin dans Amazon S3 où le plan est publié.

• 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 à appliquer à ce plan.

Réponse

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

  Renvoie le nom du plan qui a été enregistré.

Erreurs

• AlreadyExistsException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• ResourceNumberLimitExceededException

UpdateBlueprint action (Python : update_blueprint)

Met à jour un plan enregistré.

Demande

• Name – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

• Description – chaîne UTF-8, d'une longueur comprise entre 1 et 512 octets.

  Description du plan.

• BlueprintLocation – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 8 192 octets, correspondant au Custom string pattern #23.

  Spécifie un chemin dans Amazon S3 où le plan est publié.

Réponse

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

  Renvoie le nom du plan qui a été mis à jour.

Erreurs

• EntityNotFoundException

• ConcurrentModificationException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• IllegalBlueprintStateException

DeleteBlueprint action (Python : delete_blueprint)

Supprime un plan existant.

Demande

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

  Nom du plan à supprimer.

Réponse

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

  Renvoie le nom du plan qui a été supprimé.

Erreurs

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

ListBlueprints action (Python : list_blueprints)

Répertorie tous les noms de plan d'un compte.

Demande

• NextToken – Chaîne UTF-8.

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

• MaxResults— Nombre (entier), pas moins de 1 ou plus de 25.

  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.

  Filtre la liste en fonction d'une balise de AWS ressource.

Réponse

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

  Liste des noms des plans dans le compte.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, si tous les noms de plan n'ont pas été renvoyés.

Erreurs

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

BatchGetBlueprints action (Python : batch_get_blueprints)

Extrait des informations sur une liste de plans.

Demande

• Names – Obligatoire : Tableau de chaînes UTF-8, avec 1 chaîne minimum et 25 chaînes maximum.

  Une liste de noms de plan.

• IncludeBlueprint – Booléen.

  Indique si le plan doit être inclus dans la réponse ou non.

• IncludeParameterSpec – Booléen.

  Spécifie s'il faut ou non inclure les paramètres, sous forme de chaîne JSON, pour le plan dans la réponse.

Réponse

• Blueprints – Un tableau d'objets Plan .

  Renvoie la liste des plans sous forme d'objet Blueprints.

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

  Renvoie une liste de BlueprintNames qui ont été introuvables.

Erreurs

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

StartBlueprintRun action (Python : start_blueprint_run)

Démarre une nouvelle exécution du plan spécifié.

Demande

• BlueprintName – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

• Parameters – chaîne UTF-8, d'une longueur comprise entre 1 et 131 072 octets.

  Spécifie les paramètres en tant qu'objet BlueprintParameters.

• RoleArn – Obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 1024 octets, correspondant au Custom string pattern #21.

  Spécifie le rôle IAM utilisé pour créer le flux de travail.

Réponse

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

  ID d'exécution de cette exécution de plan.

Erreurs

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• ResourceNumberLimitExceededException

• EntityNotFoundException

• IllegalBlueprintStateException

GetBlueprintRun action (Python : get_blueprint_run)

Récupère les détails d'une exécution de plan.

Demande

• BlueprintName – obligatoire : chaîne UTF-8, d'une longueur comprise entre 1 et 128 octets, correspondant au Custom string pattern #22.

  Nom du plan.

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

  ID d'exécution de l'exécution de plan que vous souhaitez récupérer.

Réponse

• BlueprintRun – Un objet BlueprintRun.

  Renvoie un objet BlueprintRun.

Erreurs

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

GetBlueprintRuns action (Python : get_blueprint_runs)

Récupère les détails des exécutions de plan pour un plan spécifié.

Demande

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

  Nom du plan.

• NextToken – Chaîne UTF-8.

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

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

  La taille maximale d'une liste à renvoyer.

Réponse

• BlueprintRuns – Un tableau d'objets BlueprintRun.

  Envoie la liste des objets BlueprintRun.

• NextToken – Chaîne UTF-8.

  Jeton de continuation, si toutes les exécutions de plan ne sont pas renvoyées.

Erreurs

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• InvalidInputException

StartWorkflowRun action (Python : start_workflow_run)

Démarre une nouvelle exécution du flux de travail 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 flux de travail à démarrer.

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

  Chaque clé est une chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

  Chaque valeur est une chaîne UTF-8.

  Les propriétés d'exécution de flux de travail pour la nouvelle exécution de flux de travail.

Réponse

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

  ID pour la nouvelle exécution.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• ConcurrentRunsExceededException

StopWorkflowRun action (Python : stop_workflow_run)

Arrête l'exécution du cycle de flux de travail 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 flux de travail à arrêter.

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

  ID de du cycle de flux de travail à arrêter.

Réponse

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

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• IllegalWorkflowStateException

ResumeWorkflowRun action (Python : resume_workflow_run)

Redémarre les nœuds sélectionnés d'une précédente exécution de flux de travail partiellement terminée et reprend l'exécution de flux de travail. Les nœuds sélectionnés et tous les nœuds en aval des nœuds sélectionnés sont exécuté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 flux de travail à reprendre.

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

  ID de l'exécution du flux de travail à reprendre.

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

  Liste des ID de nœud pour les nœuds que vous souhaitez redémarrer. Les nœuds qui doivent être redémarrés doivent avoir une tentative d'exécution dans l'exécution d'origine.

Réponse

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

  Nouvel ID attribué à l'exécution de flux de travail reprise. Chaque résumé d'exécution de flux de travail aura un nouvel ID d'exécution.

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

  Liste des ID de nœud pour les nœuds qui ont été réellement redémarrés.

Erreurs

• InvalidInputException

• EntityNotFoundException

• InternalServiceException

• OperationTimeoutException

• ConcurrentRunsExceededException

• IllegalWorkflowStateException