View a markdown version of this page

Travailler avec AWS Step Functions - AWS Boîte à outils pour VS Code
Affichage des machines à états Step FunctionsCréation d'une machine à états Step FunctionsCréation d'une machine à états Step Functions à partir d'un modèleTéléchargement d'une machine à états Step FunctionsEnregistrement des modifications sur une machine à états Step FunctionsExécution d'une machine à états Step FunctionsUtilisation d'extraits de codeValidation du code

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.

Travailler avec AWS Step Functions

Les sections suivantes décrivent comment utiliser des AWS Step Functions Amazon State Language (ASL) fichiers contenant des définitions de machine à états dans le AWS Toolkit. Pour des informations détaillées sur les machines à AWS Step Functions états, consultez la rubrique En savoir plus sur les machines à états dans Step Functions du Guide du AWS Step Functions développeur.

Affichage des machines à états Step Functions

Pour afficher vos ASL fichiers existants contenant des définitions de machine à états dans l'explorateur AWS Toolkit, procédez comme suit.

  1. Dans l'explorateur de la AWS boîte à outils, développez la zone qui contient le ASL fichier que vous souhaitez afficher.

  2. Développez la rubrique Step Functions.

  3. Vos ASL fichiers s'affichent dans l' AWS explorateur.

Création d'une machine à états Step Functions

Dans la AWS boîte à outils, vous pouvez créer une nouvelle machine à états Step Functions à partir d'un fichier ou utiliser un modèle. La procédure suivante décrit comment créer une machine d'état Step Functions à partir d'un fichier. Pour plus de détails sur la création d'une machine à états SFN ; à partir d'un modèle, consultez la section Modèles de machine à états située ci-dessous, dans cette rubrique du Guide de l'utilisateur.

Note

Pour utiliser Step Functions dans VS Code, l'extension de votre fichier Amazon State Language (ASL) contenant la définition de votre machine à états doit se terminer par asl.jsonasl.yml, ou.asl.yaml.

Par défaut, les fichiers Step Functions pertinents s'ouvrent dans Workflow Studio. Pour obtenir des informations détaillées sur l'utilisation de Workflow Studio via la AWS boîte à outils, consultez la rubrique Utilisation de Workflow Studio dans ce guide de l'utilisateur.

  1. Depuis votre espace de travail dans VS Code, créez un nouveau fichier.

  2. Donnez un nom à votre fichier et spécifiez son extension comme asl.json suit :asl.yml, ou.asl.yaml.

  3. Lors de la création, le AWS Toolkit ouvre le nouveau fichier dans AWS Step Functions Workflow Studio.

  4. Dans Workflow Studio, cliquez sur le bouton Enregistrer dans le menu utilitaire pour enregistrer votre nouveau ASL fichier.

Création d'une machine à états Step Functions à partir d'un modèle

Dans la AWS boîte à outils, vous pouvez créer une machine à états Step Functions à partir d'un modèle. Le processus de modèle crée un ASL fichier contenant une définition de machine à états, fournissant un point de départ pour votre projet. La procédure suivante décrit comment créer une machine à états Step Functions à partir d'un modèle du AWS Toolkit.

  1. Dans l'explorateur de AWS boîte à outils, développez la région dans laquelle vous souhaitez créer une machine à états Step Functions.

  2. Ouvrez le menu contextuel de Step Functions (cliquez avec le bouton droit de la souris) et choisissez Créer une nouvelle machine à états Step Functions pour ouvrir l'assistant de sélection d'un modèle de démarrage (1/2) dans VS Code.

  3. Dans l'assistant Sélectionnez un modèle de démarrage (1/2), choisissez le type de modèle pour votre machine à états Step Functions pour continuer.

  4. Dans l'écran Sélectionner le format du modèle (2/2), choisissez YAML ou JSON pour le format de votre modèle.

  5. Un nouveau ASL fichier contenant la définition de votre machine à états s'ouvre dans l'éditeur VS Code.

