AWS durable-functions documentation change
Summary
Major restructuring of the AWS Durable Execution SDK documentation, including updated navigation, simplified content, and a new example focused on order processing.
Security assessment
The changes are purely structural and content-related, involving navigation updates, content reorganization, and example replacement. There is no mention of security vulnerabilities, patches, or security features. The changes are routine documentation improvements.
Diff
diff --git a/durable-functions/getting-started.md b/durable-functions/getting-started.md index 000c03713..12463a1ba 100644 --- a//durable-functions/getting-started.md +++ b//durable-functions/getting-started.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 -Getting started +Getting Started @@ -11,4 +10,0 @@ Search -[ GitHub ](https://github.com/aws/aws-durable-execution-docs "Go to repository") - -[ ](./.. "AWS Durable Execution docs") AWS Durable Execution docs - @@ -18,36 +14,4 @@ Search - * Getting Started [ Getting Started ](././) On this page - * Table of Contents - * Overview - * The two SDKs - * Execution SDK (aws-durable-execution-sdk-python) - * Testing SDK (aws-durable-execution-sdk-python-testing) - * How durable execution works - * Your development workflow - * 1\. Write your function (execution SDK) - * 2\. Test locally (testing SDK) - * 3\. Deploy to Lambda - * 4\. Test in the cloud (optional) - * Quick start - * Using a custom boto3 Lambda client - * Next steps - * See also - * [ 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/) - + * [ Getting Started ](././) + * [ SDK Reference ](../sdk-reference/operations/step/) + * [ Testing ](../testing/basic-tests/) + * [ Patterns ](../patterns/best-practices/) @@ -56 +19,0 @@ Search -On this page @@ -58,15 +21 @@ On this page - * Table of Contents - * Overview - * The two SDKs - * Execution SDK (aws-durable-execution-sdk-python) - * Testing SDK (aws-durable-execution-sdk-python-testing) - * How durable execution works - * Your development workflow - * 1\. Write your function (execution SDK) - * 2\. Test locally (testing SDK) - * 3\. Deploy to Lambda - * 4\. Test in the cloud (optional) - * Quick start - * Using a custom boto3 Lambda client - * Next steps - * See also +[  ](./.. "AWS Durable Execution SDK Developer Guide") AWS Durable Execution SDK Developer Guide @@ -73,0 +23 @@ On this page +[ GitHub ](https://github.com/aws/aws-durable-execution-docs "Go to repository") @@ -74,0 +25,30 @@ On this page + * [ Home ](./..) + * [ Getting Started ](././) + +Getting Started + * [ Key Concepts ](./key-concepts/) + * [ Quick Start ](./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/) @@ -76 +55,0 @@ On this page -[ ](https://github.com/aws/aws-durable-execution-docs/edit/main/docs/getting-started.md "Edit this page") [ ](https://github.com/aws/aws-durable-execution-docs/raw/main/docs/getting-started.md "View source of this page") @@ -78 +56,0 @@ On this page -# Getting started @@ -80 +58 @@ On this page -## Table of Contents +On this page @@ -82,5 +60,2 @@ On this page - * Overview - * The two SDKs - * How durable execution works - * Your development workflow - * Quick start + * Installation + * Quick example @@ -91,22 +66,2 @@ On this page -[← Back to main index](../) - -## Overview - -This guide explains the fundamental concepts behind durable execution and how the SDK works. You'll understand: - - * The difference between `aws-durable-execution-sdk-python` and `aws-durable-execution-sdk-python-testing` - * How checkpoints and replay enable reliable workflows - * Why your function code runs multiple times but side effects happen once - * The development workflow from writing to testing to deployment - - - -↑ Back to top - -## The two SDKs - -The durable execution ecosystem has two separate packages: - -### Execution SDK (aws-durable-execution-sdk-python) - -This is the **core SDK** that runs in your Lambda functions. It provides: + 1. [ Home ](./..) + 2. [ Getting Started ](././) @@ -114,5 +69 @@ This is the **core SDK** that runs in your Lambda functions. It provides: - * `DurableContext` \- The main interface for durable operations - * Operations - Steps, waits, callbacks, parallel, map, child contexts - * Decorators - `@durable_execution`, `@durable_step`, etc. - * Configuration - StepConfig, CallbackConfig, retry strategies - * Serialization - How data is saved in checkpoints +[ ](https://github.com/aws/aws-durable-execution-docs/edit/main/docs/getting-started/index.md "Edit this page") [ ](https://github.com/aws/aws-durable-execution-docs/raw/main/docs/getting-started/index.md "View source of this page") @@ -119,0 +71 @@ This is the **core SDK** that runs in your Lambda functions. It provides: +# Getting Started @@ -120,0 +73 @@ This is the **core SDK** that runs in your Lambda functions. It provides: +## Installation @@ -122 +75 @@ This is the **core SDK** that runs in your Lambda functions. It provides: -Install it in your Lambda deployment package: +Install the SDK using pip: @@ -128,113 +81 @@ Install it in your Lambda deployment package: -### Testing SDK (aws-durable-execution-sdk-python-testing) - -This is a **separate SDK** for testing your durable functions. It provides: - - * `DurableFunctionTestRunner` \- Run functions locally without AWS - * `DurableFunctionCloudTestRunner` \- Test deployed Lambda functions - * Pytest integration - Fixtures and markers for writing tests - * Result inspection - Examine execution state and operation results - - - -Install it in your development environment only: - - - pip install aws-durable-execution-sdk-python-testing - - -**Key distinction:** The execution SDK runs in production Lambda. The testing SDK runs on your laptop or CI/CD. They're separate concerns. - -↑ Back to top - -## How durable execution works - -Let's trace through a simple workflow to understand the execution model: - -TypeScriptPythonJava - - - // Coming soon... - - - - @durable_execution - def handler(event: dict, context: DurableContext) -> dict: