AWS Step Functions icon

AWS Step Functions

Consume the AWS Step Functions API

Actions8

Overview

This node integrates with AWS Step Functions, allowing users to interact programmatically with state machines and their executions. Specifically, the "Describe State Machine" operation retrieves detailed metadata about a specified state machine using its Amazon Resource Name (ARN). This is useful for monitoring, auditing, or dynamically adjusting workflows based on the state machine's configuration.

Practical scenarios include:

  • Fetching the definition and status of a state machine before starting an execution.
  • Auditing state machine configurations in automated workflows.
  • Integrating AWS Step Functions metadata into broader automation pipelines.

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.

Output

The output JSON contains the detailed description of the specified state machine as returned by the AWS Step Functions API. This typically includes fields such as the state machine's name, ARN, creation date, definition (the Amazon States Language JSON), role ARN, and status.

Example structure (simplified):

{
  "stateMachineArn": "string",
  "name": "string",
  "status": "string",
  "definition": "string",
  "roleArn": "string",
  "creationDate": "string"
}

No binary data is produced by this operation.

Dependencies

  • Requires valid AWS credentials with permissions to access AWS Step Functions.
  • The node uses the AWS SDK internally; no additional user setup beyond providing credentials and region is necessary.
  • AWS region must be specified in the credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing State Machine ARN will cause the API call to fail.
    • Insufficient AWS permissions can result in authorization errors.
    • Incorrect AWS region may lead to resource not found errors.

  • Error messages:

    • ResourceNotFoundException: The specified state machine ARN does not exist or is incorrect.
    • AccessDeniedException: The provided credentials lack permission to describe the state machine.
    • InvalidArn: The ARN format is invalid.

  • Resolutions:

    • Verify the ARN is correct and corresponds to an existing state machine.
    • Ensure the AWS credentials have the necessary IAM permissions for Step Functions.
    • Confirm the AWS region matches where the state machine is deployed.

Links and References

Discussion