Skip to content

Commit f8efe7b

Browse files
authored
docs: Link to checkpoint consumption from operations (#201)
Add an info box linking to the AWS Lambda durable execution SDK checkpoint consumption reference at the end of each operation page (callback, child-context, invoke, map, parallel, step, wait, and wait-for-condition). Also add the same reference link to the end of the Checkpoints section in key concepts.
1 parent fea5396 commit f8efe7b

9 files changed

Lines changed: 51 additions & 0 deletions

File tree

docs/getting-started/key-concepts.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,9 @@ Once the SDK persists a checkpoint, that operation's result is safe. If your fun
9898
interrupted at any point, the SDK can replay up to the last persisted checkpoint on the
9999
next invocation.
100100

101+
For details on how durable operations consume checkpoints, see
102+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).
103+
101104
## Replay
102105

103106
Lambda keeps a running log of all durable operations as your function executes. When

docs/sdk-reference/operations/callback.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,3 +522,9 @@ sam remote callback fail <callback-id> \
522522
waiting for the callback
523523
- [Wait](wait.md) Time-based durable waits.
524524
- [Error handling](../error-handling/retries.md)
525+
526+
!!! info "Checkpoint consumption"
527+
528+
Durable operations consume checkpoints. To understand how this operation affects
529+
your checkpoint usage, see
530+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/child-context.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,3 +322,9 @@ them to verify the child context ran and produced the expected result.
322322
- [Steps](step.md) Run a single function with automatic checkpointing
323323
- [Parallel operations](parallel.md) Execute operations concurrently
324324
- [Map operations](map.md) Run operation for each item in a collection
325+
326+
!!! info "Checkpoint consumption"
327+
328+
Durable operations consume checkpoints. To understand how this operation affects
329+
your checkpoint usage, see
330+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/invoke.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,3 +274,9 @@ Java exposes separate exception types for different failure modes:
274274
- [Child contexts](child-context.md) Group operations
275275
- [Parallel operations](parallel.md) Execute operations concurrently
276276
- [Map operations](map.md) Run operation for each item in a collection
277+
278+
!!! info "Checkpoint consumption"
279+
280+
Durable operations consume checkpoints. To understand how this operation affects
281+
your checkpoint usage, see
282+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/map.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -688,3 +688,9 @@ operations. Each nested map creates its own set of child contexts.
688688
- [Child contexts](child-context.md) understand child context isolation
689689
- [Steps](step.md) use steps within map functions
690690
- [Error handling](../error-handling/errors.md) in durable functions
691+
692+
!!! info "Checkpoint consumption"
693+
694+
Durable operations consume checkpoints. To understand how this operation affects
695+
your checkpoint usage, see
696+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/parallel.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -735,3 +735,9 @@ Each nested parallel creates its own set of child contexts.
735735
- [Child contexts](child-context.md) understand child context isolation
736736
- [Steps](step.md) use steps within parallel branches
737737
- [Error handling](../error-handling/errors.md) in durable functions
738+
739+
!!! info "Checkpoint consumption"
740+
741+
Durable operations consume checkpoints. To understand how this operation affects
742+
your checkpoint usage, see
743+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/step.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,3 +434,9 @@ concurrent code path.
434434
- [Testing](../../testing/index.md)
435435
- [Wait operations](wait.md)
436436
- [Child contexts](child-context.md)
437+
438+
!!! info "Checkpoint consumption"
439+
440+
Durable operations consume checkpoints. To understand how this operation affects
441+
your checkpoint usage, see
442+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/wait-for-condition.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,3 +184,9 @@ Lambda cold start time, and current system load.
184184
- [Callbacks](callback.md) - Wait for external system responses
185185
- [Steps](step.md) - Execute business logic with automatic checkpointing
186186
- [Getting Started](../../getting-started/index.md) - Learn the basics of durable functions
187+
188+
!!! info "Checkpoint consumption"
189+
190+
Durable operations consume checkpoints. To understand how this operation affects
191+
your checkpoint usage, see
192+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

docs/sdk-reference/operations/wait.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,3 +264,9 @@ You can verify wait operations in your tests by inspecting the operations list:
264264
- [Wait for Condition](wait-for-condition.md) - Poll until a condition is met
265265
- [Callbacks](callback.md) - Wait for external system responses
266266
- [Getting Started](../../getting-started/index.md) - Learn the basics of durable functions
267+
268+
!!! info "Checkpoint consumption"
269+
270+
Durable operations consume checkpoints. To understand how this operation affects
271+
your checkpoint usage, see
272+
[Checkpoint consumption](https://docs.aws.amazon.com/lambda/latest/dg/durable-execution-sdk.html#durable-operations-checkpoint-consumption).

0 commit comments

Comments
 (0)