Tipos de tareas Campos de estado de tarea Ejemplos de definición de estado de tarea

Task

Un estado Task ("Type": "Task") representa una única unidad de trabajo realizada por una máquina de estado. Una tarea realiza el trabajo mediante el uso de una actividad o una función AWS Lambda, mediante la integración con otros Servicios de AWS compatibles o mediante la invocación de una API de terceros, como Stripe.

El Amazon States Language representa tareas estableciendo un tipo de estado en Task y proporcionando a la tarea el Nombre de recurso de Amazon (ARN) de la actividad, la función de Lambda o el punto de conexión de la API. La siguiente definición de estado de tarea invoca una función de Lambda denominada HelloFunction.


"Lambda Invoke": {
  "Type": "Task",
  "Resource": "arn:aws:states:::lambda:invoke",
  "Parameters": {
    "Payload.$": "$",
    "FunctionName": "arn:aws:lambda:us-east-2:123456789012:function:HelloFunction:$LATEST"
  },
  "End": true
}

En este tema

Tipos de tareas
Campos de estado de tarea
Ejemplos de definición de estado de tarea
Actividades

Tipos de tareas

Step Functions es compatible con los siguientes tipos de tareas, que se pueden especificar en una definición de estado de tarea:

Actividad
Funciones de Lambda
Un Servicio de AWS compatible
Una tarea HTTP

Para especificar un tipo de tarea, proporcione su ARN en el campo Resource de una definición de estado de tarea. En el ejemplo siguiente se muestra la sintaxis del campo Resource. Todos los tipos de tareas, excepto el que invoca una API de terceros, utilizan la siguiente sintaxis. Para obtener información sobre la sintaxis de la tarea HTTP, consulte Llamada a API de terceros.

En la definición de estado de tarea, sustituya el texto en cursiva con la siguiente sintaxis por la información específica del recurso AWS.


arn:partition:service:region:account:task_type:name

En la lista siguiente, se explican los componentes individuales de esta sintaxis:

partition es la partición de AWS Step Functions que se utiliza, normalmente aws.
service indica el valor que Servicio de AWS utilizó para ejecutar la tarea y puede tener uno de los siguientes valores:
- states para una actividad.
- lambda para una función de Lambda. Si se integra con otros Servicios de AWS, por ejemplo, Amazon SNS o Amazon DynamoDB, utilice sns o dynamodb.
region es el código de región de AWS en la que se ha creado el tipo de máquina de estado o la actividad de Step Functions, la función de Lambda o cualquier otro recurso de AWS que se haya creado.
account es el ID de Cuenta de AWS en el que ha definido el recurso.
task_type es el tipo de tarea que se va a ejecutar. Puede ser uno de los siguientes valores:
- activity: una actividad.
- function: una función de Lambda.
- servicename: el nombre de un servicio conectado compatible (consulte Integraciones optimizadas para Step Functions).
name es el nombre del recurso registrado (el nombre de la actividad, el nombre de la función de Lambda o la acción de la API de servicio).

nota

Step Functions no admite hacer referencia a los ARN entre particiones o regiones. Por ejemplo, aws-cn no puede invocar tareas en la partición aws y viceversa.

En las secciones siguientes, se proporcionan más detalles sobre cada tipo de tarea.

Actividad

Las actividades representan procesos o subprocesos de trabajo implementados y alojados por usted, que realizan una tarea específica. Solo son compatibles con los flujos de trabajo estándar, pero no con los flujos de trabajo rápidos.

Los ARN de Resource de actividad usan la siguiente sintaxis.


arn:partition:states:region:account:activity:name

nota

Debe crear las actividades con Step Functions (mediante una acción de la API CreateActivity o la consola de Step Functions) antes de usarlas por primera vez.

Para obtener más información sobre la creación de una actividad y la implementación de procesos de trabajo, consulte Actividades.

Funciones de Lambda

Las tareas de Lambda ejecutan una función mediante AWS Lambda. Para especificar una función de Lambda, utilice el ARN de la función de Lambda del campo Resource.

Según el tipo de integración (integración optimizada o integración del SDK de AWS) que utilice para especificar una función de Lambda, la sintaxis del campo Resource de la función de Lambda varía.

La siguiente sintaxis del campo Resource es un ejemplo de una integración optimizada con una función de Lambda.


"arn:aws:states:::lambda:invoke"

La siguiente sintaxis del campo Resource es un ejemplo de una integración del SDK de AWS con una función de Lambda.


"arn:aws:states:::aws-sdk:lambda:invoke"

La siguiente definición del estado Task muestra un ejemplo de una integración optimizada con la función de Lambda denominada HelloWorld.


"LambdaState": {
  "Type": "Task",
  "Resource": "arn:aws:states:::lambda:invoke",
  "OutputPath": "$.Payload",
  "Parameters": {
    "Payload.$": "$",
    "FunctionName": "arn:aws:lambda:us-east-1:function:HelloWorld:$LATEST"
  },
  "Next": "NextState"
}

