Metadata-Version: 2.4
Name: capo-lambda
Version: 0.14.0
Summary: Python SDK for AWS Lambda.
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Code Generators
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jmespath>=1.0
Requires-Dist: zapros>=0.13.0
Provides-Extra: anyio
Requires-Dist: anyio>=3.0; extra == "anyio"
Provides-Extra: sso
Requires-Dist: capo-sso>=0.2.0; extra == "sso"
Requires-Dist: capo-sso-oidc>=0.2.0; extra == "sso"
Requires-Dist: capo-sts>=0.3.0; extra == "sso"
Dynamic: license-file

# Getting Started

## Installation

```
pip install capo-lambda
```

## Usage

```python
from capo_lambda import AsyncLambdaClient


async def main():
    async with AsyncLambdaClient() as lambda_:
        # Example: call the delete_function operation
        response = await lambda_.delete_function()
        print(response["status_code"])
```

## Pagination

Some operations in this SDK support pagination. If the operation supports pagination it will have an `iter_` prefixed method that returns an async iterator.

```python
from capo_lambda import AsyncLambdaClient


async def main():
    async with AsyncLambdaClient() as lambda_:
        # Example: paginate over list_capacity_providers
        async for item in lambda_.iter_list_capacity_providers():
            print(item)
```

## Streaming Request

Some operations accept a streaming request body. Pass an async iterator of `bytes` chunks, or the whole body as `bytes`, for the streaming parameter.

A plain iterator can be sent only once, so if a request fails after its body was transmitted the operation is not retried. To get retries for streamed uploads, pass a `Body` instead: it wraps a source that can be reopened, and every attempt streams a fresh copy. `Body.from_path` (sync client) and `Body.async_from_path` (async client, needs `anyio`) stream a file from disk; `Body(opener)` takes any context manager that yields a `(stream, length)` pair.

```python
from capo_lambda import AsyncLambdaClient, Body


async def main():
    async with AsyncLambdaClient() as lambda_:
        # Example: call invoke_async with a streaming request body
        async def chunks():
            yield b'Hello, World!'

        response = await lambda_.invoke_async(invoke_args=chunks())
        print(response)

        # Or pass the whole body as bytes
        response = await lambda_.invoke_async(invoke_args=b'Hello, World!')
        print(response)

        # Or stream a file with Body: the file is reopened on every retry
        # and Content-Length is taken from its size, so no content_length needed
        response = await lambda_.invoke_async(invoke_args=Body.async_from_path("hello.txt"))
        print(response)
```

## Waiters

Waiters poll an operation until a resource reaches a desired state. If the operation supports waiters it will have a `wait_until_` prefixed method.

```python
from capo_lambda import AsyncLambdaClient


async def main():
    async with AsyncLambdaClient() as lambda_:
        # Example: wait for function_exists
        await lambda_.wait_until_function_exists(max_wait_time=300)
```

## Error Handling

The SDK raises exceptions for errors returned by the API. Catch them to handle failures gracefully.

```python
from capo_lambda import AsyncLambdaClient
from capo_lambda.error import InvalidParameterValueException


async def main():
    async with AsyncLambdaClient() as lambda_:
        try:
            await lambda_.delete_function()
        except InvalidParameterValueException as e:
            print(f"Error: {e}")
            print(e.data)  # additional error data
```

## Retrying

The SDK retries failed operations automatically. Retry behaviour follows the Smithy specification: errors are retried based on their `is_retryable` and `is_throttling_error` attributes. Throttling errors use a longer base delay. Network-level failures (connection errors and timeouts) are also retried. Non-retryable errors, such as client errors without the `@retryable` trait, are raised immediately without further attempts.

The number of attempts defaults to 3 and can be changed at the client level via `retry_max_attempts`, or per call via `config_overrides`.

```python
from capo_lambda import AsyncLambdaClient


async def main():
    async with AsyncLambdaClient() as lambda_:
        # Default: 3 attempts for every operation
        response = await lambda_.delete_function()

        # Override per operation
        response = await lambda_.delete_function(config_overrides={"retry_max_attempts": 5})

        # Disable retries for this call
        response = await lambda_.delete_function(config_overrides={"retry_max_attempts": 1})
```
