ResultPath - 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.

ResultPath

La salida de un estado puede ser una copia de su entrada, el resultado que produce (por ejemplo, la salida de una función de Lambda del estado Task) o una combinación de su entrada y del resultado. Use ResultPath para controlar qué combinación de estos se pasa a la salida del estado.

Los siguientes tipos de estado pueden generar un resultado y pueden incluir ResultPath:

Use ResultPath para combinar un resultado de tarea con una entrada de tarea o para seleccionar uno de estos. La ruta que se proporciona a ResultPath controla la información que se pasa a la salida.

nota

ResultPath se limita al uso de rutas de referencia, que limitan el ámbito de forma que solo pueden identificar un único nodo en JSON. Consulte Rutas de referencia en el Lenguaje de estados de Amazon.

Estos ejemplos se basan en la máquina de estado y en la función de Lambda que se describen enCreación de un estado de Step FunctionsMachineUso de Lambda"Hello, World!" Realice el tutorial y ensaye las distintas salidas probando diversas rutas en un campo ResultPath.

sugerencia

Usarsimulador de flujo de datos en la consola de Step Functionspara probar la sintaxis de ruta JSON, para comprender mejor cómo se manipulan los datos dentro de un estado,y ver cómo se pasan los datos entre estados.

Utilice ResultPath para sustituir la entrada por el resultado

Si no especifica una ResultPath, el comportamiento predeterminado es como si hubiera especificado "ResultPath": "$". Dado que esto indica al estado que reemplace toda la entrada por el resultado, la entrada de estado se reemplaza por completo por el resultado procedente del resultado de la tarea.

En el siguiente diagrama, se muestra cómo ResultPath puede reemplazar por completo la entrada por el resultado de la tarea.


        Sustitución de la entrada con ResultPath.

Usando la máquina de estado y la función Lambda descrita enCreación de un estado de Step FunctionsMachineUso de Lambda, si pasamos la siguiente entrada:

{ "comment": "This is a test of the input and output of a Task state.", "details": "Default example", "who": "AWS Step Functions" }

La función de Lambda proporciona el siguiente resultado.

"Hello, AWS Step Functions!"

SiResultPathno se especifica en el estado o si"ResultPath": "$"Se ha establecido, la entrada del estado se reemplaza por el resultado de la función de Lambda, y la salida del estado es la siguiente.

"Hello, AWS Step Functions!"
nota

ResultPath se utiliza para incluir contenido a partir del resultado con la entrada, antes de pasarlo a la salida. Pero, si no se especifica ResultPath, el valor predeterminado consiste en reemplazar toda la entrada.

Descartar el resultado y conservar la entrada original

Si establece ResultPath en null, se transferirá la entrada original a la salida. Al utilizar "ResultPath": null, la carga de entrada del estado se copiará directamente en la salida, independientemente del resultado.

El siguiente diagrama muestra cómo una ResultPath nula copiará la entrada directamente en la salida.


        Copiar la entrada en la salida mediante ResultPath.

Utilice ResultPath para incluir el resultado con la entrada

El diagrama siguiente muestra cómo ResultPath puede incluir el resultado con la entrada.


        Incluir la entrada con ResultPath

Utilizando la máquina de estado y la función de Lambda descrita enCreación de un estado de Step FunctionsMachineUso de Lambda, podríamos pasar la siguiente entrada.

{ "comment": "This is a test of the input and output of a Task state.", "details": "Default example", "who": "AWS Step Functions" }

El resultado de la función de Lambda es el siguiente.

"Hello, AWS Step Functions!"

Para conservar la entrada, inserte el resultado de la función de Lambda y, a continuación, pase el JSON combinado al siguiente estado, podríamos establecerResultPathA lo siguiente.

"ResultPath": "$.taskresult"

Esto incluye el resultado de la función de Lambda con la entrada original.

{ "comment": "This is a test of input and output of a Task state.", "details": "Default behavior example", "who": "AWS Step Functions", "taskresult": "Hello, AWS Step Functions!" }

La salida de la función de Lambda se añade a la entrada original como un valortaskresult. La entrada, incluido el valor recién insertado, se pasa al siguiente estado.

También puede insertar el resultado en un nodo secundario de la entrada. Establezca ResultPath como se indica a continuación.

"ResultPath": "$.strings.lambdaresult"

Inicie una ejecución utilizando la siguiente entrada.

{ "comment": "An input comment.", "strings": { "string1": "foo", "string2": "bar", "string3": "baz" }, "who": "AWS Step Functions" }

El resultado de la función de Lambda se inserta como un elemento secundario destringsen la entrada.

{ "comment": "An input comment.", "strings": { "string1": "foo", "string2": "bar", "string3": "baz", "lambdaresult": "Hello, AWS Step Functions!" }, "who": "AWS Step Functions" }

La salida de estado ahora incluye el JSON de entrada original con el resultado como nodo secundario.

Utilice ResultPath para actualizar un nodo de la entrada con el resultado

En el siguiente diagrama, se muestra cómo ResultPath puede actualizar el valor de los nodos JSON existentes en la entrada por los valores del resultado de tarea.


        Sustitución de la entrada con ResultPath

Utilizando el ejemplo de la máquina de estado y de la función de Lambda descrito enCreación de un estado de Step FunctionsMachineUso de Lambda, podríamos pasar la siguiente entrada.

{ "comment": "This is a test of the input and output of a Task state.", "details": "Default example", "who": "AWS Step Functions" }

El resultado de la función de Lambda es el siguiente.

Hello, AWS Step Functions!

En lugar de conservar la entrada e insertar el resultado como un nuevo nodo en el JSON, podemos sobrescribir un nodo existente.

Por ejemplo, del mismo modo que al omitir o establecer "ResultPath": "$" se sobrescribe todo el nodo, se puede especificar un nodo determinado para sobrescribirlo con el resultado.

"ResultPath": "$.comment"

Debido a quecommentya existe en la entrada de estado, configurandoResultPathDe a"$.comment"reemplaza dicho nodo en la entrada por el resultado de la función de Lambda. Sin filtrar más mediante OutputPath, se pasa lo siguiente a la salida.

{ "comment": "Hello, AWS Step Functions!", "details": "Default behavior example", "who": "AWS Step Functions", }

El valor de la propiedadcomment node, "This is a test of the input and output of a Task state.", se reemplaza por el resultado de la función de Lambda:"Hello, AWS Step Functions!"en la salida de estado.

Uso de ResultPath para incluir el error y la entrada en un Catch

El tutorial Máquina de estado de gestión de las condiciones de error con una máquina de estado muestra cómo utilizar una máquina de estado para detectar un error. En algunos casos, es posible que desee conservar la entrada original con el error. Utilice ResultPath en un Catch para incluir el error con la entrada original, en lugar de sustituirla.

"Catch": [{ "ErrorEquals": ["States.ALL"], "Next": "NextTask", "ResultPath": "$.error" }]

Si la instrucción Catch anterior detecta un error, incluye el resultado en un nodo error dentro de la entrada de estado. Por ejemplo, con la siguiente entrada:

{"foo": "bar"}

La salida de estado al detectar un error es la siguiente.

{ "foo": "bar", "error": { "Error": "Error here" } }

Para obtener más información sobre el control de errores, consulte lo siguiente: