Amazonka.StepFunctions.StartSyncExecution

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.

Creating a Request

data StartSyncExecution

See: newStartSyncExecution smart constructor.

Constructors

StartSyncExecution'

Fields

• input :: Maybe (Sensitive Text)

  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.

• name :: Maybe Text

  The name of the execution.

• traceHeader :: Maybe Text

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

• stateMachineArn :: Text

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

Instances

ToJSON StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

toJSON :: StartSyncExecution -> Value

toEncoding :: StartSyncExecution -> Encoding

toJSONList :: [StartSyncExecution] -> Value

toEncodingList :: [StartSyncExecution] -> Encoding

ToHeaders StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

toHeaders :: StartSyncExecution -> [Header]

ToPath StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

toPath :: StartSyncExecution -> ByteString

ToQuery StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

toQuery :: StartSyncExecution -> QueryString

AWSRequest StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Associated Types

type AWSResponse StartSyncExecution

Methods

request :: (Service -> Service) -> StartSyncExecution -> Request StartSyncExecution

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartSyncExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSyncExecution)))

Generic StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Associated Types

type Rep StartSyncExecution :: Type -> Type

Methods

from :: StartSyncExecution -> Rep StartSyncExecution x

to :: Rep StartSyncExecution x -> StartSyncExecution

Show StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

showsPrec :: Int -> StartSyncExecution -> ShowS

show :: StartSyncExecution -> String

showList :: [StartSyncExecution] -> ShowS

NFData StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

rnf :: StartSyncExecution -> ()

Eq StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

(==) :: StartSyncExecution -> StartSyncExecution -> Bool

(/=) :: StartSyncExecution -> StartSyncExecution -> Bool

Hashable StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

hashWithSalt :: Int -> StartSyncExecution -> Int

hash :: StartSyncExecution -> Int

type AWSResponse StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

type AWSResponse StartSyncExecution = StartSyncExecutionResponse

type Rep StartSyncExecution

Defined in Amazonka.StepFunctions.StartSyncExecution

