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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartSyncExecution and EndStartSyncExecution.

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

Syntax

C#
public abstract Task<StartSyncExecutionResponse> StartSyncExecutionAsync(
         StartSyncExecutionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.StepFunctions.Model.StartSyncExecutionRequest

Container for the necessary parameters to execute the StartSyncExecution service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StartSyncExecution service method, as returned by StepFunctions.

Exceptions

ExceptionCondition
InvalidArnException The provided Amazon Resource Name (ARN) is not valid.
InvalidExecutionInputException The provided JSON input data is not valid.
InvalidNameException The provided name is not valid.
KmsAccessDeniedException Either your KMS key policy or API caller does not have the required permissions.
KmsInvalidStateException The KMS key is not in valid state, for example: Disabled or Deleted.
KmsThrottlingException Received when KMS returns ThrottlingException for a KMS call that Step Functions makes on behalf of the caller.
StateMachineDeletingException The specified state machine is being deleted.
StateMachineDoesNotExistException The specified state machine does not exist.
StateMachineTypeNotSupportedException State machine type is not supported.

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

See Also