Actions8
Overview
This node integrates with AWS Step Functions, specifically enabling users to describe a state machine by providing its Amazon Resource Name (ARN). It fetches detailed metadata and configuration information about the specified state machine. This is useful for monitoring, auditing, or dynamically adjusting workflows based on the state machine's properties.
Common scenarios include:
- Retrieving the definition and status of a state machine before starting executions.
- Auditing or logging state machine configurations in automated workflows.
- Validating the existence and details of a state machine ARN provided by other processes.
Example: A workflow that triggers when a new state machine is created and uses this node to fetch and log its details for compliance tracking.
Properties
Name | Meaning |
---|---|
State Machine ARN | The Amazon Resource Name (ARN) of the state machine to describe. This uniquely identifies the state machine within AWS Step Functions. |
Output
The node outputs a JSON object containing the full description of the specified state machine as returned by the AWS Step Functions API. This typically includes fields such as:
stateMachineArn
: The ARN of the state machine.name
: The name of the state machine.status
: The current status (e.g., ACTIVE).definition
: The Amazon States Language definition of the state machine.roleArn
: The ARN of the IAM role used by the state machine.creationDate
: Timestamp when the state machine was created.
No binary data output is produced by this operation.
Dependencies
- Requires valid AWS credentials with permissions to call the AWS Step Functions API.
- The node depends on the AWS SDK for JavaScript (
aws-sdk
package). - The user must configure AWS credentials (access key ID, secret access key, and region) in n8n prior to using this node.
Troubleshooting
- Invalid ARN error: Ensure the provided State Machine ARN is correct and exists in the specified AWS region.
- Access Denied: Verify that the AWS credentials have sufficient permissions to call
DescribeStateMachine
. - Network issues: Confirm that n8n can reach AWS endpoints; check firewall or proxy settings.
- Malformed JSON input: Although not applicable here, if errors occur related to JSON, verify inputs are correctly formatted.
If the node throws an error referencing AWS API failures, inspect the error message for details such as missing permissions or invalid parameters.