Création d'un flux de travail avec Workflow Studio dans Step Functions - AWS Step Functions
Créer une machine d'étatConcevoir un flux de travailExécutez votre flux de travailModifiez votre flux de travailExportez votre flux de travailCréation d'un prototype de flux de travail avec des espaces réservés

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.

Création d'un flux de travail avec Workflow Studio dans Step Functions

Apprenez à créer, modifier et exécuter des flux de travail à l'aide de Step Functions Workflow Studio. Une fois que votre flux de travail est prêt, vous pouvez l'enregistrer, l'exécuter et l'exporter.

Créer une machine d'état

Dans Workflow Studio, vous pouvez choisir un modèle de départ ou un modèle vide pour créer un flux de travail.

Un modèle de démarrage est un ready-to-run exemple de projet qui crée automatiquement le prototype et la définition du flux de travail, et déploie toutes les AWS ressources connexes dont votre projet a besoin sur votre Compte AWS compte. Vous pouvez utiliser ces modèles de démarrage pour les déployer et les exécuter tels quels, ou utiliser les prototypes de flux de travail pour les exploiter. Pour plus d'informations sur les modèles de démarrage, consultezDéployer une machine à états à l'aide d'un modèle de démarrage pour Step Functions.

Avec un modèle vierge, vous utilisez le mode Design ou Code pour créer votre flux de travail personnalisé.

Création d'une machine à états à l'aide d'un modèle de démarrage

  1. Ouvrez la console Step Functions et choisissez Create state machine.

  2. Dans la boîte de dialogue Choisir un modèle, effectuez l'une des opérations suivantes pour choisir un exemple de projet :

    • Tapez Task Timer dans la zone Rechercher par mot clé, puis choisissez Task Timer dans les résultats de la recherche.

    • Parcourez les exemples de projets répertoriés sous Tous dans le volet droit, puis choisissez Task Timer.

  3. Choisissez Next (Suivant) pour continuer.

  4. Step Functions répertorie les AWS services éléments utilisés dans l'exemple de projet que vous avez sélectionné. Il montre également un graphique de flux de travail pour l'exemple de projet. Déployez ce projet sur votre site Compte AWS ou utilisez-le comme point de départ pour créer vos propres projets. Selon la façon dont vous souhaitez procéder, choisissez Exécuter une démo ou Construire à partir de celle-ci.

  5. Choisissez Utiliser le modèle pour poursuivre votre sélection.

  6. Effectuez l’une des actions suivantes :

    • Si vous avez sélectionné Build on it, Step Functions crée le prototype de flux de travail, mais ne déploie pas les ressources contenues dans la définition du flux de travail. Vous pouvez donc continuer à développer votre prototype de flux de travail.

      Dans Workflow StudioMode de conception, vous pouvez ajouter des états à votre prototype de flux de travail. Vous pouvez également passer Mode code à l'éditeur de code intégré pour modifier la définition Amazon States Language (ASL) de votre machine à états depuis la console Step Functions.

      Important

      Vous devrez peut-être mettre à jour l'espace réservé Amazon Resource Name (ARN) pour les ressources utilisées dans l'exemple de projet avant de pouvoir exécuter votre flux de travail.

    • Si vous avez sélectionné Run a demo, Step Functions crée un projet en lecture seule qui utilise un AWS CloudFormation modèle pour déployer les AWS ressources de ce modèle sur votre. Compte AWS Vous pouvez consulter la définition de la machine à états en choisissant le mode Code.

      Choisissez Déployer et exécuter pour déployer le projet et créer les ressources.

      Notez que le déploiement peut prendre jusqu'à 10 minutes pour créer des ressources et IAM des autorisations. Pendant le déploiement de vos ressources, vous pouvez ouvrir le lien AWS CloudFormation Stack ID pour voir quelles ressources sont mises en service.

      Une fois que toutes les ressources ont été créées, vous devriez voir le projet sur la page State machines de la console.

      Important

      Des frais standard peuvent s'appliquer pour chaque service utilisé dans le CloudFormation modèle.

Création d'un flux de travail à l'aide d'un modèle vierge

