AWS durable-functions documentation change
Summary
Restructured the getting started documentation by removing detailed code examples and installation instructions, updating navigation links, and adding new sections like quickstart for container images and execution management.
Security assessment
The changes are purely structural and organizational, focusing on improving documentation navigation and content flow. There is no mention of security vulnerabilities, patches, or security features. The removal of code examples and addition of new sections are routine documentation updates without security implications.
Diff
diff --git a/durable-functions/getting-started.md b/durable-functions/getting-started.md index 12463a1ba..5f2e3d9db 100644 --- a//durable-functions/getting-started.md +++ b//durable-functions/getting-started.md @@ -15,3 +15,3 @@ Search - * [ SDK Reference ](../sdk-reference/operations/step/) - * [ Testing ](../testing/basic-tests/) - * [ Patterns ](../patterns/best-practices/) + * [ SDK Reference ](../sdk-reference/) + * [ Testing ](../testing/) + * [ Patterns ](../patterns/) @@ -30,2 +30,7 @@ Getting Started - * [ Quick Start ](./quick-start/) - * SDK Reference SDK Reference + * [ Quickstart ](./quickstart/) + * [ Quickstart for Container Image ](./quickstart-container-image/) + * [ Manage Executions ](./manage-executions/) + * [ Development Environment ](./development-environment/) + * [ SDK Reference ](../sdk-reference/) + +SDK Reference @@ -48 +53,13 @@ Getting Started - * Testing Testing + * [ Configuration ](../sdk-reference/configuration/) + +Configuration + * [ Custom Lambda Client ](../sdk-reference/configuration/custom-lambda-client/) + * [ Language Guides ](../sdk-reference/languages/) + +Language Guides + * [ TypeScript ](../sdk-reference/languages/typescript/) + * [ Python ](../sdk-reference/languages/python/) + * [ Java ](../sdk-reference/languages/java/) + * [ Testing ](../testing/) + +Testing @@ -53 +70,3 @@ Getting Started - * Patterns Patterns + * [ Patterns ](../patterns/) + +Patterns @@ -60,3 +79,2 @@ On this page - * Installation - * Quick example - * Next steps + * Prerequisites + * In this section @@ -71,66 +89 @@ On this page -# Getting Started - -## Installation - -Install the SDK using pip: - - - pip install aws-durable-execution-sdk-python - - -## 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} - - - @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"} - - - @durable_execution - def process_order(event: dict, context: DurableContext) -> dict: - order_id = event["order_id"] - amount = event["amount"] - - # Step 1: Validate the order - validation = context.step(validate_order(order_id)) - - if not validation["valid"]: - return {"status": "failed", "reason": "invalid_order"} - - # Step 2: Charge payment - payment = context.step(charge_payment(order_id, amount)) - - # Step 3: Wait for payment confirmation (simulated) - context.wait(Duration.from_seconds(5)) - - # Step 4: Fulfill the order - fulfillment = context.step(fulfill_order(order_id)) +# Getting Started¶ @@ -138,6 +91 @@ TypeScriptPythonJava - return { - "status": "completed", - "order_id": order_id, - "transaction_id": payment["transaction_id"], - "tracking_number": fulfillment["tracking_number"], - } +This section will help you get started building durable functions in [AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). @@ -144,0 +93 @@ TypeScriptPythonJava +Please see the [SDK Reference](../sdk-reference/) section for in-depth detail of the concepts introduced here. @@ -145,0 +95 @@ TypeScriptPythonJava +## Prerequisites¶ @@ -147 +97,2 @@ TypeScriptPythonJava - // Coming soon... + * An AWS account with permissions to create and execute AWS Lambda functions + * Familiarity with writing AWS Lambda functions @@ -150 +100,0 @@ TypeScriptPythonJava -Each `context.step()` call is checkpointed automatically. If Lambda recycles your execution environment, the function resumes from the last completed step. @@ -152 +102 @@ Each `context.step()` call is checkpointed automatically. If Lambda recycles you -## Next steps +## In this section¶ @@ -154,2 +104,5 @@ Each `context.step()` call is checkpointed automatically. If Lambda recycles you - * [Key Concepts](key-concepts/) \- Understand the mental model behind durable execution - * [Quick Start](quick-start/) \- Build and test your first durable function + * [Key Concepts](key-concepts/) Understand durable execution, checkpoints, replay, and the DurableContext before writing code + * [Quickstart](quickstart/) Install the SDK, write your first durable function, and deploy it with the AWS CLI + * [Quickstart for Container Image](quickstart-container-image/) Deploy a durable function in a container image + * [Manage Executions](manage-executions/) List, inspect, stop, update, and delete durable functions and executions + * [Development Environment](development-environment/) Development workflow, SDK installation, and testing setup