Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.StepFunctions.StartSyncExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a Synchronous Express state machine execution.

Synopsis

data StartSyncExecution = StartSyncExecution' {
- input :: Maybe (Sensitive Text)
- name :: Maybe Text
- traceHeader :: Maybe Text
- stateMachineArn :: Text
}
newStartSyncExecution :: Text -> StartSyncExecution
startSyncExecution_input :: Lens' StartSyncExecution (Maybe Text)
startSyncExecution_name :: Lens' StartSyncExecution (Maybe Text)
startSyncExecution_traceHeader :: Lens' StartSyncExecution (Maybe Text)
startSyncExecution_stateMachineArn :: Lens' StartSyncExecution Text
data StartSyncExecutionResponse = StartSyncExecutionResponse' {
- inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- error :: Maybe (Sensitive Text)
- input :: Maybe (Sensitive Text)
- cause :: Maybe (Sensitive Text)
- name :: Maybe Text
- stateMachineArn :: Maybe Text
- output :: Maybe (Sensitive Text)
- outputDetails :: Maybe CloudWatchEventsExecutionDataDetails
- traceHeader :: Maybe Text
- billingDetails :: Maybe BillingDetails
- httpStatus :: Int
- executionArn :: Text
- startDate :: POSIX
- stopDate :: POSIX
- status :: SyncExecutionStatus
}
newStartSyncExecutionResponse :: Int -> Text -> UTCTime -> UTCTime -> SyncExecutionStatus -> StartSyncExecutionResponse
startSyncExecutionResponse_inputDetails :: Lens' StartSyncExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
startSyncExecutionResponse_error :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_input :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_cause :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_name :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_stateMachineArn :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_output :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_outputDetails :: Lens' StartSyncExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails)
startSyncExecutionResponse_traceHeader :: Lens' StartSyncExecutionResponse (Maybe Text)
startSyncExecutionResponse_billingDetails :: Lens' StartSyncExecutionResponse (Maybe BillingDetails)
startSyncExecutionResponse_httpStatus :: Lens' StartSyncExecutionResponse Int
startSyncExecutionResponse_executionArn :: Lens' StartSyncExecutionResponse Text
startSyncExecutionResponse_startDate :: Lens' StartSyncExecutionResponse UTCTime
startSyncExecutionResponse_stopDate :: Lens' StartSyncExecutionResponse UTCTime
startSyncExecutionResponse_status :: Lens' StartSyncExecutionResponse SyncExecutionStatus

Creating a Request

data StartSyncExecution Source #

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 AWS 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

Instances details

Eq StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods (==) :: StartSyncExecution -> StartSyncExecution -> Bool # (/=) :: StartSyncExecution -> StartSyncExecution -> Bool #
Show StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods showsPrec :: Int -> StartSyncExecution -> ShowS # show :: StartSyncExecution -> String # showList :: [StartSyncExecution] -> ShowS #
Generic StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Associated Types type Rep StartSyncExecution :: Type -> Type # Methods from :: StartSyncExecution -> Rep StartSyncExecution x # to :: Rep StartSyncExecution x -> StartSyncExecution #
NFData StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods rnf :: StartSyncExecution -> () #
Hashable StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods hashWithSalt :: Int -> StartSyncExecution -> Int # hash :: StartSyncExecution -> Int #
ToJSON StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods toJSON :: StartSyncExecution -> Value # toEncoding :: StartSyncExecution -> Encoding # toJSONList :: [StartSyncExecution] -> Value # toEncodingList :: [StartSyncExecution] -> Encoding #
AWSRequest StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Associated Types type AWSResponse StartSyncExecution # Methods request :: StartSyncExecution -> Request StartSyncExecution # response :: MonadResource m => Logger -> Service -> Proxy StartSyncExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartSyncExecution))) #
ToHeaders StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods toHeaders :: StartSyncExecution -> [Header] #
ToPath StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods toPath :: StartSyncExecution -> ByteString #
ToQuery StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods toQuery :: StartSyncExecution -> QueryString #
type Rep StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution type Rep StartSyncExecution = D1 ('MetaData "StartSyncExecution" "Amazonka.StepFunctions.StartSyncExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" '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))))
type AWSResponse StartSyncExecution Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution type AWSResponse StartSyncExecution = StartSyncExecutionResponse

newStartSyncExecution Source #

Arguments

