aws-durable-execution-sdk-java

KO | EN

gitlite — search

#typescript #reactjs #css #python #vite #kotlin #deep-learning #react #openai #plugin #machine-learning #android

aws-durable-execution-sdk-java

★ 29 Open GitHub ↗

Java SDK for AWS Lambda Durable Functions

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# AWS Lambda Durable Execution SDK for Java

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Java](https://img.shields.io/badge/java-%3E%3D17-brightgreen)](https://openjdk.org/)
[![Build](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/build.yml/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/build.yml)
[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://aws.github.io/aws-durable-execution-sdk-java/javadoc/)
[![Maven](https://badges.mvnrepository.com/badge/software.amazon.lambda.durable/aws-durable-execution-sdk-java/badge.svg?label=Maven)](https://mvnrepository.com/artifact/software.amazon.lambda.durable/aws-durable-execution-sdk-java)
[![Coverage](https://aws.github.io/aws-durable-execution-sdk-java/coverage/jacoco.svg)](https://aws.github.io/aws-durable-execution-sdk-java/coverage/)
[![E2E Tests](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/e2e-tests.yml/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/e2e-tests.yml)
[![CodeQL](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/github-code-scanning/codeql)
[![Spotless](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/check-spotless.yml/badge.svg)](https://github.com/aws/aws-durable-execution-sdk-java/actions/workflows/check-spotless.yml)
[![Roadmap](https://aws.github.io/aws-durable-execution-sdk-java/milestone/badge.svg)](https://github.com/orgs/aws/projects/346/views/6)

Build resilient, long-running AWS Lambda functions that automatically checkpoint progress and resume after failures. Durable functions can run for up to one year while you pay only for active compute time.

## Key Features

- **Automatic Checkpointing** – Progress is saved after each step; failures resume from the last checkpoint
- **Cost-Effective Waits** – Suspend execution for minutes, hours, or days without compute charges
- **Configurable Retries** – Built-in retry strategies with exponential backoff and jitter
- **Replay Safety** – Functions deterministically resume from checkpoints after interruptions
- **Type Safety** – Full generic type support for step results
- **Data-Driven Concurrency** – Apply a function across a collection with `map()`, with per-item error isolation and configurable completion criteria

## How It Works

Your durable function extends `DurableHandler<I, O>` and implements `handleRequest(I input, DurableContext ctx)`. The `DurableContext` is your interface to durable operations:

- `ctx.step()` – Execute code and checkpoint the result
- `ctx.wait()` – Suspend execution without compute charges
- `ctx.createCallback()` – Wait for external events (approvals, webhooks)
- `ctx.waitForCallback()` – Simplify callback handling by combining callback creation and submission in one operation
- `ctx.invoke()` – Invoke another Lambda function, durable or standard, and wait for the result
- `ctx.runInChildContext()` – Run an isolated child context with its own checkpoint log
- `ctx.map()` – Apply a function to each item in a collection concurrently
- `ctx.parallel()` - Run multiple operations concurrently with optional concurrency control
- `ctx.waitForCondition()` – Poll a condition function until it signals done, suspending between polls

## Quick Start

### Installation

```xml
<dependency>
 <groupId>software.amazon.lambda.durable</groupId>
 <artifactId>aws-durable-execution-sdk-java</artifactId>
 <version>VERSION</version>
</dependency>
```

### Your First Durable Function

```java
public class OrderProcessor extends DurableHandler<Order, OrderResult> {

@Override
    protected OrderResult handleRequest(Order order, DurableContext ctx) {
        // Step 1: Validate and reserve inventory
        var reservation = ctx.step("reserve-inventory", Reservation.class, 
            stepCtx -> inventoryService.reserve(order.getItems()));

// Step 2: Process payment
        var payment = ctx.step("process-payment", Payment.class,
            stepCtx -> paymentService.charge(order.getPaymentMethod(), order.getTotal()));

// Wait for warehouse processing (no compute charges)
        ctx.wait(null, Duration.ofHours(2));

// Step 3: Confirm shipment
        var shipment = ctx.step("confirm-shipment", Shipment.class,
            stepCtx -> shippingService.ship(reservation, order.getAddress()));

return new OrderResult(order.getId(), shipment.getTrackingNumber());
    }
}
```

## Deployment

See [examples/README.md](./examples/README.md) for complete instructions on local testing and running cloud integration tests.

See [Deploy and invoke Lambda durable functions with the AWS CLI](https://docs.aws.amazon.com/lambda/latest/dg/durable-getting-started-cli.html) for more information on deploying and invoking durable functions.

See [Deploy Lambda durable functions with Infrastructure as Code](https://docs.aws.amazon.com/lambda/latest/dg/durable-getting-started-iac.html) for more information on deploying durable functions using infrastructure-as-code.

## Documentation

- [AWS Documentation](https://docs.aws.amazon.com/lambda/latest/dg/durable-functions.html) – Official AWS Lambda durable functions guide
- [Best Practices](https://docs.aws.amazon.com/lambda/latest/dg/durable-best-practices.html) – Patterns and recommendations
- [FAQ](https://docs.aws.amazon.com/durable-execution/sdk-reference/languages/java/) - Frequently asked questions for the Java SDK
- [Javadoc](https://aws.github.io/aws-durable-execution-sdk-java/javadoc/) - API reference for the Java SDK
- [SDK Design](docs/design.md) – Details of SDK internal architecture

**Core Operations**

- [Steps](docs/core/steps.md) – Execute code with automatic checkpointing and retry support
- [Wait](docs/core/wait.md) - Pause execution without blocking Lambda resources
- [Callbacks](docs/core/callbacks.md) - Wait for external systems to respond
- [Invoke](docs/core/invoke.md) - Call durable functions or standard Lambda functions
- [Child Contexts](docs/core/child-contexts.md) - Organize complex workflows into isolated units
- [Map](docs/core/map.md) - Apply a function across a collection concurrently
- [Parallel](docs/core/parallel.md) - Run multiple operations concurrently with optional concurrency control
- [Wait for Condition](docs/core/wait-for-condition.md) - Poll a condition until it's met, with configurable backoff

**Examples**

- [Examples](examples/README.md) - Working examples of each operation

**Advanced Topics**

- [Configuration](docs/advanced/configuration.md) - Customize SDK behaviour
- [Error Handling](docs/advanced/error-handling.md) - SDK exceptions for handling failures
- [Logging](docs/advanced/logging.md) - How to use DurableLogger
- [Migrating from 1.x to 2.x](docs/migration-1.x-to-2.x.md) - Upgrade guide for breaking changes since `v1.2.1`
- [Release Process](RELEASE.md) - Prepare and publish Maven releases
- [Testing](docs/advanced/testing.md) - Utilities for local development and cloud-based integration testing

## Related SDKs

- [JavaScript/TypeScript SDK](https://github.com/aws/aws-durable-execution-sdk-js)
- [Python SDK](https://github.com/aws/aws-durable-execution-sdk-python)

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for information about reporting security issues.

## License

This project is licensed under the Apache-2.0 License. See [LICENSE](LICENSE) for details.

aws-durable-execution-sdk-java

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README