AWS Step Functions icon

AWS Step Functions

Consume the AWS Step Functions API

Overview

This node integrates with AWS Step Functions, allowing workflows to interact with state machines and their executions. Specifically, the "Send Task Heartbeat" operation reports to AWS Step Functions that a task represented by a given task token is still in progress. This is useful in long-running tasks where periodic heartbeats prevent the task from being considered timed out or failed.

Practical scenarios include:

  • Workers processing asynchronous tasks can send heartbeats to keep the task alive.
  • Monitoring systems can use this to signal ongoing progress for tasks managed by Step Functions.

Properties

Name Meaning
Task Token The token representing the specific task assigned by AWS Step Functions. It is used to identify the task when sending a heartbeat.

Output

The output JSON contains the response from AWS Step Functions after sending the heartbeat. Typically, this response confirms that the heartbeat was received successfully. There is no binary data output.

Example output structure (simplified):

{}

(The actual response is usually empty or minimal, indicating success.)

Dependencies

  • Requires an AWS API authentication credential with permissions to interact with AWS Step Functions.
  • The node uses the AWS SDK for JavaScript internally.
  • AWS region must be specified as part of the credentials configuration.

Troubleshooting

  • Invalid or expired Task Token: If the task token is incorrect or expired, AWS will reject the heartbeat. Ensure the token is current and correctly passed.
  • Network or permission errors: Lack of proper AWS permissions or network connectivity issues may cause failures. Verify AWS IAM policies and network access.
  • Task already completed or failed: Sending a heartbeat for a task that has finished or failed will result in errors. Confirm the task is still active before sending heartbeats.

Common error messages might include authorization errors, invalid token errors, or timeout errors. Resolving them typically involves checking credentials, token validity, and network connectivity.

Links and References

Discussion