Découvrez comment démarrer avec Step Functions

Le service Step Functions vous permet d'orchestrer des flux de travail applicatifs complexes. Pour commencer, vous allez utiliser Workflow Studio pour créer et exécuter un flux de travail Hello World intégré. Vous allez passer en revue la définition générée automatiquement Amazon States Language (ASL) dans le code. Enfin, vous allez glisser-déposer une intégration de service pour effectuer une analyse des sentiments.

Après avoir terminé ce didacticiel, vous saurez comment utiliser Workflow Studio pour créer, configurer, exécuter et mettre à jour un flux de travail à l'aide des modes Conception et Code.

Durée estimée : 20 à 30 minutes

Ce que vous allez construire

Votre première machine à états démarrera avec les états de flux. Les états de flux sont utilisés pour diriger et contrôler votre flux de travail. Après avoir appris à exécuter le flux de travail, vous allez ajouter une action pour intégrer le service Amazon Comprehend à un état de tâche.

Le schéma suivant montre un visuel de la machine à états complète que vous allez créer. Lorsque vous créez la machine d'état Hello World pour la première fois, elle n'a pas besoin de ressources supplémentaires pour fonctionner. La console Step Functions créera tous les états et un rôle IAM en un seul clic. Plus tard, lorsque vous ajouterez l'intégration du service, vous devrez créer un rôle avec une politique d'autorisation personnalisée.

Étape 1 - Créez votre machine à états

Dans Step Functions, les flux de travail sont appelés machines à états. Nous utiliserons les deux termes de manière interchangeable. Vos flux de travail contiendront des états qui prennent des mesures ou contrôlent le flux de vos machines à états.

Présentation de Workflow Studio

Avec Workflow Studio pour Step Functions, vous pouvez faire glisser et déposer visuellement des états sur un canevas pour créer des flux de travail.

Vous pouvez ajouter et modifier des états, configurer des étapes, transformer les résultats et configurer la gestion des erreurs. La capture d'écran suivante montre quatre zones importantes de l'interface que vous utiliserez pour créer vos machines d'état.

Modes - Workflow Studio propose trois modes de fonctionnement et utilise par défaut le mode de conception visuelle.

Le navigateur States contient les trois onglets suivants :

Le diagramme de canevas et de flux de travail vous permet de glisser-déposer des états sur votre graphique de flux de travail, de modifier l'ordre des états et de sélectionner les états à configurer et à tester.

Le panneau de l'inspecteur vous permet de visualiser et de modifier les propriétés de tout état sélectionné sur le canevas. Vous pouvez activer le bouton Définition pour afficher le code correspondant à l'état actuellement sélectionné.

Vue d'ensemble de la machine à états

Le flux de travail Hello World commence par un état Pass qui transmet son entrée à sa sortie, sans effectuer de travail. Les états de passe peuvent être utilisés pour générer une sortie JSON statique ou transformer une entrée JSON avant de passer les données à l'état suivant. Les états de passe sont utiles lors de la création et du débogage de machines à états.

L'état suivant, un état Choice, utilise les données saisies IsHelloWorldExample pour choisir la branche suivante du flux de travail. Si la première règle correspond, le flux de travail s'arrête en mode attente, puis exécute deux tâches en mode parallèle, avant de passer à un point de contrôle et de terminer le flux de travail avec succès. En l'absence de correspondance, le flux de travail passe par défaut à l'état Échec avant d'arrêter la machine à états.

Les états d'attente peuvent être utiles lorsque vous souhaitez attendre avant d'effectuer d'autres tâches. Votre flux de travail attendra peut-être 30 secondes après la saisie d'une commande, afin que votre client ait le temps de remarquer et de corriger une adresse de livraison incorrecte.

Les états parallèles peuvent exécuter plusieurs processus sur vos données. Peut-être que le flux de travail imprimera un bon de commande, mettra à jour l'inventaire et augmentera simultanément un rapport de ventes quotidien.

Afficher le code du flux de travail (ASL)

Votre première machine à états est en fait assez détaillée, alors explorez plus en détail en passant en revue le code.

Les machines à états sont définies à l'aide d'Amazon States Language (ASL), une spécification open source qui décrit un JSON-based langage pour décrire les machines à états de manière déclarative.

Pour afficher la définition complète de la machine à états

Avez-vous remarqué comment la définition de l'État est mise en évidence dans la vue du code ?

Pour afficher le code dans l'inspecteur

