get_durable_execution_state¶
Operation¶
get_durable_execution_state
async
¶
get_durable_execution_state(input: GetDurableExecutionStateInput, plugins: list[Plugin] | None = None) -> GetDurableExecutionStateOutput
Retrieves the current execution state required for the replay process during durable function execution. This API is used by the Lambda durable functions SDK to get state information needed for replay. You typically don't need to call this API directly as the SDK handles state management automatically.
The response contains operations ordered by start sequence number in ascending order. Completed operations with children don't include child operation details since they don't need to be replayed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDurableExecutionStateInput
|
An instance of |
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 |
|---|---|
GetDurableExecutionStateOutput
|
An instance of |
Input¶
GetDurableExecutionStateInput
dataclass
¶
Dataclass for GetDurableExecutionStateInput structure.
Attributes¶
checkpoint_token
class-attribute
instance-attribute
¶
checkpoint_token: str | None = None
A checkpoint token that identifies the current state of the execution. This token is provided by the Lambda runtime and ensures that state retrieval is consistent with the current execution context.
durable_execution_arn
class-attribute
instance-attribute
¶
durable_execution_arn: str | None = None
The Amazon Resource Name (ARN) of the durable execution.
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 operations. Each pagination token expires
after 24 hours.
max_items
class-attribute
instance-attribute
¶
max_items: int = 0
The maximum number of operations 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.
Output¶
GetDurableExecutionStateOutput
dataclass
¶
The response from the GetDurableExecutionState operation, containing the current execution state for replay.