Usar Workflow Studio - AWS Step Functions

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.

Usar Workflow Studio

Aprenda a crear, editar y ejecutar flujos de trabajo con Step Functions Workflow Studio. Una vez que el flujo de trabajo esté listo, puede exportarlo. También puede usar Workflow Studio para crear prototipos rápidamente.

Crear un flujo de trabajo

En Workflow Studio, puede elegir una plantilla de inicio o bien una plantilla en blanco para crear un flujo de trabajo desde cero. En el caso de las plantillas en blanco, puede usar el modo Diseño o Código para crear su flujo de trabajo.

Una plantilla de inicio es un proyecto de ready-to-run ejemplo que crea automáticamente el prototipo y la definición del flujo de trabajo y despliega todos los AWS recursos relacionados que el proyecto necesite. Cuenta de AWS Puede usar estas plantillas de inicio para implementarlas y ejecutarlas tal cual, o bien usar los prototipos de flujo de trabajo para desarrollarlas a partir de ellos. Para obtener más información acerca de las plantillas de inicio, consulte Proyectos de muestra para Step Functions.

Crear un flujo de trabajo con plantillas de inicio

  1. Abra la consola de Step Functions y seleccione Crear máquina de estado.

  2. En el cuadro de diálogo Elegir una plantilla, realice una de las siguientes acciones para elegir un proyecto de muestra, por ejemplo, el proyecto de muestra Temporizador de tareas:

    • Escriba Task Timer en el cuadro Buscar por palabra clave y, a continuación, seleccione Temporizador de tareas en los resultados de búsqueda que aparecen.

    • Examine los proyectos de muestra que aparecen en Todos en el panel derecho y, a continuación, seleccione Temporizador de tareas.

  3. Elija Siguiente para continuar.

  4. Step Functions muestra una lista de las Servicios de AWS utilizadas en el proyecto de muestra que ha seleccionado. También muestra un gráfico del flujo de trabajo para el proyecto de muestra. Implemente este proyecto en su empresa Cuenta de AWS o utilícelo como punto de partida para crear sus propios proyectos. En función de cómo desee continuar, elija Ejecutar una demostración o Crear a partir de ella.

  5. Elija Utilizar plantilla para continuar con la selección.

  6. Realice una de las acciones siguientes:

    • Si se ha seleccionado Crear a partir de ella, Step Functions crea el prototipo de flujo de trabajo para el proyecto de muestra que ha seleccionado. Step Functions no implementa los recursos que se enumeran en la definición del flujo de trabajo. En Modo Diseño, arrastre y suelte los estados desde el Navegador de estados para seguir creando su prototipo de flujo de trabajo. También puede cambiar al Modo Código para actualizar la definición de Lenguaje de estados de Amazon (ASL) del flujo de trabajo.

      importante

      No olvide actualizar el marcador de posición del nombre de recurso de Amazon (ARN) para los recursos que se utilizan en el proyecto de muestra antes de ejecutar el flujo de trabajo.

    • Si seleccionó Ejecutar una demostración, Step Functions crea un proyecto de ejemplo de solo lectura que utiliza una AWS CloudFormation plantilla para implementar los AWS recursos que figuran en esa plantilla en su empresa. Cuenta de AWS

      sugerencia

      Seleccione Código para ver la definición de máquina de estados del proyecto de muestra.

      Cuando esté listo, elija Implementar y ejecutar para implementar el proyecto de muestra y crear los recursos.

      nota

      El proceso de creación de estos recursos y los permisos de IAM relacionados puede tardar hasta 10 minutos. Mientras se despliegan sus recursos, puede abrir el enlace CloudFormation Stack ID para ver qué recursos se están aprovisionando.

      importante

      Se aplican cargos estándar por cada servicio utilizado en la CloudFormation plantilla.

Crear un flujo de trabajo con una plantilla en blanco

  1. Abra la consola de Step Functions.

  2. Elija Crear máquina de estado.

  3. En el cuadro de diálogo Elegir una plantilla, seleccione En blanco.

  4. Elija Seleccionar. Se abrirá Workflow Studio en Modo Diseño.

    Ahora puede empezar a diseñar su flujo de trabajo en Modo Diseño o escribir su definición de flujo de trabajo en Modo Código.

  5. Seleccione Config para administrar la configuración de su flujo de trabajo en el Modo Config. Por ejemplo, proporcione un nombre para su flujo de trabajo y seleccione su tipo.

