Table Of Contents

Feedback

User Guide

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

[ aws . stepfunctions ]

create-state-machine

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-state-machine
--name <value>
--definition <value>
--role-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the state machine. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide .

A name must not contain:

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

--definition (string)

The Amazon States Language definition of the state machine.

--role-arn (string)

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

--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.

--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.

Output

stateMachineArn -> (string)

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

creationDate -> (timestamp)

The date the state machine is created.