type Rep StartSyncExecution = D1 ('MetaData "StartSyncExecution" "Amazonka.StepFunctions.StartSyncExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "StartSyncExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartSyncExecution

Arguments

:: Text

StartSyncExecution

-> StartSyncExecution

Create a value of StartSyncExecution with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

StartSyncExecution, startSyncExecution_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.

StartSyncExecution, startSyncExecution_name - The name of the execution.

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

StartSyncExecution, startSyncExecution_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.

Request Lenses

startSyncExecution_input :: Lens' StartSyncExecution (Maybe Text)

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.

startSyncExecution_name :: Lens' StartSyncExecution (Maybe Text)

The name of the execution.

startSyncExecution_traceHeader :: Lens' StartSyncExecution (Maybe Text)

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

startSyncExecution_stateMachineArn :: Lens' StartSyncExecution Text

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

Destructuring the Response

data StartSyncExecutionResponse

See: newStartSyncExecutionResponse smart constructor.

Constructors

StartSyncExecutionResponse'

Fields

• billingDetails :: Maybe BillingDetails

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

• cause :: Maybe (Sensitive Text)

  A more detailed explanation of the cause of the failure.

• error :: Maybe (Sensitive Text)

  The error code of the failure.

• input :: Maybe (Sensitive Text)

  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 :: Maybe CloudWatchEventsExecutionDataDetails
• name :: Maybe Text

  The name of the execution.

• output :: Maybe (Sensitive Text)

  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.

• outputDetails :: Maybe CloudWatchEventsExecutionDataDetails
• stateMachineArn :: Maybe Text

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

• traceHeader :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• executionArn :: Text

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

• startDate :: POSIX

  The date the execution is started.

• stopDate :: POSIX

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

• status :: SyncExecutionStatus

  The current status of the execution.

Instances

Generic StartSyncExecutionResponse

Defined in Amazonka.StepFunctions.StartSyncExecution

Associated Types

type Rep StartSyncExecutionResponse :: Type -> Type

Methods

from :: StartSyncExecutionResponse -> Rep StartSyncExecutionResponse x

to :: Rep StartSyncExecutionResponse x -> StartSyncExecutionResponse

Show StartSyncExecutionResponse

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

showsPrec :: Int -> StartSyncExecutionResponse -> ShowS

show :: StartSyncExecutionResponse -> String

showList :: [StartSyncExecutionResponse] -> ShowS

NFData StartSyncExecutionResponse

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

rnf :: StartSyncExecutionResponse -> ()

Eq StartSyncExecutionResponse

Defined in Amazonka.StepFunctions.StartSyncExecution

Methods

(==) :: StartSyncExecutionResponse -> StartSyncExecutionResponse -> Bool

(/=) :: StartSyncExecutionResponse -> StartSyncExecutionResponse -> Bool

type Rep StartSyncExecutionResponse

Defined in Amazonka.StepFunctions.StartSyncExecution

type Rep StartSyncExecutionResponse = D1 ('MetaData "StartSyncExecutionResponse" "Amazonka.StepFunctions.StartSyncExecution" "amazonka-stepfunctions-2.0-K6z2kqboJVbL1MZX8DUt0f" 'False) (C1 ('MetaCons "StartSyncExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "billingDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingDetails)) :*: (S1 ('MetaSel ('Just "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "inputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))))) :*: (((S1 ('MetaSel ('Just "outputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails)) :*: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) :*: ((S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :*: (S1 ('MetaSel ('Just "stopDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SyncExecutionStatus))))))

newStartSyncExecutionResponse

Arguments

:: Int

$sel:httpStatus:StartSyncExecutionResponse'

-> Text

StartSyncExecutionResponse

-> UTCTime

StartSyncExecutionResponse

-> UTCTime

StartSyncExecutionResponse

-> SyncExecutionStatus

StartSyncExecutionResponse

-> StartSyncExecutionResponse

Create a value of StartSyncExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:billingDetails:StartSyncExecutionResponse', startSyncExecutionResponse_billingDetails - An object that describes workflow billing details, including billed duration and memory use.

StartSyncExecutionResponse, startSyncExecutionResponse_cause - A more detailed explanation of the cause of the failure.

StartSyncExecutionResponse, startSyncExecutionResponse_error - The error code of the failure.

StartSyncExecution, startSyncExecutionResponse_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.

StartSyncExecutionResponse, startSyncExecutionResponse_inputDetails - Undocumented member.

StartSyncExecution, startSyncExecutionResponse_name - The name of the execution.

StartSyncExecutionResponse, startSyncExecutionResponse_output - 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.

StartSyncExecutionResponse, startSyncExecutionResponse_outputDetails - Undocumented member.

StartSyncExecution, startSyncExecutionResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the state machine.

StartSyncExecution, startSyncExecutionResponse_traceHeader - The X-Ray trace header that was passed to the execution.

$sel:httpStatus:StartSyncExecutionResponse', startSyncExecutionResponse_httpStatus - The response's http status code.

StartSyncExecutionResponse, startSyncExecutionResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution.

StartSyncExecutionResponse, startSyncExecutionResponse_startDate - The date the execution is started.

StartSyncExecutionResponse, startSyncExecutionResponse_stopDate - If the execution has already ended, the date the execution stopped.

StartSyncExecutionResponse, startSyncExecutionResponse_status - The current status of the execution.

Response Lenses

startSyncExecutionResponse_billingDetails :: Lens' StartSyncExecutionResponse (Maybe BillingDetails)

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

startSyncExecutionResponse_cause :: Lens' StartSyncExecutionResponse (Maybe Text)

A more detailed explanation of the cause of the failure.

startSyncExecutionResponse_error :: Lens' StartSyncExecutionResponse (Maybe Text)

The error code of the failure.

startSyncExecutionResponse_input :: Lens' StartSyncExecutionResponse (Maybe Text)

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.

startSyncExecutionResponse_inputDetails :: Lens' StartSyncExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)

Undocumented member.

startSyncExecutionResponse_name :: Lens' StartSyncExecutionResponse (Maybe Text)

The name of the execution.

startSyncExecutionResponse_output :: Lens' StartSyncExecutionResponse (Maybe Text)

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.

startSyncExecutionResponse_outputDetails :: Lens' StartSyncExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)

Undocumented member.

startSyncExecutionResponse_stateMachineArn :: Lens' StartSyncExecutionResponse (Maybe Text)

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

startSyncExecutionResponse_traceHeader :: Lens' StartSyncExecutionResponse (Maybe Text)

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

startSyncExecutionResponse_httpStatus :: Lens' StartSyncExecutionResponse Int

The response's http status code.

startSyncExecutionResponse_executionArn :: Lens' StartSyncExecutionResponse Text

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

startSyncExecutionResponse_startDate :: Lens' StartSyncExecutionResponse UTCTime

The date the execution is started.

startSyncExecutionResponse_stopDate :: Lens' StartSyncExecutionResponse UTCTime

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

startSyncExecutionResponse_status :: Lens' StartSyncExecutionResponse SyncExecutionStatus

The current status of the execution.