paws.application.integration (version 0.9.0)

sfn_start_sync_execution: Starts a Synchronous Express state machine execution

Description

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

See https://www.paws-r-sdk.com/docs/sfn_start_sync_execution/ for full documentation.

Usage

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

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:

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

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.

traceHeader

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

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.