Essayez de choisir d'autres états. Vous voyez comment le code ASL de chaque état que vous sélectionnez est affiché et surligné ?

(En fait) Créez la machine à états

Jusqu'à présent, vous travailliez sur une ébauche de votre machine à État. Aucune ressource n'a encore été créée.

Pour renommer et créer votre machine à états

Vous devriez voir des notifications indiquant que votre machine d'état et un nouveau rôle IAM ont été créés.

L'option permettant de démarrer la machine d'état vous sera automatiquement présentée. C'est ce que vous ferez à l'étape suivante !

Étape 2 - Démarrez votre machine à états

Une fois que votre machine à états a été créée, vous pouvez démarrer votre flux de travail.

Les flux de travail prennent éventuellement des entrées qui peuvent être utilisées dans l'état, envoyées aux services intégrés et passées à l'état suivant.

La machine d'état Hello World est autonome et ne nécessite aucune saisie.

Pour démarrer la machine d'état

Passez en revue les détails de l'exécution

Immédiatement après le démarrage, vous devriez voir que les deux premiers états ont réussi.

Après une courte attente, les autres transitions d'état s'exécuteront pour terminer le flux de travail.

Vous vous demandez comment se trouve l'état Choice (Is Hello World Example) ? ) a décidé de passer à l'état Wait for X Seconds ?

Vous devriez voir que l'entrée State est vide, mais que la sortie State contient du JSON qui définit la valeur IsHelloWorldExample surtrue.

Passez de la vue graphique à la vue Tableau pour afficher la liste des états par nom, type et statut.

Il existe deux autres vues à explorer sur cette page des détails des exécutions : la vue des événements et la vue de l'état.

La vue des événements est une vue granulaire détaillée du flux d'un état à l'autre.

Développez le premier PassStateEntered et les PassStateExited événements du tableau Event View pour voir comment l'état ne prend aucune entrée, attribue une variable appelée CheckpointCount valeur zéro et produit la sortie que vous avez vue précédemment.

Enfin, vous avez la vue État qui est similaire à la vue Tableau. Dans le tableau d'affichage des états, vous pouvez développer les états de manière sélective pour afficher uniquement les entrées et les sorties de chaque état :

Étape 3 - Traiter les entrées externes

Il n'est pas réaliste de IsHelloWorldExample définir la valeur de sur une valeur constante dans le flux de travail. Vous devez vous attendre à ce que votre machine à états réponde à différentes données d'entrée.

Dans cette étape, nous allons vous montrer comment les données JSON externes peuvent être utilisées comme entrées dans votre flux de travail :

Supprimer l'entrée codée en dur

Tout d'abord, remplacez la valeur codée en dur dans la sortie du premier état Pass.

La sortie d'état mise à jour extraira les données d'entrée de la variable $states réservée à l'aide d'une expression JSonata. Ces valeurs seront transmises à l'état suivant en tant que sortie pour devenir l'entrée de l'état suivant.

Exécutez le flux de travail mis à jour, avec les données d'entrée

Ensuite, exécutez le flux de travail et fournissez des données d'entrée externes au format JSON.

L'exécution de votre machine d'état devrait attendre beaucoup plus longtemps (20 secondes), mais elle devrait finalement réussir en utilisant l'entrée que vous avez fournie.

Dans la vue graphique, vérifiez Input/Output le premier état du pass. Remarquez comment les entrées que vous avez fournies ont été converties en sorties. Consultez également les entrées et sorties d'exécution sur la page des détails de l'exécution. Les deux emplacements indiquent l'entrée que vous avez utilisée pour démarrer l'exécution.

Vérifiez les exécutions des flux de travail

Maintenant que vous avez exécuté votre flux de travail à quelques reprises, passez en revue les détails d'exécution pour passer en revue les exécutions de votre flux de travail.

Pour consulter les détails de l'exécution

Dans l'onglet Exécutions, vous devriez voir une liste des exécutions, similaire à la capture d'écran suivante :

Une dernière remarque : les noms d'exécution des flux de travail doivent être uniques et ne peuvent pas être réutilisés. Bien que nous ayons suggéré un nom abrégé (hello001) dans ce didacticiel, nous vous recommandons d'utiliser une convention de dénomination qui sera toujours unique pour vos charges de travail de production.

Étape 4 - Intégrer un service

