AWS Step Functions

Starts a Synchronous Express state machine execution.

See also: AWS API Documentation

Request Syntax

client.start_sync_execution(
    stateMachineArn='string',
    name='string',
    input='string',
    traceHeader='string'
)

type stateMachineArn:

string

param stateMachineArn:

[REQUIRED]

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

type name:

string

param name:

The name of the execution.

type input:

string

param input:

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

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

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

type traceHeader:

string

param traceHeader:

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

rtype:

dict

returns:

Response Syntax

{
    'executionArn': 'string',
    'stateMachineArn': 'string',
    'name': 'string',
    'startDate': datetime(2015, 1, 1),
    'stopDate': datetime(2015, 1, 1),
    'status': 'SUCCEEDED'|'FAILED'|'TIMED_OUT',
    'error': 'string',
    'cause': 'string',
    'input': 'string',
    'inputDetails': {
        'included': True|False
    },
    'output': 'string',
    'outputDetails': {
        'included': True|False
    },
    'traceHeader': 'string',
    'billingDetails': {
        'billedMemoryUsedInMB': 123,
        'billedDurationInMilliseconds': 123
    }
}

Response Structure

• (dict) --

  • executionArn (string) --

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

  • stateMachineArn (string) --

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

  • name (string) --

    The name of the execution.

  • startDate (datetime) --

    The date the execution is started.

  • stopDate (datetime) --

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

  • status (string) --

    The current status of the execution.

  • error (string) --

    The error code of the failure.

  • cause (string) --

    A more detailed explanation of the cause of the failure.

  • input (string) --

    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.

  • inputDetails (dict) --

    Provides details about execution input or output.

    • included (boolean) --

      Indicates whether input or output was included in the response. Always true for API calls.

  • output (string) --

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

  • outputDetails (dict) --

    Provides details about execution input or output.

    • included (boolean) --

      Indicates whether input or output was included in the response. Always true for API calls.

  • traceHeader (string) --

    The AWS X-Ray trace header that was passed to the execution.

  • billingDetails (dict) --

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

    • billedMemoryUsedInMB (integer) --

      Billed memory consumption of your workflow, in MB.

    • billedDurationInMilliseconds (integer) --

      Billed duration of your workflow, in milliseconds.