Skip to content

Lambda  >  Operations  >  get_durable_execution_history

get_durable_execution_history

Operation

get_durable_execution_history async 

get_durable_execution_history(input: GetDurableExecutionHistoryInput, plugins: list[Plugin] | None = None) -> GetDurableExecutionHistoryOutput

Retrieves the execution history for a durable execution, showing all the steps, callbacks, and events that occurred during the execution. This provides a detailed audit trail of the execution's progress over time.

The history is available while the execution is running and for a retention period after it completes (1-90 days, default 30 days). You can control whether to include execution data such as step results and callback payloads.

Parameters:

Name Type Description Default
input GetDurableExecutionHistoryInput

An instance of GetDurableExecutionHistoryInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetDurableExecutionHistoryOutput

An instance of GetDurableExecutionHistoryOutput.

Input

GetDurableExecutionHistoryInput dataclass

Dataclass for GetDurableExecutionHistoryInput structure.

Attributes

durable_execution_arn class-attribute instance-attribute 
durable_execution_arn: str | None = None

The Amazon Resource Name (ARN) of the durable execution.

include_execution_data class-attribute instance-attribute 
include_execution_data: bool | None = None

Specifies whether to include execution data such as step results and callback payloads in the history events. Set to true to include data, or false to exclude it for a more compact response. The default is true.

marker class-attribute instance-attribute 
marker: str | None = None

If NextMarker was returned from a previous request, use this value to retrieve the next page of results. Each pagination token expires after 24 hours.

max_items class-attribute instance-attribute 
max_items: int = 0

The maximum number of history events to return per call. You can use Marker to retrieve additional pages of results. The default is 100 and the maximum allowed is 1000. A value of 0 uses the default.

reverse_order class-attribute instance-attribute 
reverse_order: bool | None = None

When set to true, returns the history events in reverse chronological order (newest first). By default, events are returned in chronological order (oldest first).

Output

GetDurableExecutionHistoryOutput dataclass

The response from the GetDurableExecutionHistory operation, containing the execution history and events.

Attributes

events instance-attribute 
events: list[Event]

An array of execution history events, ordered chronologically unless ReverseOrder is set to true. Each event represents a significant occurrence during the execution, such as step completion or callback resolution.

next_marker class-attribute instance-attribute 
next_marker: str | None = None

If present, indicates that more history events are available. Use this value as the Marker parameter in a subsequent request to retrieve the next page of results.