Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . stepfunctions ]



Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the AWS Step Functions User Guide.


This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.


CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine 's idempotency check is based on the state machine name , definition , type , and LoggingConfiguration . If a following request has a different roleArn or tags , Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--name <value>
--definition <value>
--role-arn <value>
[--type <value>]
[--logging-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--name (string)

The name of the state machine.

A name must not contain:

  • white space
  • brackets `` { } [ ]``
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ , ; : /
  • control characters (U+0000-001F , U+007F-009F )

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

--definition (string)

The Amazon States Language definition of the state machine. See Amazon States Language .

--role-arn (string)

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

--type (string)

Determines whether a Standard or Express state machine is created. The default is STANDARD . You cannot update the type of a state machine once it has been created.

Possible values:


--logging-configuration (structure)

Defines what execution history events are logged and where they are logged.


By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

JSON Syntax:

  "level": "ALL"|"ERROR"|"FATAL"|"OFF",
  "includeExecutionData": true|false,
  "destinations": [
      "cloudWatchLogsLogGroup": {
        "logGroupArn": "string"

--tags (list)

Tags to be added when creating a state machine.

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide , and Controlling Access Using IAM Tags .

Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @ .

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

    "key": "string",
    "value": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


stateMachineArn -> (string)

The Amazon Resource Name (ARN) that identifies the created state machine.

creationDate -> (timestamp)

The date the state machine is created.