AWS durable-functions.md documentation change
Summary
Major restructuring of AWS Durable Execution SDK documentation, changing from general docs to a Developer Guide format with reorganized navigation, updated branding, and clearer separation between SDK and service documentation.
Security assessment
This is a documentation reorganization and branding update. The changes include navigation restructuring, title updates, and content reorganization. While the new version mentions IAM permissions in a related documentation section, this is a reference to existing Lambda service documentation rather than adding new security content. There's no evidence of addressing a specific security vulnerability, weakness, or incident in this diff.
Diff
diff --git a/durable-functions.md b/durable-functions.md index 77cecf24d..c6082cbce 100644 --- a//durable-functions.md +++ b//durable-functions.md @@ -3 +3 @@ Skip to content -[ ]( "AWS Durable Execution docs") +[  ]( "AWS Durable Execution SDK Developer Guide") @@ -5 +5 @@ Skip to content -AWS Durable Execution docs +AWS Durable Execution SDK Developer Guide @@ -7 +7 @@ AWS Durable Execution docs -AWS Durable Execution SDK +AWS Durable Execution SDK Developer Guide @@ -13,21 +13 @@ Search -[ ]( "AWS Durable Execution docs") AWS Durable Execution docs - -[ GitHub ](https://github.com/aws/aws-durable-execution-docs "Go to repository") - - * Home [ Home ]() On this page - * Table of Contents - * What is the Durable Execution SDK? - * Key features - * Installation - * Quick example - * Core concepts - * Durable functions - * Operations - * Checkpoints - * Replay - * Decorators - * Architecture - * Key components - * Checkpointing - * Use cases - * Getting help + * [ Home ]() @@ -35,19 +15,3 @@ Search - * [ Best Practices ](./best-practices/) - * Core Core - * [ Step ](./core/steps/) - * [ Wait ](./core/wait/) - * [ Wait for Condition ](./core/wait-for-condition/) - * [ Callback ](./core/callbacks/) - * [ Invoke ](./core/invoke/) - * [ Parallel ](./core/parallel/) - * [ Map ](./core/map/) - * [ Child Context ](./core/child-contexts/) - * [ Logger ](./core/logger/) - * Advanced Advanced - * [ Error Handling ](./advanced/error-handling/) - * [ Serialization ](./advanced/serialization/) - * [ Testing Modes ](./advanced/testing-modes/) - * Testing Patterns Testing Patterns - * [ Basic Tests ](./testing-patterns/basic-tests/) - * [ Complex Workflows ](./testing-patterns/complex-workflows/) - * [ Stores ](./testing-patterns/stores/) + * [ SDK Reference ](./sdk-reference/operations/step/) + * [ Testing ](./testing/basic-tests/) + * [ Patterns ](./patterns/best-practices/) @@ -57 +21 @@ Search -On this page +[  ]( "AWS Durable Execution SDK Developer Guide") AWS Durable Execution SDK Developer Guide @@ -59,16 +23 @@ On this page - * Table of Contents - * What is the Durable Execution SDK? - * Key features - * Installation - * Quick example - * Core concepts - * Durable functions - * Operations - * Checkpoints - * Replay - * Decorators - * Architecture - * Key components - * Checkpointing - * Use cases - * Getting help +[ GitHub ](https://github.com/aws/aws-durable-execution-docs "Go to repository") @@ -75,0 +25,2 @@ On this page + * [ Home ]() + * [ Getting Started ](./getting-started/) @@ -76,0 +28,27 @@ On this page +Getting Started + * [ Key Concepts ](./getting-started/key-concepts/) + * [ Quick Start ](./getting-started/quick-start/) + * SDK Reference SDK Reference + * Operations Operations + * [ Step ](./sdk-reference/operations/step/) + * [ Wait ](./sdk-reference/operations/wait/) + * [ Wait for Condition ](./sdk-reference/operations/wait-for-condition/) + * [ Callback ](./sdk-reference/operations/callback/) + * [ Invoke ](./sdk-reference/operations/invoke/) + * [ Parallel ](./sdk-reference/operations/parallel/) + * [ Map ](./sdk-reference/operations/map/) + * [ Child Context ](./sdk-reference/operations/child-context/) + * Error Handling Error Handling + * [ Errors ](./sdk-reference/error-handling/errors/) + * [ Retries ](./sdk-reference/error-handling/retries/) + * State State + * [ Serialization ](./sdk-reference/state/serialization/) + * Observability Observability + * [ Logging ](./sdk-reference/observability/logging/) + * Testing Testing + * [ Basic Tests ](./testing/basic-tests/) + * [ Complex Workflows ](./testing/complex-workflows/) + * [ Stores ](./testing/stores/) + * [ Testing Modes ](./testing/testing-modes/) + * Patterns Patterns + * [ Best Practices ](./patterns/best-practices/) @@ -78 +55,0 @@ On this page -[ ](https://github.com/aws/aws-durable-execution-docs/edit/main/docs/index.md "Edit this page") [ ](https://github.com/aws/aws-durable-execution-docs/raw/main/docs/index.md "View source of this page") @@ -80 +56,0 @@ On this page -# AWS Durable Execution SDK @@ -82 +58 @@ On this page -## Table of Contents +On this page @@ -84 +59,0 @@ On this page - * What is the Durable Execution SDK? @@ -86,4 +60,0 @@ On this page - * Installation - * Quick example - * Core concepts - * Architecture @@ -92,60 +63 @@ On this page - * License - - - -## What is the Durable Execution SDK? - -The AWS Durable Execution SDK lets you build reliable, long-running workflows in AWS Lambda. Your functions can pause execution, wait for external events, retry failed operations, and resume exactly where they left off—even if Lambda recycles your execution environment. - -The SDK provides a `DurableContext` that gives you operations like steps, waits, callbacks, and parallel execution. Each operation is checkpointed automatically, so your workflow state is preserved across interruptions. - -↑ Back to top - -## Key features - - * **Automatic checkpointing** \- Your workflow state is saved automatically after each operation - * **Durable steps** \- Execute code with configurable retry strategies and at-most-once or at-least-once semantics - * **Wait operations** \- Pause execution for seconds, minutes, or hours without blocking Lambda resources - * **Callbacks** \- Wait for external systems to respond with results or approvals - * **Parallel execution** \- Run multiple operations concurrently with configurable completion criteria - * **Map operations** \- Process collections in parallel with batching and failure tolerance - * **Child contexts** \- Isolate nested workflows for better organization and error handling - * **Structured logging** \- Integrate with your logger to track execution flow and debug issues - - - -↑ Back to top - -## Installation - -Install the SDK using pip: - - - pip install aws-durable-execution-sdk-python - - -↑ Back to top - -## Quick example - -Here's a simple durable function that processes an order: - -TypeScriptPythonJava - - - // Coming soon... - - - - from aws_durable_execution_sdk_python import ( - DurableContext, - durable_execution, - durable_step, - ) - from aws_durable_execution_sdk_python.config import Duration - - - @durable_step - def validate_order(order_id: str) -> dict: - # Validation logic here - return {"order_id": order_id, "valid": True} + * Related documentation @@ -154,99 +65,0 @@ TypeScriptPythonJava - @durable_step - def charge_payment(order_id: str, amount: float) -> dict: - # Payment processing logic here - return {"transaction_id": "txn_123", "status": "completed"} - - - @durable_step - def fulfill_order(order_id: str) -> dict: - # Fulfillment logic here - return {"tracking_number": "TRK123456"} - -