Cuando se completa la función de Lambda especificada en el campo Resource, su salida se envía al estado identificado en el campo Next ("NextState").

Un Servicio de AWS compatible

Cuando se hace referencia a un recurso conectado, Step Functions llama directamente a las acciones de la API de un servicio compatible. Especifique el servicio y la acción en el campo Resource.

Los ARN de Resource de los servicios conectados usan la siguiente sintaxis.


arn:partition:states:region:account:servicename:APIname

nota

Para crear una conexión síncrona a un recurso conectado, añada .sync a la entrada APIname en el ARN. Para obtener más información, consulte Trabajo con otros servicios.

Por ejemplo:


{
 "StartAt": "BATCH_JOB",
 "States": {
   "BATCH_JOB": {
     "Type": "Task",
     "Resource": "arn:aws:states:::batch:submitJob.sync",
     "Parameters": {  
       "JobDefinition": "preprocessing",
       "JobName": "PreprocessingBatchJob",
       "JobQueue": "SecondaryQueue",
       "Parameters.$": "$.batchjob.parameters",
       "RetryStrategy": {
          "attempts": 5
        }
     },
     "End": true
    }
  }
}

Campos de estado de tarea

Además de los campos de estado comunes, los estados Task, disponen de los siguientes campos:

Resource (Obligatorio)

Un URI, en concreto, un ARN que identifica de forma inequívoca la tarea específica que se va a ejecutar.

Parameters (opcional)

Se utiliza para pasar información a las acciones de la API de los recursos conectados. Los parámetros pueden utilizar una combinación de JsonPath y JSON estático. Para obtener más información, consulte Cómo pasar parámetros a una API de servicio.

Credentials (opcional)

Especifica un rol de destino que debe asumir la función de ejecución de la máquina de estado antes de invocar el Resource especificado. Como alternativa, también puede especificar un valor de JSONPath o una función intrínseca que se resuelva en un ARN de rol de IAM en tiempo de ejecución en función de la entrada de ejecución. Si especifica un valor de JSONPath, debe anteponerle la notación $..

Para ver ejemplos del uso de este campo en el estado Task, consulte Ejemplos del campo Credentials de estado de tarea. Para ver un ejemplo del uso de este campo para acceder a un AWS recurso multicuenta desde su máquina de estado, consulte Tutorial: Acceso a recursos multicuenta AWS.

nota

Este campo es compatible con los Tipos de tareas que utilizan funciones de Lambda y un servicio AWS compatible.

ResultPath (opcional)

Especifica dónde se colocan (en la entrada) los resultados de la ejecución de la tarea especificada en Resource. La entrada se filtra según el contenido del campo OutputPath (si existe) antes de utilizarla como salida del estado. Para obtener más información, consulte Procesamiento de entrada y salida.

ResultSelector (opcional)

Pase un conjunto de pares clave-valor, donde los valores sean estáticos o se seleccionen del resultado. Para obtener más información, consulte ResultSelector.

Retry (opcional)

Una matriz de objetos, denominados "reintentadores", que definen una política de reintentos si el estado encuentra errores en tiempo de ejecución. Para obtener más información, consulte Ejemplos de máquina de estado que usan Retry y Catch.

Catch (opcional)

Una matriz de objetos, denominados "receptores", que definen un estado alternativo. Este estado se ejecuta si el estado encuentra errores en tiempo de ejecución y su política de reintentos está agotada o no se ha definido. Para obtener más información, consulte Estados alternativos.

TimeoutSeconds (opcional)

Especifica el tiempo máximo que puede ejecutarse una actividad o tarea antes de que se agote el tiempo de espera y se produzca un error States.Timeout. El valor del tiempo de inactividad debe ser un número entero positivo, distinto de cero. El valor predeterminado es 99999999.

El tiempo de inactividad empieza a contar cuando se inicia la tarea, por ejemplo, cuando se registra ActivityStarted o LambdaFunctionStarted en el historial de eventos de ejecución. En las actividades, el tiempo empieza a contar cuando GetActivityTask recibe un token y se registra ActivityStarted en el historial de eventos de ejecución.

Cuando se inicia una tarea, Step Functions espera a que el proceso de trabajo de la tarea o actividad responda correctamente o no dentro del período TimeoutSeconds especificado. Si el proceso de trabajo de la tarea o actividad no responde dentro de este tiempo, Step Functions marca la ejecución del flujo de trabajo como fallida.

TimeoutSecondsPath (opcional)

Si desea proporcionar un valor de tiempo de espera de forma dinámica a partir de la entrada de estado con una ruta de referencia, utilice TimeoutSecondsPath. Una vez resuelta, la ruta de referencia debe seleccionar campos cuyos valores sean enteros positivos.

