Table Of Contents

Feedback

User Guide

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

[ aws . stepfunctions ]

start-execution

Description

Starts a state machine execution.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  start-execution
--state-machine-arn <value>
[--name <value>]
[--input <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--state-machine-arn (string)

The Amazon Resource name (ARN) of the state machine to execute.

--name (string)

The name of the execution. 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 .

Warning

An execution can't use the name of another execution for 90 days.

When you make multiple start-execution calls with the same name, the new execution doesn't run and the following rules apply:

  • When the original execution is open and the execution input from the new call is different , the ExecutionAlreadyExists message is returned.
  • When the original execution is open and the execution input from the new call is identical , the Success message is returned.
  • When the original execution is closed, the ExecutionAlreadyExists message is returned regardless of input.

A name must not contain:

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

--input (string)

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

Note

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

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

executionArn -> (string)

The Amazon Resource name (ARN) that identifies the execution.

startDate -> (timestamp)

The date the execution is started.