Diseñar un flujo de trabajo

Si conoce el nombre del estado que desea añadir, utilice el cuadro de búsqueda que aparece en la parte superior del Navegador de estados para buscar ese estado en las pestañas Acciones y Flujo del Modo Diseño.

Búsqueda en Step Functions Workflow Studio

De lo contrario, seleccione un estado en el navegador de estados y arrástrelo y suéltelo en el lienzo, colocándolo donde desee en su flujo de trabajo. También puede reordenar los estados del flujo de trabajo arrastrándolos a una ubicación diferente del flujo de trabajo. A medida que arrastra un estado al lienzo, aparece una línea en el lugar donde puede colocarlo en el flujo de trabajo. Una vez que se arrastra un estado en el lienzo, su código se genera automáticamente y se añade a la definición de flujo de trabajo. Para ver la definición, active el botón Definición en el panel Inspector. Para editar la definición de su flujo de trabajo, seleccione el Modo Código que ofrezca un editor de código integrado.

Adición de estado de Step Functions Workflow Studio al lienzo

Después de colocar un estado en el lienzo, puede configurarlo en el panel Inspector de la derecha. Este panel contiene las pestañas Configuración, Entrada, Salida y Control de errores para cada estado o acción de API que coloque en el lienzo. En la pestaña Configuración se configuran los estados que se incluyen en los flujos de trabajo. Por ejemplo, la pestaña Configuración para la acción de la API Lambda Invoke consta de las siguientes opciones:

Opciones de configuración
  1. El nombre del estado identifica el estado. Puede usar su propio nombre o aceptar el nombre generado de manera predeterminada.

  2. La API muestra la acción de API que utiliza el estado.

  3. La lista desplegable Tipo de integración ofrece opciones para elegir el tipo de integraciones de servicios disponibles en Step Functions. El tipo de integración que elijas se utiliza para llamar a las acciones de la API de una parte específica Servicio de AWS de tu flujo de trabajo.

  4. El nombre de la función ofrece opciones para:

    • Introducir el nombre de una función: puede introducir el nombre de la función o su ARN.

    • Obtener el nombre de una función en tiempo de ejecución a partir de la entrada de estado: puede usar esta opción para obtener dinámicamente el nombre de la función a partir de la entrada de estado en función de la ruta que especifique.

    • Seleccionar el nombre de una función: puede seleccionar directamente entre las funciones disponibles en su cuenta y región.

  5. La carga le permite seleccionar entre las siguientes opciones:

    • Usar la entrada de estado como carga: puede usar esta opción para pasar la entrada del estado como la carga que se proporciona a la función de Lambda.

    • Introducir su propia carga: puede usar esta opción para construir un objeto JSON y pasarlo como carga a la función de Lambda. Este JSON puede incluir valores estáticos y valores seleccionados de la entrada de estado.

    • Sin carga: puede usar esta opción si no quiere pasar ninguna carga a la función de Lambda.

  6. (Opcional) Algunos estados tendrán la opción de seleccionar Esperar a que se complete la tarea o Espere la devolución de la llamada. Cuando estén disponibles, estas opciones seleccionan uno de los siguientes patrones de integración de servicios:

    • No se ha seleccionado ninguna opción: Step Functions usará el patrón de integración Respuesta de la solicitud. Step Functions esperará una respuesta HTTP y pasará al siguiente estado. Step Functions no esperará a que se complete un trabajo. Cuando no haya opciones disponibles, el estado utilizará este patrón.

    • Esperar a que se complete la tarea: Step Functions utilizará el patrón de integración Ejecutar un trabajo (.sync).

    • Esperar la devolución de la llamada: Step Functions utilizará el patrón de integración Cómo esperar una devolución de llamada con el token de tarea.

  7. (Opcional) Para acceder a los recursos configurados de forma diferente Cuentas de AWS dentro de sus flujos de trabajo, Step Functions ofrece acceso multicuenta. El rol de IAM para el acceso entre cuentas ofrece opciones para:

    • Proporcionar el ARN del rol de IAM: permite especificar el rol de IAM que contiene los permisos de acceso a los recursos adecuados. Estos recursos están disponibles en una cuenta de destino, que es una cuenta Cuenta de AWS a la que se pueden realizar llamadas entre cuentas.

    • Obtener ARN del rol de IAM en tiempo de ejecución a partir de la entrada de estado: permite especificar una ruta de referencia a un par clave-valor existente en la entrada JSON del estado que contiene el rol de IAM.

  8. El estado siguiente le permite seleccionar el estado al que desea pasar a continuación.

  9. (Opcional) El campo Comentario se puede utilizar para añadir su propio comentario. No afectará al flujo de trabajo, pero se puede usar para anotarlo.

