Metadata-Version: 2.4
Name: capo-rds
Version: 0.2.0
Summary: Python SDK for RDS.
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
Dynamic: license-file

# Getting Started

## Installation

```
pip install capo-rds
```

## Usage

```python
from capo_rds import AsyncRDSClient


async def main():
    async with AsyncRDSClient() as s3:
        # Example: call the add_role_to_db_cluster operation
        response = await s3.add_role_to_db_cluster()
        print(response)
```

## 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_rds import AsyncRDSClient


async def main():
    async with AsyncRDSClient() as s3:
        # Example: paginate over describe_blue_green_deployments
        async for item in s3.iter_describe_blue_green_deployments():
            print(item)
```

## Error Handling

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

```python
from capo_rds import AsyncRDSClient
from capo_rds.error import DBClusterNotFoundFault


async def main():
    async with AsyncRDSClient() as s3:
        try:
            await s3.add_role_to_db_cluster()
        except DBClusterNotFoundFault 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_rds import AsyncRDSClient


async def main():
    async with AsyncRDSClient() as s3:
        # Default: 3 attempts for every operation
        response = await s3.add_role_to_db_cluster()

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

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