StartSyncExecutionRequest Class | AWS SDK for .NET V3

Container for the parameters to the StartSyncExecution operation. Starts a Synchronous Express state machine execution. StartSyncExecution is not available for STANDARD workflows.

StartSyncExecution will return a 200 OK response, even if your execution fails, because the status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

This API action isn't logged in CloudTrail.

Inheritance Hierarchy

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

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

Syntax

public class StartSyncExecutionRequest : AmazonStepFunctionsRequest
         IAmazonWebServiceRequest

The StartSyncExecutionRequest type exposes the following members

Constructors

	Name	Description
	StartSyncExecutionRequest()

Properties

Name	Type	Description
IncludedData	Amazon.StepFunctions.IncludedData	Gets and sets the property IncludedData. If your state machine definition is encrypted with a KMS key, callers must have `kms:Decrypt` permission to decrypt the definition. Alternatively, you can call the API with `includedData = METADATA_ONLY` to get a successful response without the encrypted definition.
Input	System.String	Gets and sets the property Input. The string that contains the JSON input data for the execution, for example: `"{\"first_name\" : \"Alejandro\"}"` If you don't include any JSON input data, you still must include the two braces, for example: `"{}"` Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.
Name	System.String	Gets and sets the property Name. The name of the execution.
StateMachineArn	System.String	Gets and sets the property StateMachineArn. The Amazon Resource Name (ARN) of the state machine to execute.
TraceHeader	System.String	Gets and sets the property TraceHeader. Passes the X-Ray trace header. The trace header can also be passed in the request payload. For X-Ray traces, all Amazon Web Services services use the `X-Amzn-Trace-Id` header from the HTTP request. Using the header is the preferred mechanism to identify a trace. `StartExecution` and `StartSyncExecution` API operations can also use `traceHeader` from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5