Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartSyncExecution

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

Note

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.

Note

This API action isn't logged in CloudTrail.

Request Syntax


{
   "includedData": "string",
   "input": "string",
   "name": "string",
   "stateMachineArn": "string",
   "traceHeader": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

includedData

If your state machine definition is encrypted with a AWS 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.

Type: String

Valid Values: ALL_DATA | METADATA_ONLY

Required: No

input

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

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

Note

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

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Type: String

Length Constraints: Maximum length of 262144.

Required: No

name

The name of the execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Required: No

stateMachineArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

traceHeader

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: \p{ASCII}*

Required: No

Response Syntax


{
   "billingDetails": { 
      "billedDurationInMilliseconds": number,
      "billedMemoryUsedInMB": number
   },
   "cause": "string",
   "error": "string",
   "executionArn": "string",
   "input": "string",
   "inputDetails": { 
      "included": boolean
   },
   "name": "string",
   "output": "string",
   "outputDetails": { 
      "included": boolean
   },
   "startDate": number,
   "stateMachineArn": "string",
   "status": "string",
   "stopDate": number,
   "traceHeader": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

billingDetails

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

Type: BillingDetails object

cause

A more detailed explanation of the cause of the failure.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 32768.

error

The error code of the failure.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

executionArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

input

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.

Type: String

Length Constraints: Maximum length of 262144.

inputDetails