Les machines d'état Step Functions peuvent appeler plus de 220 AWS services à l'aide des intégrations du AWS SDK. AWS les services fournissent plus de 10 000 actions d'API potentielles pour vos machines d'état.

Au cours de cette étape, vous allez intégrer une tâche Amazon Comprehend pour l'analyse des sentiments afin de traiter les entrées de votre machine à états.

Les intégrations de services utilisent l'un des trois modèles d'intégration de services suivants :

Pour votre première intégration, vous utiliserez le modèle d'intégration Request Response (par défaut).

Comment fonctionnent les intégrations ?

Un état de tâche représente une unité de travail unique exécutée par une machine à états. Tout le travail au sein de votre machine d'état est effectué par des tâches.

Une tâche effectue généralement son travail en transmettant des données d'entrée aux actions d'API d'autres services, qui effectuent ensuite leur propre travail. Vous pouvez spécifier le mode d'exécution d'une tâche à l'aide d'un certain nombre de champsCredentials, notamment :Retry,Catch,TimeoutSeconds, et plus encore. Vous pouvez en savoir plus sur les tâches dansÉtat du flux de travail des tâches.

Pour utiliser les intégrations du AWS SDK, vous devez spécifier le nom du service et l'API à appeler. Certaines intégrations nécessitent également des paramètres.

Vous pouvez utiliser Amazon States Language pour spécifier une action d' AWS API dans le champ Ressource d'un état de tâche. Vous pouvez éventuellement ajouter un type d'intégration de service au nom du service.

Pour spécifier une action d'API, vous allez utiliser le modèle de nom de ressource suivant :

arn:aws:states:::aws-sdk:serviceName:apiAction.[serviceIntegrationPattern]

Exemples de noms de ressources

Lorsque Step Functions appelle un autre service en utilisant l'Taskétat, le modèle par défaut est Request Response. Grâce au modèle d'intégration Request Response, Step Functions appelle un service, reçoit une réponse et passe immédiatement à l'état suivant.

Étape 4.1 - Ajouter un état d'analyse des sentiments

Étape 4.2 - Configurer l'état de l'analyse des sentiments

Après avoir choisi ces options de saisie semi-automatique, vous devriez disposer du JSON suivant pour vos arguments d'état :

{
    "LanguageCode": "en",
    "Text": "{% $states.context.Execution.Input.feedback_comment %}"
}

Étape 4.3 - Configuration d'une politique d'identité

Avant de pouvoir exécuter le flux de travail, vous devez créer un rôle et une politique permettant à la machine d'état d'effectuer des appels d'API vers le service externe.

Pour créer un rôle IAM pour Step Functions

Pour ajouter une politique au HelloWorldWorkflowRole pour Amazon Comprehend

Si vous examinez la politique, vous verrez qu'elle autorise toutes les ressources à prendre l'action "comprehend:DetectSentiment".

Pour associer le rôle IAM à la machine d'état Step Functions

Étape 4.4 - Exécutez votre machine à états

Commencez à exécuter votre machine d'état avec le JSON suivant pour la saisie :

{
    "hello_world": false,
    "wait": 42,
    "feedback_comment" : "This getting started with Step Functions workshop is a challenge!"
}

User: arn:aws:sts::account-id:assumed-role/StepFunctions-MyStateMachine-role is not authorized
to perform: comprehend:DetectSentiment because no identity-based policy allows the comprehend:DetectSentiment
action (Service: Comprehend, Status Code: 400, Request ID: a1b2c3d4-5678-90ab-cdef-EXAMPLE11111)
        

Mettez en pratique ce que vous avez appris !

Avant de vous lancer dans des flux de travail plus complexes, mettez en pratique ce que vous avez appris en effectuant les tâches suivantes :

Pour en savoir plus sur les résultats de l'analyse des sentiments, consultez Amazon Comprehend - Sentiment.

Une façon de penser à l'intégration de Request Response est que la réponse ne représente généralement qu'un accusé de réception de la demande. Cependant, dans certaines intégrations, telles que l'analyse des sentiments, l'accusé de réception représente en fait l'achèvement de la tâche.

L'enseignement clé est que l'TaskÉtat n'attend pas la tâche sous-jacente dans les intégrations Request Response. Pour attendre une réponse, vous devez explorer le modèle d'intégration du service Run a Job (.sync).

nettoyer des ressources ;

Procédez comme suit pour nettoyer les ressources que vous avez créées :

Votre machine à états et le rôle associé devraient maintenant être supprimés avec succès.