Describe Execution
sfn_describe_execution | R Documentation |
Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata¶
Description¶
Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've redriven an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.
If you specify a version or alias ARN when you call the
start_execution
API action, describe_execution
returns that ARN.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
Executions of an EXPRESS
state machine aren't supported by
describe_execution
unless a Map Run dispatched them.
Usage¶
Arguments¶
executionArn
[required] The Amazon Resource Name (ARN) of the execution to describe.
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 DescribeStateMachine API withincludedData = METADATA_ONLY
to get a successful response without the encrypted definition.
Value¶
A list with the following syntax:
list(
executionArn = "string",
stateMachineArn = "string",
name = "string",
status = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|"PENDING_REDRIVE",
startDate = as.POSIXct(
"2015-01-01"
),
stopDate = as.POSIXct(
"2015-01-01"
),
input = "string",
inputDetails = list(
included = TRUE|FALSE
),
output = "string",
outputDetails = list(
included = TRUE|FALSE
),
traceHeader = "string",
mapRunArn = "string",
error = "string",
cause = "string",
stateMachineVersionArn = "string",
stateMachineAliasArn = "string",
redriveCount = 123,
redriveDate = as.POSIXct(
"2015-01-01"
),
redriveStatus = "REDRIVABLE"|"NOT_REDRIVABLE"|"REDRIVABLE_BY_MAP_RUN",
redriveStatusReason = "string"
)