:: Text	`$sel:stateMachineArn: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:

$sel:input: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.

$sel:name:StartSyncExecution', startSyncExecution_name - The name of the execution.

$sel:traceHeader:StartSyncExecution', startSyncExecution_traceHeader - Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

$sel:stateMachineArn:StartSyncExecution', startSyncExecution_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.

Request Lenses

startSyncExecution_input :: Lens' StartSyncExecution (Maybe Text) Source #

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) Source #

The name of the execution.

startSyncExecution_traceHeader :: Lens' StartSyncExecution (Maybe Text) Source #

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

startSyncExecution_stateMachineArn :: Lens' StartSyncExecution Text Source #

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

Destructuring the Response

data StartSyncExecutionResponse Source #

See: newStartSyncExecutionResponse smart constructor.

Constructors

StartSyncExecutionResponse'

Fields

inputDetails :: Maybe CloudWatchEventsExecutionDataDetails
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.
cause :: Maybe (Sensitive Text)
A more detailed explanation of the cause of the failure.
name :: Maybe Text
The name of the execution.
stateMachineArn :: Maybe Text
The Amazon Resource Name (ARN) that identifies the state machine.
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
traceHeader :: Maybe Text
The AWS X-Ray trace header that was passed to the execution.
billingDetails :: Maybe BillingDetails
An object that describes workflow billing details, including billed duration and memory use.
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

Instances details

Eq StartSyncExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods (==) :: StartSyncExecutionResponse -> StartSyncExecutionResponse -> Bool # (/=) :: StartSyncExecutionResponse -> StartSyncExecutionResponse -> Bool #
Show StartSyncExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods showsPrec :: Int -> StartSyncExecutionResponse -> ShowS # show :: StartSyncExecutionResponse -> String # showList :: [StartSyncExecutionResponse] -> ShowS #
Generic StartSyncExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Associated Types type Rep StartSyncExecutionResponse :: Type -> Type # Methods from :: StartSyncExecutionResponse -> Rep StartSyncExecutionResponse x # to :: Rep StartSyncExecutionResponse x -> StartSyncExecutionResponse #
NFData StartSyncExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution Methods rnf :: StartSyncExecutionResponse -> () #
type Rep StartSyncExecutionResponse Source #
Instance details Defined in Amazonka.StepFunctions.StartSyncExecution type Rep StartSyncExecutionResponse = D1 ('MetaData "StartSyncExecutionResponse" "Amazonka.StepFunctions.StartSyncExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "StartSyncExecutionResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "inputDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchEventsExecutionDataDetails)) :: (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 "cause") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stateMachineArn") '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 "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "billingDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingDetails)) :: 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 Source #

Arguments

:: Int	`$sel:httpStatus:StartSyncExecutionResponse'`
-> Text	`$sel:executionArn:StartSyncExecutionResponse'`
-> UTCTime	`$sel:startDate:StartSyncExecutionResponse'`
-> UTCTime	`$sel:stopDate:StartSyncExecutionResponse'`
-> SyncExecutionStatus	`$sel:status: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:inputDetails:StartSyncExecutionResponse', startSyncExecutionResponse_inputDetails - Undocumented member.

$sel:error:StartSyncExecutionResponse', startSyncExecutionResponse_error - The error code of the failure.

$sel:input: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.

$sel:cause:StartSyncExecutionResponse', startSyncExecutionResponse_cause - A more detailed explanation of the cause of the failure.

$sel:name:StartSyncExecution', startSyncExecutionResponse_name - The name of the execution.

$sel:stateMachineArn:StartSyncExecution', startSyncExecutionResponse_stateMachineArn - The Amazon Resource Name (ARN) that identifies the state machine.

$sel:output: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.

$sel:outputDetails:StartSyncExecutionResponse', startSyncExecutionResponse_outputDetails - Undocumented member.

$sel:traceHeader:StartSyncExecution', startSyncExecutionResponse_traceHeader - The AWS X-Ray trace header that was passed to the execution.

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

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

$sel:executionArn:StartSyncExecutionResponse', startSyncExecutionResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution.

$sel:startDate:StartSyncExecutionResponse', startSyncExecutionResponse_startDate - The date the execution is started.

$sel:stopDate:StartSyncExecutionResponse', startSyncExecutionResponse_stopDate - If the execution has already ended, the date the execution stopped.

$sel:status:StartSyncExecutionResponse', startSyncExecutionResponse_status - The current status of the execution.

Response Lenses

startSyncExecutionResponse_inputDetails :: Lens' StartSyncExecutionResponse (Maybe CloudWatchEventsExecutionDataDetails) Source #

Undocumented member.

startSyncExecutionResponse_error :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

The error code of the failure.

startSyncExecutionResponse_input :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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_cause :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

A more detailed explanation of the cause of the failure.

startSyncExecutionResponse_name :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

The name of the execution.

startSyncExecutionResponse_stateMachineArn :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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

startSyncExecutionResponse_output :: Lens' StartSyncExecutionResponse (Maybe Text) Source #

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) Source #

Undocumented member.

startSyncExecutionResponse_traceHeader :: Lens' StartSyncExecutionResponse (Maybe Text) Source #