nota

Un estado Task no puede incluir tanto TimeoutSeconds como TimeoutSecondsPath.

HeartbeatSeconds (opcional)

Determina la frecuencia de las señales de latido que envía un proceso de trabajo de actividad durante la ejecución de una tarea. Los latidos indican que una tarea aún se está ejecutando y necesita más tiempo para completarse. Los latidos impiden que se agote el tiempo de espera de una actividad o tarea durante la duración de TimeoutSeconds.

HeartbeatSeconds debe ser un valor entero positivo, distinto de cero, inferior al valor del campo TimeoutSeconds. El valor predeterminado es 99999999. Si transcurre más tiempo que los segundos especificados entre los latidos de la tarea, el estado de la tarea produce el error States.Timeout.

En las actividades, el tiempo empieza a contar cuando GetActivityTask recibe un token y se registra ActivityStarted en el historial de eventos de ejecución.

HeartbeatSecondsPath (opcional)

Si desea proporcionar un valor de latido de forma dinámica desde la entrada de estado mediante una ruta de referencia, utilice HeartbeatSecondsPath. Una vez resuelta, la ruta de referencia debe seleccionar campos cuyos valores sean enteros positivos.

nota

Un estado Task no puede incluir tanto HeartbeatSeconds como HeartbeatSecondsPath.

Un estado Task debe establecer el campo End en true si el estado finaliza su ejecución, o bien debe proporcionar un estado en el campo Next que se ejecuta cuando finaliza el estado Task.

Ejemplos de definición de estado de tarea

En los siguientes ejemplos se muestra cómo puede especificar la definición de estado de tarea en función de sus necesidades.

Especificar tiempos de espera de estado de tarea e intervalos de latido
- Ejemplo de notificación de latido y tiempo de espera estático
- Ejemplo de notificación de latido y tiempo de espera dinámico
Uso del campo Credentials

Tiempos de espera de estado de tarea e intervalos de latido

Es aconsejable definir un valor de tiempo de espera y un intervalo de latido para actividades de ejecución prolongada. Para hacer esto se puede especificar los valores de tiempo de espera y latido o configurarlos de forma dinámica.

Ejemplo de notificación de latido y tiempo de espera estático

Cuando se complete HelloWorld, se ejecutará el siguiente estado (que aquí se llama NextState).

Si esta tarea no puede completarse en un plazo de 300 segundos o no envía notificaciones de latido a intervalos de 60 segundos, la tarea se marca como failed.


"ActivityState": {
  "Type": "Task",
  "Resource": "arn:aws:states:us-east-1:123456789012:activity:HelloWorld",
  "TimeoutSeconds": 300,
  "HeartbeatSeconds": 60,
  "Next": "NextState"
}

Ejemplo de notificación de latido y tiempo de espera dinámico

En este ejemplo, cuando se completa el trabajo AWS Glue se ejecuta el estado siguiente.

Si esta tarea no se completa dentro del intervalo establecido de manera dinámica por el trabajo AWS Glue, la tarea se marca como failed.


"GlueJobTask": {
  "Type": "Task",
  "Resource": "arn:aws:states:::glue:startJobRun.sync",
  "Parameters": {
    "JobName": "myGlueJob"
  },
  "TimeoutSecondsPath": "$.params.maxTime",
  
  "Next": "NextState"
}

Ejemplos del campo Credentials de estado de tarea

Especificación del ARN del rol de IAM codificado de forma rígida

En el siguiente ejemplo se especifica un rol de IAM de destino que debe asumir el rol de ejecución de una máquina de estado para acceder a una función de Lambda entre cuentas denominada Echo. En este ejemplo, el ARN del rol de destino se especifica como un valor codificado de forma rígida.


{
  "StartAt": "Cross-account call",
  "States": {
    "Cross-account call": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn": "arn:aws:iam::111122223333:role/LambdaRole"
      },
      "Parameters": {
        "FunctionName": "arn:aws:lambda:us-east-2:111122223333:function:Echo"
      },
      "End": true
    }
  }
}

Especificar JSONPath como un ARN de rol de IAM

En el siguiente ejemplo se especifica un valor de JSONPath, que se resolverá en un ARN de rol de IAM en tiempo de ejecución.


{
  "StartAt": "Lambda",
  "States": {
    "Lambda": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn.$": "$.roleArn"
      },
      ...
    }
  }
}

Especificar una función intrínseca como ARN del rol de IAM

En el siguiente ejemplo, se utiliza la función intrínseca States.Format, que se convierte en un ARN de rol de IAM en tiempo de ejecución.


{
  "StartAt": "Lambda",
  "States": {
    "Lambda": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Credentials": {
        "RoleArn.$": "States.Format('arn:aws:iam::{}:role/ROLENAME', $.accountId)"
      },
      ...
    }
  }
}

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Pass

Actividades