Trabajando con AWS Step Functions - AWS Kit de herramientas para VS Code
Requisitos previosTrabajar con máquinas de estado en VS CodePlantillas de máquina de estadoVisualización de gráfico de máquina de estadoFragmentos de códigoFinalización y validación de código

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabajando con AWS Step Functions

Puede usar el AWS Toolkit for Visual Studio Code (código VS) para realizar diversas operaciones con máquinas de estado.

Requisitos previos

  • Asegúrese de que el sistema cumple los requisitos previos especificados en Instalación del kit de herramientas para VS Code y después instale el kit de herramientas.

  • Asegúrese de que ha configurado sus credenciales antes de abrir el Explorador de AWS .

Trabajar con máquinas de estado en VS Code

Puede usar VS Code para interactuar con máquinas de estado remotas y desarrollar máquinas de estado localmente en YAML formato JSON o formato. Puede crear o actualizar máquinas de estado, mostrar las máquinas de estado existentes, ejecutarlas y descargarlas. VS Code también le permite crear nuevas máquinas de estado a partir de plantillas, ver una visualización de su máquina de estado y proporciona fragmentos de código, finalización de código y validación de código.

Mostrar las máquinas de estado existentes

Si ya ha creado máquinas de estado, puede ver una lista de ellas:

  1. Abra AWS Explorer.

  2. Seleccione Step Functions.

  3. Compruebe que muestra todas las máquinas de estado de su cuenta.

    AWS Explorer menu showing regions and services, with LambdaStateMachine highlighted under Step Functions.

Descargar una máquina de estado

Para descargar una máquina de estado:

  1. Desde el Explorador de AWS , haga clic con el botón derecho en la máquina de estado que desea descargar.

  2. Seleccione Download (Descargar) y, a continuación, seleccione la ubicación en la que desea descargar la máquina de estado.

  3. Verifique que se haya descargado correctamente.

    AWS Explorer menu showing LambdaStateMachine with Download Definition option highlighted.

Creación de una máquina de estado

Puede crear una nueva máquina de estado usted mismo o puede utilizar una plantilla. Para obtener más información sobre cómo crear una máquina de estado a partir de una plantilla, consulte la sección State Machine Template (Plantillas de máquina de estado). Para crear una nueva máquina de estado:

  1. Cree un nuevo archivo de Amazon States Language (ASL) con la definición de su máquina de estados. Utiliza el menú de la parte inferior derecha para configurarlo como lenguaje de estados de Amazon.

  2. Seleccione Publish to Step Functions (Publicar en Step Functions).

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.

  3. Seleccione Quick Create (Creación rápida), elija un rol y asigne un nombre a su máquina de estado.

    Quick Create option highlighted for creating a state machine with default settings.
    Dropdown menu showing execution role options, with ECSRole highlighted for selection.
    Dialog box prompting user to name their state machine, with input field and instructions.

Actualización de la máquina de estado

Para actualizar una máquina de estado

  1. Edite el ASL archivo con la definición de su máquina de estados.

  2. Seleccione Publish to Step Functions (Publicar en Step Functions).

    JSON code snippet showing state machine configuration with FirstState and ChoiceState.

  3. Seleccione Quick Update (Actualización rápida), y, a continuación, seleccione la máquina de estado que desea actualizar.

    Quick Update option highlighted in the Publish to AWS Step Functions menu.
    Dropdown menu showing state machine options for updating in us-east-1 region.

Ejecución de una máquina de estado

Para ejecutar una máquina de estado:

  1. Desde el Explorador de AWS , haga clic con el botón derecho en la máquina de estado que desea ejecutar.

  2. Proporcione la entrada de la máquina de estado. Puede probar la entrada desde un archivo y la entrada en un cuadro de texto.

  3. Inicie la máquina de estado y verifique que se ejecuta correctamente.

    AWS Explorer menu showing LambdaStateMachine with Start Execution option highlighted.
    Start Execution interface for LambdaStateMachine with JSON input option and example.

Plantillas de máquina de estado

Cuando crea una máquina de estado, tiene la opción de crearla a partir de una plantilla. La plantilla contiene una definición de máquina de estado de ejemplo con varios estados de uso común y proporciona un punto de partida. Para utilizar plantillas de máquina de estado:

  1. Abra la paleta de comandos en VS Code.

  2. Seleccione Kit de herramientas de AWS : crear una nueva máquina de estado Step Functions.

  3. Elija la plantilla que desea utilizar.

    List of starter templates including Hello world, Retry failure, Wait state, and others.

  4. Elija si desea utilizar el formato de plantilla JSON o el formato YAML de plantilla.

    Dropdown menu showing JSON and YAML options for selecting a template format.

Visualización de gráfico de máquina de estado

Las visualizaciones de gráficos le permiten ver cómo se ve su máquina de estado en formato gráfico. Al crear una visualización gráfica, se abrirá otra pestaña que mostrará una visualización de la máquina de estados JSON oYAML. A continuación, puede comparar la definición de máquina de estado que está escribiendo simultáneamente con su visualización. A medida que cambie la definición de la máquina de estado, la visualización se actualizará.

nota

Para crear una visualización de una definición de máquina de estado, la definición debe estar abierta en el editor activo. Si cierra o cambia el nombre del archivo de definición, la visualización se cerrará.

Para crear una visualización de gráfico de máquina de estado:

  1. Defina su máquina de estado.

  2. Abra la paleta de comandos en VS Code.

  3. Para crear una visualización, utilice el botón de visualización en la esquina superior derecha o elija Gráfico de representación de AWS .

    JSON code and graph visualization of Lenguaje de estados de Amazon with choice state example.

Fragmentos de código

Los fragmentos de código le permiten insertar secciones cortas de código. Para usar fragmentos de código:

  1. Abra un archivo y guárdelo con la extensión .asl.json para JSON formato o .asl.yaml para YAML formato.

  2. Cree una nueva máquina de estado con la propiedad States (Estados).

  3. Coloque el cursor dentro de States (Estados).

  4. Utilice la combinación de teclas Control + Space y seleccione su fragmento de código preferido.

  5. Utilice Tab para recorrer la variable y los parámetros en el fragmento de código.

  6. Pruebe los fragmentos Retry y Catch colocando el cursos en el estado relacionado.

    Code snippet for Lambda Task State with dropdown menu showing various state types.

Finalización y validación de código

Para ver cómo funciona la finalización del código:

  1. Cree varios estados.

  2. Coloque el cursor después de la propiedad Siguiente o Predeterminada. StartAt

  3. Utilice la combinación de teclas Control + Space para enumerar las finalizaciones disponibles. Se puede acceder a propiedades adicionales utilizando Control + Space de nuevo y se basarán en el Type de State.

  4. A medida que trabaje, se llevará a cabo la validación de código para:

    • Propiedades que faltan

    • Valores incorrectos

    • Estado no terminal

    • Estados inexistentes a los que se señala

    JSON code snippet showing state machine structure with task, choice, and default states.
    Code snippet showing AWS Lambda function properties with a tooltip describing the Catch property.