Algunos estados tendrán opciones de configuración más genéricas. Por ejemplo, la configuración del estado RunTask de Amazon ECS contiene un campo API Parameters rellenado con valores de los marcadores de posición.

Opciones de configuración para el estado RunTask de Amazon ECS

Para estos estados, puede reemplazar los valores de los marcadores de posición por configuraciones que se adapten a sus necesidades.

Para eliminar un estado, puede usar la barra de retroceso, hacer clic con el botón derecho y elegir Eliminar estado, o bien elegir Eliminar en la barra de herramientas de diseño.

Eliminar estado

A medida que el flujo de trabajo vaya creciendo, es posible que no quepa en el lienzo. Puede hacer lo siguiente:

  1. Usar los controles de los paneles laterales para cambiar el tamaño de los paneles o cerrarlos.

  2. Usar los controles de la barra de herramientas de diseño situados en la parte superior del Canvas para acercar o alejar el gráfico del flujo de trabajo.

Controles de lienzo

Ejecutar el flujo de trabajo

Después de crear o editar el flujo de trabajo con Workflow Studio, puede ejecutarlo y ver su ejecución en la consola de Step Functions.

Para ejecutar un flujo de trabajo en Workflow Studio
  1. En los modos Diseño, Código o Config, elija Ejecutar.

    Se abre el cuadro de diálogo Iniciar ejecución en una pestaña nueva.

  2. En el cuadro de diálogo Iniciar ejecución, haga lo siguiente:

    1. (Opcional) Para identificar la ejecución, puede especificar un nombre en el cuadro Nombre. De forma predeterminada, Step Functions genera automáticamente un nombre de ejecución único.

      nota

      Step Functions le permite crear nombres para máquinas de estados, ejecuciones y actividades, así como etiquetas que contienen caracteres no ASCII. Estos nombres que no son ASCII no funcionan con Amazon. CloudWatch Para asegurarse de que puede realizar un seguimiento de CloudWatch las métricas, elija un nombre que utilice únicamente caracteres ASCII.

    2. (Opcional) En el cuadro Entrada, introduzca los valores de entrada en formato JSON para ejecutar el flujo de trabajo.

    3. Seleccione Iniciar ejecución.

    4. La consola de Step Functions le dirige a una página cuyo título es su ID de ejecución. Esta página se conoce como Detalles de la ejecución. En esta página, puede revisar los resultados de la ejecución a medida que avanza la ejecución o una vez finalizada.

      Para revisar los resultados de la ejecución, elija los estados individuales en la Vista de gráfico y, a continuación, elija las pestañas individuales del panel Detalles del paso para ver los detalles de cada estado, incluidas la entrada, la salida y la definición, respectivamente. Para obtener más información sobre la ejecución que puede ver en la página Detalles de la ejecución, consulte Página de detalles de ejecución: información general de la interfaz.

Editar el flujo de trabajo

Puede editar visualmente un flujo de trabajo existente en el Modo Diseño de Workflow Studio. También puede editar la definición del flujo de trabajo en Modo Código de Workflow Studio.

Para editar un flujo de trabajo existente:

  1. Abra la consola de Step Functions.

  2. En la página Máquinas de estados, elija el flujo de trabajo que desee editar.

  3. En la página Detalle de la máquina de estado, elija Editar.

  4. El flujo de trabajo se abre en el modo Diseño de Workflow Studio. Edite el flujo de trabajo según sea necesario.

    Editar el flujo de trabajo en modo Diseño
    nota

    Si se observan errores en el flujo de trabajo, deben corregirse en el modo Diseño. No se puede cambiar al modo Código o Config si hay algún error en el flujo de trabajo.

  5. (Opcional) Pulse el botón Código para ver o editar la definición del flujo de trabajo en Workflow Studio.

    Ver o editar el flujo de trabajo en modo Código
  6. Cuando haya terminado, elija Guardar para guardar el flujo de trabajo actualizado.

  7. (Opcional) Para ejecutar el flujo de trabajo actualizado, seleccione Ejecutar. Se abre el cuadro de diálogo Iniciar ejecución en una pestaña nueva.

