/AWS1/CL_SFNSTARTSYNCEXECOUT¶
StartSyncExecutionOutput
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_executionarn
TYPE /AWS1/SFNARN
/AWS1/SFNARN
¶
The Amazon Resource Name (ARN) that identifies the execution.
iv_startdate
TYPE /AWS1/SFNTIMESTAMP
/AWS1/SFNTIMESTAMP
¶
The date the execution is started.
iv_stopdate
TYPE /AWS1/SFNTIMESTAMP
/AWS1/SFNTIMESTAMP
¶
If the execution has already ended, the date the execution stopped.
iv_status
TYPE /AWS1/SFNSYNCEXECUTIONSTATUS
/AWS1/SFNSYNCEXECUTIONSTATUS
¶
The current status of the execution.
Optional arguments:¶
iv_statemachinearn
TYPE /AWS1/SFNARN
/AWS1/SFNARN
¶
The Amazon Resource Name (ARN) that identifies the state machine.
iv_name
TYPE /AWS1/SFNNAME
/AWS1/SFNNAME
¶
The name of the execution.
iv_error
TYPE /AWS1/SFNSENSITIVEERROR
/AWS1/SFNSENSITIVEERROR
¶
The error code of the failure.
iv_cause
TYPE /AWS1/SFNSENSITIVECAUSE
/AWS1/SFNSENSITIVECAUSE
¶
A more detailed explanation of the cause of the failure.
iv_input
TYPE /AWS1/SFNSENSITIVEDATA
/AWS1/SFNSENSITIVEDATA
¶
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.
io_inputdetails
TYPE REF TO /AWS1/CL_SFNCLOUDWATCHEVTSEX00
/AWS1/CL_SFNCLOUDWATCHEVTSEX00
¶
inputDetails
iv_output
TYPE /AWS1/SFNSENSITIVEDATA
/AWS1/SFNSENSITIVEDATA
¶
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.
io_outputdetails
TYPE REF TO /AWS1/CL_SFNCLOUDWATCHEVTSEX00
/AWS1/CL_SFNCLOUDWATCHEVTSEX00
¶
outputDetails
iv_traceheader
TYPE /AWS1/SFNTRACEHEADER
/AWS1/SFNTRACEHEADER
¶
The X-Ray trace header that was passed to the execution.
For X-Ray traces, all Amazon Web Services services use the
X-Amzn-Trace-Id
header from the HTTP request. Using the header is the preferred mechanism to identify a trace.StartExecution
andStartSyncExecution
API operations can also usetraceHeader
from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.
io_billingdetails
TYPE REF TO /AWS1/CL_SFNBILLINGDETAILS
/AWS1/CL_SFNBILLINGDETAILS
¶
An object that describes workflow billing details, including billed duration and memory use.
Queryable Attributes¶
executionArn¶
The Amazon Resource Name (ARN) that identifies the execution.
Accessible with the following methods¶
Method | Description |
---|---|
GET_EXECUTIONARN() |
Getter for EXECUTIONARN, with configurable default |
ASK_EXECUTIONARN() |
Getter for EXECUTIONARN w/ exceptions if field has no value |
HAS_EXECUTIONARN() |
Determine if EXECUTIONARN has a value |
stateMachineArn¶
The Amazon Resource Name (ARN) that identifies the state machine.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATEMACHINEARN() |
Getter for STATEMACHINEARN, with configurable default |
ASK_STATEMACHINEARN() |
Getter for STATEMACHINEARN w/ exceptions if field has no val |
HAS_STATEMACHINEARN() |
Determine if STATEMACHINEARN has a value |
name¶
The name of the execution.
Accessible with the following methods¶
Method | Description |
---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
startDate¶
The date the execution is started.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STARTDATE() |
Getter for STARTDATE, with configurable default |
ASK_STARTDATE() |
Getter for STARTDATE w/ exceptions if field has no value |
HAS_STARTDATE() |
Determine if STARTDATE has a value |
stopDate¶
If the execution has already ended, the date the execution stopped.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STOPDATE() |
Getter for STOPDATE, with configurable default |
ASK_STOPDATE() |
Getter for STOPDATE w/ exceptions if field has no value |
HAS_STOPDATE() |
Determine if STOPDATE has a value |
status¶
The current status of the execution.
Accessible with the following methods¶
Method | Description |
---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
error¶
The error code of the failure.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ERROR() |
Getter for ERROR, with configurable default |
ASK_ERROR() |
Getter for ERROR w/ exceptions if field has no value |
HAS_ERROR() |
Determine if ERROR has a value |
cause¶
A more detailed explanation of the cause of the failure.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CAUSE() |
Getter for CAUSE, with configurable default |
ASK_CAUSE() |
Getter for CAUSE w/ exceptions if field has no value |
HAS_CAUSE() |
Determine if CAUSE has a value |
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_INPUT() |
Getter for INPUT, with configurable default |
ASK_INPUT() |
Getter for INPUT w/ exceptions if field has no value |
HAS_INPUT() |
Determine if INPUT has a value |
inputDetails¶
inputDetails
Accessible with the following methods¶
Method | Description |
---|---|
GET_INPUTDETAILS() |
Getter for INPUTDETAILS |
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_OUTPUT() |
Getter for OUTPUT, with configurable default |
ASK_OUTPUT() |
Getter for OUTPUT w/ exceptions if field has no value |
HAS_OUTPUT() |
Determine if OUTPUT has a value |
outputDetails¶
outputDetails
Accessible with the following methods¶
Method | Description |
---|---|
GET_OUTPUTDETAILS() |
Getter for OUTPUTDETAILS |
traceHeader¶
The X-Ray trace header that was passed to the execution.
For X-Ray traces, all Amazon Web Services services use the
X-Amzn-Trace-Id
header from the HTTP request. Using the header is the preferred mechanism to identify a trace.StartExecution
andStartSyncExecution
API operations can also usetraceHeader
from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.
Accessible with the following methods¶
Method | Description |
---|---|
GET_TRACEHEADER() |
Getter for TRACEHEADER, with configurable default |
ASK_TRACEHEADER() |
Getter for TRACEHEADER w/ exceptions if field has no value |
HAS_TRACEHEADER() |
Determine if TRACEHEADER has a value |
billingDetails¶
An object that describes workflow billing details, including billed duration and memory use.
Accessible with the following methods¶
Method | Description |
---|---|
GET_BILLINGDETAILS() |
Getter for BILLINGDETAILS |