Proper syntax to start-execution with Step Functions in AWS CLI

Question

IS there any syntax documentation for how to run Step Functions with AWS CLI, and specifically for how to start an execution.

I input the ARN, and the json input but keep getting an error that the --input argument is only expecting one argument. I was hoping someone could provide an example of the proper syntax for these parameters.

Thanks!

Answer

Hello,

The correct syntax looks like this:

AWS stepfunctions start-execution --state-machine-arn $ARN  --input "{\"first_name\" : \"test\"}"

I agree with you that the documentation is misleading/confusing because `"input": "{\"first_name\" : \"test\"}"` is not a valid JSON.

If your having issues with JSON encoding, [jq](https://linuxhint.com/bash_jq_command/) can help, for example:

AWS stepfunctions start-execution --state-machine-arn $ARN --input "$(echo '{"my_key": "my_value"}' | jq -R . )"

You can also read the input from a file:

aws stepfunctions start-execution --state-machine-arn $ARN --input "$(jq -R . input.json --raw-output)"

I hope this helps!

Regards,

Carl Östrand

Answer

Hello,
Attaching the link necessary for the same. Please refer the same to check for the syntax and the right options . [1]

Hope this helps !!

Link- https://awscli.amazonaws.com/v2/documentation/api/latest/reference/stepfunctions/start-execution.html -- [1]

Proper syntax to start-execution with Step Functions in AWS CLI

Relevant content