Exportar el flujo de trabajo

Puede exportar la definición de Lenguaje de estados de Amazon (ASL) de su flujo de trabajo y el gráfico de su flujo de trabajo:

  1. Elija su flujo de trabajo en la consola de Step Functions.

  2. En la página Detalle de la máquina de estado, elija Editar.

  3. (Opcional) El flujo de trabajo se abre en el modo Diseño de Workflow Studio. Edite el flujo de trabajo en el modo Diseño o cambie al modo Código.

  4. Elija el botón desplegable Acciones y luego realice una o ambas de las siguientes acciones:

    • Para exportar el gráfico del flujo de trabajo a un archivo SVG o PNG, seleccione el formato que desee en Exportar gráfico.

    • Para exportar la definición del flujo de trabajo como un archivo JSON o YAML, seleccione el formato que desee en Exportar definición.

Crear el prototipo del flujo de trabajo

Puede usar Workflow Studio para crear prototipos de nuevos flujos de trabajo que contengan recursos de marcadores de posición. También puede crear sus flujos de trabajo con Workflow Studio en Application Composer. Para crear un prototipo:

  1. Inicie sesión en la consola de Step Functions.

  2. Elija Crear máquina de estado.

  3. En el cuadro de diálogo Elegir una plantilla, seleccione En blanco.

  4. Elija Seleccionar. Se abrirá Workflow Studio en Modo Diseño.

  5. Se abre el modo Diseño de Workflow Studio. Diseñe su flujo de trabajo en Workflow Studio. Para incluir recursos de marcadores de posición:

    1. Elija el estado para el que desea incluir un recurso de marcador de posición y, a continuación, en Configuración:

      • Para los estados Lambda Invoke, seleccione Nombre de función y luego Introducir nombre de función. También puede introducir un nombre personalizado para la función.

      • Para los estados Enviar mensaje de Amazon SQS, seleccione URL de cola y luego Introducir URL de cola. Introduzca un marcador de posición para la URL de cola.

      • Para los estados Publicar de Amazon SNS, seleccione un ARN de tema en Tema.

      • Para el resto de estados que aparecen en Acciones, puede usar la configuración predeterminada.

      nota

      Si se observan errores en el flujo de trabajo, deben corregirse en el modo Diseño. No se puede cambiar al modo Código o Config si hay algún error en el flujo de trabajo.

    2. (Opcional) Para ver la definición de ASL generada automáticamente de su flujo de trabajo, seleccione Definición.

    3. (Opcional) Para actualizar la definición del flujo de trabajo en Workflow Studio, pulse el botón Código.

      nota

      Si se observan errores en la definición del flujo de trabajo, deben corregirse en el modo Código. No se puede cambiar al modo Código o Config si hay algún error en la definición del flujo de trabajo.

  6. (Opcional) Para editar el nombre de la máquina de estado, seleccione el icono de edición situado junto al nombre predeterminado de la máquina de estado MyStateMachiney especifique un nombre en el cuadro Nombre de la máquina de estado.

    También puede cambiar al Modo Config para editar el nombre predeterminado de la máquina de estado.

  7. Especifique la configuración del flujo de trabajo, como el tipo de máquina de estado y su función de ejecución.

  8. Seleccione Crear.

Ya ha creado un nuevo flujo de trabajo con recursos de marcadores de posición que se pueden utilizar para crear prototipos. Puede exportar la definición y gráfico de su flujo de trabajo.

  • Para exportar la definición del flujo de trabajo como un archivo JSON o YAML, en el modo Diseño o Código, seleccione el botón desplegable Acciones. A continuación, en Exportar definición, seleccione el formato que desee exportar. Puede utilizar esta definición exportada como punto de partida para el desarrollo local con el AWS Toolkit for Visual Studio Code.

  • Para exportar el gráfico del flujo de trabajo a un archivo SVG o PNG, en el modo Diseño o Código, seleccione el botón desplegable Acciones. A continuación, en Exportar definición, seleccione el formato que dese.