AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartExecution operation. Starts a state machine execution.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StepFunctions.AmazonStepFunctionsRequest
      Amazon.StepFunctions.Model.StartExecutionRequest

Namespace: Amazon.StepFunctions.Model
Assembly: AWSSDK.StepFunctions.dll
Version: 3.x.y.z

Syntax

C#
public class StartExecutionRequest : AmazonStepFunctionsRequest
         IAmazonWebServiceRequest

The StartExecutionRequest type exposes the following members

Constructors

NameDescription
Public Method StartExecutionRequest()

Properties

NameTypeDescription
Public Property Input System.String

Gets and sets the property Input.

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

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

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

Public Property Name System.String

Gets and sets the property Name.

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.

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

When you make multiple StartExecution 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)

Public Property StateMachineArn System.String

Gets and sets the property StateMachineArn.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms