HistoryEvent - Amazon Step Functions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

HistoryEvent

Contains details about the events of an execution.

Contents

activityFailedEventDetails

Type: ActivityFailedEventDetails object

Required: No

activityScheduledEventDetails

Type: ActivityScheduledEventDetails object

Required: No

activityScheduleFailedEventDetails

Contains details about an activity schedule event that failed during an execution.

Type: ActivityScheduleFailedEventDetails object

Required: No

activityStartedEventDetails

Type: ActivityStartedEventDetails object

Required: No

activitySucceededEventDetails

Type: ActivitySucceededEventDetails object

Required: No

activityTimedOutEventDetails

Type: ActivityTimedOutEventDetails object

Required: No

executionAbortedEventDetails

Type: ExecutionAbortedEventDetails object

Required: No

executionFailedEventDetails

Type: ExecutionFailedEventDetails object

Required: No

executionStartedEventDetails

Type: ExecutionStartedEventDetails object

Required: No

executionSucceededEventDetails

Type: ExecutionSucceededEventDetails object

Required: No

executionTimedOutEventDetails

Type: ExecutionTimedOutEventDetails object

Required: No

id

The id of the event. Events are numbered sequentially, starting at one.

Type: Long

Required: Yes

lambdaFunctionFailedEventDetails

Type: LambdaFunctionFailedEventDetails object

Required: No

lambdaFunctionScheduledEventDetails

Type: LambdaFunctionScheduledEventDetails object

Required: No

lambdaFunctionScheduleFailedEventDetails

Type: LambdaFunctionScheduleFailedEventDetails object

Required: No

lambdaFunctionStartFailedEventDetails

Contains details about a lambda function that failed to start during an execution.

Type: LambdaFunctionStartFailedEventDetails object

Required: No

lambdaFunctionSucceededEventDetails

Contains details about a Lambda function that terminated successfully during an execution.

Type: LambdaFunctionSucceededEventDetails object

Required: No

lambdaFunctionTimedOutEventDetails

Type: LambdaFunctionTimedOutEventDetails object

Required: No

mapIterationAbortedEventDetails

Contains details about an iteration of a Map state that was aborted.

Type: MapIterationEventDetails object

Required: No

mapIterationFailedEventDetails

Contains details about an iteration of a Map state that failed.

Type: MapIterationEventDetails object

Required: No

mapIterationStartedEventDetails

Contains details about an iteration of a Map state that was started.

Type: MapIterationEventDetails object

Required: No

mapIterationSucceededEventDetails

Contains details about an iteration of a Map state that succeeded.

Type: MapIterationEventDetails object

Required: No

mapStateStartedEventDetails

Contains details about Map state that was started.

Type: MapStateStartedEventDetails object

Required: No

previousEventId

The id of the previous event.

Type: Long

Required: No

stateEnteredEventDetails

Type: StateEnteredEventDetails object

Required: No

stateExitedEventDetails

Type: StateExitedEventDetails object

Required: No

taskFailedEventDetails

Contains details about the failure of a task.

Type: TaskFailedEventDetails object

Required: No

taskScheduledEventDetails

Contains details about a task that was scheduled.

Type: TaskScheduledEventDetails object

Required: No

taskStartedEventDetails

Contains details about a task that was started.

Type: TaskStartedEventDetails object

Required: No

taskStartFailedEventDetails

Contains details about a task that failed to start.

Type: TaskStartFailedEventDetails object

Required: No

taskSubmitFailedEventDetails

Contains details about a task that where the submit failed.

Type: TaskSubmitFailedEventDetails object

Required: No

taskSubmittedEventDetails

Contains details about a submitted task.

Type: TaskSubmittedEventDetails object

Required: No

taskSucceededEventDetails

Contains details about a task that succeeded.

Type: TaskSucceededEventDetails object

Required: No

taskTimedOutEventDetails

Contains details about a task that timed out.

Type: TaskTimedOutEventDetails object

Required: No

timestamp

The date and time the event occurred.

Type: Timestamp

Required: Yes

type

The type of the event.

Type: String

Valid Values: ActivityFailed | ActivityScheduled | ActivityScheduleFailed | ActivityStarted | ActivitySucceeded | ActivityTimedOut | ChoiceStateEntered | ChoiceStateExited | ExecutionAborted | ExecutionFailed | ExecutionStarted | ExecutionSucceeded | ExecutionTimedOut | FailStateEntered | LambdaFunctionFailed | LambdaFunctionScheduled | LambdaFunctionScheduleFailed | LambdaFunctionStarted | LambdaFunctionStartFailed | LambdaFunctionSucceeded | LambdaFunctionTimedOut | MapIterationAborted | MapIterationFailed | MapIterationStarted | MapIterationSucceeded | MapStateAborted | MapStateEntered | MapStateExited | MapStateFailed | MapStateStarted | MapStateSucceeded | ParallelStateAborted | ParallelStateEntered | ParallelStateExited | ParallelStateFailed | ParallelStateStarted | ParallelStateSucceeded | PassStateEntered | PassStateExited | SucceedStateEntered | SucceedStateExited | TaskFailed | TaskScheduled | TaskStarted | TaskStartFailed | TaskStateAborted | TaskStateEntered | TaskStateExited | TaskSubmitFailed | TaskSubmitted | TaskSucceeded | TaskTimedOut | WaitStateAborted | WaitStateEntered | WaitStateExited

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: