Fail - AWS Step Functions

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Fail

UNFailÉtat ("Type": "Fail") arrête l'exécution de la machine à états et la marque comme une défaillance, sauf si elle est interceptée par unCatchbloquer.

L'état Fail autorise uniquement l'utilisation de champs Type et Comment à partir de l'ensemble de champs d'état courants. En outre, l'état Fail autorise les champs suivants :

Cause (facultatif)

Chaîne personnalisée qui décrit la cause de l'erreur. Vous pouvez spécifier ce champ à des fins opérationnelles ou diagnostiques.

CausePath (facultatif)

Si vous souhaitez fournir une description détaillée de la cause de l'erreur de manière dynamique à partir de l'entrée d'état à l'aide d'unchemin de référence, utiliserCausePath. Une fois résolu, le chemin de référence doit sélectionner un champ contenant une valeur de chaîne.

Vous pouvez également spécifierCausePathà l'aide d'unfonction intrinsèquequi renvoie une chaîne. Ces éléments intrinsèques sont les suivants :États. Format,States.JsonToString,States.ArrayGetItem,States.Base64Encode,States.Base64Decode,States.Hash, etStates.UUID.

Important
  • Vous pouvez utiliser lesCauseouCausePath, mais pas les deux dans votre définition de l'état d'échec.

  • Comme bonne pratique en matière de sécurité, nous vous recommandons de supprimer les informations sensibles ou les informations relatives aux systèmes internes dans la description de la cause.

Error (facultatif)

Nom d'erreur que vous pouvez fournir pour effectuer la gestion des erreurs à l'aide deRéessayerouAttraperchamps. Vous pouvez également fournir un nom d'erreur à des fins opérationnelles ou de diagnostic.

ErrorPath (facultatif)

Si vous souhaitez attribuer un nom à l'erreur de manière dynamique à partir de l'entrée d'état à l'aide d'unchemin de référence, utiliserErrorPath. Une fois résolu, le chemin de référence doit sélectionner un champ contenant une valeur de chaîne.

Vous pouvez également spécifierErrorPathà l'aide d'unfonction intrinsèquequi renvoie une chaîne. Ces éléments intrinsèques sont les suivants :États. Format,States.JsonToString,States.ArrayGetItem,States.Base64Encode,States.Base64Decode,States.Hash, etStates.UUID.

Important
  • Vous pouvez utiliser lesErrorouErrorPath, mais pas les deux dans votre définition de l'état d'échec.

  • Comme bonne pratique en matière de sécurité, nous vous recommandons de supprimer les informations sensibles ou les informations relatives aux systèmes internes du nom de l'erreur.

Comme les états Fail quittent toujours la machine d'état, ils n'ont pas de champ Next ni ne nécessitent un champ End.

Exemples de définition de l'état d'échec

L'exemple de définition de l'état d'échec suivant spécifie une valeur statiqueErroretCausevaleurs relatives aux champs.

"FailState": { "Type": "Fail", "Cause": "Invalid response.", "Error": "ErrorA" }

L'exemple de définition de l'état d'échec suivant utilise des chemins de référence de manière dynamique pour résoudre leErroretCausevaleurs relatives aux champs.

"FailState": { "Type": "Fail", "CausePath": "$.Cause", "ErrorPath": "$.Error" }

L'exemple de définition de l'état d'échec suivant utiliseÉtats. Formatfonction intrinsèque pour spécifier leErroretCausevaleurs relatives aux champs.

"FailState": { "Type": "Fail", "CausePath": "States.Format('This is a custom error message for {}, caused by {}.', $.Error, $.Cause)", "ErrorPath": "States.Format('{}', $.Error)" }