Step Functions: Create state machine alias from the CLI

Part 391 of AWS from Zero. This is lesson 10 in the Step Functions track.

What we are learning

Use create-state-machine-alias to create or register one Step Functions resource through the CLI. This lesson identifies the required input shape, saves the raw response, and keeps inspection separate from execution.

The AWS CLI operation is aws stepfunctions create-state-machine-alias. Required operation inputs: --name (string), --routing-configuration (list). The modeled top-level response contains stateMachineAliasArn, creationDate.

Before you run it

aws sts get-caller-identity
REGION="${AWS_REGION:-ap-south-1}"
NAME="replace-with-name"
aws stepfunctions create-state-machine-alias help

Use a sandbox account or an approved learning environment. Read the operation help before supplying identifiers, ARNs, network ranges, policy documents, or customer data.

Cost note: State transitions or Express workflow requests and duration can incur charges.

The command

aws stepfunctions create-state-machine-alias \
  --generate-cli-skeleton input > part-391-request.json
 
# Edit every placeholder in part-391-request.json, then run:
aws stepfunctions create-state-machine-alias \
  --cli-input-json file://part-391-request.json \
  --region "$REGION" \
  --output json > part-391-response.json

The response is saved to part-391-response.json so inspection is separate from execution. Review part-391-request.json, replace every placeholder, and remove unsupported optional fields before the real call.

Inspect the result

node -e "const r=require('./part-391-response.json'); console.log(Object.keys(r))"
node -e "const r=require('./part-391-response.json'); console.log(JSON.stringify(r, null, 2))"

Compare the returned identifiers and status fields with the account, Region, and resource you intended to target. For asynchronous operations, continue with the service's matching get, list, or describe command until it reaches a terminal state.

One tiny variation

node -e "const r=require('./part-391-response.json'); console.log(JSON.stringify(r["stateMachineAliasArn"], null, 2))"

This variation changes output inspection rather than adding another infrastructure concept. Keep the raw JSON while developing a query so a narrow projection does not hide an error or unexpected field.

Common mistake

Do not run a generated request unchanged. Replace every placeholder, add ownership tags where supported, estimate cost, and verify that the selected Region and account are disposable.

Cleanup

# Review the inverse operation before removing the demo resource.
aws stepfunctions delete-state-machine-alias help
rm -f part-391-request.json part-391-response.json part-391-payload.bin part-391-debug.log

Local request and response files may contain account IDs, ARNs, names, or service configuration. Remove them when the lab is complete and follow dependency-aware cleanup for any AWS resource you created.

Next, we will learn Step Functions: Update map run from the CLI.

Official AWS CLI reference