Estado de un flujo de trabajo de tarea

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 HTTPS, como Stripe.

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 de HTTPS.

Invocación de una función con argumentos de JSONata

La siguiente definición de estado de tarea (JSONata) invoca una función de Lambda denominada priceWatcher.

Tenga en cuenta el uso de expresiones de JSONata para consultar los datos de entrada para usarlos en argumentos y el resultado de la tarea en el campo de asignación.

"Get Current Price": {
  "Type": "Task",
  "QueryLanguage" : "JSONata",
  "Resource": "arn:aws:states:::lambda:invoke",
  "Next": "Check Price",
  "Arguments": {
    "Payload": {
    "product": "{% $states.context.Execution.Input.product %}"
    },
    "FunctionName": "arn:aws:lambda:<region>:account-id:function:priceWatcher:$LATEST"
  },
  "Assign": {
    "currentPrice": "{% $states.result.Payload.current_price %}"
  }
}

Invocación de una función con parámetros de JSONPath

La siguiente definición de estado de tarea (JSONPath) invoca una función de Lambda denominada HelloFunction.

"Lambda Invoke": {
  "Type": "Task",
  "Resource": "arn:aws:states:::lambda:invoke",
  "Parameters": {
    "Payload.$": "$",
    "FunctionName": "arn:aws:lambda:region:account-id:function:HelloFunction:$LATEST"
  },
  "End": true
}

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:

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 HTTPS, utilizan la siguiente sintaxis. Para obtener información sobre la sintaxis de la tarea HTTP, consulte Llamada a API de HTTPS en flujos de trabajo de Step Functions.

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:

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

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.

La forma del campo Resource de la función de Lambda varía en función del tipo de integración.

Para una integración estándar de AWS SDK con una función de Lambda, el campo Resource contendrá el siguiente valor:

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

Recomendamos utilizar la integración optimizada para las funciones de Lambda, utilizando el siguiente valor para el campo Resource:

"arn:aws:states:::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 mediante JSONata.

"Optimized call to Lambda function (JSONata)": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Output": "{% $states.result.Payload %}",
      "Arguments": {
        "FunctionName": "arn:aws:lambda:region:account-id:function:HelloWorld:$LATEST",
        "Payload": {
          "key": "{% $states.input.myKey %}"
        }
      },
  "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-id:servicename:APIname

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:

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.

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:region: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)"
      },
      ...
    }
  }
}