generateFromAwsResponse

function generateFromAwsResponse(params):
  | SvgOutput
  | HtmlOutput
  | MermaidOutput;

Defined in: src/index.ts:277

Generate a diagram from an AWS SDK DescribeStateMachine response

This is a convenience function for integrating with the AWS SDK. It extracts the ASL definition from the response and generates a diagram.

Parameters

params

GenerateFromAwsParams

Configuration object

Returns

| SvgOutput | HtmlOutput | MermaidOutput

SVG output if format is ‘svg’, Mermaid output if format is ‘mermaid’

Throws

If response.definition is missing

Throws

If the definition contains invalid JSON (also an instanceof SyntaxError and AslValidationError)

Throws

If the ASL definition structure is invalid

Example

import { SFNClient, DescribeStateMachineCommand } from '@aws-sdk/client-sfn';
import { generateFromAwsResponse } from 'sfn-diagram';

const client = new SFNClient({ region: 'us-east-1' });
const response = await client.send(
  new DescribeStateMachineCommand({
    stateMachineArn: 'arn:aws:states:...'
  })
);

const { svg } = generateFromAwsResponse({
  response,
  theme: 'light',
  layout: 'TB'
});