Téléchargement d'une machine à états Step Functions

Pour télécharger une machine d'état Step Functions stockée à distance sur votre instance locale de VS Code, procédez comme suit.

  1. Dans l'explorateur de AWS boîte à outils, développez la région contenant la machine à états Step Functions que vous souhaitez télécharger.

  2. Développez Step Functions, puis cliquez avec le bouton droit sur la machine d'état Step Functions que vous souhaitez télécharger et choisissez Télécharger la définition... .

  3. Spécifiez un emplacement pour stocker localement votre machine d'état Step Functions pour continuer.

  4. La machine d'état Step Functions s'ouvre dans Workflow Studio une fois la procédure terminée.

Enregistrement des modifications sur une machine à états Step Functions

La procédure suivante décrit comment enregistrer les modifications apportées à votre machine à états Step Functions.

Note

Les modifications effectuées dans Workflow Studio sont synchronisées avec votre fichier local, mais ne sont pas enregistrées tant que votre travail n'est pas enregistré dans l'éditeur VS Code ou Workflow Studio. Si votre fichier local est modifié et enregistré alors que Workflow Studio est ouvert et qu'aucune erreur n'est détectée dans votre ASL fichier, vous recevez une notification de réussite dans Workflow Studio une fois l'enregistrement terminé. Toutefois, si le contenu de votre fichier local n'est pas valide JSON ou YAML si vous tentez de l'enregistrer, la synchronisation de votre fichier local échoue et vous recevez une notification d'avertissement dans Workflow Studio.

  1. À partir d'un ASL fichier ouvert contenant une définition de machine à états dans Workflow Studio, accédez aux boutons Utilitaires.

  2. Choisissez le bouton Enregistrer.

  3. VS Code vous avertit lorsque le fichier a été enregistré.

Exécution d'une machine à états Step Functions

La procédure suivante décrit comment exécuter une machine d'état Step Functions dans le AWS Toolkit.

  1. Dans l'explorateur de AWS boîte à outils, développez la zone contenant la machine d'état Step Functions que vous souhaitez exécuter.

  2. Développez Step Functions, puis cliquez avec le bouton droit sur la machine d'état Step Functions que vous souhaitez exécuter.

  3. Dans le menu contextuel, choisissez Démarrer l'exécution pour lancer le processus de lancement.

  4. L'état du lancement est affiché dans la fenêtre de sortie du AWS Toolkit dans VS Code.

Utilisation d'extraits de code

Les extraits de code sont des suggestions automatisées qui sont générées en fonction du code sur lequel vous travaillez. Pour utiliser des extraits de code avec Step Functions dans la boîte à outils, procédez comme suit.

Note

Pour utiliser des extraits de code Step Functions dans VS Code, l'extension de votre ASL fichier contenant la définition de votre machine à états doit se terminer par .asl.json.asl.yml, ou. .asl.yaml

Par défaut, vos fichiers Step Functions pertinents s'ouvrent dans Workflow Studio.

  1. Dans VS Code, ouvrez un ASL fichier contenant la définition de machine à états que vous souhaitez modifier ou créez un nouveau ASL fichier.

  2. Dans Workflow Studio, passez en mode Code si vous êtes en mode Conception.

  3. Depuis l'éditeur de code Workflow Studio, placez votre curseur dans la "States" propriété.

  4. Appuyez control + space pour ouvrir le menu des extraits de code. Des propriétés supplémentaires sont accessibles en appuyant sur control + space et sont basées sur. "State" "Type"

  5. Choisissez l'extrait de code que vous souhaitez dans la liste.

Validation du code

Lorsque vous travaillez sur Step Functions dans Workflow Studio, la validation du code identifie activement les erreurs et propose les solutions suivantes :

  • Propriétés manquantes

  • Valeurs incorrectes

  • État non terminal

  • États pointés non existants