Module Values.StartSyncExecutionOutputSource

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.

Sourcetype nonrec t = {
  1. executionArn : Arn.t option;
    (*

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

    *)
  2. stateMachineArn : Arn.t option;
    (*

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

    *)
  3. name : Name.t option;
    (*

    The name of the execution.

    *)
  4. startDate : Timestamp.t option;
    (*

    The date the execution is started.

    *)
  5. stopDate : Timestamp.t option;
    (*

    If the execution has already ended, the date the execution stopped.

    *)
  6. status : SyncExecutionStatus.t option;
    (*

    The current status of the execution.

    *)
  7. error : SensitiveError.t option;
    (*

    The error code of the failure.

    *)
  8. cause : SensitiveCause.t option;
    (*

    A more detailed explanation of the cause of the failure.

    *)
  9. input : SensitiveData.t option;
    (*

    The string that contains the JSON input data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    *)
  10. inputDetails : CloudWatchEventsExecutionDataDetails.t option;
  11. output : SensitiveData.t option;
    (*

    The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding. This field is set only if the execution succeeds. If the execution fails, this field is null.

    *)
  12. outputDetails : CloudWatchEventsExecutionDataDetails.t option;
  13. traceHeader : TraceHeader.t option;
    (*

    The X-Ray trace header that was passed to the execution. 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.

    *)
  14. billingDetails : BillingDetails.t option;
    (*

    An object that describes workflow billing details, including billed duration and memory use.

    *)
}
Sourcetype nonrec error = [
  1. | `InvalidArn of InvalidArn.t
  2. | `InvalidExecutionInput of InvalidExecutionInput.t
  3. | `InvalidName of InvalidName.t
  4. | `KmsAccessDeniedException of KmsAccessDeniedException.t
  5. | `KmsInvalidStateException of KmsInvalidStateException.t
  6. | `KmsThrottlingException of KmsThrottlingException.t
  7. | `StateMachineDeleting of StateMachineDeleting.t
  8. | `StateMachineDoesNotExist of StateMachineDoesNotExist.t
  9. | `StateMachineTypeNotSupported of StateMachineTypeNotSupported.t
  10. | `Unknown_operation_error of string * string option
]
Sourceval make : ?executionArn:??? -> ?stateMachineArn:??? -> ?name:??? -> ?startDate:??? -> ?stopDate:??? -> ?status:??? -> ?error:??? -> ?cause:??? -> ?input:??? -> ?inputDetails:??? -> ?output:??? -> ?outputDetails:??? -> ?traceHeader:??? -> ?billingDetails:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InvalidArn of InvalidArn.t | `InvalidExecutionInput of InvalidExecutionInput.t | `InvalidName of InvalidName.t | `KmsAccessDeniedException of KmsAccessDeniedException.t | `KmsInvalidStateException of KmsInvalidStateException.t | `KmsThrottlingException of KmsThrottlingException.t | `StateMachineDeleting of StateMachineDeleting.t | `StateMachineDoesNotExist of StateMachineDoesNotExist.t | `StateMachineTypeNotSupported of StateMachineTypeNotSupported.t | `Unknown_operation_error of string * string option ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InvalidArn of InvalidArn.t | `InvalidExecutionInput of InvalidExecutionInput.t | `InvalidName of InvalidName.t | `KmsAccessDeniedException of KmsAccessDeniedException.t | `KmsInvalidStateException of KmsInvalidStateException.t | `KmsThrottlingException of KmsThrottlingException.t | `StateMachineDeleting of StateMachineDeleting.t | `StateMachineDoesNotExist of StateMachineDoesNotExist.t | `StateMachineTypeNotSupported of StateMachineTypeNotSupported.t | `Unknown_operation_error of string * string option ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of Arn.t | `Structure of (string * [> `Boolean of IncludedDetails.t | `Long of BilledMemoryUsed.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t