Lorsque vous souhaitez partir d'un canevas propre, créez un flux de travail à partir du modèle vierge.

  1. Ouvrez la console Step Functions.

  2. Choisissez Create state machine (Créer une machine d'état).

  3. Dans la boîte de dialogue Choisir un modèle, sélectionnez Vide.

  4. Choisissez Sélectionner pour ouvrir Workflow Studio dansMode de conception.

    Vous pouvez désormais commencer à concevoir votre flux de travail Mode de conception ou à écrire votre définition de flux de travail dansMode code.

  5. Choisissez Config pour gérer la configuration de votre flux de travail dans leMode Config. Par exemple, donnez un nom à votre flux de travail et choisissez son type.

Concevoir un flux de travail

Lorsque vous connaissez le nom de l'État que vous souhaitez ajouter, utilisez le champ de recherche en haut Navigateur d'états pour le trouver. Sinon, recherchez l'état dont vous avez besoin dans le navigateur et ajoutez-le sur le canevas.

Vous pouvez réorganiser les états de votre flux de travail en les faisant glisser vers un autre emplacement de votre flux de travail. Lorsque vous faites glisser un état sur le canevas, une ligne apparaît pour indiquer où l'état sera inséré dans votre flux de travail, comme le montre la capture d'écran suivante :

Capture d'écran illustrative montrant la ligne bleue qui indique la destination d'un État.

Une fois qu'un état est déposé sur le canevas, son code est généré automatiquement et ajouté dans la définition du flux de travail. Pour voir la définition, activez le bouton Definition dans le panneau Inspector. Vous pouvez choisir Mode code de modifier la définition à l'aide de l'éditeur de code intégré.

Après avoir déposé un état sur le canevas, vous pouvez le configurer dans le Panneau Inspector panneau de droite. Ce panneau contient les onglets Configuration, Entrée, Sortie et Gestion des erreurs pour chaque état ou API action que vous placez sur le canevas. Vous configurez les états que vous incluez dans vos flux de travail dans l'onglet Configuration.

Par exemple, l'onglet Configuration de l'APIaction Lambda Invoke propose les options suivantes :

  • Nom de l'État : vous pouvez identifier l'État avec un nom personnalisé ou accepter le nom généré par défaut.

  • APIindique quelle API action est utilisée par l'État.

  • Type d'intégration : vous pouvez choisir le type d'intégration de service utilisé pour appeler API des actions sur d'autres services.

  • Le nom de la fonction fournit des options pour :

    • Entrez le nom de la fonction : vous pouvez saisir le nom de votre fonction ou sonARN.

    • Obtenir le nom de la fonction au moment de l'exécution à partir de l'entrée d'état : vous pouvez utiliser cette option pour obtenir dynamiquement le nom de la fonction à partir de l'entrée d'état en fonction du chemin que vous spécifiez.

    • Sélectionnez le nom de la fonction : vous pouvez sélectionner directement l'une des fonctions disponibles dans votre compte et dans votre région.

  • Charge utile : vous pouvez choisir d'utiliser l'entrée d'état, un JSON objet ou de ne pas utiliser de charge utile à transmettre comme charge utile à votre fonction Lambda. Si vous le souhaitezJSON, vous pouvez inclure à la fois des valeurs statiques et des valeurs sélectionnées à partir de l'entrée d'état.

  • (Facultatif) Certains États auront la possibilité de sélectionner Attendre la fin de la tâche ou Attendre le rappel. Le cas échéant, vous pouvez choisir l'un des modèles d'intégration de services suivants :

    • Aucune option sélectionnée : Step Functions utilisera le modèle Réponse à la requête d'intégration. Step Functions attendra une HTTP réponse, puis passera à l'état suivant. Step Functions n'attendra pas qu'une tâche soit terminée. Lorsqu'aucune option n'est disponible, l'État utilise ce modèle.

    • Attendez que la tâche soit terminée : Step Functions utilisera le modèle Exécuter une tâche (.sync) d'intégration.

    • Attendez le rappel : Step Functions utilisera le modèle Attendre un rappel avec le jeton de tâche d'intégration.

  • (Facultatif) Pour accéder aux ressources configurées de différentes manières au Comptes AWS sein de vos flux de travail, Step Functions fournit un accès entre comptes. IAMle rôle pour l'accès entre comptes fournit des options pour :

    • Fournir un IAM rôle ARN : Spécifiez le IAM rôle qui contient les autorisations d'accès aux ressources appropriées. Ces ressources sont disponibles sur un compte cible, qui est un compte Compte AWS vers lequel vous passez des appels entre comptes.

    • Obtenir IAM le rôle ARN au moment de l'exécution à partir de l'entrée de l'état : Spécifiez un chemin de référence vers une paire clé-valeur existante dans l'JSONentrée de l'état qui contient le IAM rôle.

  • L'état suivant vous permet de sélectionner l'état vers lequel vous souhaitez passer au suivant.

  • (Facultatif) Le champ de commentaire n'affectera pas le flux de travail, mais vous pouvez l'utiliser pour annoter votre flux de travail.

Certains États disposeront d'options de configuration génériques supplémentaires. Par exemple, la configuration de ECS RunTask l'état d'Amazon contient un API Parameters champ rempli de valeurs d'espace réservé. Pour ces états, vous pouvez remplacer les valeurs d'espace réservé par des configurations adaptées à vos besoins.

Pour supprimer un état

Vous pouvez appuyer sur la touche Retour arrière, cliquer avec le bouton droit de la souris et sélectionner Supprimer l'état, ou choisir Supprimer dans la barre d'outils de conception.

Exécutez votre flux de travail

Lorsque votre flux de travail est prêt, vous pouvez l'exécuter et visualiser son exécution depuis la console Step Functions.

Pour exécuter un flux de travail dans Workflow Studio

  1. En mode Design, Code ou Config, choisissez Execute.

    La boîte de dialogue Démarrer l'exécution s'ouvre dans un nouvel onglet.

  2. Dans la boîte de dialogue Démarrer l'exécution, procédez comme suit :

    1. (Facultatif) Pour identifier votre exécution, vous pouvez spécifier un nom ou utiliser le nom d'exécution généré par défaut.

      Note

      Step Functions accepte les noms des machines d'état, des exécutions, des activités et des étiquettes contenant des caractères autres que des ASCII caractères. Comme les noms ne contenant pas de ASCII caractères ne fonctionneront pas avec Amazon CloudWatch, nous vous recommandons de n'utiliser que ASCII des caractères afin de pouvoir suivre les statistiques. CloudWatch

    2. (Facultatif) Dans la zone de saisie, entrez les valeurs d'entrée au JSON format permettant d'exécuter votre flux de travail.

    3. Choisissez Start execution (Démarrer l'exécution).

    4. La console Step Functions vous dirige vers une page intitulée avec votre ID d'exécution. Cette page est connue sous le nom de page Détails de l'exécution. Sur cette page, vous pouvez consulter les résultats de l'exécution au fur et à mesure que l'exécution progresse ou une fois celle-ci terminée.

      Pour consulter les résultats de l'exécution, choisissez des états individuels dans la vue graphique, puis choisissez les onglets individuels du Détails de l'étape volet pour afficher les détails de chaque état, y compris les entrées, les sorties et la définition respectivement. Pour plus de détails sur les informations d'exécution que vous pouvez consulter sur la page Détails de l'exécution, voirPage de détails d'exécution — Vue d'ensemble de l'interface.

Modifiez votre flux de travail

Vous pouvez modifier visuellement un flux de travail existant dans Mode de conception Workflow Studio.

Dans la console Step Functions, choisissez le flux de travail que vous souhaitez modifier sur la page State machines. Le flux de travail s'ouvre en mode Design de Workflow Studio.

Vous pouvez également modifier la définition du flux de travail dansMode code. Cliquez sur le bouton Code pour afficher ou modifier la définition du flux de travail dans Workflow Studio.

Note

Si vous constatez des erreurs dans votre flux de travail, vous devez les corriger en mode Création. Vous ne pouvez pas passer en mode Code ou Config en cas d'erreur dans votre flux de travail.

Exportez votre flux de travail

Vous pouvez exporter la définition de votre flux de travail Amazon States Language (ASL) et le graphique de votre flux de travail :

  1. Choisissez votre flux de travail dans la console Step Functions.

  2. Sur la page détaillée de State machine, choisissez Modifier.

  3. Cliquez sur le bouton déroulant Actions, puis effectuez l'une des opérations suivantes ou les deux :

    • Pour exporter le graphique du flux de travail vers un PNG fichier SVG OR, sous Exporter le graphique, sélectionnez le format souhaité.

    • Pour exporter la définition du flux de travail sous forme de YAML fichier JSON OR, sous Définition d'exportation, sélectionnez le format souhaité.

Création d'un prototype de flux de travail avec des espaces réservés

Vous pouvez utiliser Workflow Studio ou Workflow Studio Application Composer pour créer des prototypes de nouveaux flux de travail contenant des ressources fictives nommées ressources qui n'existent pas encore.

Pour créer un prototype de flux de travail :

  1. Connectez-vous à la console Step Functions.

  2. Choisissez Create state machine (Créer une machine d'état).

  3. Dans la boîte de dialogue Choisir un modèle, sélectionnez Vide.

  4. Choisissez Sélectionner pour ouvrir Workflow Studio dansMode de conception.

  5. Le mode Design de Workflow Studio s'ouvre. Concevez votre flux de travail dans Workflow Studio. Pour inclure des ressources réservées :

    1. Choisissez l'état pour lequel vous souhaitez inclure une ressource d'espace réservé, puis dans Configuration :

      • Pour les états Lambda Invoke, choisissez le nom de la fonction, puis entrez le nom de la fonction. Vous pouvez également saisir un nom personnalisé pour votre fonction.

      • Pour les états Amazon SQS Send Message, choisissez Queue URL, puis Enter queue URL. Entrez une file d'attente URL réservée.

      • Pour les états Amazon SNS Publish, dans Rubrique, choisissez un sujetARN.

      • Pour tous les autres états répertoriés sous Actions, vous pouvez utiliser la configuration par défaut.

      Note

      Si vous constatez des erreurs dans votre flux de travail, vous devez les corriger en mode Création. Vous ne pouvez pas passer en mode Code ou Config en cas d'erreur dans votre flux de travail.

    2. (Facultatif) Pour afficher la ASL définition générée automatiquement de votre flux de travail, choisissez Definition.

    3. (Facultatif) Pour mettre à jour la définition du flux de travail dans Workflow Studio, cliquez sur le bouton Code.

      Note

      Si vous constatez des erreurs dans la définition de votre flux de travail, vous devez les corriger en mode Code. Vous ne pouvez pas passer en mode Design ou Config si des erreurs existent dans la définition de votre flux de travail.

  6. (Facultatif) Pour modifier le nom de la machine d'état, cliquez sur l'icône d'édition à côté du nom de la machine d'état par défaut de MyStateMachineet spécifiez un nom dans le champ Nom de la machine d'état.

    Vous pouvez également passer au Mode Config pour modifier le nom de la machine à états par défaut.

  7. Spécifiez les paramètres de votre flux de travail, tels que le type de machine à états et son rôle d'exécution.

  8. Sélectionnez Create (Créer).

Vous venez de créer un nouveau flux de travail avec des ressources réservées qui peuvent être utilisées pour le prototypage. Vous pouvez exporter la définition de votre flux de travail et le graphique du flux de travail.

  • Pour exporter la définition de votre flux de travail sous forme de YAML fichier JSON OR, en mode Design ou Code, cliquez sur le bouton déroulant Actions. Ensuite, sous Définition de l'exportation, sélectionnez le format que vous souhaitez exporter. Vous pouvez utiliser cette définition exportée comme point de départ pour le développement local avec le AWS Toolkit for Visual Studio Code.

  • Pour exporter votre graphique de flux de travail vers un PNG fichier SVG OR, en mode Design ou Code, cliquez sur le bouton déroulant Actions. Ensuite, sous Définition de l'exportation, sélectionnez le format souhaité.