Starts a Synchronous Express state machine execution¶

Description¶

Starts a Synchronous Express state machine execution. start_sync_execution is not available for STANDARD workflows.

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

Usage¶

sfn_start_sync_execution(stateMachineArn, name, input, traceHeader,
  includedData)

Arguments¶

• stateMachineArn

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

• name

  The name of the execution.

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

• 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. start_execution and start_sync_execution 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.

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

Value¶

A list with the following syntax:

list(
  executionArn = "string",
  stateMachineArn = "string",
  name = "string",
  startDate = as.POSIXct(
    "2015-01-01"
  ),
  stopDate = as.POSIXct(
    "2015-01-01"
  ),
  status = "SUCCEEDED"|"FAILED"|"TIMED_OUT",
  error = "string",
  cause = "string",
  input = "string",
  inputDetails = list(
    included = TRUE|FALSE
  ),
  output = "string",
  outputDetails = list(
    included = TRUE|FALSE
  ),
  traceHeader = "string",
  billingDetails = list(
    billedMemoryUsedInMB = 123,
    billedDurationInMilliseconds = 123
  )
)

Request syntax¶

svc$start_sync_execution(
  stateMachineArn = "string",
  name = "string",
  input = "string",
  traceHeader = "string",
  includedData = "ALL_DATA"|"METADATA_ONLY"
)